Skip to content

Commit

Permalink
Merge pull request #18206 from cockroachdb/cloud_cluster_creation_reskin
Browse files Browse the repository at this point in the history
Create and edit cloud clusters using the stepper wizard
  • Loading branch information
Amruta-Ranade authored Jan 31, 2024
2 parents 0a273dc + 4fb3699 commit 4ab6a10
Show file tree
Hide file tree
Showing 35 changed files with 194 additions and 190 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,11 @@
1. If you haven't already, <a href="https://cockroachlabs.cloud/signup?referralId={{page.referral_id}}" rel="noopener" target="_blank">sign up for a CockroachDB {{ site.data.products.cloud }} account</a>.
1. [Log in](https://cockroachlabs.cloud/) to your CockroachDB {{ site.data.products.cloud }} account.
1. On the **Clusters** page, click **Create Cluster**.
1. On the **Create your cluster** page, select **Serverless**.
1. Click **Create cluster**.
1. On the **Select a plan** page, select **Serverless**.
1. On the **Cloud & Regions** page, select a cloud provider (GCP or AWS) in the **Cloud provider** section.
1. In the **Regions** section, select a region for the cluster. Refer to [CockroachDB {{ site.data.products.cloud }} Regions]({% link cockroachcloud/regions.md %}) for the regions where CockroachDB {{ site.data.products.serverless }} clusters can be deployed. To create a multi-region cluster, click **Add region** and select additional regions. A cluster can have at most six regions.
1. Click **Next: Capacity**.
1. On the **Capacity** page, select **Start for free**. Click **Next: Finalize**.
1. On the **Finalize** page, click **Create cluster**.

Your cluster will be created in a few seconds and the **Create SQL user** dialog will display.
2 changes: 1 addition & 1 deletion src/current/_includes/cockroachcloud/serverless-usage.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
The best way to estimate your resource usage is to [set resource limits]({% link cockroachcloud/serverless-cluster-management.md %}#edit-your-resource-limits) you're comfortable with and run your workload. You can see the RUs and storage your cluster has used in the **Usage this month** section of the [**Cluster Overview**]({% link cockroachcloud/serverless-cluster-management.md %}#view-cluster-overview) page. Once enough usage data is available, you can also see a graph of your monthly resource usage and recommended spend limit on the [**Edit cluster**]({% link cockroachcloud/serverless-cluster-management.md %}#edit-your-resource-limits) page.
The best way to estimate your resource usage is to [set resource limits]({% link cockroachcloud/serverless-cluster-management.md %}#edit-cluster-capacity) you're comfortable with and run your workload. You can see the RUs and storage your cluster has used in the **Usage this month** section of the [**Cluster Overview**]({% link cockroachcloud/serverless-cluster-management.md %}#view-cluster-overview) page. Once enough usage data is available, you can also see a graph of your monthly resource usage and recommended spend limit on the [**Edit cluster**]({% link cockroachcloud/serverless-cluster-management.md %}#edit-cluster-capacity) page.

A typical `SELECT` query consumes between 1 and 15 RUs, depending on the amount of data it scans and returns. A typical `INSERT` or `UPDATE` statement consumes between 10 and 25 RUs, depending on the amount of data it inserts or updates. To estimate the RU consumption of individual SQL statements, you can use the [`EXPLAIN ANALYZE`](https://www.cockroachlabs.com/docs/{{site.current_cloud_version}}/explain-analyze) SQL statement. For an example, see [Example Request Unit calculation]({% link cockroachcloud/serverless-resource-usage.md %}#example-request-unit-calculation).
2 changes: 1 addition & 1 deletion src/current/_includes/releases/cloud/2023-08-01.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

<h3> General changes </h3>

- {{ site.data.products.serverless }} pricing changes that went into effect for newly-created organizations beginning on [May 1, 2023](#may-1-2023) are now in effect for all organizations. Review the [new pricing](../cockroachcloud/plan-your-cluster-serverless.html#pricing), and review your current [resource limits](../cockroachcloud/serverless-cluster-management.html#edit-your-resource-limits) to prevent disruptions to your service.
- {{ site.data.products.serverless }} pricing changes that went into effect for newly-created organizations beginning on [May 1, 2023](#may-1-2023) are now in effect for all organizations. Review the [new pricing](../cockroachcloud/plan-your-cluster-serverless.html#pricing), and review your current [resource limits](../cockroachcloud/serverless-cluster-management.html#edit-cluster-capacity) to prevent disruptions to your service.
5 changes: 5 additions & 0 deletions src/current/_includes/releases/cloud/2024-01-25.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
## January 25, 2024

<h3 id="2024-01-17-general-updates"> General updates </h3>

- The single-page CockroachDB Cloud [Create cluster](https://www.cockroachlabs.com/docs/cockroachcloud/create-a-serverless-cluster) and [Edit cluster](https://www.cockroachlabs.com/docs/cockroachcloud/serverless-cluster-management) have been updated to use multi-step wizards.
2 changes: 1 addition & 1 deletion src/current/_includes/v22.2/setup/sample-setup-certs.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ You can create a CockroachDB {{ site.data.products.serverless }} cluster using e

### Create a free cluster

{% include {{ page.version.version }}/setup/create-a-free-cluster.md %}
{% include cockroachcloud/quickstart/create-a-free-cluster.md %}

### Create a SQL user

Expand Down
2 changes: 1 addition & 1 deletion src/current/_includes/v22.2/setup/sample-setup-jdbc.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ You can create a CockroachDB {{ site.data.products.serverless }} cluster using e

### Create a free cluster

{% include {{ page.version.version }}/setup/create-a-free-cluster.md %}
{% include cockroachcloud/quickstart/create-a-free-cluster.md %}

### Create a SQL user

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ You can install a CockroachDB {{ site.data.products.serverless }} cluster using

### Create a free cluster

{% include {{ page.version.version }}/setup/create-a-free-cluster.md %}
{% include cockroachcloud/quickstart/create-a-free-cluster.md %}

### Create a SQL user

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ You can install a CockroachDB {{ site.data.products.serverless }} cluster using

### Create a free cluster

{% include {{ page.version.version }}/setup/create-a-free-cluster.md %}
{% include cockroachcloud/quickstart/create-a-free-cluster.md %}

### Create a SQL user

Expand Down
2 changes: 1 addition & 1 deletion src/current/_includes/v22.2/setup/sample-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ You can install a CockroachDB {{ site.data.products.serverless }} cluster using

### Create a free cluster

{% include {{ page.version.version }}/setup/create-a-free-cluster.md %}
{% include cockroachcloud/quickstart/create-a-free-cluster.md %}

### Create a SQL user

Expand Down
2 changes: 1 addition & 1 deletion src/current/_includes/v23.1/setup/sample-setup-certs.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ You can create a CockroachDB {{ site.data.products.serverless }} cluster using e

### Create a free cluster

{% include {{ page.version.version }}/setup/create-a-free-cluster.md %}
{% include cockroachcloud/quickstart/create-a-free-cluster.md %}

### Create a SQL user

Expand Down
2 changes: 1 addition & 1 deletion src/current/_includes/v23.1/setup/sample-setup-jdbc.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ You can create a CockroachDB {{ site.data.products.serverless }} cluster using e

### Create a free cluster

{% include {{ page.version.version }}/setup/create-a-free-cluster.md %}
{% include cockroachcloud/quickstart/create-a-free-cluster.md %}

### Create a SQL user

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ You can install a CockroachDB {{ site.data.products.serverless }} cluster using

### Create a free cluster

{% include {{ page.version.version }}/setup/create-a-free-cluster.md %}
{% include cockroachcloud/quickstart/create-a-free-cluster.md %}

### Create a SQL user

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ You can install a CockroachDB {{ site.data.products.serverless }} cluster using

### Create a free cluster

{% include {{ page.version.version }}/setup/create-a-free-cluster.md %}
{% include cockroachcloud/quickstart/create-a-free-cluster.md %}

### Create a SQL user

Expand Down
2 changes: 1 addition & 1 deletion src/current/_includes/v23.1/setup/sample-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ You can install a CockroachDB {{ site.data.products.serverless }} cluster using

### Create a free cluster

{% include {{ page.version.version }}/setup/create-a-free-cluster.md %}
{% include cockroachcloud/quickstart/create-a-free-cluster.md %}

### Create a SQL user

Expand Down
2 changes: 1 addition & 1 deletion src/current/_includes/v23.2/setup/sample-setup-certs.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ You can create a CockroachDB {{ site.data.products.serverless }} cluster using e

### Create a free cluster

{% include {{ page.version.version }}/setup/create-a-free-cluster.md %}
{% include cockroachcloud/quickstart/create-a-free-cluster.md %}

### Create a SQL user

Expand Down
2 changes: 1 addition & 1 deletion src/current/_includes/v23.2/setup/sample-setup-jdbc.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ You can create a CockroachDB {{ site.data.products.serverless }} cluster using e

### Create a free cluster

{% include {{ page.version.version }}/setup/create-a-free-cluster.md %}
{% include cockroachcloud/quickstart/create-a-free-cluster.md %}

### Create a SQL user

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ You can install a CockroachDB {{ site.data.products.serverless }} cluster using

### Create a free cluster

{% include {{ page.version.version }}/setup/create-a-free-cluster.md %}
{% include cockroachcloud/quickstart/create-a-free-cluster.md %}

### Create a SQL user

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ You can install a CockroachDB {{ site.data.products.serverless }} cluster using

### Create a free cluster

{% include {{ page.version.version }}/setup/create-a-free-cluster.md %}
{% include cockroachcloud/quickstart/create-a-free-cluster.md %}

### Create a SQL user

Expand Down
2 changes: 1 addition & 1 deletion src/current/_includes/v23.2/setup/sample-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ You can install a CockroachDB {{ site.data.products.serverless }} cluster using

### Create a free cluster

{% include {{ page.version.version }}/setup/create-a-free-cluster.md %}
{% include cockroachcloud/quickstart/create-a-free-cluster.md %}

### Create a SQL user

Expand Down
2 changes: 1 addition & 1 deletion src/current/cockroachcloud/billing-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ We keep a card on file after the associated organization is deleted so we can pr

## Check trial code details

If you used a CockroachDB {{ site.data.products.dedicated }} trial code while [creating a cluster]({% link cockroachcloud/create-your-cluster.md %}#step-9-enter-billing-details), you can check the trial expiration details on the **Overview** tab of the **Billing** page.
If you used a CockroachDB {{ site.data.products.dedicated }} trial code while [creating a cluster]({% link cockroachcloud/create-your-cluster.md %}#step-6-enter-billing-details), you can check the trial expiration details on the **Overview** tab of the **Billing** page.

{{site.data.alerts.callout_info}}
Your credit card will be charged after the trial ends.
Expand Down
69 changes: 30 additions & 39 deletions src/current/cockroachcloud/cluster-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,57 +64,48 @@ You cannot scale a multi-node cluster down to a single-node cluster. If you need
To add or remove nodes from your cluster:

1. Navigate to the cluster's **Overview** page.
1. Select **Actions > Edit cluster**.
1. In the **Cluster settings** section, click the pencil icon next to the cluster's **Regions**.

The **Edit cluster** page displays.

1. From the **Nodes** dropdown, select the number of nodes you want in each region.
1. In the **Summary** sidebar, verify the hourly estimated cost for the cluster.
1. Click **Next: Payment**.
1. On the **Summary** page, verify your new cluster configuration.
1. Click **Update**.
1. On the **Regions** page, select the number of nodes you want in each region from the **Nodes** dropdown.
1. In the sidebar, verify the hourly estimated cost for the cluster.
1. Click **Next: Capacity** and then **Update cluster**.

### Increase storage for a cluster
### Change compute for a cluster

{{site.data.alerts.callout_danger}}
AWS disks can only be scaled once every six hours.
{{site.data.alerts.end}}

1. Navigate to the cluster's **Overview** page.
1. Select **Actions > Edit cluster**.
1. Navigate to the cluster's **Overview** page and click **Update capacity**.

The **Edit cluster** page displays.

1. Navigate to the **Storage** dropdown in the **Hardware per node** section.
1. Select the new amount of storage per node.
1. In the **Compute per node** section, select the new amount of vCPUs per node.

{{site.data.alerts.callout_danger}}
Storage space cannot be removed due to cloud provider limitations.
{{site.data.alerts.callout_info}}
When scaling up your cluster, it is generally more effective to increase node size up to 16 vCPUs before adding more nodes. For most production applications, we recommend **at least 4 to 8 vCPUs** per node.
{{site.data.alerts.end}}

1. In the **Summary** sidebar, verify the hourly estimated cost for the cluster.
1. Click **Next: Payment**.
1. On the **Summary** page, verify your new cluster configuration.
1. Click **Update**.
1. In the sidebar, verify the hourly estimated cost for the cluster.
1. Click **Next: Update cluster**.

### Change compute for a cluster
### Increase storage for a cluster

{{site.data.alerts.callout_danger}}
AWS disks can only be scaled once every six hours.
{{site.data.alerts.end}}

1. Navigate to the cluster's **Overview** page.
1. Select **Actions > Edit cluster**.

The **Edit cluster** page displays.

1. Navigate to the **Compute** dropdown in the **Hardware per node** section.
1. Select the new amount of vCPUs per node.
1. In the **Storage per node** section, select the new amount of storage per node.

{{site.data.alerts.callout_info}}
When scaling up your cluster, it is generally more effective to increase node size up to 16 vCPUs before adding more nodes. For most production applications, we recommend **at least 4 to 8 vCPUs** per node.
{{site.data.alerts.callout_danger}}
Storage space cannot be removed due to cloud provider limitations.
{{site.data.alerts.end}}

1. In the **Summary** sidebar, verify the hourly estimated cost for the cluster.
1. Click **Next: Payment**.
1. On the **Summary** page, verify your new cluster configuration.
1. Click **Update**.
1. In the sidebar, verify the hourly estimated cost for the cluster.
1. Click **Next: Update cluster**.

## Add or remove regions from a cluster

Expand All @@ -125,17 +116,17 @@ You can add or remove up to nine regions at a time through the Console. Note tha
You can add up to nine regions at a time through the Console. See [Planning your cluster]({% link cockroachcloud/plan-your-cluster.md %}) for cluster requirements and recommendations before proceeding.

1. Navigate to the cluster's **Overview** page.
1. Select **Actions > Edit cluster**.
1. In the **Cluster settings** section, click the pencil icon next to the cluster's **Regions**.

The **Edit cluster** page displays.

1. Click **Add a region**.
1. On the **Regions** page, click **Add a region**.

If you have a GCP cluster with [VPC peering]({% link cockroachcloud/network-authorization.md %}) enabled, the IP range will be automatically populated for added regions.

1. In the **Regions & Nodes** section, select the desired new region and specify the number of nodes for it.
1. In the **Summary** sidebar, verify the hourly estimated cost for the cluster.
1. Click **Update**.
1. Select the desired new region and specify the number of nodes for it.
1. In the sidebar, verify the hourly estimated cost for the cluster.
1. Click **Next: Capacity** and then **Update cluster**.

### Remove a region from your cluster

Expand All @@ -148,16 +139,16 @@ If your [zone configurations](https://www.cockroachlabs.com/docs/{{site.current_
To remove a region from your cluster:

1. Navigate to the cluster's **Overview** page.
1. Select **Actions > Edit cluster**.
1. In the **Cluster settings** section, click the pencil icon next to the cluster's **Regions**.

The **Edit cluster** page displays.

1. Click the **X** button next to each region you want to remove.
1. On the **Regions** page, click the **X** button next to each region you want to remove.
{{site.data.alerts.callout_info}}
If you remove one region from a three-region cluster, CockroachDB Cloud will automatically reduce it to a single-region configuration by deleting two regions.
{{site.data.alerts.end}}
1. In the **Summary** sidebar, verify the hourly estimated cost for the cluster.
1. Click **Update**.
1. In the sidebar, verify the hourly estimated cost for the cluster.
1. Click **Next: Capacity** and then **Update cluster**.

## Set a maintenance window

Expand Down
Loading

0 comments on commit 4ab6a10

Please sign in to comment.