Update cockroachcloud/ links in Cloud 2.0 to use Liquid syntax (#18846)

* Update cockroachcloud/ links in Cloud 2.0 to use Liquid syntax Relates to DOC-10953 Relates to #18844
cockroachdb · Aug 23, 2024 · 1a21e62 · 1a21e62
1 parent 4d8a7d2
commit 1a21e62
Show file tree

Hide file tree

Showing 187 changed files with 539 additions and 450 deletions.
diff --git a/src/current/_includes/cockroachcloud/filter-tabs/cluster-management.md b/src/current/_includes/cockroachcloud/filter-tabs/cluster-management.md
@@ -1,4 +1,4 @@
 {% assign tab_names_html = "CockroachDB Basic;CockroachDB Standard;CockroachDB Advanced" %}
-{% assign html_page_filenames = "basic-cluster-management.html;cluster-management.html;cluster-management.html;advanced-cluster-management.html" %}
+{% assign html_page_filenames = "basic-cluster-management.html;cluster-management.html;cluster-management-advanced.html;advanced-cluster-management.html" %}
 
 {% include filter-tabs.md tab_names=tab_names_html page_filenames=html_page_filenames page_folder="cockroachcloud" %}
diff --git a/src/current/_includes/cockroachcloud/note-egress-perimeter-cdc-backup.md b/src/current/_includes/cockroachcloud/note-egress-perimeter-cdc-backup.md
@@ -1,3 +1,3 @@
 {{site.data.alerts.callout_info}}
-Cockroach Labs recommends enabling Egress Perimeter Controls on CockroachDB {{ site.data.products.advanced }} clusters to mitigate the risk of data exfiltration when accessing external resources, such as cloud storage for change data capture or backup and restore operations. See [Egress Perimeter Controls](https://www.cockroachlabs.com/docs/cockroachcloud/egress-perimeter-controls) for detail and setup instructions.
+Cockroach Labs recommends enabling Egress Perimeter Controls on CockroachDB {{ site.data.products.advanced }} clusters to mitigate the risk of data exfiltration when accessing external resources, such as cloud storage for change data capture or backup and restore operations. See [Egress Perimeter Controls]({% link cockroachcloud/egress-perimeter-controls.md %}) for detail and setup instructions.
 {{site.data.alerts.end}}
diff --git a/src/current/cockroachcloud/alerts-page.md b/src/current/cockroachcloud/alerts-page.md
@@ -24,7 +24,7 @@ The **Alerts** page is applicable for CockroachDB {{ site.data.products.advanced
 
 ### CMEK
 
-The [Customer-Managed Encryption Keys (CMEK)](https://www.cockroachlabs.com/docs/cockroachcloud/cmek) alert is triggered when the cluster node is unable to start due to CMEK key access failure.
+The [Customer-Managed Encryption Keys (CMEK)]({% link cockroachcloud/cmek.md %}) alert is triggered when the cluster node is unable to start due to CMEK key access failure.
 {% comment %}- Encrypted backup failed due to CMEK key access failure.{% endcomment %}
 
 If you receive the alert repeatedly, verify the following:

diff --git a/src/current/cockroachcloud/cluster-management-advanced.md b/src/current/cockroachcloud/cluster-management-advanced.md
@@ -0,0 +1,90 @@
+---
+title: Manage a CockroachDB Advanced Cluster
+summary: Manage your cluster's schema, data, and more.
+toc: true
+docs_area: manage
+---
+
+{% include cockroachcloud/filter-tabs/cluster-management.md %}
+
+This page describes the cluster management and cluster deletion workflows for CockroachDB {{ site.data.products.advanced }}.
+
+## Planning your cluster
+
+Before making any changes to your cluster's regions, review the [requirements and recommendations]({% link cockroachcloud/plan-your-cluster.md %}) for CockroachDB {{ site.data.products.cloud }} cluster configuration.
+
+## View Clusters page
+
+After you [log in to the CockroachDB {{ site.data.products.cloud }} Console](https://cockroachlabs.cloud/), the **Clusters** page is displayed. The **Clusters** page provides a high-level view of your clusters.
+
+To view and manage a specific cluster, click the name of the cluster. The [**Overview**](#view-cluster-overview) page will display.
+
+## View cluster overview
+
+The [**Overview** page]({% link cockroachcloud/cluster-overview-page.md %}) displays details about the selected CockroachDB {{ site.data.products.cloud }} cluster.
+
+From the **Overview** page, you can connect to your cluster. For more information, refer to [Connect to Your CockroachDB {{ site.data.products.advanced }} Cluster]({% link cockroachcloud/connect-to-your-cluster.md %}).
+
+## Add a region to your cluster
+
+1. Navigate to the cluster's **Overview** page.
+1. In the **Cluster settings** section, click the pencil icon next to the cluster's **Regions**.
+
+    The **Edit Cluster** page displays.
+
+1. On the **Regions** page, click Add Region and select the desired new region.
+1. In the sidebar, verify the hourly estimated cost for the cluster.
+1. Click **Next: Capacity** and then **Update cluster**.
+
+## Edit cluster capacity
+
+To edit your cluster's capacity:
+
+1. Navigate to the cluster's **Overview** page.
+1. In the **Capacity** section, click **Update capacity**.
+    The **Capacity** page displays.
+1. Enter the desired compute per node and storage per node.
+
+1. In the sidebar, verify the new estimated cost for the cluster and click **Update cluster**.
+
+{% comment %}
+## Configure PCI ready features
+
+CockroachDB {{ site.data.products.advanced }} clusters have a **PCI ready** panel to monitor the status of security features required for [PCI DSS readiness]({% link cockroachcloud/pci-dss.md %}). Feature statuses will update from **INACTIVE** to **ACTIVE** once you configure them. Learn more about configuring these features:
+
+- [CockroachDB {{ site.data.products.cloud }} Organization Audit logs]({% link cockroachcloud/cloud-org-audit-logs.md %})
+- [Customer-Managed Encryption Keys (CMEK)]({% link cockroachcloud/managing-cmek.md %})
+- [Egress Perimeter Controls]({% link cockroachcloud/egress-perimeter-controls.md %})
+- Single Sign-On (SSO) for your [CockroachDB {{ site.data.products.cloud }} organization]({% link cockroachcloud/configure-cloud-org-sso.md %}) and your [clusters]({% link cockroachcloud/cloud-sso-sql.md %})
+- [Network security]({% link cockroachcloud/network-authorization.md %})
+
+You can also check the status of these features on the [**PCI ready**]({% link cockroachcloud/cluster-overview-page.md %}?filters=dedicated#pci-ready-dedicated-advanced) page of the CockroachDB {{ site.data.products.cloud }} Console.
+{% endcomment %}
+
+## Restore data from a backup
+
+Refer to [Managed-Service Backups]({% link cockroachcloud/use-managed-service-backups.md %}) for instructions to restore your cluster from an automatic cluster backup.
+
+You can also [back up and restore]({% link cockroachcloud/take-and-restore-customer-owned-backups.md %}) your cluster manually. You can take [backups locally]({% link cockroachcloud/take-and-restore-customer-owned-backups.md %}) to [`userfile`]({% link {{site.current_cloud_version}}/use-userfile-storage.md %}) or [back up to cloud storage]({% link cockroachcloud/take-and-restore-customer-owned-backups.md %}).
+
+## Enable deletion protection
+
+To help prevent a cluster from being deleted by mistake, you can enable _deletion protection_. Before you can delete a cluster with deletion protection enabled, you must disable deletion protection. A user with permission to delete a cluster can enable deletion protection on the same cluster.
+
+1. Navigate to the **Overview** page for the cluster you want to protect.
+1. If deletion protection is disabled, click the pencil icon next to it. Toggle the setting, then click **Save**.
+
+## Delete cluster
+
+{{site.data.alerts.callout_danger}}
+Deleting a cluster will delete all cluster data.
+{{site.data.alerts.end}}
+
+Proceed with the following steps only if you are sure you want to delete a cluster:
+
+1. Navigate to the **Overview** page for the cluster you want to delete.
+1. If [deletion protection](#enable-deletion-protection) is enabled, click the pencil icon next to it. Toggle the setting, then click **Save**.
+1. Click the **Actions** button in the top right corner.
+1. Select **Delete cluster**.
+1. In the confirmation window, enter the name of the cluster.
+1. Click **Delete**.
diff --git a/src/current/cockroachcloud/egress-perimeter-controls.md b/src/current/cockroachcloud/egress-perimeter-controls.md
@@ -33,12 +33,13 @@ Regardless of user-specific Egress Perimeter Control policy, egress is always pe
 {{site.data.alerts.end}}
 
 ## Before you begin
-
+{% comment %}Commented out for Cloud 2.0 for now, awaiting confirmation about PCI Ready
 - Egress Perimeter Controls are supported on AWS and GCP for the following deployment types:
-    - CockroachDB {{ site.data.products.dedicated }} advanced with [PCI-ready features](https://www.cockroachlabs.com/docs/cockroachcloud/cluster-management#configure-pci-ready-features-dedicated-advanced).
-    - CockroachDB {{ site.data.products.dedicated }} [Private Cluster]({% link cockroachcloud/private-clusters.md %}).
+    - CockroachDB {{ site.data.products.advanced }} clusters with [PCI-ready features]({% link cockroachcloud/cluster-management-advanced.md %}#configure-pci-ready-features-dedicated-advanced).
+    - CockroachDB {{ site.data.products.advanced }} [Private Clusters]({% link cockroachcloud/private-clusters.md %}).
 
     Egress Perimeter Controls are not supported for CockroachDB {{ site.data.products.dedicated }} on Azure or for CockroachDB {{ site.data.products.serverless }}.
+{% endcomment %}
 - You need a service account with the [Cluster Administrator]({% link cockroachcloud/authorization.md %}#cluster-administrator) role on clusters in your organization. You can provision service accounts and API keys in CockroachDB Cloud Console. Refer to [Service Accounts]({% link cockroachcloud/managing-access.md %}#manage-service-accounts).
 
 {{site.data.alerts.callout_danger}}

diff --git a/src/current/v23.1/api-support-policy.md b/src/current/v23.1/api-support-policy.md
@@ -82,8 +82,8 @@ A *mixed* API includes both stable and unstable features.
 | [Cluster API]({% link {{ page.version.version }}/cluster-api.md %})                                         | Mixed    | [Versioned independently from CockroachDB.]({% link {{ page.version.version }}/cluster-api.md %}#versioning-and-stability) | For information on supported endpoints, see [Cluster API]({% link {{ page.version.version }}/cluster-api.md %}).                                                                                                                                               | CockroachDB {{ site.data.products.dedicated }}, CockroachDB {{ site.data.products.core }} |
 | [DB Console]({% link {{ page.version.version }}/ui-overview.md %})                                          | Unstable | N/A                                                                                    | For stable access to the information present in this tool, use the [Cluster API]({% link {{ page.version.version }}/cluster-api.md %}).                                                                                                                        | CockroachDB {{ site.data.products.dedicated }}, CockroachDB {{ site.data.products.core }} |
 | [Logging]({% link {{ page.version.version }}/logging-overview.md %})                                        | Mixed    | Versioned concurrently with CockroachDB.                                               | Stability varies by [event type]({% link {{ page.version.version }}/eventlog.md %}). Structured events are stable and unstructured events are unstable.                                                                                                        | CockroachDB {{ site.data.products.dedicated }}, CockroachDB {{ site.data.products.core }} |
-| [`ccloud` CLI](https://www.cockroachlabs.com/docs/cockroachcloud/ccloud-get-started)               | Mixed    | Versioned independently from CockroachDB.                                              | Default output is unstable. Specify the `–json` argument in the CLI for stable output that follows the versioning scheme.                                                                                                  | CockroachDB {{ site.data.products.cloud }}                                       |
-| [CockroachDB {{ site.data.products.cloud }} API](https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api)     | Stable   | Versioned independently from CockroachDB.                                              |                                                                                                                                                                                                                            | CockroachDB {{ site.data.products.cloud }}                                       |
+| [`ccloud` CLI]({% link cockroachcloud/ccloud-get-started.md %})               | Mixed    | Versioned independently from CockroachDB.                                              | Default output is unstable. Specify the `–json` argument in the CLI for stable output that follows the versioning scheme.                                                                                                  | CockroachDB {{ site.data.products.cloud }}                                       |
+| [CockroachDB {{ site.data.products.cloud }} API]({% link cockroachcloud/cloud-api.md %})     | Stable   | Versioned independently from CockroachDB.                                              |                                                                                                                                                                                                                            | CockroachDB {{ site.data.products.cloud }}                                       |
 | CockroachDB {{ site.data.products.cloud }} Console                                     | Unstable | N/A                                                                                    |                                                                                                                                                                                                                            | CockroachDB {{ site.data.products.cloud }}                                       |
 | [Advanced Debug endpoints]({% link {{ page.version.version }}/ui-debug-pages.md %})                         | Reserved | N/A                                                                                    |                                                                                                                                                                                                                            | N/A                                                               |
 

diff --git a/src/current/v23.1/authorization.md b/src/current/v23.1/authorization.md
@@ -7,12 +7,12 @@ docs_area: manage
 
 This page documents procedures for managing the lifecycle of SQL users and roles on CockroachDB clusters.
 
-Procedures for managing access are covered in [Managing Access in CockroachDB {{ site.data.products.cloud }}](https://www.cockroachlabs.com/docs/cockroachcloud/managing-access).
+Procedures for managing access are covered in [Managing Access in CockroachDB {{ site.data.products.cloud }}]({% link cockroachcloud/managing-access.md %}).
 
 {{site.data.alerts.callout_info}}
 The concept of *Organization user* is distinct from Authorization of *SQL user/role* on clusters is distinct from authorization of CockroachDB {{ site.data.products.cloud }} users within CockroachDB {{ site.data.products.cloud }} organizations.
 
-Learn more: [Overview of the CockroachDB Cloud authorization model](https://www.cockroachlabs.com/docs/cockroachcloud/authorization#overview-of-the-cockroachdb-cloud-two-level-authorization-model)
+Learn more: [Overview of the CockroachDB Cloud authorization model]({% link cockroachcloud/authorization.md %}#overview-of-the-cockroachdb-cloud-authorization-model)
 {{site.data.alerts.end}}
 
 

diff --git a/src/current/v23.1/aws-dms.md b/src/current/v23.1/aws-dms.md
@@ -39,7 +39,7 @@ Complete the following items before starting the DMS migration:
 
     This prevents a potential issue when migrating especially large tables with millions of rows.
 
-- Manually create all schema objects in the target CockroachDB cluster. If you are migrating from PostgreSQL, MySQL, Oracle, or Microsoft SQL Server, you can [use the **Schema Conversion Tool**](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) to convert and export your schema.
+- Manually create all schema objects in the target CockroachDB cluster. If you are migrating from PostgreSQL, MySQL, Oracle, or Microsoft SQL Server, you can [use the **Schema Conversion Tool**]({% link cockroachcloud/migrations-page.md %}) to convert and export your schema.
 
     - All tables must have an explicitly defined primary key. For more guidance, see the [Migration Overview]({% link {{ page.version.version }}/migration-overview.md %}#schema-design-best-practices).
 
@@ -215,7 +215,7 @@ If your migration failed for some reason, you can check the checkbox next to the
 
 ### AWS PrivateLink
 
-If using CockroachDB {{ site.data.products.standard }} or {{ site.data.products.advanced }}, you can enable [AWS PrivateLink](https://aws.amazon.com/privatelink/) to securely connect your AWS application with your CockroachDB {{ site.data.products.standard }} or {{ site.data.products.advanced }} cluster using a private endpoint. To configure AWS PrivateLink with CockroachDB {{ site.data.products.standard }} or {{ site.data.products.advanced }}, see [Network Authorization](https://www.cockroachlabs.com/docs/cockroachcloud/network-authorization#aws-privatelink).
+If using CockroachDB {{ site.data.products.standard }} or {{ site.data.products.advanced }}, you can enable [AWS PrivateLink](https://aws.amazon.com/privatelink/) to securely connect your AWS application with your CockroachDB {{ site.data.products.standard }} or {{ site.data.products.advanced }} cluster using a private endpoint. To configure AWS PrivateLink with CockroachDB {{ site.data.products.standard }} or {{ site.data.products.advanced }}, see [Network Authorization]({% link cockroachcloud/network-authorization.md %}#aws-privatelink).
 
 ### `BatchApplyEnabled`
 
@@ -413,7 +413,7 @@ The `BatchApplyEnabled` setting can improve replication performance and is recom
 ## See Also
 
 - [Migration Overview]({% link {{ page.version.version }}/migration-overview.md %})
-- [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page)
+- [Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %})
 - [`cockroach demo`]({% link {{ page.version.version }}/cockroach-demo.md %})
 - [AWS DMS documentation](https://docs.aws.amazon.com/dms/latest/userguide/Welcome.html)
 - [Client connection parameters]({% link {{ page.version.version }}/connection-parameters.md %})

diff --git a/src/current/v23.1/bulk-delete-data.md b/src/current/v23.1/bulk-delete-data.md
@@ -33,7 +33,7 @@ Exercise caution when batch deleting rows from tables with foreign key constrain
 
 Before reading this page, do the following:
 
-- [Create a CockroachDB {{ site.data.products.standard }} cluster](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart) or [start a local cluster](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart?filters=local).
+- [Create a CockroachDB {{ site.data.products.standard }} cluster]({% link cockroachcloud/quickstart.md %}) or [start a local cluster](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart?filters=local).
 - [Install a Driver or ORM Framework]({% link {{ page.version.version }}/install-client-drivers.md %}).
 - [Connect to the database]({% link {{ page.version.version }}/connect-to-the-database.md %}).
 - [Insert data]({% link {{ page.version.version }}/insert-data.md %}) that you now want to delete.

diff --git a/src/current/v23.1/bulk-update-data.md b/src/current/v23.1/bulk-update-data.md
@@ -19,7 +19,7 @@ Exercise caution when batch-updating rows from tables with foreign key constrain
 
 Before reading this page, do the following:
 
-- [Create a CockroachDB {{ site.data.products.standard }} cluster](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart) or [start a local cluster](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart?filters=local).
+- [Create a CockroachDB {{ site.data.products.standard }} cluster]({% link cockroachcloud/quickstart.md %}) or [start a local cluster](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart?filters=local).
 - [Install a Driver or ORM Framework]({% link {{ page.version.version }}/install-client-drivers.md %}).
 
     For the example on this page, we use the `psycopg2` Python driver.

diff --git a/src/current/v23.1/cloud-storage-authentication.md b/src/current/v23.1/cloud-storage-authentication.md
@@ -268,7 +268,7 @@ Construct the ARN for your identity role. You will need this to add into the Tru
 arn:aws:iam::{AWS account ID}:role/crl-dr-store-user-{cluster ID suffix}
 ~~~
 
-You can find the AWS account ID and your cluster's ID using the [Cloud API](https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api):
+You can find the AWS account ID and your cluster's ID using the [Cloud API]({% link cockroachcloud/cloud-api.md %}):
 
 {% include_cached copy-clipboard.html %}
 ~~~shell
@@ -580,7 +580,7 @@ Construct the service account name for your identity service account. You will n
 crl-dr-store-user-{cluster id suffix}@{project id}.iam.gserviceaccount.com
 ~~~
 
-You can find the GCP project ID and your cluster's ID using the [Cloud API](https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api):
+You can find the GCP project ID and your cluster's ID using the [Cloud API]({% link cockroachcloud/cloud-api.md %}):
 
 {% include_cached copy-clipboard.html %}
 ~~~shell