Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for changing cluster plan between Standard and Basic #19462

Merged
merged 15 commits into from
Apr 3, 2025
24 changes: 18 additions & 6 deletions src/current/_includes/v24.2/sidebar-data/cloud-deployments.json
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,12 @@
"urls": [
"/cockroachcloud/provision-a-cluster-with-terraform.html"
]
},
{
"title": "Change a Cluster's Plan Between Basic and Standard",
"urls": [
"/cockroachcloud/change-plan-between-basic-and-standard.html"
]
}
]
},
Expand Down Expand Up @@ -107,9 +113,15 @@
]
},
{
"title": "Migrate from Standard or Basic to Advanced",
"urls": [
"/cockroachcloud/migrate-from-standard-to-advanced.html"
"title": "Migrate from Standard to Advanced",
"urls": [
"/cockroachcloud/migrate-from-standard-to-advanced.html"
]
},
{
"title": "Change a Cluster's Plan Between Basic and Standard",
"urls": [
"/cockroachcloud/change-plan-between-basic-and-standard.html"
]
}
]
Expand Down Expand Up @@ -160,9 +172,9 @@
]
},
{
"title": "Migrate from Standard or Basic to Advanced",
"urls": [
"/cockroachcloud/migrate-from-standard-to-advanced.html"
"title": "Migrate from Standard to Advanced",
"urls": [
"/cockroachcloud/migrate-from-standard-to-advanced.html"
]
}
]
Expand Down
24 changes: 18 additions & 6 deletions src/current/_includes/v24.3/sidebar-data/cloud-deployments.json
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,12 @@
"urls": [
"/cockroachcloud/provision-a-cluster-with-terraform.html"
]
},
{
"title": "Change a Cluster's Plan Between Basic and Standard",
"urls": [
"/cockroachcloud/change-plan-between-basic-and-standard.html"
]
}
]
},
Expand Down Expand Up @@ -107,9 +113,15 @@
]
},
{
"title": "Migrate from Standard or Basic to Advanced",
"urls": [
"/cockroachcloud/migrate-from-standard-to-advanced.html"
"title": "Migrate from Standard to Advanced",
"urls": [
"/cockroachcloud/migrate-from-standard-to-advanced.html"
]
},
{
"title": "Change a Cluster's Plan Between Basic and Standard",
"urls": [
"/cockroachcloud/change-plan-between-basic-and-standard.html"
]
}
]
Expand Down Expand Up @@ -160,9 +172,9 @@
]
},
{
"title": "Migrate from Standard or Basic to Advanced",
"urls": [
"/cockroachcloud/migrate-from-standard-to-advanced.html"
"title": "Migrate from Standard to Advanced",
"urls": [
"/cockroachcloud/migrate-from-standard-to-advanced.html"
]
}
]
Expand Down
16 changes: 14 additions & 2 deletions src/current/_includes/v25.1/sidebar-data/cloud-deployments.json
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,12 @@
"urls": [
"/cockroachcloud/provision-a-cluster-with-terraform.html"
]
},
{
"title": "Change a Cluster's Plan Between Basic and Standard",
"urls": [
"/cockroachcloud/change-plan-between-basic-and-standard.html"
]
}
]
},
Expand Down Expand Up @@ -107,10 +113,16 @@
]
},
{
"title": "Migrate from Standard or Basic to Advanced",
"title": "Migrate from Standard to Advanced",
"urls": [
"/cockroachcloud/migrate-from-standard-to-advanced.html"
]
},
{
"title": "Change a Cluster's Plan Between Basic and Standard",
"urls": [
"/cockroachcloud/change-plan-between-basic-and-standard.html"
]
}
]
},
Expand Down Expand Up @@ -160,7 +172,7 @@
]
},
{
"title": "Migrate from Standard or Basic to Advanced",
"title": "Migrate from Standard to Advanced",
"urls": [
"/cockroachcloud/migrate-from-standard-to-advanced.html"
]
Expand Down
6 changes: 6 additions & 0 deletions src/current/cockroachcloud/basic-cluster-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,12 @@ A CockroachDB {{ site.data.products.basic }} cluster cannot be moved from one re
1. [Create a new CockroachDB {{ site.data.products.basic }} cluster]({% link cockroachcloud/create-a-basic-cluster.md %}) in the desired region.
1. 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.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
title: Change a Cluster's Plan Between Basic and Standard
summary: Learn how to change a cluster's plan between a CockroachDB Basic cluster and a CockroachDB Standard cluster.
toc: true
---

{{site.data.alerts.callout_info}}
CockroachDB {{ site.data.products.standard }}, our new, enterprise-ready plan, is currently in [Preview]({% link {{ site.current_cloud_version }}/cockroachdb-feature-availability.md %}).
{{site.data.alerts.end}}

This page describes how to change a cluster's [plan]({% link cockroachcloud/index.md %}#plans) between CockroachDB {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} using the [{{ site.data.products.cloud }} Console](https://cockroachlabs.cloud/).

To use the CockroachDB Cloud API to change your cluster's plan, refer to [Use the CockroachDB Cloud API]({% link cockroachcloud/cloud-api.md %}#change-a-clusters-plan).

## Before you begin

You'll need the [Cluster Administrator]({% link cockroachcloud/authorization.md %}#cluster-administrator) or [Cluster Operator]({% link cockroachcloud/authorization.md %}#cluster-operator) role on the running {{ site.data.products.standard }} or {{ site.data.products.basic }} cluster in order to change the cluster's [plan]({% link cockroachcloud/index.md %}#plans).

For changing plans from {{ site.data.products.standard }} to {{ site.data.products.basic }}, you must disable {{ site.data.products.standard }}-only features before starting the plan change.

### Considerations

- If the option to Change Plan Type is unavailable, hovering your mouse on this option may display a note that the cluster was created on legacy architecture and, therefore, its plan cannot be changed in the Cloud Console. Such a cluster will not support multi-region features or private connections on any plan. To use these features, you must take a [backup]({% link cockroachcloud/backup-and-restore-overview.md %}) and restore into a new cluster. Alternatively, to change the plan for your current cluster despite these feature limitations, you can use the [Cloud API]({% link cockroachcloud/cloud-api.md %}#change-a-clusters-plan).
- The plan change will take up to 5 minutes.
- The cluster will remain operational under the current plan during the switching period.
- You can change back the plan if needed. However, when you change from {{ site.data.products.standard }} to {{ site.data.products.basic }}, you will need to wait 48 hours before being able to change back to {{ site.data.products.standard }}.

## Change a cluster's plan

{{site.data.alerts.callout_info}}
When you change from {{ site.data.products.standard }} to {{ site.data.products.basic }}, you will not be able to change the plan back to {{ site.data.products.standard }} for 48 hours.
{{site.data.alerts.end}}

1. On the [**Clusters** page]({% link cockroachcloud/cluster-management.md %}#view-clusters-page), select the cluster that requires a plan change.
1. On the [**Cluster Overview** page]({% link cockroachcloud/cluster-overview-page.md %}), select the **Action** dropdown in the top-right corner, and then **Change plan type**. If this option is unavailable, refer to [Considerations](#considerations).
1. Choose a [plan]({% link cockroachcloud/index.md %}#plans) from {{ site.data.products.standard }} or {{ site.data.products.basic }} to change to. The current plan of the cluster will be labeled, while the other plan type will be highlighted. Select **Next: Capacity**.
1. For capacity:
- If you are changing to a {{ site.data.products.standard }} plan, choose the amount of [provisioned capacity]({% link cockroachcloud/plan-your-cluster.md %}#provisioned-capacity) you want for your cluster. The Cloud Console provides a suggestion for provisioned vCPU, we recommend monitoring CPU utilization and adjusting the cluster's compute capacity as necessary. For additional information, refer to [Recommended provisioned capacity when changing cluster plan]({% link cockroachcloud/plan-your-cluster.md %}#recommended-provisioned-capacity-when-changing-cluster-plan). Select **Next: Finalize**.
- If you are changing to a [{{ site.data.products.basic }} plan]({% link cockroachcloud/create-a-basic-cluster.md %}#step-4-configure-cluster-capacity), choose whether the cluster should have **Unlimited** capacity to scale, or **Set a monthly limit**. Select **Next: Finalize**.
1. Review the changes and then **Update cluster**.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We include the following in the UI, if it makes sense to include here as well:

  • The upgrade process will take up to 5 mins
  • Their cluster will remain functional under the current plan during the switching period
  • They can switch back the plan if needed. But when you go from Standard to Basic, you need to wait 48 hours before being able to change the plan back to Standard.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The 48 hours wait is just for if the cluster was originally Standard? I have a note earlier on the page that mentions this generally about any switch back, so maybe I need to change that?

I have added these as bullet points to the final step.


## See more

- [CockroachDB Cloud Documentation]({% link cockroachcloud/index.md %})
- [Use the CockroachDB Cloud API]({% link cockroachcloud/cloud-api.md %})



8 changes: 7 additions & 1 deletion src/current/cockroachcloud/cluster-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,11 +106,17 @@ When the upgrade occurs, your cluster status will be listed as `Available (Maint

For manual upgrades to a newer major version of CockroachDB, refer to [Upgrade a cluster in CockroachDB Cloud]({% link cockroachcloud/upgrade-cockroach-version.md %}).

## 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.standard }} 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

Refer to [Managed Backups]({% link cockroachcloud/managed-backups.md %}) for instructions to restore your cluster from an automatic cluster backup.

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

## Enable deletion protection

Expand Down
Loading
Loading