Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
  • Loading branch information
mdlinville authored Oct 13, 2023
1 parent e88c761 commit 535f387
Show file tree
Hide file tree
Showing 19 changed files with 28 additions and 28 deletions.
2 changes: 1 addition & 1 deletion src/current/_includes/releases/cloud/2021-02-09.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ New CockroachCloud clusters will now run CockroachDB [v20.2.4]({% link releases/

- You can now [restore databases and tables](https://www.cockroachlabs.com/docs/cockroachcloud/use-managed-service-backups) from backups of CockroachCloud clusters. This feature is only available to clusters running the paid version of CockroachCloud.
- [reCAPTCHA](https://www.google.com/recaptcha/about/) has been added to the sign up process for new users signing up with an email and password. Some users may need to complete an image challenge.
- An email will now be sent to [org admins](https://www.cockroachlabs.com/docs/cockroachcloud/authorization#org-administrator-legacy) when a [30-day free trial of CockroachDB {{ site.data.products.cloud }}](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart-dedicated) is nearing its end and once it has expired.
- An email will now be sent to [Org Administrators](https://www.cockroachlabs.com/docs/cockroachcloud/authorization#org-administrator) when a [30-day free trial of CockroachDB {{ site.data.products.cloud }}](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart-dedicated) is nearing its end and when it expires.
2 changes: 1 addition & 1 deletion src/current/_includes/releases/cloud/2023-10-16.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

<h3 id="2023-10-16-general-changes"> General changes </h3>

- Free trials of CockroachDB {{ site.data.products.dedicated }} are no longer available through the {{ site.data.products.cloud }} Console. If you would like to request a trial cluster, contact your Cockroach Labs account team.
- Free trials of CockroachDB {{ site.data.products.dedicated }} can no longer be created from within the {{ site.data.products.cloud }} Console. To request a trial cluster, contact your Cockroach Labs account team.
2 changes: 1 addition & 1 deletion src/current/cockroachcloud/create-your-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This page walks you through the process of creating a CockroachDB {{ site.data.p
Only [CockroachDB {{ site.data.products.cloud }} Org Administrators]({% link cockroachcloud/authorization.md %}#org-administrator-legacy) or users with Cluster Creator / Cluster Admin roles assigned at organization scope can create clusters. If you are a Developer and need to create a cluster, contact your CockroachDB {{ site.data.products.cloud }} Administrator.

{{site.data.alerts.callout_success}}
To create and connect to CockroachDB {{ site.data.products.dedicated }} cluster and run your first query, see the [Quickstart]({% link cockroachcloud/quickstart-dedicated.md %}).
To create and connect to CockroachDB {{ site.data.products.dedicated }} cluster and run your first query, refer to the [Quickstart]({% link cockroachcloud/quickstart-dedicated.md %}).
{{site.data.alerts.end}}

## Step 1. Start the cluster creation process
Expand Down
2 changes: 1 addition & 1 deletion src/current/cockroachcloud/frequently-asked-questions.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ CockroachDB {{ site.data.products.dedicated }} advanced clusters have access to

### How do I connect to my cluster?

To connect to a cluster, you need to authorize your network, create a SQL user, download the CA certificate, and then generate a connection string or parameters. You can use this information to connect to your cluster through the CockroachDB SQL client or a PostgreSQL-compatible driver or ORM. For more details, see [Connect to Your CockroachDB {{ site.data.products.dedicated }} Cluster]({% link cockroachcloud/connect-to-your-cluster.md %}).
To connect to a cluster, you need to authorize your network, create a SQL user, download the CA certificate, and then generate a connection string or parameters. To connect to your cluster through the CockroachDB SQL client or a PostgreSQL-compatible driver or ORM using this information, refer to [Connect to Your CockroachDB {{ site.data.products.dedicated }} Cluster]({% link cockroachcloud/connect-to-your-cluster.md %}).

## Security

Expand Down
4 changes: 2 additions & 2 deletions src/current/cockroachcloud/quickstart-dedicated.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ docs_area: get_started

This page shows you how to deploy a CockroachDB cluster on CockroachDB {{ site.data.products.dedicated }}, connect to it using a sample workload, and run your first query.

To run CockroachDB on your local machine instead, see [Start a Local Cluster](quickstart.html?filters=local).
To run CockroachDB on your local machine instead, refer to [Start a Local Cluster](quickstart.html?filters=local).

## Step 1. Create a cluster

Expand All @@ -21,7 +21,7 @@ For this tutorial, you will create a 3-node GCP cluster in the `us-west2` region
1. For **Regions & nodes**, use the default selection of `California (us-west)` region and 3 nodes.

{{site.data.alerts.callout_info}}
You can also select 3 regions with 3 nodes per region if you want to create a [multi-region]({% link cockroachcloud/plan-your-cluster.md %}#multi-region-clusters) cluster.
To create a [multi-region]({% link cockroachcloud/plan-your-cluster.md %}#multi-region-clusters) cluster instead of a single-region cluster, select three regions and specify three nodes per region.
{{site.data.alerts.end}}

1. Under **Hardware per node**, select 2vCPU for **Compute** and a 35 GiB disk for **Storage**.
Expand Down
10 changes: 5 additions & 5 deletions src/current/cockroachcloud/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,9 +208,9 @@ Now that you have a free CockroachDB {{ site.data.products.serverless }} cluster
- Explore our [example apps](https://www.cockroachlabs.com/docs/{{site.current_cloud_version}}/example-apps) for examples on how to build applications using your preferred driver or ORM and run it on CockroachDB.
- [Migrate your existing data](https://www.cockroachlabs.com/docs/{{site.current_cloud_version}}/migration-overview).

This page highlights just one way you can get started with CockroachDB. For information on other options that are available when creating a CockroachDB cluster, see the following:
This page shows how to get started with CockroachDB by creating a small, simple CockroachDB {{ site.data.products.serverless }} cluster. For comprehensive information about creating and customizing a cluster, refer to:

- To create a Self-Hosted cluster, see [Start a Local Cluster](https://www.cockroachlabs.com/docs/{{site.current_cloud_version}}/start-a-local-cluster).
- To create a CockroachDB {{ site.data.products.dedicated }} cluster, see [Quickstart with CockroachDB {{ site.data.products.dedicated }}]({% link cockroachcloud/quickstart-dedicated.md %}).
- To create a CockroachDB {{ site.data.products.serverless }} cluster with other configurations (e.g., a different cloud provider, region, or monthly budget), see [Create a CockroachDB {{ site.data.products.serverless }} Cluster]({% link cockroachcloud/create-a-serverless-cluster.md %}).
- To connect to a CockroachDB {{ site.data.products.serverless }} cluster with other options (e.g., a different SQL user) and connection methods (with an application or [CockroachDB compatible tool](https://www.cockroachlabs.com/docs/{{site.current_cloud_version}}/third-party-database-tools)), see [Connect to a CockroachDB {{ site.data.products.serverless }} Cluster]({% link cockroachcloud/connect-to-a-serverless-cluster.md %}).
- [Start a Local Cluster](https://www.cockroachlabs.com/docs/{{site.current_cloud_version}}/start-a-local-cluster).
- [Quickstart with CockroachDB {{ site.data.products.dedicated }}]({% link cockroachcloud/quickstart-dedicated.md %}).
- [Create a CockroachDB {{ site.data.products.serverless }} Cluster]({% link cockroachcloud/create-a-serverless-cluster.md %}).
- To connect to a CockroachDB {{ site.data.products.serverless }} cluster with other options or connection methods (such as with a different SQL user, from within an application, or using a [CockroachDB-compatible tool](https://www.cockroachlabs.com/docs/{{site.current_cloud_version}}/third-party-database-tools)), refer to [Connect to a CockroachDB {{ site.data.products.serverless }} Cluster]({% link cockroachcloud/connect-to-a-serverless-cluster.md %}).
2 changes: 1 addition & 1 deletion src/current/v21.1/frequently-asked-questions.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ Yes. The CockroachDB {{ site.data.products.dedicated }} offering is currently in
- Upgrades to the latest stable release of CockroachDB
- Monitoring to provide SLA-level support

For more details, see the [CockroachDB {{ site.data.products.dedicated }}](../cockroachcloud/quickstart-dedicated.html) docs.
For more details, refer to [CockroachDB {{ site.data.products.dedicated }}](../cockroachcloud/quickstart-dedicated.html).

## Why did Cockroach Labs change the license for CockroachDB?

Expand Down
2 changes: 1 addition & 1 deletion src/current/v21.2/architecture/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Term | Definition
**region** | A logical identification of how nodes and data are clustered around [geographical locations](../multiregion-overview.html). A _cluster region_ is the set of locations where cluster nodes are running. A _database region_ is the subset of cluster regions database data should be restricted to.
**availability zone** | A part of a data center that is considered to form a unit with regards to failures and fault tolerance. There can be multiple nodes in a single availability zone, however Cockroach Labs recommends that you to place different replicas of your data in different availability zones.
**[CockroachDB {{ site.data.products.serverless }}](../../cockroachcloud/quickstart.html)** | A fully managed, multi-tenant CockroachDB deployment, in a single region and cloud (AWS or GCP). Delivers an instant, autoscaling database and offers a generous free tier and consumption based billing once free limits are exceeded.
**[CockroachDB {{ site.data.products.dedicated }}](../../cockroachcloud/quickstart-dedicated.html)** | A fully managed, single tenant CockroachDB deployment in a single region or multi-region cloud (AWS or GCP).
**[CockroachDB {{ site.data.products.dedicated }}](../../cockroachcloud/quickstart-dedicated.html)** | A fully-managed single-tenant CockroachDB deployment in a single region or multiple regions.
**[CockroachDB Self-Hosted](../start-a-local-cluster.html)** | A full featured, self-managed CockroachDB deployment.

For more information on deployment options and guidelines on how to choose a deployment option, see [How to Choose a Deployment Option](../choose-a-deployment-option.html).
Expand Down
2 changes: 1 addition & 1 deletion src/current/v21.2/choose-a-deployment-option.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Cockroach Labs offers three ways to deploy CockroachDB: two managed services&mda
<li>Applications that require real-time integration with other systems.</li>
</ul></td>
<td><ul>
<li><b><a href="../cockroachcloud/quickstart-dedicated.html">CockroachDB {{ site.data.products.dedicated }}</a></b>: A fully managed, single tenant CockroachDB deployment in a single region or multi-region cloud (AWS or GCP).</li>
<li><b><a href="../cockroachcloud/quickstart-dedicated.html">CockroachDB {{ site.data.products.dedicated }}</a></b>: A fully-managed single-tenant CockroachDB deployment in a single region or multiple regions.</li>
</ul></td>
<td><ul>
<li><b>Scale</b>: Node-based; self-service add and remove nodes.</li>
Expand Down
2 changes: 1 addition & 1 deletion src/current/v22.1/architecture/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Term | Definition
**region** | A logical identification of how nodes and data are clustered around [geographical locations](../multiregion-overview.html). A _cluster region_ is the set of locations where cluster nodes are running. A _database region_ is the subset of cluster regions database data should be restricted to.
**availability zone** | A part of a data center that is considered to form a unit with regards to failures and fault tolerance. There can be multiple nodes in a single availability zone, however Cockroach Labs recommends that you to place different replicas of your data in different availability zones.
**[CockroachDB {{ site.data.products.serverless }}](../../cockroachcloud/quickstart.html)** | A fully managed, multi-tenant CockroachDB deployment, in a single region and cloud (AWS or GCP). Delivers an instant, autoscaling database and offers a generous free tier and consumption based billing once free limits are exceeded.
**[CockroachDB {{ site.data.products.dedicated }}](../../cockroachcloud/quickstart-dedicated.html)** | A fully managed, single tenant CockroachDB deployment in a single region or multi-region cloud (AWS or GCP).
**[CockroachDB {{ site.data.products.dedicated }}](../../cockroachcloud/quickstart-dedicated.html)** | A fully-managed single-tenant CockroachDB deployment in a single region or multiple regions
**[CockroachDB Self-Hosted](../start-a-local-cluster.html)** | A full featured, self-managed CockroachDB deployment.

For more information on deployment options and guidelines on how to choose a deployment option, see [How to Choose a Deployment Option](../choose-a-deployment-option.html).
Expand Down
2 changes: 1 addition & 1 deletion src/current/v22.1/choose-a-deployment-option.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Cockroach Labs offers three ways to deploy CockroachDB: two managed services&mda
<li>Applications that require real-time integration with other systems.</li>
</ul></td>
<td><ul>
<li><a id="dedicated"></a><b><a href="../cockroachcloud/quickstart-dedicated.html">CockroachDB {{ site.data.products.dedicated }}</a></b>: A fully managed, single tenant CockroachDB deployment in a single region or multi-region cloud (AWS or GCP).</li>
<li><a id="dedicated"></a><b><a href="../cockroachcloud/quickstart-dedicated.html">CockroachDB {{ site.data.products.dedicated }}</a></b>: A fully-managed single-tenant CockroachDB deployment in a single region or multiple regions.</li>
</ul></td>
<td><ul>
<li><b>Scale</b>: Node-based; self-service add and remove nodes.</li>
Expand Down
4 changes: 2 additions & 2 deletions src/current/v22.2/architecture/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ Term | Definition
**region** | A logical identification of how nodes and data are clustered around [geographical locations](../multiregion-overview.html). A _cluster region_ is the set of locations where cluster nodes are running. A _database region_ is the subset of cluster regions database data should be restricted to.
**availability zone** | A part of a data center that is considered to form a unit with regards to failures and fault tolerance. There can be multiple nodes in a single availability zone, however Cockroach Labs recommends that you to place different replicas of your data in different availability zones.
**[CockroachDB {{ site.data.products.serverless }}](../../cockroachcloud/quickstart.html)** | A fully managed, multi-tenant CockroachDB deployment, in a single region and cloud (AWS or GCP). Delivers an instant, autoscaling database and offers a generous free tier and consumption based billing once free limits are exceeded.
**[CockroachDB {{ site.data.products.dedicated }}](../../cockroachcloud/quickstart-dedicated.html)** | A fully managed, single tenant CockroachDB deployment in a single region or multi-region cloud (AWS or GCP).
**[CockroachDB {{ site.data.products.dedicated }}](../../cockroachcloud/quickstart-dedicated.html)** | A fully-managed single-tenant CockroachDB deployment in a single region or multiple regions.
**[CockroachDB Self-Hosted](../start-a-local-cluster.html)** | A full featured, self-managed CockroachDB deployment.

For more information on deployment options and guidelines on how to choose a deployment option, see [How to Choose a Deployment Option](../choose-a-deployment-option.html).
For more information on deployment options and guidelines on how to choose a deployment option, refer to [Choose a Deployment Option](../choose-a-deployment-option.html).

{% include common/basic-terms.md %}

Expand Down
4 changes: 2 additions & 2 deletions src/current/v22.2/choose-a-deployment-option.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Cockroach Labs offers four ways to deploy CockroachDB: three managed services&md
<li>Applications that require real-time integration with other systems.</li>
</ul></td>
<td>
<a id="dedicated-standard"></a><b><a href="../cockroachcloud/quickstart-dedicated.html">CockroachDB {{ site.data.products.dedicated }} standard</a></b>: A fully managed, single tenant CockroachDB deployment in a single region or multi-region cloud (AWS or GCP).
<a id="dedicated-standard"></a><b><a href="../cockroachcloud/quickstart-dedicated.html">CockroachDB {{ site.data.products.dedicated }} standard</a></b>: A fully-managed single-tenant CockroachDB deployment in a single region or multiple regions.
</td>
<td><ul>
<li><b>Scale</b>: Node-based; self-service add and remove nodes.</li>
Expand All @@ -65,7 +65,7 @@ Cockroach Labs offers four ways to deploy CockroachDB: three managed services&md
<li>Applications that need to be PCI compliant.</li>
</ul></td>
<td>
<a id="dedicated-advanced"></a><b><a href="../cockroachcloud/quickstart-dedicated.html">CockroachDB {{ site.data.products.dedicated }} advanced</a></b>:A fully managed, single tenant, <a href="../cockroachcloud/pci-dss.html">PCI-ready</a> CockroachDB deployment in a single region or multi-region cloud (AWS or GCP).
<a id="dedicated-advanced"></a><b><a href="../cockroachcloud/quickstart-dedicated.html">CockroachDB {{ site.data.products.dedicated }} advanced</a></b>:A fully-managed single-tenant <a href="../cockroachcloud/pci-dss.html">PCI-ready</a> CockroachDB deployment in a single region or multiple regions, deployed on AWS or GCP.
</td>
<td><ul>
<li><b>All CockroachDB Dedicated features.</b></li>
Expand Down
4 changes: 2 additions & 2 deletions src/current/v22.2/movr-flask-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ You can also deploy CockroachDB manually. For instructions, see the [Manual Depl
- For **Plan**, select CockroachDB {{ site.data.products.dedicated }}.
- For **Cloud Provider**, select Google Cloud.
- For **Regions & nodes**, add "us-east1", "us-west1", and "europe-west1", with 3 nodes in each region.
- Leave the **Hardware** and **Cluster name** as their default values.
- For **Additional settings**, turn on VPC peering, with the default IP range.
- Use the default values for **Hardware** and **Cluster name**.
- For **Additional settings**, enable VPC peering and use the default IP range.

1. Select **Next**, and on the **Summary** page, enter your credit card details.
1. Select **Create cluster**.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ On top of CockroachDB's built-in automation, you can use a third-party [orchestr
This page demonstrates a basic integration with the open-source [Kubernetes](http://kubernetes.io/) orchestration system. Using either the CockroachDB [Helm](https://helm.sh/) chart or a few configuration files, you'll quickly create a 3-node local cluster. You'll run some SQL commands against the cluster and then simulate node failure, watching how Kubernetes auto-restarts without the need for any manual intervention. You'll then scale the cluster with a single command before shutting the cluster down, again with a single command.

{{site.data.alerts.callout_info}}
To orchestrate a physically distributed cluster in production, see [Orchestrated Deployments](kubernetes-overview.html). To deploy a CockroachDB {{ site.data.products.dedicated }} cluster instead of running CockroachDB yourself, see the [Quickstart](../cockroachcloud/quickstart.html).
To deploy a physically-distributed self-hosted cluster using Kubernetes, refer to [Kubernetes Overview](kubernetes-overview.html). To deploy a CockroachDB {{ site.data.products.dedicated }} cluster instead of running CockroachDB yourself, refer to the [Quickstart](../cockroachcloud/quickstart.html).
{{site.data.alerts.end}}

{% include {{ page.version.version }}/orchestration/local-start-kubernetes.md %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ On top of CockroachDB's built-in automation, you can use a third-party [orchestr
This page demonstrates a basic integration with the open-source [Kubernetes](http://kubernetes.io/) orchestration system. Using either the CockroachDB [Helm](https://helm.sh/) chart or a few configuration files, you'll quickly create a 3-node local cluster. You'll run some SQL commands against the cluster and then simulate node failure, watching how Kubernetes auto-restarts without the need for any manual intervention. You'll then scale the cluster with a single command before shutting the cluster down, again with a single command.

{{site.data.alerts.callout_info}}
To orchestrate a physically distributed cluster in production, see [Orchestrated Deployments](kubernetes-overview.html). To deploy a CockroachDB {{ site.data.products.dedicated }} cluster instead of running CockroachDB yourself, see the [Quickstart](../cockroachcloud/quickstart.html).
To deploy a physically-distributed self-hosted cluster using Kubernetes, refer to [Kubernetes Overview](kubernetes-overview.html). To deploy a CockroachDB {{ site.data.products.dedicated }} cluster instead of running CockroachDB yourself, refer to the [Quickstart](../cockroachcloud/quickstart.html).
{{site.data.alerts.end}}

## Limitations
Expand Down
Loading

0 comments on commit 535f387

Please sign in to comment.