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 (Serverless, Dedicated standard, or Dedicated advanced)
• The date and time the cluster was Created
• The cluster's current State
• The cluster's Cloud provider, GCP, AWS, or Azure
• 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
  • 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 cluster's Configuration shows details about the cluster, its deployment environment, and its nodes, such as the cluster's cloud provider, plan type, regions, and each node's status, compute, and storage.

The Cluster upgrades section shows the cluster's Upgrade window for patch upgrades and the current value for the Delay patch upgrades setting.

• The PCI Ready section shows the status of features required for PCI DSS. Requires CockroachDB Dedicated advanced.

• The status of security features required for PCI readiness.

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 due to cloud provider limitations.

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.

Set an upgrade window

From your cluster's Overview page, you can view and manage the patch upgrade window for your cluster. During the window, your cluster may experience restarts, degraded performance, and downtime for single-node clusters. To help keep your clusters updated while minimizing disruptions, set a window of time when your cluster is experiencing the lowest traffic. Note that upgrades may not always be completed by the end of the window, and other kinds of cluster maintenance may occur outside the window.

To set an upgrade window:

1. Click the pencil icon next to Cluster upgrades to edit the upgrade window.
2. From the Upgrade day dropdown, select the day of the week during which upgrades may be applied.

3. From the Start of window dropdown, select a start time for your upgrade window in UTC.

   The window will last for 6 hours from the start time.

4. (Optional) If you want to delay automatic upgrades for 60 days, switch Delay patch upgrades to On.

   You can enable this setting for development and testing clusters if you want to ensure that they are upgraded before production clusters.

Restore data from a backup

Cockroach Labs runs full backups daily and incremental backups hourly for every CockroachDB Dedicated cluster. Full backups are retained for 30 days and incremental backups for 7 days. See the Use Managed-Service Backups page for ways to restore data from your cluster's automatic backups in the Console.

Additionally, you can back up and restore your CockroachDB Dedicated cluster manually. For detail on taking backups to your cloud storage, see Take and Restore Customer-Owned Backups.

Configure PCI ready features (Dedicated advanced)

CockroachDB Dedicated advanced clusters have a PCI ready panel to monitor the status of security features required for PCI readiness. Feature statuses will update from INACTIVE to ACTIVE once you configure them. Learn more about configuring these features:

• CockroachDB Cloud Organization Audit logs
• Customer-Managed Encryption Keys (CMEK)
• Egress Perimeter Controls
• Single Sign-On (SSO) for your CockroachDB Cloud organization and your clusters
• Network security

You can also check the status of these features on the PCI ready page of the CockroachDB Cloud Console.

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.