Docs for basic tier and link updates #18340

Amruta-Ranade · 2024-03-01T20:51:14Z

In this PR:

Trivial content updates (feel free to ignore -- will have to revisit content in April once the workflows are finalized)
File renames and related link updates
Navigation bar (partial) updates
Tab updates

github-actions · 2024-03-01T20:51:36Z

Files changed:

src/current/_data/redirects.yml
src/current/_includes/cockroachcloud/basic-usage.md:

src/current/_includes/cockroachcloud/filter-tabs/cluster-management.md:

src/current/_includes/cockroachcloud/filter-tabs/create-cluster-cloud.md:

src/current/_includes/cockroachcloud/filter-tabs/plan-your-cluster.md:

src/current/_includes/cockroachcloud/free-cluster-limit.md:

src/current/cockroachcloud/create-a-basic-cluster.md
src/current/_includes/cockroachcloud/quickstart/create-a-free-cluster.md:

src/current/cockroachcloud/quickstart.md

src/current/_includes/common/basic-terms.md
src/current/_includes/releases/cloud/2023-08-01.md:
- releases/cloud.md
src/current/_includes/releases/cloud/2023-08-22.md:
- releases/cloud.md
src/current/_includes/releases/cloud/2023-09-29.md:
- releases/cloud.md
src/current/_includes/sidebar-data-cockroachcloud.json
src/current/_includes/v21.2/sidebar-data/deploy.json
src/current/_includes/v21.2/sidebar-data/manage.json
src/current/_includes/v22.1/sidebar-data/deploy.json
src/current/_includes/v22.1/sidebar-data/manage.json
src/current/_includes/v22.2/sidebar-data/deploy.json
src/current/_includes/v22.2/sidebar-data/manage.json
src/current/_includes/v23.1/sidebar-data/cloud-deployments.json
src/current/_includes/v23.2/sidebar-data/cloud-deployments.json
src/current/cockroachcloud/architecture.md
src/current/cockroachcloud/aws-privatelink.md
src/current/cockroachcloud/basic-cluster-management.md
src/current/cockroachcloud/cluster-overview-page.md
src/current/cockroachcloud/connect-to-a-serverless-cluster.md
src/current/cockroachcloud/create-a-basic-cluster.md
src/current/cockroachcloud/create-your-cluster.md
src/current/cockroachcloud/export-metrics.md
src/current/cockroachcloud/plan-your-cluster-basic.md
src/current/cockroachcloud/quickstart.md
src/current/cockroachcloud/serverless-faqs.md
src/current/cockroachcloud/serverless-resource-usage.md
src/current/cockroachcloud/sql-shell.md
src/current/cockroachcloud/troubleshooting-page.md
src/current/v21.2/security-reference/config-secure-hba.md
src/current/v22.1/security-reference/config-secure-hba.md
src/current/v22.1/vault-db-secrets-tutorial.md
src/current/v22.2/explain-analyze.md
src/current/v22.2/security-reference/config-secure-hba.md
src/current/v22.2/vault-db-secrets-tutorial.md

netlify · 2024-03-01T20:55:17Z

✅ Netlify Preview

Name	Link
🔨 Latest commit	`9b4d2de`
🔍 Latest deploy log	https://app.netlify.com/sites/cockroachdb-docs/deploys/65e63076e27cda000875b5ac
😎 Deploy Preview	https://deploy-preview-18340--cockroachdb-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

mdlinville · 2024-03-04T19:02:20Z

src/current/_data/redirects.yml

@@ -819,6 +809,25 @@
    - interleave-in-parent.md
    - stable/interleave-in-parent.md

+# Cloud 2.0 updates (Serverless/Dedicated to Basic/Standard/Advanced)


Nit: I'd remove this comment before merging.

I meant it as a header to help us add and track redirects more easily for Cloud 2.0

mdlinville · 2024-03-04T19:02:50Z

src/current/_includes/cockroachcloud/filter-tabs/cluster-management.md

