Modify a Cluster

    +
    Review, modify, rename, and scale clusters. Copy and paste node hostnames on clusters.

    You must have the Project Owner or Cluster Manager role for the project containing the cluster you want to review, modify, or rename.

    Review Cluster Nodes and Services

    Before you modify a cluster, you might want to review a list of all individual nodes running on it. You can view the CPU, RAM, disk usage, and status of each node. Node statuses are Normal, Deploying, and Unhealthy. You can correlate nodes on the cluster with your application logs for debugging purposes. You can also view all services associated with each node. Nodes added or removed from a cluster are shown or removed as appropriate.

    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.

    4. In the list, hover over a node’s hostname to view its full name.

    5. Review the services on each node including any truncated services you might need to hover over.

    6. Add a new service or modify an existing service configuration. See Add a New Service to a Cluster and Modify an Existing Service Configuration for more information.

    Add a New Service to a Cluster

    Limitations

    You cannot add new services to clusters that were deployed using the Starter Kit template, as this template includes all of the services for you. Similarly, you cannot add a particular service to a cluster when the same service is already deployed on the cluster.

    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.

    4. Do one of the following:

      • Click Add Service Group.

      • Click the down-arrow on the service configuration row that you want to add a service to and select the Couchbase service that you require. Only services that are not already deployed on the cluster are available for selection.

    5. Complete the following fields:

      Field Description

      Nodes

      Select the number of nodes having the current configuration that you want to add to the cluster. A minimum of two nodes are required for a service, except for a data service where the minimum is three nodes.

      Compute

      Select one of the available compute instance types. The compute instance type you choose is used for each node in the service configuration.

      Disk Type

      Select the required SSD volume type in AWS EBS for the service. 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.

      Storage

      Enter the required amount of storage for the service. The minimum disk size is 50GB.

      IOPS

      Enter the required amount of IOPS for the service.

      For more information about the above fields, see Sizing a Cluster.

    6. Do one of the following:

      • Click Cancel to undo your changes and start again.

      • Click Update Configuration when you are happy with your changes.

    7. In the notification that appears, click Confirm.

      The cluster begins to rebalance and the service’s data is redistributed 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 node, and how much data is redistributed. The cluster remains up and available during the rebalance.

    Modify an Existing Service Configuration

    Limitations

    When deployed using your own cloud, you cannot modify services on clusters that were deployed using the Starter Kit template, as this template includes all of the services for you. These services are not editable.

    Additionally, with your own cloud, you cannot decrease the number of nodes of an existing service, or change the capacity (VM instance type) or storage of service nodes.

    1. Go to the cluster’s Configuration tab.

    2. Add services or edit the fields in the service configuration rows. See Add a New Service to a Cluster for more information about services and fields. For example, select the required number of nodes that you want to scale the service to. For more information about sizing your cluster, see Sizing a Cluster.

    3. Do one of the following:

      • Click Cancel to undo your changes and start again.

      • Click Update Configuration when you are happy with your changes.

    4. In the notification that appears, click Confirm.

      The cluster begins to rebalance and the service’s data is redistributed over the new superset of nodes. For example, if you added a new node to the Data Service, then whatever active and replica vBuckets were previously distributed across the existing Data nodes are redistributed across the new superset of Data nodes created by the addition.

      The amount of time taken for the new nodes to rebalance into the cluster depends on the service of the new node, and how much data is redistributed. During the rebalance, cluster services remain available.

    Remove a Service from a Cluster

    You can remove a service from a cluster that is hosted by Couchbase. If you are using your own cloud account, for example, AWS or Azure, removing a service is not currently supported.

    1. Open the Clusters tab in the main navigation.

    2. Find and click on the cluster from where you want to remove a service.

    3. Click the cluster’s Configuration tab.

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

    5. Click Update Configuration.

    6. Click Confirm.

    Rename a Cluster

    1. From the Clusters tab, find the cluster that 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 Update Cluster Name flyout, in the field provided, type a new name for the cluster.

    5. Click Update Cluster Name.

      The cluster name is updated. Cluster services remain available.

    Copy and Paste a Node Hostname

    You can copy the hostnames of nodes running on specific services, and paste them into integrations or curl commands.

    1. Click the cluster’s Nodes tab.

    2. In the list, on a node, click Copy Hostname to Clipboard.

    3. Paste the node hostname where you want to copy it to.