Manage a CockroachDB Dedicated Cluster

This page describes the cluster management and cluster deletion workflows for CockroachDB Dedicated.

Planning your cluster

Before making any changes to your cluster's nodes or regions, review the requirements and recommendations for CockroachDB Cloud cluster configuration.

View Clusters page

On logging in to the CockroachDB Cloud Console, the Clusters page is displayed. The Clusters page provides a high-level view of your clusters.

For each cluster, the following details display:

• The cluster's Name
• The cluster's Plan Type, either Serverless or Dedicated
• The date and time the cluster was Created
• The cluster's current State
• The cluster's Cloud provider, either GCP or AWS
• The Version of CockroachDB the cluster is running
• The Action button, which is used to:
  • Add or remove nodes
  • Increase storage
  • Change compute
  • Upgrade major version
  • Add/remove regions
  • Delete cluster

To view and manage a specific cluster, click the name of the cluster. The Overview page will display.

View cluster overview

The Overview page displays details about the selected CockroachDB Cloud cluster:

• The Current Charges and next billing date for the cluster
• The cluster's Cloud provider
• The cluster's Hardware per node

• A list of the selected cluster's nodes.

  For each node, the page displays the node's Name and Status, nested under its region.

From the Overview page, you can connect to your cluster. For more information, see Connect to Your CockroachDB Dedicated Cluster.

Scale your cluster

Add or remove nodes from a cluster

You can add or remove nodes from your cluster through the Console. See Planning your cluster for cluster requirements and recommendations before proceeding.

To add or remove nodes from your cluster:

1. Navigate to the cluster's Overview page.

2. Select Actions > Edit cluster.

   The Edit cluster page displays.

3. From the Nodes dropdown, select the number of nodes you want in each region.

4. In the Summary sidebar, verify the hourly estimated cost for the cluster.

5. Click Next: Payment.

6. On the Summary page, verify your new cluster configuration.

7. Click Update.

Increase storage for a cluster

1. Navigate to the cluster's Overview page.

2. Select Actions > Edit cluster.

   The Edit cluster page displays.

3. Navigate to the Storage dropdown in the Hardware per node section.

4. Select the new amount of storage per node.

   Warning:

   Storage space cannot be removed from a node once added.

5. In the Summary sidebar, verify the hourly estimated cost for the cluster.

6. Click Next: Payment.

7. On the Summary page, verify your new cluster configuration.

8. Click Update.

Change compute for a cluster

1. Navigate to the cluster's Overview page.

2. Select Actions > Edit cluster.

   The Edit cluster page displays.

3. Navigate to the Compute dropdown in the Hardware per node section.

4. Select the new amount of vCPUs per node.

   Note:

   When scaling up your cluster, it is generally more effective to increase node size up to 16 vCPUs before adding more nodes. For most production applications, we recommend at least 4 to 8 vCPUs per node.

5. In the Summary sidebar, verify the hourly estimated cost for the cluster.

6. Click Next: Payment.

7. On the Summary page, verify your new cluster configuration.

8. Click Update.

Add or remove regions from a cluster

You can add or remove up to nine regions at a time through the Console. Note that you cannot have a two-region cluster, and it will take about 30 minutes to add or remove each region. See Planning your cluster for cluster requirements and recommendations before proceeding.

Add a region to your cluster

1. Navigate to the cluster's Overview page.

2. Select Actions > Edit cluster.

   The Edit cluster page displays.

3. Click Add a region.

   If you have a GCP cluster with VPC peering enabled, the IP range will be automatically populated for added regions.

4. From the Choose a region dropdown, select the region you want to use.

5. From the Nodes dropdown, select the number of nodes in the new region.

6. In the Summary sidebar, verify the hourly estimated cost for the cluster.

7. Click Continue to payment.

8. In the Confirmation dialog, verify your new cluster configuration.

9. Click OK.

Remove a region from your cluster

1. Navigate to the cluster's Overview page.

2. Select Actions > Edit cluster.

   The Edit cluster page displays.

3. Click the X button next to each region you want to remove.

4. In the Summary sidebar, verify the hourly estimated cost for the cluster.

5. Click Continue to payment.

6. In the Confirmation dialog, verify your new cluster configuration.

7. Click OK.

Restore data from a backup

Cockroach Labs runs full backups daily and incremental backups hourly for every CockroachDB Dedicated cluster. The full backups are retained for 30 days and incremental backups for 7 days.

To restore your data, contact us.

Additionally, you can backup and restore data on your own.

Delete cluster

Proceed with the following steps only if you are sure you want to delete a cluster:

1. Navigate to the Overview page for the cluster you want to delete.
2. Click the Actions button in the top right corner.
3. Select Delete cluster.
4. In the confirmation window, enter the name of the cluster.
5. Click Delete.