@@ -1,4 +1,4 @@
-{% assign tab_names_html = "CockroachDB Serverless;CockroachDB Dedicated" %}
-{% assign html_page_filenames = "serverless-cluster-management.html;cluster-management.html" %}
+{% assign tab_names_html = "CockroachDB Basic;CockroachDB Standard;CockroachDB Advanced" %}


We are going back to capitals for the tiers?

I assumed we'd follow the convention for the current tiers. I don't remember a discussion about not capitalizing tier names (or I might have missed it)

mdlinville · 2024-03-04T19:04:01Z

src/current/_includes/cockroachcloud/free-cluster-limit.md

@@ -1,3 +1,3 @@
 {{site.data.alerts.callout_info}}
-Organizations without billing information on file can only create one CockroachDB {{ site.data.products.serverless }} cluster.
+Organizations without billing information on file can only create one CockroachDB {{ site.data.products.basic }} cluster.


Should we say "Organizations without a payment method configured can create only one...."? Not loving "billing information on file" but I understand it could be a credit card or a contract.

Nah this goes away after the new free trial is implemented anyways I think

mdlinville · 2024-03-04T19:05:35Z

src/current/_includes/common/basic-terms.md

@@ -36,7 +36,7 @@ However, 'legacy service accounts' that were created before the updated authoriz

 To learn more, refer to [Manage Service Accounts]({{ link_prefix }})managing-access.html#manage-service-accounts)

-#### CockroachDB {{ site.data.products.serverless }} cluster
+#### CockroachDB {{ site.data.products.basic }} cluster

 A CockroachDB {{ site.data.products.cloud }} cluster deployed on request for a specific customer in *shared* network and compute infrastructure.


Is this the right terminology? Might be an opportunity to say "A CockroachDB cluster deployed on {{ site.data.products.cloud }} for a specific customer...." I don't think we want to say the type of cluster is a Cloud one -- it's actually a Basic one.

Nah it can be either standard or basic (+ not focusing on existing content in this PR)

mdlinville · 2024-03-04T19:06:51Z

src/current/_includes/v22.2/sidebar-data/deploy.json

