Modify a Paid Cluster

  • Capella Operational
      +
      Review, modify, and rename Couchbase Capella clusters.

      Use the procedures on this page to modify an existing Couchbase Capella cluster. If you want to learn about scaling a cluster, see Cluster Scaling.

      Prerequisites

      View Cluster Node Configurations

      Before modifying a cluster, you can review a list of all individual nodes running on it. This list includes the hostname, status, and services associated with each node. It also describes each node’s CPU, RAM, and disk usage. Node statuses are Normal, Deploying, and Unhealthy.

      1. Open the Settings page for your cluster:

        1. With the Projects tab in your organization open, click the project with the cluster you’re working with.

        2. With the Operational tab open, select your cluster.

        3. Click the Settings tab.

      2. In the navigation pane, click Nodes:

        Database nodes page

        To modify service configurations, see Modify the Cluster Configuration.

      Modify the Cluster Configuration

      Cluster configuration options depend on the chosen cloud provider. For more information about the configuration options available for each cloud provider, see Amazon Web Services (AWS) and Google Cloud Platform (GCP).

      Add a Service

      You can enable Couchbase Capella’s Storage Auto-Expansion feature to automatically increase your storage capacity as your data grows.

      Service groups allow you to create node configurations for specified Couchbase services.

      1. Open the Settings page for your cluster:

        1. With the Projects tab in your organization open, click the project with the cluster you’re working with.

        2. With the Operational tab open, select your cluster.

        3. Click the Settings tab.

      2. In the navigation pane, click Services.

      3. Use the Services list to select the services you want to add:

        Adding services to cluster

        You can also add another service group by clicking Add Service Group.

        Once you add a service to a new or existing service group, you may need to adjust its hardware configuration. For more information about sizing a cluster, see Sizing a Cluster.

        Node RAM Allocations

        If you deploy multiple Services in a Service Group, Capella distributes the memory allocated to each node in that group between the operating system and all deployed Services.

        Capella gives 20% of the available RAM on a node to the operating system. It divides the remaining RAM evenly between Services in the Service Group. For example, if there was 25 GB of RAM available on a node in a Service Group that needed to run 3 Services, each Service would get 8.3 GB of RAM (25/3).

        If you plan to run more than 1 Service on the nodes in your Service Groups, make sure to size your nodes with appropriate compute resources. For production clusters, consider running each of your Services with their own dedicated nodes to give them enough RAM.

      4. If you have no other changes, review and apply the new configuration.

      Limitations
      You cannot add a service when that service already exists on the cluster. To deploy the Search, Analytics, or Eventing Services on a Single Node cluster, you must use a 4vCPU 16 GB RAM compute configuration. For more information, see Compute Configuration.

      Remove a Service

      1. Open the Settings page for your cluster:

        1. With the Projects tab in your organization open, click the project with the cluster you’re working with.

        2. With the Operational tab open, select your cluster.

        3. Click the Settings tab.

      2. In the navigation pane, click Services.

      3. To remove a service, click the x icon for the service you’re removing in the Services list:

        Deleting a cluster service
      4. If you have no other changes, review and apply the new configuration.

      Limitations
      You cannot remove the Data Service.

      Add or Remove Nodes

      1. Open the Settings page for your cluster:

        1. With the Projects tab in your organization open, click the project with the cluster you’re working with.

        2. With the Operational tab open, select your cluster.

        3. Click the Settings tab.

      2. In the navigation pane, click Services.

      3. Using the Nodes list in the service group you’re modifying, choose a new number of nodes for this configuration.

      4. If you have no other changes, review and apply the new configuration.

      Limitations
      Services require a minimum of two nodes, except for the Data Service, which needs three. A cluster can have up to 27 nodes.

      Change Compute

      1. Open the Settings page for your cluster:

        1. With the Projects tab in your organization open, click the project with the cluster you’re working with.

        2. With the Operational tab open, select your cluster.

        3. Click the Settings tab.

      2. In the navigation pane, click Services.

      3. Use the Compute drop-down in the service group you’re modifying to choose a new compute instance type.

        The compute dictates the number of vCPUs and memory provisioned for each node in a service group.

      4. If you have no other changes, review and apply the new configuration.

      Change Disk Type

      1. Open the Settings page for your cluster:

        1. With the Projects tab in your organization open, click the project with the cluster you’re working with.

        2. With the Operational tab open, select your cluster.

        3. Click the Settings tab.

      2. In the navigation pane, click Services.

      3. Use the Disk Type control to change disk types for the configuration you’re modifying.

      4. If you have no other changes, review and apply the new configuration.

      Limitations
      • GCP: Only supports PD-SSD.

      Increase Storage

      1. Open the Settings page for your cluster:

        1. With the Projects tab in your organization open, click the project with the cluster you’re working with.

        2. With the Operational tab open, select your cluster.

        3. Click the Settings tab.

      2. In the navigation pane, click Services.

      3. Using the Storage box of the service group you’re modifying, enter the amount of storage you want per node for this configuration. If the cluster uses Azure, you must choose a new disk type to increase storage.

      4. If you have no other changes, review and apply the new configuration.

      Limitations

      Storage can’t be removed from a service configuration once added.

      • Azure: You can only increase storage by choosing a new disk type.

      Change IOPS

      Adjusting the IOPS rate affects performance and cost. When creating or modifying a cluster with AWS gp3, AWS io2, or Azure Ultra Disk and choosing a storage option, Capella uses recommended defaults for the IOPS field. You can replace the default IOPS value with one higher than the default but not lower. For the recommended IOPS values for clusters using AWS gp3, AWS io2, or Azure Ultra Disk, see IOPS Defaults.

      1. Open the Settings page for your cluster:

        1. With the Projects tab in your organization open, click the project with the cluster you’re working with.

        2. With the Operational tab open, select your cluster.

        3. Click the Settings tab.

      2. In the navigation pane, click Services.

      3. Using the IOPS box, enter the IOPS value for the service group you’re modifying.

        This field isn’t shown when a cluster uses GCP as its cloud provider. If you’re using Azure’s Premium SSD disk type, you can’t change the value of this field.

      4. If you have no other changes, review and apply the new configuration.

      Limitations
      • GCP: IOPS (Input/Output Operations per Second) isn’t a directly configurable value. Instead, it’s automatically set at 30 reads and 30 writes IOPS per GB of storage provisioned.

      • Azure: IOPS for the Premium SSD (P) disk type are based on the chosen Premium SSD disk size. The IOPS for the Ultra disk type can be set, but the possible range depends on the chosen storage size.

      Review and Apply Changes

      1. Review and update configuration

        All the changes you make to a cluster are on the Service page. Review this new configuration to ensure it meets your requirements.

        Any warnings about your proposed changes appear on the Service page and can prevent you from updating the configuration until you resolve them. If you need to discard your changes, click Cancel.

      2. Once you have reviewed the changes, click Save.

      The cluster rebalances and redistributes service data over the new superset of nodes. The amount of time taken for the new nodes to rebalance into the cluster depends on the service of the new nodes, and how much data is redistributed. The cluster remains available during the rebalance, but you can’t make further changes until the rebalancing is complete.

      Rename a Cluster

      1. Open the Settings page for your cluster:

        1. With the Projects tab in your organization open, click the project with the cluster you’re working with.

        2. With the Operational tab open, select your cluster.

        3. Click the Settings tab.

      2. In the Cluster Name field, enter a new name for the cluster.

      3. Click Save.

      Change Your Deletion Protection

      Turn on deletion protection to stop accidental deletion of a cluster from the Capella UI, the Management API, or any other external tools, such as Terraform. If you turn on deletion protection, Capella will also automatically turn on deletion protection for any App Services linked to your cluster.

      Cluster deletion protection also prevents bucket deletion or bucket flushing.

      You can change this setting even when a cluster is turned off.

      To change deletion protection settings, you must have the Organization Owner role in your organization, or one of the following project roles for the project that contains your cluster:

      To change the deletion protection setting for a cluster:

      1. Open the Settings page for your cluster:

        1. With the Projects tab in your organization open, click the project with the cluster you’re working with.

        2. With the Operational tab open, select your cluster.

        3. Click the Settings tab.

      2. Select or clear Enable Deletion Protection.

      3. Click Save.