CockroachDB Standard, our new, enterprise-ready plan, is currently in Preview.
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
- Navigate to the cluster's Overview page.
In the Cluster settings section, click the pencil icon next to the cluster's Regions.
The Edit Cluster page displays.
On the Regions page, click Add Region and select the desired new region.
In the sidebar, verify the hourly estimated cost for the cluster.
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:
- Navigate to the cluster's Overview page.
- In the Capacity section, click Update capacity. The Capacity page displays.
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.
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
By default, major-version and patch upgrades are automatically applied to CockroachDB Standard clusters. To control when a cluster is upgraded to a new major version, you can disable automatic major-version upgrades. Patch upgrades are always applied automatically.
If you disable automatic major-version upgrades for a cluster, to maintain support for the cluster, you must manually upgrade it to a later major version before its current version reaches End of Support (EOS).
To disable automatic major-version upgrades for a CockroachDB Standard cluster:
- On the Cluster Overview page for the cluster, click Action, then select Manual upgrade settings.
- Read the information provided, then set Manual upgrades to on.
- Click Apply.
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.
- Navigate to the Overview page for the cluster you want to protect.
- If deletion protection is disabled, click the pencil icon next to it. Toggle the setting, then click Save.
Delete cluster
Deleting a cluster will delete all cluster data.
You will be billed only for a CockroachDB Standard cluster while it is running. You can delete a cluster at any time to prevent charges from accumulating.
Proceed with the following steps only if you are sure you want to delete a cluster:
- Navigate to the Overview page for the cluster you want to delete.
- If deletion protection is enabled, click the pencil icon next to it. Toggle the setting, then click Save.
- Click the Actions button in the top right corner.
- Select Delete cluster.
- In the confirmation window, enter the name of the cluster.
- Click Delete.