Skip to content

Commit

Permalink
[DOC-10355] Document major version selection in Dedicated (#18759)
Browse files Browse the repository at this point in the history
* [DOC-10355] Document major version selection in Dedicated

---------

Co-authored-by: Mike Lewis <[email protected]>
  • Loading branch information
mdlinville and mikeCRL authored Jul 31, 2024
1 parent 4505486 commit 007ee2b
Show file tree
Hide file tree
Showing 9 changed files with 33 additions and 67 deletions.
15 changes: 0 additions & 15 deletions src/current/_includes/releases/cloud/2024-06-12.md

This file was deleted.

5 changes: 0 additions & 5 deletions src/current/_includes/releases/cloud/2024-06-14.md

This file was deleted.

5 changes: 0 additions & 5 deletions src/current/_includes/releases/cloud/2024-06-17.md

This file was deleted.

5 changes: 0 additions & 5 deletions src/current/_includes/releases/cloud/2024-06-26.md

This file was deleted.

5 changes: 0 additions & 5 deletions src/current/_includes/releases/cloud/2024-07-18.md

This file was deleted.

7 changes: 0 additions & 7 deletions src/current/_includes/releases/cloud/2024-07-19.md

This file was deleted.

4 changes: 2 additions & 2 deletions src/current/cockroachcloud/cluster-overview-page.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,8 @@ The **Cluster configuration** panel displays the settings you chose during [clus
|-----------|---------------------------------------------------------------------------------------------------------|
| Cloud | The cluster's [cloud provider]({% link cockroachcloud/create-your-cluster.md %}#step-2-select-the-cloud-provider). |
| Plan type | The [plan type]({% link cockroachcloud/create-your-cluster.md %}#step-1-start-the-cluster-creation-process) used to create the cluster. |
| Region(s) | The cluster's [region(s)]({% link cockroachcloud/create-your-cluster.md %}#step-3-configure-region-s-and-node-s). |
| Nodes | The [number of nodes]({% link cockroachcloud/create-your-cluster.md %}#step-3-configure-region-s-and-node-s) the cluster has and how many are live. |
| Regions | The cluster's [region(s)]({% link cockroachcloud/create-your-cluster.md %}#step-3-configure-regions-and-nodes). |
| Nodes | The [number of nodes]({% link cockroachcloud/create-your-cluster.md %}#step-3-configure-regions-and-nodes) the cluster has and how many are live. |
| Compute | The cluster's [compute power per node]({% link cockroachcloud/create-your-cluster.md %}#step-5-configure-cluster-capacity). |
| Storage | The cluster's [storage per node]({% link cockroachcloud/create-your-cluster.md %}#step-5-configure-cluster-capacity). |

Expand Down
48 changes: 25 additions & 23 deletions src/current/cockroachcloud/create-your-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,15 @@ You do not need an account in the deployment environment you choose. The cluster

{% include cockroachcloud/cockroachcloud-pricing.md %}

## Step 3. Configure region(s) and node(s)
## Step 3. Configure regions and nodes

Select the region(s) and number of nodes for your cluster:
Select the regions for your cluster and the number of nodes per region:

1. In the **Regions** section, select at minimum one region. Refer to [CockroachDB {{ site.data.products.cloud }} Regions]({% link cockroachcloud/regions.md %}) for the regions where CockroachDB {{ site.data.products.dedicated }} clusters can be deployed. For optimal performance, select the cloud provider region in which you are running your application. For example, if your application is deployed in GCP's `us-east1` region, select `us-east1` for your CockroachDB {{ site.data.products.dedicated }} cluster.

A multi-region cluster contains at minimum three regions and can survive the loss of a single region. Refer to [Planning your cluster](plan-your-cluster.html?filters=dedicated) for the configuration requirements and recommendations for CockroachDB {{ site.data.products.dedicated }} clusters.

1. Select the number of nodes:
1. Select the number of nodes per region:
- For single-region application development and testing on AWS or GCP, you can create a single-node cluster. Single-node clusters are not available on Azure.
- For single-region production deployments, we recommend a minimum of 3 nodes. The number of nodes also depends on your storage capacity and performance requirements. See [Example](plan-your-cluster.html?filters=dedicated#dedicated-example) for further guidance.
- For multi-region deployments, we require a minimum of 3 nodes per region. For best performance and stability, you should use the same number of nodes in each region.
Expand All @@ -56,12 +56,10 @@ Select the region(s) and number of nodes for your cluster:

Currently, you can add a maximum of 150 nodes to your cluster. For larger configurations, [contact us](https://support.cockroachlabs.com/hc/requests/new).

Click **Next: Capacity**.

<a id="step-4-enable-vpc-peering-optional"></a>
## Step 4. Enable GCP VPC Peering (optional)

You can use [GCP VPC peering]({% link cockroachcloud/network-authorization.md %}#gcp-vpc-peering) to establish a private connection between a GCP application and a CockroachDB {{ site.data.products.dedicated }} cluster deployed on GCP. A separate VPC Peering connection is required for each cluster.
For clusters deployed on GCP, you can use [GCP VPC peering]({% link cockroachcloud/network-authorization.md %}#gcp-vpc-peering) to establish a private connection between a GCP application and a CockroachDB {{ site.data.products.dedicated }} cluster deployed on GCP. A separate VPC Peering connection is required for each cluster.

If you don't want to enable VPC Peering, leave the default selection of **Use the default IP range** as is and click **Next: Capacity**.

Expand All @@ -81,10 +79,10 @@ You can use CockroachDB {{ site.data.products.cloud }}'s default IP range and si
Custom IP ranges are temporarily unavailable for multi-region clusters.
{{site.data.alerts.end}}

1. Click **Next: Capacity**.

After your cluster is created, refer to [Establish private connectivity]({% link cockroachcloud/connect-to-your-cluster.md %}#gcp-vpc-peering) to finish setting up VPC Peering for your cluster.

1. Click **Next: Capacity**.

## Step 5. Configure cluster capacity

{% capture cap_per_vcpu %}{% include_cached v23.1/prod-deployment/provision-storage.md %}{% endcapture %}
Expand Down Expand Up @@ -129,11 +127,12 @@ To change the hardware configuration after the cluster is created, see [Manage a

See the [Example](plan-your-cluster.html?filters=dedicated#dedicated-example) for further guidance.


Click **Next: Finalize**.

## Step 6. Enter billing details

If you have not yet configured billing for your CockroachDB {{ site.data.products.cloud }} organization, follow these steps to configure it:

1. On the **Finalize** page, verify your selections for the cloud provider, region(s), number of nodes, and the capacity.

Once your cluster is created, see [Establish VPC Peering or AWS PrivateLink]({% link cockroachcloud/connect-to-your-cluster.md %}#establish-gcp-vpc-peering-or-aws-privatelink) to finish setting up VPC Peering for your cluster.
Expand All @@ -154,32 +153,35 @@ The cluster is automatically given a randomly-generated name. If desired, change

## Step 8. Select the CockroachDB version

When you create a new cluster, it uses the [latest CockroachDB {{ site.data.products.cloud }} production release](https://www.cockroachlabs.com/docs/releases/cloud) by default. All clusters are then upgraded automatically to each subsequent patch release of their major version as it becomes available. To learn more, refer to [Upgrade Policy]({% link cockroachcloud/upgrade-policy.md %}).
When you create a new CockroachDB {{ site.data.products.dedicated }} cluster, it defaults to using the [latest CockroachDB {{ site.data.products.cloud }} production release]({% link releases/cloud.md %}) unless you select a release explicitly. Releases are rolled out gradually to CockroachDB {{ site.data.products.cloud }}. At any given time, you may be able to choose among two or more types of releases. In the list, releases are labeled according to their stability:

Prior to the GA release of a new CockroachDB major version, a series of Beta and Release Candidate (RC) releases are made available for CockroachDB {{ site.data.products.dedicated }} as [Pre-Production Preview]({% link cockroachcloud/upgrade-policy.md %}#pre-production-preview-upgrades) releases. If available, the latest Pre-Production Preview release is listed as an option alongside the latest production release.
- **Latest Stable**: The latest stable GA release is the default version and is suitable for production.
- **Stable**: One or more stable releases may be listed at any given time. All listed releases that are not labeled **Pre-Production Preview** are stable releases suitable for production.
- **Pre-Production Preview**: Prior to the GA release of a new CockroachDB major version, a series of Beta and Release Candidate (RC) releases may be made available for CockroachDB {{ site.data.products.dedicated }} as [Pre-Production Preview]({% link cockroachcloud/upgrade-policy.md %}#pre-production-preview-upgrades) releases. Pre-Production Preview releases are no longer available after the GA release of a major version.

{{site.data.alerts.callout_danger}}
Testing releases, including Pre-Production Preview releases, are provided for testing and experimentation only, and are not qualified for production environments and not eligible for support or uptime SLA commitments.
{{site.data.alerts.end}}
{{site.data.alerts.callout_danger}}
Testing releases, including Pre-Production Preview releases, are provided for testing and experimentation only, and are not qualified for production environments and not eligible for support or uptime SLA commitments.
{{site.data.alerts.end}}

To select a version for your cluster:

1. Under **Cluster Version**, click **More versions**.
1. Select the cluster version from the **Cluster version** list.

If you install a Pre-Production Preview release, it will be upgraded to each subsequent beta or RC release automatically, before being upgraded to the GA and subsequent patch releases as they become available.
After the cluster is created, patch releases within its major version are required and are applied automatically. If you install or upgrade to a Pre-Production Preview release, subsequent Pre-Production Preview patch releases, the GA release, and subsequent patches within the major version are applied automatically. To learn more, refer to the [CockroachDB Cloud Support and Upgrade Policy]({% link cockroachcloud/upgrade-policy.md %}).

## Step 9. Finish creating the cluster

Click **Create cluster**. Your cluster will be created in approximately 20-30 minutes.

## What's next

To start using your CockroachDB {{ site.data.products.cloud }} cluster, see the following pages:
To start using your CockroachDB {{ site.data.products.dedicated }} cluster, refer to:

- [Connect to your cluster]({% link cockroachcloud/connect-to-your-cluster.md %})
- [Authorize users]({% link cockroachcloud/managing-access.md %})
- [Deploy a Python To-Do App with Flask, Kubernetes, and CockroachDB {{ site.data.products.cloud }}]({% link cockroachcloud/deploy-a-python-to-do-app-with-flask-kubernetes-and-cockroachcloud.md %})

If you created a multi-region cluster, it is important to carefully choose:

- The right [survival goal](https://www.cockroachlabs.com/docs/{{site.current_cloud_version}}/multiregion-survival-goals) for each database.
- The right [table locality](https://www.cockroachlabs.com/docs/{{site.current_cloud_version}}/table-localities) for each of your tables.

Not doing so can result in unexpected latency and resiliency. For more information, see the [Multi-Region Capabilities Overview]({% link {{ site.current_cloud_version}}/multiregion-overview.md %}).
- For [multi-region clusters]({% link {{ site.current_cloud_version}}/multiregion-overview.md %}), learn how to reduce latency and increase resiliency by choosing the best [survival goal]({% link {{site.current_cloud_version}}/multiregion-survival-goals.md %}) for each database and the best [table locality]({% link {{site.current_cloud_version}}/table-localities.md %}) for each table.

{% comment %}
### [WIP] Select hardware configuration based on performance requirements
Expand Down
6 changes: 6 additions & 0 deletions src/current/releases/cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@ Get future release notes emailed to you:

{% include marketo.html formId=1083 %}

## July 31, 2024

<h3 id="2024-07-24-general-updates"> General updates </h3>

- When creating a new CockroachDB {{ site.data.products.dedicated }} cluster, you can now [select the cluster's major version]({% link cockroachcloud/create-your-cluster.md %}#step-8-select-the-cockroachdb-version). The default option is the latest stable version. At any given time, you may be able to choose from additional stable releases or experimental [Pre-Production Preview]({% link cockroachcloud/upgrade-policy.md %}#pre-production-preview-upgrades) releases. Patch releases within a major version are applied automatically.

## July 19, 2024

<h3 id="2024-07-19-general-updates"> General updates </h3>
Expand Down

0 comments on commit 007ee2b

Please sign in to comment.