Add docs for changing cluster plan between Standard and Basic #19462
Conversation
Files changed:
|
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify site configuration. |
katmayb
force-pushed
the
cloud-change-plan-docs
branch
from
6224538 to
0e7f08c
Compare
katmayb
force-pushed
the
cloud-change-plan-docs
branch
from
0e7f08c to
0f29ee4
Compare
|
|
||
| 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 }}, you must first change your cluster's plan from {{ site.data.products.basic }} to {{ site.data.products.standard }}, and then you can refer to [Change a Cluster's Plan from Standard to Advanced]({% link cockroachcloud/change-plan-from-standard-to-advanced.md %}). |
There was a problem hiding this comment.
I am not sure this is required - I think you would be able to go straight from Basic to Advanced with these instructions. Can you check with @marksoper or @devarshishah3?
There was a problem hiding this comment.
I picked this up from the linked google doc in the issue, I'll wait for confirmation on the recommendation here.
|
|
||
| ## Before you begin | ||
|
|
||
| You'll need the [Cluster Administrator]({% link cockroachcloud/authorization.md %}#cluster-administrator) 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). |
There was a problem hiding this comment.
@katmayb Cluster Operator roles can also perform the 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**. | ||
| 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 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. Select **Next: Finalize**. |
There was a problem hiding this comment.
@katmayb we give a recommendation in CC console for your provisioned vCPU depending on your peak RU/s in the last 30 days. For your reference, we calculate this vCPU based on the 30-day peak RU/s plus a 40% buffer, then convert using 500 RU/s = 1 vCPU. We use a 10-minute roll-up for the peak RU/s. -- This calculation may be good to include in docs somewhere to reference; Mike had suggested adding it to "Plan your cluster".
There are also a few caveats that we may want to mention with respect to the recommendation in the UI:
- This should be interpreted as a suggestion. Users should keep an eye on their CPU utilization % and adjust their compute capacity as needed.
- Standard currently supports a maximum of 60 vCPUs. If we estimate you need more than 60 vCPU, we tell them that we estimate they need more than our capacity, but "You can provision up to 60 vCPU. If your workload consistently spikes above that level you may experience performance issues."
There was a problem hiding this comment.
I added a section to "plan your cluster" with the calculation. And I've added that the Cloud Console provides a suggestion but that users should monitor this.
Your last bullet point — I've added to the Plan your cluster page. I haven't not specifically mentioned the 60 vCPUs for ease of keeping the docs up to date. But, if that's a number that won't change frequently or you'd prefer it specified I can update these changes.
| 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. 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**. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
|
|
||
| These instructions assume you already have the following: | ||
|
|
||
| - A [CockroachDB {{ site.data.products.standard }} or {{ site.data.products.basic }} cluster]({% link cockroachcloud/quickstart.md %}) from which you want to migrate data. | ||
| - A [CockroachDB {{ site.data.products.standard }} cluster]({% link cockroachcloud/quickstart.md %}) of which you want to change the plan. | ||
| - A [paid CockroachDB {{ site.data.products.advanced }} cluster]({% link cockroachcloud/quickstart-trial-cluster.md %}). Your first paid CockroachDB {{ site.data.products.advanced }} cluster is free for a 30-day trial. |
There was a problem hiding this comment.
Line 21 - the part about your first cluster being free for 30 days is actually no longer true. We have replaced this version of the free trial now.
There was a problem hiding this comment.
Thanks @katmayb. I left a few comments inline. There are a couple of additional considerations that should be called out for the UI workflow:
- If the cluster was created on legacy architecture, then it cannot be upgraded via UI. The cluster will not support multi-region features or private connections. To use these features, a customer would need to do backup and restore into a new cluster. If they still want to change the plan for their current cluster despite the feature limitations, they can do so via API (https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api#change-a-clusters-plan).
- If a cluster was recently downgraded to Basic from Standard, it must wait 48 hours to be upgraded back to Standard.
- When you're downgrading from Standard to Basic, you need to disable Standard-only premium features first (private connections, manual version control setting, metrics/log export to DataDog/Prometheus).
I also spoke to Devarshi about changes to the "Migrate from Standard/Basic to Advanced" page. He said we should keep using the terminology "Migrate" in that case since we don't support simple plan changes for that flow yet. The user would still need to perform a full migration.
I have mentioned these in the "Considerations" and prerequisites. Regarding "legacy architecture", what do we mean here exactly — and is that how we want to phrase it in docs? |
Fixes DOC-10627
This PR adds a page to describe changing cluster plans between Standard and Basic clusters.
Also:
Preview
New page: https://deploy-preview-19462--cockroachdb-docs.netlify.app/docs/cockroachcloud/change-plan-between-basic-and-standard.html