Skip to content

Latest commit

 

History

History
124 lines (77 loc) · 7.37 KB

basic-cluster-management.md

File metadata and controls

124 lines (77 loc) · 7.37 KB
title summary toc docs_area
Manage a CockroachDB Basic Cluster
Manage your cluster's schema, data, and more.
true
manage

{% include cockroachcloud/filter-tabs/cluster-management.md %}

This page describes the cluster management and cluster deletion workflows for CockroachDB {{ site.data.products.basic }}.

View Clusters page

On logging in to the CockroachDB {{ site.data.products.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 {{ site.data.products.basic }} cluster. For more information, see [Cluster Overview Page]({% link cockroachcloud/cluster-overview-page.md %}).

Estimate usage cost

{{site.data.alerts.callout_info}} This feature is not available if your organization is billed through [Credits]({% link cockroachcloud/billing-management.md %}). {{site.data.alerts.end}}

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]({% link cockroachcloud/cluster-overview-page.md %}), 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]({% link cockroachcloud/plan-your-cluster-basic.md %}#request-units), 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]({% link cockroachcloud/plan-your-cluster-basic.md %}#free-vs-paid-usage) granted to each non-contract organization, which you would have to use up before being charged.

Edit cluster capacity

The price-performance characteristics of CockroachDB {{ site.data.products.basic }} vary significantly depending on the workload. It can be difficult to estimate a workload's compute requirements in advance. With {{ site.data.products.basic }}, by default compute and storage scale with your cluster's needs, but you can limit a cluster's resource usage:

  1. In the Capacity used this month section of your cluster's [Overview page]({% link cockroachcloud/cluster-overview-page.md %}), click Update capacity.

  2. On the Capacity page, edit the resource limits. In the sidebar, click Update cluster.

Changes apply to the current and future billing cycles. For more details, refer to [Plan a CockroachDB {{ site.data.products.basic }} cluster]({% link cockroachcloud/plan-your-cluster-basic.md %}).

Edit regions

You can add up to six [regions]({% link cockroachcloud/regions.md %}) at a time and change your [primary region]({% link cockroachcloud/plan-your-cluster-basic.md %}#multi-region-clusters) through the {{ site.data.products.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.

{{site.data.alerts.callout_info}} You can only add regions to clusters created after May 16, 2023. {{site.data.alerts.end}}

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 {{ site.data.products.basic }} 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 {{ site.data.products.basic }} cluster with the desired region configuration:

  1. [Back up your existing cluster's data]({% link cockroachcloud/take-and-restore-self-managed-backups.md %}).
  2. [Create a new CockroachDB {{ site.data.products.basic }} cluster]({% link cockroachcloud/create-a-basic-cluster.md %}) in the desired region.
  3. Once the new cluster is set up, [restore your data]({% link cockroachcloud/take-and-restore-self-managed-backups.md %}) from the backup into the new cluster.

Change a cluster's plan

To change your cluster's plan between {{ site.data.products.basic }} and {{ site.data.products.standard }}, refer to [Change a Cluster's Plan Between Standard and Basic]({% link cockroachcloud/change-plan-between-basic-and-standard.md %}).

To change from {{ site.data.products.basic }} to {{ site.data.products.advanced }}, refer to [Migrate from Standard or Basic to Advanced]({% link cockroachcloud/migrate-from-standard-to-advanced.md %}).

Restore data from a backup

Use the [Managed Backups]({% link cockroachcloud/managed-backups.md %}) to restore your cluster from automatic full cluster backups.

You can also [back up and restore]({% link cockroachcloud/take-and-restore-self-managed-backups.md %}) your CockroachDB {{ site.data.products.basic }} cluster manually. You can take [backups locally]({% link cockroachcloud/take-and-restore-self-managed-backups.md %}) to [userfile]({% link {{site.current_cloud_version}}/use-userfile-storage.md %}) or [back up to cloud storage]({% link cockroachcloud/take-and-restore-self-managed-backups.md %}).

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

{{site.data.alerts.callout_danger}} Deleting a cluster will delete all cluster data. {{site.data.alerts.end}}

{{site.data.alerts.callout_info}} Free CockroachDB {{ site.data.products.basic }} clusters are subject to deletion after 6 months of no activity. {{site.data.alerts.end}}

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.