Manage a CockroachDB Standard Cluster

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

Planning your cluster

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

View Clusters page

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

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.

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

Add a region to your cluster

1. Navigate to the cluster's Overview page.

2. In the Cluster settings section, click the pencil icon next to the cluster's Regions.

   The Edit Cluster page displays.

3. On the Regions page, click Add Region and select the desired new region.

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

5. Click Next: Capacity and then Update cluster.

Edit cluster capacity

The price-performance characteristics of CockroachDB Standard vary significantly depending on the workload. It can be difficult to estimate a workload's compute requirements in advance. To increase or decrease a cluster's provisioned capacity:

To edit your cluster's capacity:

1. Navigate to the cluster's Overview page.
2. In the Capacity section, click Update capacity. The Capacity page displays.

3. Enter the desired number of request units per second or use the slider to increase or decrease the request units per second.

   Tip:

   You can decrease the provisioned capacity only three times within a 7-day period. You can increase the provisioned capacity at any time.

4. In the sidebar, verify the new estimated cost for the cluster and click Update cluster.

To learn more, refer to Plan a CockroachDB Standard cluster.

Manage cluster upgrades

Set major-version upgrades to automatic or manual

By default, major-version upgrades are automatically applied to CockroachDB Standard clusters. For each cluster, you have the option to enable manual upgrades, instead.

When automatic upgrades are enabled and a new major version is available for CockroachDB Standard:

• The cluster is automatically upgraded by Cockroach Labs to an early production patch release of the new major version, for example vXX.Y.1.
• Each major version, whether a Regular release or Innovation release, is included.
• Each upgrade is finalized immediately, so it is not possible to roll back to the previous major version.

When manual upgrades are enabled and a new major version is available for CockroachDB Standard:

• You will need to manually upgrade the cluster during its support window, to maintain support.
• Once the initial production patch release for the new major version is made available to CockroachDB Standard, you can upgrade at any time to the latest available patch release for that major version.
• You can choose to skip Innovation releases and upgrade directly to the subsequent major verison.
• The upgrade is finalized after a 72-hour window, within which you can choose to roll back to the previous major version.

To disable automatic major-version upgrades for a CockroachDB Standard cluster:

1. On the Cluster Overview page for the cluster, click Actions, then select Manual upgrade settings.
2. Read the information provided, then set Manual upgrades to on.
3. Click Apply.

For manual upgrades to a newer major version of CockroachDB, refer to Upgrade a cluster in CockroachDB Cloud.

Automatic major-version upgrades

When Manual upgrades is set to Off, a CockroachDB Standard cluster will automatically upgrade to a new major version. The version will be a production patch release (likely vXX.Y.1) that is made available soon after the initial GA release (vXX.Y.0).

Before an upgrade is set to occur, a banner displayed in the Console informing you of the version to which the cluster will be upgraded.

When the upgrade occurs, your cluster status will be listed as Available (Maintenance) and will remain operational. When the upgrade is complete, the new version will be indicated in the CockroachDB Cloud Console and you will receive an email notification.

Upgrade the major version manually

For manual upgrades to a newer major version of CockroachDB, refer to Upgrade a cluster in CockroachDB Cloud.

Restore data from a backup

Refer to Managed Backups for instructions to restore your cluster from an automatic cluster backup.

You can also back up and restore your CockroachDB Serverless cluster manually. You can take backups locally to userfile or back up to cloud storage.

Enable deletion protection

To help prevent a cluster from being deleted by mistake, you can enable deletion protection. Before you can delete a cluster with deletion protection enabled, you must disable deletion protection. A user with permission to delete a cluster can enable deletion protection on the same cluster.

1. Navigate to the Overview page for the cluster you want to protect.
2. If deletion protection is disabled, click the pencil icon next to it. Toggle the setting, then click Save.

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. If deletion protection is enabled, click the pencil icon next to it. Toggle the setting, then click Save.
3. Click the Actions button in the top right corner.
4. Select Delete cluster.
5. In the confirmation window, enter the name of the cluster.
6. Click Delete.