Skip to content

Commit 0e7f08c

Browse files
committed
Add docs for changing cluster plan between Standard and BAsic
1 parent a2674a7 commit 0e7f08c

File tree

8 files changed

+127
-40
lines changed

8 files changed

+127
-40
lines changed

src/current/_data/redirects.yml

+4
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,10 @@
109109
sources: ['cdc-transformations.md']
110110
versions: ['v23.1']
111111

112+
- destination: change-plan-from-standard-to-advanced.md
113+
sources: ['migrate-from-standard-to-advanced.md']
114+
versions: ['cockroachcloud']
115+
112116
- destination: change-data-capture-overview.md
113117
sources: ['change-data-capture.md']
114118
versions: ['v21.2']

src/current/_includes/v24.2/sidebar-data/cloud-deployments.json

+18-6
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,12 @@
5858
"urls": [
5959
"/cockroachcloud/provision-a-cluster-with-terraform.html"
6060
]
61+
},
62+
{
63+
"title": "Change a Cluster's Plan Between Basic and Standard",
64+
"urls": [
65+
"/cockroachcloud/change-plan-between-basic-and-standard.html"
66+
]
6167
}
6268
]
6369
},
@@ -107,9 +113,15 @@
107113
]
108114
},
109115
{
110-
"title": "Migrate from Standard or Basic to Advanced",
111-
"urls": [
112-
"/cockroachcloud/migrate-from-standard-to-advanced.html"
116+
"title": "Change a Cluster's Plan from Standard to Advanced",
117+
"urls": [
118+
"/cockroachcloud/change-plan-from-standard-to-advanced.html"
119+
]
120+
},
121+
{
122+
"title": "Change a Cluster's Plan Between Basic and Standard",
123+
"urls": [
124+
"/cockroachcloud/change-plan-between-basic-and-standard.html"
113125
]
114126
}
115127
]
@@ -160,9 +172,9 @@
160172
]
161173
},
162174
{
163-
"title": "Migrate from Standard or Basic to Advanced",
164-
"urls": [
165-
"/cockroachcloud/migrate-from-standard-to-advanced.html"
175+
"title": "Change a Cluster's Plan from Standard to Advanced",
176+
"urls": [
177+
"/cockroachcloud/change-plan-from-standard-to-advanced.html"
166178
]
167179
}
168180
]

src/current/_includes/v24.3/sidebar-data/cloud-deployments.json

+18-6
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,12 @@
5858
"urls": [
5959
"/cockroachcloud/provision-a-cluster-with-terraform.html"
6060
]
61+
},
62+
{
63+
"title": "Change a Cluster's Plan Between Basic and Standard",
64+
"urls": [
65+
"/cockroachcloud/change-plan-between-basic-and-standard.html"
66+
]
6167
}
6268
]
6369
},
@@ -107,9 +113,15 @@
107113
]
108114
},
109115
{
110-
"title": "Migrate from Standard or Basic to Advanced",
111-
"urls": [
112-
"/cockroachcloud/migrate-from-standard-to-advanced.html"
116+
"title": "Change a Cluster's Plan from Standard to Advanced",
117+
"urls": [
118+
"/cockroachcloud/change-plan-from-standard-to-advanced.html"
119+
]
120+
},
121+
{
122+
"title": "Change a Cluster's Plan Between Basic and Standard",
123+
"urls": [
124+
"/cockroachcloud/change-plan-between-basic-and-standard.html"
113125
]
114126
}
115127
]
@@ -160,9 +172,9 @@
160172
]
161173
},
162174
{
163-
"title": "Migrate from Standard or Basic to Advanced",
164-
"urls": [
165-
"/cockroachcloud/migrate-from-standard-to-advanced.html"
175+
"title": "Change a Cluster's Plan from Standard to Advanced",
176+
"urls": [
177+
"/cockroachcloud/change-plan-from-standard-to-advanced.html"
166178
]
167179
}
168180
]

src/current/_includes/v25.1/sidebar-data/cloud-deployments.json

+16-4
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,12 @@
5858
"urls": [
5959
"/cockroachcloud/provision-a-cluster-with-terraform.html"
6060
]
61+
},
62+
{
63+
"title": "Change a Cluster's Plan Between Basic and Standard",
64+
"urls": [
65+
"/cockroachcloud/change-plan-between-basic-and-standard.html"
66+
]
6167
}
6268
]
6369
},
@@ -107,10 +113,16 @@
107113
]
108114
},
109115
{
110-
"title": "Migrate from Standard or Basic to Advanced",
116+
"title": "Change a Cluster's Plan from Standard to Advanced",
111117
"urls": [
112-
"/cockroachcloud/migrate-from-standard-to-advanced.html"
118+
"/cockroachcloud/change-plan-from-standard-to-advanced.html"
113119
]
120+
},
121+
{
122+
"title": "Change a Cluster's Plan Between Basic and Standard",
123+
"urls": [
124+
"/cockroachcloud/change-plan-between-basic-and-standard.html"
125+
]
114126
}
115127
]
116128
},
@@ -160,9 +172,9 @@
160172
]
161173
},
162174
{
163-
"title": "Migrate from Standard or Basic to Advanced",
175+
"title": "Change a Cluster's Plan from Standard to Advanced",
164176
"urls": [
165-
"/cockroachcloud/migrate-from-standard-to-advanced.html"
177+
"/cockroachcloud/change-plan-from-standard-to-advanced.html"
166178
]
167179
}
168180
]

