Modify a Cluster

      +
      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.

      Change Options

      You can change the following options in a deployed Couchbase Capella cluster:

      Option Actions Considerations

      Cluster Name

      You can rename a cluster at any time.

      Plan

      You may be unable to downgrade a service plan if your cluster uses features specific to its current plan.

      Couchbase Services

      A service can only be added once to a cluster. The Data Service cannot be removed. These actions are not supported for clusters using your own cloud account (inVPC).

      Nodes

      Add or remove nodes

      The Data Service requires at least three nodes. All other services require at least two nodes.

      Compute

      Change compute

      Compute options depend on the chosen cloud provider.

      Disk Type

      Change disk type

      AWS: The options are GP3 or IO2. GP3 is general purpose to balance price and performance where you can provision performance independent of storage capacity. IO2 is higher performance and more durable with better reliability.

      GCP: PD-SSD is the only disk type and cannot be changed.

      Storage

      Increase storage

      You cannot decrease storage once it has been added to a cluster.

      IOPS

      Change IOPS

      AWS: The available IOPS range depends on the disk type.

      GCP: IOPS is not a directly configurable value. It’s set based on the amount of storage you’ve assigned to a service group (30 read and 30 write IOPS per GB).

      Prerequisites

      Permissions Required
      For any change, you must have the Project Owner or Cluster Manager role for the project containing the cluster you want to modify.

      View Cluster Nodes

      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. Nodes added or removed from a cluster are shown or removed as appropriate.

      The Nodes page is useful in correlating cluster nodes with your application logs for debugging purposes.

      To view cluster nodes:

      1. Go to the Clusters tab in the main navigation.

      2. Find and click on the cluster that you want to review.

        This opens the cluster with its Metrics tab selected.

      3. Click the cluster’s Nodes tab.

        This action opens the Nodes page.

        A cluster’s Nodes page
      4. In the list, you can hover over a node’s truncated hostname to view it fully.

        You can copy a hostname for a node by clicking the Copy button () on the right side of the table.
      5. Review the services on each node, including any truncated services you might need to hover over to view fully.

      To modify existing service configurations, see the Modify an Existing Service Configuration section for more information.

      View the Cluster Configuration

      1. Go to the Clusters tab in the main navigation.

      2. Find and click on the cluster that you want to modify.

        This opens the cluster with its Metrics tab selected.

      3. Click the Configuration tab.

        This action opens the Configuration page.

        A cluster’s Configuration page.

      Modify the Cluster Configuration

      When using Capella with your own cloud account (inVPC), you cannot decrease the number of nodes, change the capacity (VM instance type), or change the storage of service nodes.
      Cluster configuration options depend on the cluster’s cloud provider. For more information on the configuration options available for each cloud provider, see Amazon Web Services (AWS) and Google Cloud Platform (GCP).

      Add a Service

      Limitations
      You cannot add a service to a cluster when the same service is already on the cluster.

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

      1. Go to the cluster’s Configuration tab.

      2. Add new Services.

        Add more services to an existing service group by clicking the Services drop-down menu and selecting the services you require. Alternatively, you can add more service groups by clicking Add Service Group.

        Only services not on the cluster are available to add.

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

      3. If you have no other cluster changes to make, you need to review and apply your current changes.

      Remove a Service

      Limitations
      You cannot remove the Data Service.
      1. Go to the cluster’s Configuration tab.

      2. In the appropriate service configuration row, click the Clear icon on the service you want to remove.

      3. If you have no other cluster changes to make, you need to review and apply your current changes.

      Add or Remove Nodes

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

      2. Using the Nodes drop-down of the service group you’re modifying, choose a new number of nodes you want for this configuration.

      3. If you have no other cluster changes to make, you need to review and apply your current changes.

      Change Compute

      1. Go to the cluster’s Configuration tab.

      2. Using the Compute drop-down of the service group you’re modifying, choose a new compute instance type for this configuration.

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

      3. If you have no other cluster changes to make, you need to review and apply your current changes.

      Change Disk Type

      Limitations
      GCP only supports PD-SSD. You can only change the disk type for clusters deployed with AWS (GP3 or IO2).
      1. Go to the cluster’s Configuration tab.

      2. Use the Disk Type toggle to switch between GP3 and IO2 for the configuration you’re modifying.

      3. If you have no other cluster changes to make, you need to review and apply your current changes.

      Increase Storage

      Limitations
      Storage cannot be removed from a service configuration once added.
      1. Go to the cluster’s Configuration tab.

      2. Using the Storage field of the service group you’re modifying, increment to or enter the amount (GB) of storage you want per node for this configuration.

      3. If you have no other cluster changes to make, you need to review and apply your current changes.

      Change IOPS

      Limitations
      IOPS (Input/Output Operations per Second) is not a directly configurable value for clusters deployed with GCP. Instead, it’s automatically set at 30 read and 30 write IOPS per GB of storage provisioned.
      1. Go to the cluster’s Configuration tab.

      2. Using the IOPS field, increment to or enter the IOPS value for the service group you’re modifying.

        This field is not shown when a cluster uses GCP as its cloud provider.

      3. If you have no other cluster changes to make, you need to review and apply your current changes.

      Review and Apply Changes

      1. Review and update configuration

        Any changes you make to a cluster appear on the Configuration page. Review this new configuration to ensure that it meets your requirements.

        Any warnings about your proposed changes are shown on the page and will not let you update the configuration until you resolve them. If you need to discard your changes, click Cancel.

      2. Once you have reviewed the changes, click Update Configuration.

      3. In the notification that appears, click Confirm.

        The cluster will rebalance and redistribute 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 up and available during the rebalance.

      Rename a Cluster

      1. From the Clusters tab, find the cluster you want to rename and click its name.

        This opens the cluster with its Metrics tab selected.

      2. Click the vertical ellipsis icon to the right of the cluster’s name.

      3. From the drop-down menu, click Edit Cluster Name.

        This action opens the Update Cluster Name flyout.

      4. In the field provided, type a new name for the cluster.

      5. Click Update Cluster Name.

        The cluster name is updated immediately.