+              "title": "CockroachDB Advanced",
+              "items": [
+                {
+                  "title": "Plan a CockroachDB Dedicated Cluster",


Nit: Update the title?

mdlinville · 2024-03-04T19:13:29Z

src/current/cockroachcloud/serverless-faqs.md


 Organizations without billing information on file can only create one cluster. Once you [set up billing information]({% link cockroachcloud/billing-management.md %}), your organization can have up to 200 clusters.

 ### What is a Request Unit?

-With CockroachDB {{ site.data.products.serverless }}, you are charged for the storage and activity of your cluster. All cluster activity, including SQL queries, bulk operations, and background jobs, is measured in [Request Units]({% link cockroachcloud/plan-your-cluster-serverless.md %}#request-units), or RUs. An RU is an abstracted metric that represent the size and complexity of requests made to your cluster. See [Plan your CockroachDB {{ site.data.products.serverless }} Cluster]({% link cockroachcloud/plan-your-cluster-serverless.md %}#request-units) for more information.
+With CockroachDB {{ site.data.products.serverless }}, you are charged for the storage and activity of your cluster. All cluster activity, including SQL queries, bulk operations, and background jobs, is measured in [Request Units]({% link cockroachcloud/plan-your-cluster-basic.md %}#request-units), or RUs. An RU is an abstracted metric that represent the size and complexity of requests made to your cluster. See [Plan your CockroachDB {{ site.data.products.serverless }} Cluster]({% link cockroachcloud/plan-your-cluster-basic.md %}#request-units) for more information.


Nit: Update the variable?

No, I had to leave the variables as is since I'm not updating this file in this PR. Only updating the links for now so they don't make the build fail. I know it's messy, but I'd rather look at each file holistically than change them piecemeal in multiple PRs

mdlinville · 2024-03-04T19:13:49Z

src/current/cockroachcloud/serverless-faqs.md

@@ -73,7 +73,7 @@ To connect to a cluster, download the CA certificate, and then generate a connec

 ### I created a CockroachCloud Free (beta) cluster before CockroachDB {{ site.data.products.serverless }} was available. Can I still use my cluster?

-Yes, your free cluster has been automatically migrated to CockroachDB {{ site.data.products.serverless }}. Your ability to use your cluster should not be affected, and you will now have the option to [add resource limits]({% link cockroachcloud/serverless-cluster-management.md %}#edit-cluster-capacity) for your cluster with no downtime.
+Yes, your free cluster has been automatically migrated to CockroachDB {{ site.data.products.serverless }}. Your ability to use your cluster should not be affected, and you will now have the option to [add resource limits]({% link cockroachcloud/basic-cluster-management.md %}#edit-cluster-capacity) for your cluster with no downtime.


Nit: Update the variable?

src/current/cockroachcloud/serverless-faqs.md

mdlinville · 2024-03-04T19:15:40Z

src/current/v22.1/vault-db-secrets-tutorial.md

@@ -22,7 +22,7 @@ To follow along with this tutorial you will need the following:

 - The CockroachDB CLI [installed locally](install-cockroachdb-mac.html).
 - The Vault CLI [installed locally](https://www.vaultproject.io/downloads).
- Access to a CockroachDB cluster as [`admin` SQL user](security-reference/authorization.html#admin-role). This tutorial will use a CockroachDB {{ site.data.products.serverless }} cluster, but you may either [Create a CockroachDB {{ site.data.products.serverless }} cluster](../cockroachcloud/create-a-serverless-cluster.html) or [Start a Local Cluster (secure)](start-a-local-cluster.html) in order to follow along. In either case you must have the public CA certificate for your cluster, and a username/password combination for the `root` SQL user (or another SQL user with the [`admin` role](security-reference/authorization.html#admin-role).
+- Access to a CockroachDB cluster as [`admin` SQL user](security-reference/authorization.html#admin-role). This tutorial will use a CockroachDB {{ site.data.products.serverless }} cluster, but you may either [Create a CockroachDB {{ site.data.products.serverless }} cluster](../cockroachcloud/create-a-basic-cluster.html) or [Start a Local Cluster (secure)](start-a-local-cluster.html) in order to follow along. In either case you must have the public CA certificate for your cluster, and a username/password combination for the `root` SQL user (or another SQL user with the [`admin` role](security-reference/authorization.html#admin-role).


Nit: Update the variable?

mdlinville · 2024-03-04T19:16:00Z

src/current/v22.2/explain-analyze.md

@@ -62,7 +62,7 @@ Property        | Description
 `network usage` | The amount of data transferred over the network while the statement was executed. If the value is 0 B, the statement was executed on a single node and didn't use the network.
 `regions` | The [regions](show-regions.html) where the affected nodes were located.
 `max sql temp disk usage` | ([`DISTSQL`](#distsql-option) option only) How much disk spilling occurs when executing a query. This property is displayed only when the disk usage is greater than zero.
-`estimated RUs consumed` | The estimated number of [Request Units (RUs)](../cockroachcloud/plan-your-cluster-serverless.html#request-units) consumed by the statement. This property is visible only on CockroachDB {{ site.data.products.serverless }} clusters.
+`estimated RUs consumed` | The estimated number of [Request Units (RUs)](../cockroachcloud/plan-your-cluster-basic.html#request-units) consumed by the statement. This property is visible only on CockroachDB {{ site.data.products.serverless }} clusters.


Nit: Update the variable?

mdlinville · 2024-03-04T19:17:48Z

The deploy preview failure is due to several broken links. Might be worth make linkcheck locally.

Amruta-Ranade · 2024-03-04T20:21:39Z

src/current/_data/redirects.yml

@@ -819,6 +809,25 @@
    - interleave-in-parent.md
    - stable/interleave-in-parent.md

+# Cloud 2.0 updates (Serverless/Dedicated to Basic/Standard/Advanced)


I meant it as a header to help us add and track redirects more easily for Cloud 2.0

Amruta-Ranade · 2024-03-04T20:22:51Z

src/current/_includes/cockroachcloud/filter-tabs/cluster-management.md

@@ -1,4 +1,4 @@
-{% assign tab_names_html = "CockroachDB Serverless;CockroachDB Dedicated" %}
-{% assign html_page_filenames = "serverless-cluster-management.html;cluster-management.html" %}
+{% assign tab_names_html = "CockroachDB Basic;CockroachDB Standard;CockroachDB Advanced" %}


I assumed we'd follow the convention for the current tiers. I don't remember a discussion about not capitalizing tier names (or I might have missed it)

Amruta-Ranade · 2024-03-04T20:23:33Z

src/current/_includes/cockroachcloud/free-cluster-limit.md

@@ -1,3 +1,3 @@
 {{site.data.alerts.callout_info}}
-Organizations without billing information on file can only create one CockroachDB {{ site.data.products.serverless }} cluster.
+Organizations without billing information on file can only create one CockroachDB {{ site.data.products.basic }} cluster.


Nah this goes away after the new free trial is implemented anyways I think

Amruta-Ranade · 2024-03-04T20:26:12Z

src/current/_includes/common/basic-terms.md

@@ -36,7 +36,7 @@ However, 'legacy service accounts' that were created before the updated authoriz

 To learn more, refer to [Manage Service Accounts]({{ link_prefix }})managing-access.html#manage-service-accounts)

-#### CockroachDB {{ site.data.products.serverless }} cluster
+#### CockroachDB {{ site.data.products.basic }} cluster

 A CockroachDB {{ site.data.products.cloud }} cluster deployed on request for a specific customer in *shared* network and compute infrastructure.


Nah it can be either standard or basic (+ not focusing on existing content in this PR)

src/current/_includes/v22.2/sidebar-data/deploy.json

Amruta-Ranade · 2024-03-04T20:27:57Z

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

@@ -95,7 +95,54 @@
            ]
            },
            {
-            "title": "CockroachDB Dedicated on Azure",
+            "title": "Migrate from Serverless to Dedicated",


Nope -- only updated the sidebar entries for docs updated in this PR

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

Amruta-Ranade · 2024-03-04T20:29:46Z

src/current/cockroachcloud/create-a-basic-cluster.md


 Click **Next: Capacity**.

 ## Step 4. Configure cluster capacity

 Your cluster's capacity dictates its [resource limits](https://www.cockroachlabs.com/docs/{{site.current_cloud_version}}/architecture/glossary#resource-limits), which are the maximum amount of storage and RUs you can use in a month. If you reach your storage limit, your cluster will be throttled and you may only be able to delete data. If you reach your RU limit, your cluster will be disabled until the end of the billing cycle unless you raise the limit.

-All CockroachDB {{ site.data.products.cloud }} organizations get 50M RUs and 10 GiB of storage for free each month. Free resources can be spent across all CockroachDB {{ site.data.products.serverless }} clusters in an organization. You can set higher resource limits to maintain a high level of performance with larger workloads. You will only be charged for what you use.
+All CockroachDB {{ site.data.products.cloud }} organizations get 50M RUs and 10 GiB of storage for free each month. Free resources can be spent across all CockroachDB {{ site.data.products.basic }} clusters in an organization. You can set higher resource limits to maintain a high level of performance with larger workloads. You will only be charged for what you use.


Yep, -- will handle it in April when I work on content updates

Amruta-Ranade · 2024-03-04T20:31:58Z

src/current/cockroachcloud/serverless-faqs.md


 Organizations without billing information on file can only create one cluster. Once you [set up billing information]({% link cockroachcloud/billing-management.md %}), your organization can have up to 200 clusters.

 ### What is a Request Unit?

-With CockroachDB {{ site.data.products.serverless }}, you are charged for the storage and activity of your cluster. All cluster activity, including SQL queries, bulk operations, and background jobs, is measured in [Request Units]({% link cockroachcloud/plan-your-cluster-serverless.md %}#request-units), or RUs. An RU is an abstracted metric that represent the size and complexity of requests made to your cluster. See [Plan your CockroachDB {{ site.data.products.serverless }} Cluster]({% link cockroachcloud/plan-your-cluster-serverless.md %}#request-units) for more information.
+With CockroachDB {{ site.data.products.serverless }}, you are charged for the storage and activity of your cluster. All cluster activity, including SQL queries, bulk operations, and background jobs, is measured in [Request Units]({% link cockroachcloud/plan-your-cluster-basic.md %}#request-units), or RUs. An RU is an abstracted metric that represent the size and complexity of requests made to your cluster. See [Plan your CockroachDB {{ site.data.products.serverless }} Cluster]({% link cockroachcloud/plan-your-cluster-basic.md %}#request-units) for more information.


No, I had to leave the variables as is since I'm not updating this file in this PR. Only updating the links for now so they don't make the build fail. I know it's messy, but I'd rather look at each file holistically than change them piecemeal in multiple PRs

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

src/current/cockroachcloud/create-a-basic-cluster.md

Co-authored-by: Matt Linville (he/him) <linville@cockroachlabs.com>

Amruta-Ranade added 4 commits March 1, 2024 11:29

File renames, redirects, link updates, and trivial content updates

8f8f30f

more link updates

e312722

Fixed broken links

9fe724a

partially updated the sidebar nav

5450a96

Amruta-Ranade requested a review from mdlinville March 4, 2024 18:27

Resolving conflict

d4f5100

mdlinville approved these changes Mar 4, 2024

View reviewed changes

Fixed broken links

4bd0078

Amruta-Ranade commented Mar 4, 2024

View reviewed changes

src/current/cockroachcloud/basic-cluster-management.md Outdated Show resolved Hide resolved

Amruta-Ranade commented Mar 4, 2024

View reviewed changes

src/current/cockroachcloud/create-a-basic-cluster.md Outdated Show resolved Hide resolved

Apply suggestions from code review

9b4d2de

Co-authored-by: Matt Linville (he/him) <linville@cockroachlabs.com>

Amruta-Ranade merged commit eaa0138 into cloud-2.0 Mar 4, 2024
4 checks passed

Amruta-Ranade deleted the docs-for-basic-and-link-updates branch March 4, 2024 21:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs for basic tier and link updates #18340

Docs for basic tier and link updates #18340

Amruta-Ranade commented Mar 1, 2024

github-actions bot commented Mar 1, 2024 •

edited

Loading

netlify bot commented Mar 1, 2024 •

edited

Loading

mdlinville Mar 4, 2024

Amruta-Ranade Mar 4, 2024

mdlinville Mar 4, 2024

Amruta-Ranade Mar 4, 2024

mdlinville Mar 4, 2024

Amruta-Ranade Mar 4, 2024

mdlinville Mar 4, 2024

Amruta-Ranade Mar 4, 2024

mdlinville Mar 4, 2024

mdlinville Mar 4, 2024

Amruta-Ranade Mar 4, 2024 •

edited

Loading

mdlinville Mar 4, 2024

mdlinville Mar 4, 2024

mdlinville Mar 4, 2024

mdlinville commented Mar 4, 2024

Amruta-Ranade Mar 4, 2024

Amruta-Ranade Mar 4, 2024

Amruta-Ranade Mar 4, 2024

Amruta-Ranade Mar 4, 2024

Amruta-Ranade Mar 4, 2024

Amruta-Ranade Mar 4, 2024

Amruta-Ranade Mar 4, 2024 •

edited

Loading

Docs for basic tier and link updates #18340

Docs for basic tier and link updates #18340

Conversation

Amruta-Ranade commented Mar 1, 2024

github-actions bot commented Mar 1, 2024 • edited Loading

Files changed:

netlify bot commented Mar 1, 2024 • edited Loading

✅ Netlify Preview

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Amruta-Ranade Mar 4, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mdlinville commented Mar 4, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Amruta-Ranade Mar 4, 2024 • edited Loading

Choose a reason for hiding this comment

github-actions bot commented Mar 1, 2024 •

edited

Loading

netlify bot commented Mar 1, 2024 •

edited

Loading

Amruta-Ranade Mar 4, 2024 •

edited

Loading

Amruta-Ranade Mar 4, 2024 •

edited

Loading