-
Notifications
You must be signed in to change notification settings - Fork 468
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
Changes from all commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
ac36379
Add docs for changing cluster plan between Standard and BAsic
katmayb d274a2b
Remove redirect
katmayb b863407
Remove edits for migrate --> change
katmayb 51ee414
Additional feedback edits
katmayb 522e100
vCPU spike
katmayb 2f98022
Include considerations
katmayb 8ece20f
Fix link
katmayb 73ccd71
Edits from feedback
katmayb dec28ef
Feedback RU/sec + roll-up + page name
katmayb 5701a7c
Add cloud release note
katmayb 8f90784
Update release date
katmayb beab99e
Apply suggestions from code review
katmayb 80bd4f8
Apply suggestions from code review
katmayb 7573578
Apply suggestions from code review
katmayb 53a58dd
Update src/current/cockroachcloud/change-plan-between-basic-and-stand…
katmayb File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
48 changes: 48 additions & 0 deletions
48
src/current/cockroachcloud/change-plan-between-basic-and-standard.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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**. | ||
|
||
## See more | ||
|
||
- [CockroachDB Cloud Documentation]({% link cockroachcloud/index.md %}) | ||
- [Use the CockroachDB Cloud API]({% link cockroachcloud/cloud-api.md %}) | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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:
There was a problem hiding this comment.
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.