Manage a CockroachDB Serverless Cluster

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

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:
  • Edit cluster
  • Move cluster
  • Delete cluster
  • Get support

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 Serverless cluster:

• The Cluster settings section, including Cloud provider, Plan type, and Regions
• The Capacity used this month section, including Request Units and Storage
• The cluster's Current activity
• Time-series graphs of the cluster's Request Units, Storage usage, and SQL statements

For more information, see Cluster Overview Page.

Estimate usage cost

The monthly cost estimate is calculated using simple extrapolation that assumes your workload during the selected time frame is an accurate representation of your workload over the month. If you haven't been running a workload for at least the length of the selected time frame, your results will be inaccurate.

1. In the Capacity used this month section of your cluster's Overview page, click Update capacity.
2. On the Edit cluster page, navigate to Capacity.

3. Under the Estimate cost based on usage section, select a time period in which your workload was active.

   Your used RUs, used storage, and accrued costs during the time period will be shown along with a monthly cost estimate. The accrued costs and monthly cost estimate do not account for the free resources granted to each non-contract organization, which you would have to use up before being charged.

Edit cluster capacity

On the Overview page, you can edit your resource limits. Changes apply to the current and future billing cycles. For more details, refer to Plan a CockroachDB Serverless cluster.

1. In the Capacity used this month section of your cluster's Overview page, click Update capacity.

2. On the Capacity page, set the configure the new resource limits. In the sidebar, click Update cluster.

Edit regions

You can add up to six regions at a time and change your primary region through the Cloud Console. You cannot currently edit the region configuration for a single-region cluster once it has been created, and you cannot remove a region once it has been added.

Add regions

To add regions 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. Click Add region.

4. Choose the region you want to add or use the suggested one.

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

6. Click Next: Capacity and then click Update cluster.

Edit the primary region

To set the primary region:

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. Select Set primary region next to your preferred region.

4. Click Next: Capacity and then click Update cluster.

Move cluster to a new region

A CockroachDB Serverless cluster cannot be moved from one region to another directly. Instead, you must restore the cluster's data from a backup to a new CockroachDB Serverless cluster with the desired region configuration:

1. Back up your existing cluster's data.
2. Create a new CockroachDB Serverless cluster in the desired region.
3. Once the new cluster is set up, restore your data from the backup into the new cluster.

Restore data from a backup

Use the Managed-Service Backups to restore your cluster from automatic full cluster backups.

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.