Manage a CockroachDB Dedicated Cluster

On this page Carat arrow pointing down

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

Planning your cluster

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

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:

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:

The cluster's Configuration shows details about the cluster, its deployment environment, and its nodes, such as the cluster's cloud provider, plan type, regions, and each node's status, compute, and storage.

The Cluster upgrades section shows the cluster's Upgrade window for patch upgrades and the current value for the Delay patch upgrades setting.

  • The PCI Ready section shows the status of features required for PCI DSS. Requires CockroachDB Dedicated advanced.

  • The status of security features required for PCI DSS readiness.

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

Scale your cluster

These sections show how to scale a Dedicated cluster horizontally by adding or removing nodes or vertically by changing each node's storage and compute resources.

Add or remove nodes from a cluster

You can add or remove nodes from your cluster through the Console. See Planning your cluster for cluster requirements and recommendations before proceeding.

Note:

You cannot scale a multi-node cluster down to a single-node cluster. If you need to scale down to a single-node cluster, back up your cluster and restore it into a new single-node cluster. Single-node clusters are not available on Azure.

To add or remove nodes from a cluster on AWS or GCP:

  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, select the number of nodes you want in each region from the Nodes dropdown.

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

  5. Click Next: Capacity and then Update cluster.

Change compute for a cluster

  1. Navigate to the cluster's Overview page and click Update capacity.

    The Edit cluster page displays.

  2. In the Compute per node section, select the new amount of vCPUs per node.

    Note:

    When scaling up your cluster, it is generally more effective to increase node size up to 16 vCPUs before adding more nodes. For most production applications, we recommend at least 4 to 8 vCPUs per node.

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

  4. Click Next: Update cluster.

Increase storage for a cluster

Warning:

AWS disks can only be scaled once every six hours.

  1. Navigate to the cluster's Overview page.

  2. Select Actions > Edit cluster.

    The Edit cluster page displays.

  3. In the Storage per node section, select the new amount of storage per node.

    Warning:

    Storage space cannot be removed due to cloud provider limitations.

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

  5. Click Next: Update cluster.

Add or remove regions from a cluster

You can add or remove up to nine regions at a time through the Console. Note that you cannot have a two-region cluster, and it will take about 30 minutes to add or remove each region. See Planning your cluster for cluster requirements and recommendations before proceeding.

Add a region to your cluster

You can add up to nine regions at a time through the Console. See Planning your cluster for cluster requirements and recommendations before proceeding.

  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 a region.

    If you have a GCP cluster with VPC peering enabled, the IP range will be automatically populated for added regions.

  4. Select the desired new region and specify the number of nodes for it.

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

  6. Click Next: Capacity and then Update cluster.

Remove a region from your cluster

When you remove a region from a multi-region cluster, the node in that region with the highest ordinal will be decommissioned first. Any ranges on that node will be up-replicated to other nodes, and once decommission is complete that node will be shut down. This process is then repeated for every other node in the region.

Note:

If your zone configurations are set to pin range replicas to a specific region, you cannot remove that region.

To remove a region from 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 the X button next to each region you want to remove.

    Note:
    If you remove one region from a three-region cluster, CockroachDB Cloud will automatically reduce it to a single-region configuration by deleting two regions.

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

  5. Click Next: Capacity and then Update cluster.

Set a maintenance window

From your cluster's Overview page, you can view and manage the maintenance and patch upgrade window for your cluster. During the window, your cluster may experience restarts, degraded performance, and downtime for single-node clusters. To help keep your clusters updated while minimizing disruptions, set a window of time when your cluster is experiencing the lowest traffic. If no maintenance window is set, your cluster will be automatically upgraded as soon as new patch versions are available, and other cluster maintenance occurs as needed. Refer to CockroachDB Cloud Upgrade Policy.

Note:

Maintenance operations that are critical for cluster security or stability may be applied outside of the maintenance window, and upgrades that begin in a maintenance window may not always be completed by the end of the window.

To set a maintenance window:

  1. Click the pencil icon next to Cluster maintenance to edit the maintenance window.
  2. From the Day dropdown, select the day of the week during which maintenance may be applied.

  3. From the Start of window dropdown, select a start time for your maintenance window in UTC.

    The window will last for 6 hours from the start time.

  4. (Optional) If you want to delay automatic patch upgrades for 60 days, switch Delay patch upgrades to On.

    Enable this setting for production clusters to ensure that development and testing clusters are upgraded before production clusters. This setting applies only to patch versions and not to other kinds of upgrades.

Restore data from a backup

Cockroach Labs runs full backups daily and incremental backups hourly for every CockroachDB Dedicated cluster. Full backups are retained for 30 days and incremental backups for 7 days. See the Use Managed-Service Backups page for ways to restore data from your cluster's automatic backups in the Console.

Additionally, you can back up and restore your CockroachDB Dedicated cluster manually. For detail on taking backups to your cloud storage, see Take and Restore Customer-Owned Backups.

Note:

All databases are not backed up at the same time. Each database is backed up every hour based on the time of creation. For larger databases, you might see an hourly CPU spike while the database is being backed up.

Configure PCI ready features (Dedicated advanced)

CockroachDB Dedicated advanced clusters have a PCI ready panel to monitor the status of security features required for PCI DSS readiness. Feature statuses will update from INACTIVE to ACTIVE once you configure them. Learn more about configuring these features:

You can also check the status of these features on the PCI ready page of the CockroachDB Cloud Console.

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.

Note:

You will only be billed for a CockroachDB Dedicated cluster while it is running. You can delete a cluster at any time to stop charges from accumulating.

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

Product

Resources

Learn

Support Channels

Company

Get developer news