src/current/cockroachcloud/basic-cluster-management.md

+6
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,12 @@ A CockroachDB {{ site.data.products.basic }} cluster cannot be moved from one re
8585
1. [Create a new CockroachDB {{ site.data.products.basic }} cluster]({% link cockroachcloud/create-a-basic-cluster.md %}) in the desired region.
8686
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.
8787

88+
## Change a cluster's plan
89+
90+
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 %}).
91+
92+
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 %}).
93+
8894
## Restore data from a backup
8995

9096
Use the [Managed Backups]({% link cockroachcloud/managed-backups.md %}) to restore your cluster from automatic full cluster backups.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
title: Change a Cluster's Plan Between Basic and Standard
3+
summary: Learn how to change a cluster's plan between a CockroachDB Basic cluster and a CockroachDB Standard cluster.
4+
toc: true
5+
---
6+
7+
{{site.data.alerts.callout_info}}
8+
CockroachDB {{ site.data.products.standard }}, our new, enterprise-ready plan, is currently in [Preview]({% link {{ site.current_cloud_version }}/cockroachdb-feature-availability.md %}).
9+
{{site.data.alerts.end}}
10+
11+
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/).
12+
13+
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).
14+
15+
## Before you begin
16+
17+
You'll need the [Cluster Administrator]({% link cockroachcloud/authorization.md %}#cluster-administrator) role on the running CockroachDB {{ site.data.products.standard }} or CockroachDB {{ site.data.products.basic }} cluster in order to change the cluster's [plan]({% link cockroachcloud/index.md %}#plans).
18+
19+
## Change a cluster's plan
20+
21+
{{site.data.alerts.callout_info}}
22+
After changing your cluster's plan, you will not be able to change the plan again for 48 hours.
23+
{{site.data.alerts.end}}
24+
25+
1. On the [**Clusters** page]({% link cockroachcloud/cluster-management.md %}#view-clusters-page), select the cluster that requires a plan change.
26+
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**.
27+
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**.
28+
1. For capacity:
29+
- 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**.
30+
- If you are change 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**.
31+
1. Review the changes and then **Update cluster**.
32+
33+
## See more
34+
35+
- [CockroachDB Cloud Documentation]({% link cockroachcloud/index.md %})
36+
- [Use the CockroachDB Cloud API]({% link cockroachcloud/cloud-api.md %})
37+
38+
39+

src/current/cockroachcloud/migrate-from-standard-to-advanced.md src/current/cockroachcloud/change-plan-from-standard-to-advanced.md

+19-23
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Migrate from Standard or Basic to Advanced
3-
summary: Learn how to migrate data from a CockroachDB Standard or Basic cluster into a CockroachDB Advanced cluster.
2+
title: Change a Cluster's Plan from Standard to Advanced
3+
summary: Learn how to change a cluster's plan from a CockroachDB Standard cluster to a CockroachDB Advanced cluster.
44
toc: true
55
docs_area: migrate
66
---
@@ -9,23 +9,23 @@ docs_area: migrate
99
CockroachDB Standard, our new, enterprise-ready plan, is currently in [Preview]({% link {{ site.current_cloud_version }}/cockroachdb-feature-availability.md %}).
1010
{{site.data.alerts.end}}
1111

12-
This page has instructions for migrating data from a CockroachDB {{ site.data.products.standard }} or {{ site.data.products.basic }} cluster to a CockroachDB {{ site.data.products.advanced }} cluster, by exporting to CSV and using [`IMPORT INTO`]({% link {{site.current_cloud_version}}/import-into.md %}). You may want to migrate to CockroachDB {{ site.data.products.advanced }} if you want a single-tenant cluster with no shared resources.
12+
This page has instructions for changing cluster [plan]({% link cockroachcloud/index.md %}#plans) from a CockroachDB {{ site.data.products.standard }} cluster to a CockroachDB {{ site.data.products.advanced }} cluster, by exporting to CSV and using [`IMPORT INTO`]({% link {{site.current_cloud_version}}/import-into.md %}). You may want to change your cluster's plan to CockroachDB {{ site.data.products.advanced }} if you want a single-tenant cluster with no shared resources.
1313

14-
The steps below use sample data from the [`tpcc` workload]({% link {{site.current_cloud_version}}/cockroach-workload.md %}#workloads).
14+
The following steps use sample data from the [`tpcc` workload]({% link {{site.current_cloud_version}}/cockroach-workload.md %}#workloads).
1515

16-
## Before you start
16+
## Before you begin
1717

1818
These instructions assume you already have the following:
1919

20-
- A [CockroachDB {{ site.data.products.standard }} or {{ site.data.products.basic }} cluster]({% link cockroachcloud/quickstart.md %}) from which you want to migrate data.
20+
- A [CockroachDB {{ site.data.products.standard }} cluster]({% link cockroachcloud/quickstart.md %}) of which you want to change the plan.
2121
- 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.
2222
- [Cloud storage]({% link {{site.current_cloud_version}}/use-cloud-storage.md %}).
2323

2424
## Step 1. Export data to cloud storage
2525

26-
First, upload your CockroachDB {{ site.data.products.standard }} or {{ site.data.products.basic }} data to a cloud storage location where the CockroachDB {{ site.data.products.advanced }} cluster can access it.
26+
First, upload your CockroachDB {{ site.data.products.standard }} data to a cloud storage location where the CockroachDB {{ site.data.products.advanced }} cluster can access it.
2727

28-
1. [Connect to your CockroachDB {{ site.data.products.basic }} cluster]({% link cockroachcloud/connect-to-a-basic-cluster.md %}) and run the [`EXPORT`]({% link {{site.current_cloud_version}}/export.md %}) statement for each table you need to migrate. For example, the following statement exports the `warehouse` table from the [`tpcc`]({% link {{site.current_cloud_version}}/cockroach-workload.md %}#workloads) database to an Amazon S3 bucket:
28+
1. [Connect to your CockroachDB {{ site.data.products.standard }} cluster]({% link cockroachcloud/connect-to-your-cluster.md %}) and run the [`EXPORT`]({% link {{site.current_cloud_version}}/export.md %}) statement for each table you need to migrate. For example, the following statement exports the `warehouse` table from the [`tpcc`]({% link {{site.current_cloud_version}}/cockroach-workload.md %}#workloads) database to an Amazon S3 bucket:
2929

3030
{% include copy-clipboard.html %}
3131
~~~ sql
@@ -34,7 +34,7 @@ First, upload your CockroachDB {{ site.data.products.standard }} or {{ site.data
3434
FROM TABLE tpcc.warehouse;
3535
~~~
3636

37-
Note that we uploaded the table in CSV format to a `migration-data` directory in the S3 bucket.
37+
This command uploads the table in CSV format to a `migration-data` directory in the S3 bucket.
3838

3939
The output shows the programmatically generated filename, which you'll reference when you [import the CSV](#step-2-import-the-csv):
4040
@@ -50,7 +50,7 @@ First, upload your CockroachDB {{ site.data.products.standard }} or {{ site.data
5050
0,8,17,13,11,SF,640911111,0.0806,300000.00
5151
~~~
5252
53-
1. Repeat this step for each table you want to migrate. For example, let's export one more table (`district`) from the `tpcc` database:
53+
1. Repeat this step for each table you want to migrate. For example, export one more table (`district`) from the `tpcc` database:
5454
5555
{% include copy-clipboard.html %}
5656
~~~ sql
@@ -81,26 +81,26 @@ First, upload your CockroachDB {{ site.data.products.standard }} or {{ site.data
8181
~~~
8282
8383
{{site.data.alerts.callout_success}}
84-
For more information about using cloud storage with CockroachDB, see [Use Cloud Storage]({% link {{site.current_cloud_version}}/use-cloud-storage.md %}).
84+
For more information about using cloud storage with CockroachDB, refer to [Use Cloud Storage]({% link {{site.current_cloud_version}}/use-cloud-storage.md %}).
8585
{{site.data.alerts.end}}
8686
8787
## Step 2. Import the CSV
8888
8989
{{site.data.alerts.callout_success}}
90-
For best practices for optimizing import performance in CockroachDB, see [Import Performance Best Practices]({% link {{site.current_cloud_version}}/import-performance-best-practices.md %}).
90+
For best practices for optimizing import performance in CockroachDB, refer to [Import Performance Best Practices]({% link {{site.current_cloud_version}}/import-performance-best-practices.md %}).
9191
{{site.data.alerts.end}}
9292
9393
1. [Connect to your CockroachDB {{ site.data.products.advanced }} cluster]({% link cockroachcloud/connect-to-your-cluster.md %}) and [create the database]({% link {{site.current_cloud_version}}/create-database.md %}) you want to import the tables into. For example:
9494
9595
{% include copy-clipboard.html %}
9696
~~~ sql
97-
> CREATE DATABASE tpcc;
97+
CREATE DATABASE tpcc;
9898
~~~
9999
100100
1. Write a [`CREATE TABLE`]({% link {{site.current_cloud_version}}/create-table.md %}) statement that matches the schema of the table data you're importing.
101101

102102
{{site.data.alerts.callout_success}}
103-
You can use the [`SHOW CREATE TABLE`]({% link {{site.current_cloud_version}}/show-create.md %}#show-the-create-table-statement-for-a-table) statement in the CockroachDB {{ site.data.products.standard }} or {{ site.data.products.basic }} cluster to view the `CREATE` statement for the table you're migrating.
103+
You can use the [`SHOW CREATE TABLE`]({% link {{site.current_cloud_version}}/show-create.md %}#show-the-create-table-statement-for-a-table) statement in the CockroachDB {{ site.data.products.standard }} cluster to view the `CREATE` statement for the table you're migrating.
104104
{{site.data.alerts.end}}
105105

106106
{% include v20.2/misc/csv-import-callout.md %}
@@ -139,7 +139,7 @@ For best practices for optimizing import performance in CockroachDB, see [Import
139139
(1 row)
140140
~~~
141141

142-
1. Repeat the above for each CSV file you want to import. For example, let's import the `tpcc.district` data:
142+
1. Repeat the previous command for each CSV file you want to import. For example, import the `tpcc.district` data:
143143

144144
Issue the following statement to create a new `district` table:
145145

@@ -167,7 +167,7 @@ For best practices for optimizing import performance in CockroachDB, see [Import
167167
{% include copy-clipboard.html %}
168168
~~~ sql
169169
IMPORT INTO tpcc.district (d_id, d_w_id, d_name, d_street_1, d_street_2, d_city, d_state, d_zip, d_tax, d_ytd, d_next_o_id)
170-
CSV DATA ('s3://{BUCKET NAME}/migration-data/{EXPORT FILENAME}?AWS_ACCESS_KEY_ID={ACCESS_KEY}&AWS_SECRET_ACCESS_KEY={SECRET_KEY}')
170+
CSV DATA ('s3://{BUCKET NAME}/migration-data/{EXPORT FILENAME}?AWS_ACCESS_KEY_ID={ACCESS_KEY}&AWS_SECRET_ACCESS_KEY={SECRET_KEY}');
171171
~~~
172172

173173
~~~
@@ -177,11 +177,11 @@ For best practices for optimizing import performance in CockroachDB, see [Import
177177
(1 row)
178178
~~~
179179

180-
1. _(Optional)_ To verify that the data was imported, use [`SHOW TABLES`]({% link {{site.current_cloud_version}}/show-tables.md %}):
180+
1. **(Optional)** To verify that the data was imported, use [`SHOW TABLES`]({% link {{site.current_cloud_version}}/show-tables.md %}):
181181

182182
{% include copy-clipboard.html %}
183183
~~~ sql
184-
> SHOW TABLES FROM tpcc;
184+
SHOW TABLES FROM tpcc;
185185
~~~
186186

187187
~~~
@@ -201,13 +201,9 @@ Once all of the tables you want to migrate have been imported into the Cockroach
201201
ALTER TABLE tpcc.district ADD CONSTRAINT fk_d_w_id_ref_warehouse FOREIGN KEY (d_w_id) REFERENCES tpcc.warehouse(w_id);
202202
~~~
203203

204-
~~~
205-
ALTER TABLE
206-
~~~
207-
208204
## See also
209205

210-
- [`IMPORT`]({% link {{site.current_cloud_version}}/import-into.md %})
206+
- [`IMPORT INTO`]({% link {{site.current_cloud_version}}/import-into.md %})
211207
- [Migration Overview]({% link {{site.current_cloud_version}}/migration-overview.md %})
212208
- [Migrate from CSV]({% link {{site.current_cloud_version}}/migrate-from-csv.md %})
213209
- [Import Performance Best Practices]({% link {{site.current_cloud_version}}/import-performance-best-practices.md %})

src/current/cockroachcloud/cluster-management.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -106,11 +106,17 @@ When the upgrade occurs, your cluster status will be listed as `Available (Maint
106106

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

109+
## Change a cluster's plan
110+
111+
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 %}).
112+
113+
To change from {{ site.data.products.standard }} to {{ site.data.products.advanced }}, refer to [Change a Cluster's Plan from Standard to Advanced]({% link cockroachcloud/change-plan-from-standard-to-advanced.md %}).
114+
109115
## Restore data from a backup
110116

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

113-
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 %}).
119+
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 %}).
114120

115121
## Enable deletion protection
116122

0 commit comments

Comments
 (0)