Cluster Management

This page describes the cluster management and cluster deletion workflows.

Planning your cluster

Request Units

CockroachDB Serverless (beta) cluster resource usage is measured by two metrics: storage and Request Units, or RUs. RUs represent the compute and I/O resources used by a query. All database operations cost a certain amount of RUs depending on the resources used. For example, a "small read" might cost 2 RUs, and a "large read" such as a full table scan with indexes could cost a large number of RUs. You can see how many Request Units your cluster has used on the Cluster Overview page.

Cluster scaling

CockroachDB Serverless (beta) clusters scale based on your workload. Baseline performance for a Serverless cluster is 100 RUs per second, and any usage above that is called burst performance. Clusters start with 10M RUs of free burst capacity each month and earn 100 RUs per second up to a maximum of 250M free RUs per month. Earned RUs can be used immediately or accumulated as burst capacity. If you use all of your burst capacity, your cluster will revert to baseline performance.

You can set your spend limit higher to maintain a high level of performance with larger workloads. If you have a spend limit, your cluster will not be throttled to baseline performance once you use all of your free earned RUs. Instead, it will continue to use burst performance as needed until you reach your spend limit. You will only be charged for the resources you use up to your spend limit. If you reach your spend limit, your cluster will revert to the baseline performance of 100 RUs per second.

The best way to estimate your resource usage is to enter a spend limit you're comfortable with and run your workload. You can see the RUs and storage your cluster has used in the Usage this month section of the Cluster Overview page. Once enough usage data is available, you can also see a graph of your monthly resource usage and recommended spend limit on the Edit cluster page.

All Console Admins will receive email alerts when your cluster reaches 75% and 100% of its burst capacity or storage limit. If you set a spend limit, you will also receive alerts at 50%, 75%, and 100% of your spend limit.

Example

Let's say you have an application that processes sensor data at the end of the week. Most of the week it handles only occasional read requests and uses under the 100 RUs per second baseline. At the end of the week the sensors send in their data to the application, requiring a performance burst over the 100 RUs per second baseline. When the cluster requires more than 100 RUs per second to cover the burst, it first spends the earned RUs that accrued over the previous week and the 10M free burst RUs given to the cluster each month.

If you have a free cluster, it will be throttled to baseline performance once all of the free and earned burst RUs are used. The sensor data will still be processed while the cluster is throttled, but it may take longer to complete the job. If you have a spend limit set, the cluster will be able to scale up and spend RUs to cover the burst, up to your maximum spend limit. If you reach your spend limit at any point during the month, your cluster will be throttled to baseline performance.

If your cluster gets throttled after using all of its burst capacity during the high load period, it will still earn RUs during lower load periods and be able to burst again. At the end of the month, your usage will reset and you will receive another 10M free burst RUs.

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:

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 (beta) cluster:

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

For more information, see Cluster Overview Page.

Edit your spend limit

You can edit your spend limit from the Overview page. The change in your spend limit will affect current and upcoming billing cycles. See Planning your cluster for more information on resource usage.

  1. Navigate to the Overview page for the cluster you want to edit.
  2. Click the pencil icon (or Add a spend limit if you haven't set one before) next to your Spend limit in the Usage this month section.

    You will be taken to the Edit cluster page, which shows a graph of your cluster's Recommended budget compared to your current budget.

  3. Enter a new Spend limit.

  4. Click Update.

Restore data from a backup

You can backup and restore your CockroachDB Serverless (beta) cluster manually. If you don't have billing information on file for your Organization, you can take backups locally to userfile. Once you enter billing information, even if you don't set a spend limit, you can also backup to cloud storage.

Delete cluster

Warning:

Deleting a cluster will delete all cluster data.

Note:

Free CockroachDB Serverless clusters are subject to deletion after 6 months of no activity.

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.
YesYes NoNo