Manage a CockroachDB Advanced Cluster

On this page Carat arrow pointing down

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

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 Advanced 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

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 compute per node and storage per node.

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

Restore data from a backup

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

You can also back up and restore your 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

Warning:

Deleting a cluster will delete all cluster data.

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.

Yes No
On this page

Yes No