Skip to content

Latest commit

 

History

History
98 lines (65 loc) · 4.94 KB

serverless-cluster-management.md

File metadata and controls

98 lines (65 loc) · 4.94 KB
title summary toc docs_area
Manage a CockroachDB Serverless 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 {{ site.data.products.serverless }}.

View Clusters page

On logging in to the {{ site.data.products.db }} 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 {{ site.data.products.serverless }} 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.

Estimate usage cost

{{site.data.alerts.callout_info}} This feature is not available if your organization is billed through Credits. {{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 Usage this month section of your cluster's Overview page, click Estimate usage cost.

  2. Select a time frame in which your workload was active.

    Your used RUs, used storage, and spend from the selected time frame will be shown along with your monthly cost estimate. The spend and cost estimate do not account for the free resources granted to every {{ site.data.products.serverless }} cluster, which you would have to use up before being charged.

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.

Create a database

You can use the Databases page to create a new database from the {{ site.data.products.db }} Console.

  1. Navigate to the Databases page from the Overview page of your cluster.
  2. Click Add database.
  3. Enter a name for the new database.
  4. Click Create.

Restore data from a backup

Use the Backups page to restore your cluster from automatic full cluster backups.

You can also backup and restore your {{ site.data.products.serverless }} 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

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

{{site.data.alerts.callout_info}} Free {{ site.data.products.serverless }} 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. 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.