From 4018a613ed3167cf9e92786857a4918ff0355e80 Mon Sep 17 00:00:00 2001 From: Rich Loveland Date: Wed, 21 Aug 2024 14:13:48 -0400 Subject: [PATCH] Update cockroachcloud/ links to use Liquid syntax (#18844) Fixes DOC-10953 --- src/current/cockroachcloud/alerts-page.md | 2 +- .../egress-perimeter-controls.md | 2 +- .../serverless-cluster-management.md | 2 +- src/current/v23.1/api-support-policy.md | 4 +-- src/current/v23.1/authorization.md | 4 +-- src/current/v23.1/aws-dms.md | 6 ++-- .../v23.1/backup-and-restore-monitoring.md | 6 ++-- src/current/v23.1/backup.md | 2 +- src/current/v23.1/bulk-delete-data.md | 2 +- src/current/v23.1/bulk-update-data.md | 2 +- .../v23.1/choose-a-deployment-option.md | 4 +-- .../v23.1/cloud-storage-authentication.md | 4 +-- src/current/v23.1/common-issues-to-monitor.md | 2 +- ...gefeed-kafka-sink-with-oauth-using-okta.md | 2 +- src/current/v23.1/connect-to-the-database.md | 12 ++++---- src/current/v23.1/connection-parameters.md | 2 +- src/current/v23.1/datadog.md | 2 +- src/current/v23.1/debezium.md | 2 +- src/current/v23.1/delete-data.md | 2 +- ...-monitoring-integrations-and-db-console.md | 6 ++-- src/current/v23.1/example-apps.md | 2 +- src/current/v23.1/explain-analyze.md | 2 +- .../v23.1/frequently-asked-questions.md | 4 +-- src/current/v23.1/goldengate.md | 2 +- src/current/v23.1/hashicorp-integration.md | 20 ++++++------- src/current/v23.1/hasura-getting-started.md | 6 ++-- .../import-performance-best-practices.md | 2 +- src/current/v23.1/insert-data.md | 2 +- src/current/v23.1/kibana.md | 2 +- src/current/v23.1/known-limitations.md | 2 +- src/current/v23.1/learn-cockroachdb-sql.md | 2 +- src/current/v23.1/migrate-from-mysql.md | 6 ++-- src/current/v23.1/migrate-from-postgres.md | 16 +++++------ src/current/v23.1/migration-overview.md | 28 +++++++++---------- .../migration-strategy-lift-and-shift.md | 4 +-- src/current/v23.1/monitoring-and-alerting.md | 2 +- src/current/v23.1/movr-flask-deployment.md | 4 +-- .../v23.1/multiregion-scale-application.md | 4 +-- ...-local-cluster-with-kubernetes-insecure.md | 2 +- ...estrate-a-local-cluster-with-kubernetes.md | 2 +- src/current/v23.1/performance-recipes.md | 14 +++++----- src/current/v23.1/qlik.md | 4 +-- .../v23.1/query-behavior-troubleshooting.md | 2 +- src/current/v23.1/query-data.md | 2 +- .../restoring-backups-across-versions.md | 2 +- src/current/v23.1/schema-design-database.md | 2 +- src/current/v23.1/schema-design-indexes.md | 2 +- src/current/v23.1/schema-design-schema.md | 2 +- src/current/v23.1/schema-design-table.md | 2 +- src/current/v23.1/schema-design-update.md | 2 +- src/current/v23.1/sso-db-console.md | 2 +- src/current/v23.1/sso-sql.md | 8 +++--- ...feed-to-a-confluent-cloud-kafka-cluster.md | 2 +- src/current/v23.1/striim.md | 4 +-- src/current/v23.1/troubleshooting-overview.md | 2 +- src/current/v23.1/ui-overview.md | 2 +- src/current/v23.1/update-data.md | 2 +- .../v23.1/vault-db-secrets-tutorial.md | 2 +- src/current/v23.2/api-support-policy.md | 4 +-- src/current/v23.2/authorization.md | 4 +-- src/current/v23.2/aws-dms.md | 6 ++-- src/current/v23.2/backup.md | 2 +- src/current/v23.2/bulk-delete-data.md | 2 +- src/current/v23.2/bulk-update-data.md | 2 +- .../v23.2/choose-a-deployment-option.md | 4 +-- .../v23.2/cloud-storage-authentication.md | 4 +-- .../v23.2/cockroachdb-feature-availability.md | 2 +- src/current/v23.2/common-issues-to-monitor.md | 2 +- ...gefeed-kafka-sink-with-oauth-using-okta.md | 2 +- src/current/v23.2/connect-to-the-database.md | 12 ++++---- src/current/v23.2/connection-parameters.md | 2 +- src/current/v23.2/datadog.md | 2 +- src/current/v23.2/debezium.md | 2 +- src/current/v23.2/delete-data.md | 2 +- ...-monitoring-integrations-and-db-console.md | 6 ++-- src/current/v23.2/example-apps.md | 2 +- src/current/v23.2/explain-analyze.md | 2 +- .../v23.2/frequently-asked-questions.md | 4 +-- src/current/v23.2/goldengate.md | 2 +- src/current/v23.2/hashicorp-integration.md | 20 ++++++------- src/current/v23.2/hasura-getting-started.md | 6 ++-- .../import-performance-best-practices.md | 2 +- src/current/v23.2/insert-data.md | 2 +- src/current/v23.2/kibana.md | 2 +- src/current/v23.2/learn-cockroachdb-sql.md | 2 +- src/current/v23.2/migrate-from-mysql.md | 6 ++-- src/current/v23.2/migrate-from-postgres.md | 16 +++++------ src/current/v23.2/migration-overview.md | 28 +++++++++---------- .../migration-strategy-lift-and-shift.md | 4 +-- src/current/v23.2/monitoring-and-alerting.md | 2 +- src/current/v23.2/movr-flask-deployment.md | 4 +-- .../v23.2/multiregion-scale-application.md | 4 +-- ...-local-cluster-with-kubernetes-insecure.md | 2 +- ...estrate-a-local-cluster-with-kubernetes.md | 2 +- src/current/v23.2/performance-recipes.md | 16 +++++------ src/current/v23.2/qlik.md | 4 +-- .../v23.2/query-behavior-troubleshooting.md | 2 +- src/current/v23.2/query-data.md | 2 +- .../restoring-backups-across-versions.md | 2 +- src/current/v23.2/schema-design-database.md | 2 +- src/current/v23.2/schema-design-indexes.md | 2 +- src/current/v23.2/schema-design-schema.md | 2 +- src/current/v23.2/schema-design-table.md | 2 +- src/current/v23.2/schema-design-update.md | 2 +- src/current/v23.2/sso-db-console.md | 2 +- src/current/v23.2/sso-sql.md | 6 ++-- ...feed-to-a-confluent-cloud-kafka-cluster.md | 2 +- src/current/v23.2/striim.md | 4 +-- ...take-and-restore-locality-aware-backups.md | 2 +- src/current/v23.2/troubleshooting-overview.md | 2 +- src/current/v23.2/ui-overview.md | 2 +- src/current/v23.2/update-data.md | 2 +- .../v23.2/vault-db-secrets-tutorial.md | 2 +- src/current/v24.1/api-support-policy.md | 4 +-- src/current/v24.1/authorization.md | 4 +-- src/current/v24.1/aws-dms.md | 6 ++-- src/current/v24.1/backup.md | 2 +- src/current/v24.1/bulk-delete-data.md | 2 +- src/current/v24.1/bulk-update-data.md | 2 +- .../v24.1/choose-a-deployment-option.md | 4 +-- .../v24.1/cloud-storage-authentication.md | 4 +-- .../v24.1/cockroachdb-feature-availability.md | 4 +-- src/current/v24.1/common-issues-to-monitor.md | 2 +- ...gefeed-kafka-sink-with-oauth-using-okta.md | 2 +- src/current/v24.1/connect-to-the-database.md | 12 ++++---- src/current/v24.1/connection-parameters.md | 2 +- src/current/v24.1/datadog.md | 2 +- src/current/v24.1/debezium.md | 2 +- src/current/v24.1/delete-data.md | 2 +- ...-monitoring-integrations-and-db-console.md | 6 ++-- src/current/v24.1/example-apps.md | 2 +- src/current/v24.1/explain-analyze.md | 2 +- .../v24.1/frequently-asked-questions.md | 4 +-- src/current/v24.1/goldengate.md | 2 +- src/current/v24.1/hashicorp-integration.md | 20 ++++++------- src/current/v24.1/hasura-getting-started.md | 6 ++-- .../import-performance-best-practices.md | 2 +- src/current/v24.1/insert-data.md | 2 +- src/current/v24.1/kibana.md | 2 +- src/current/v24.1/learn-cockroachdb-sql.md | 2 +- src/current/v24.1/migrate-from-mysql.md | 6 ++-- src/current/v24.1/migrate-from-postgres.md | 16 +++++------ src/current/v24.1/migration-overview.md | 28 +++++++++---------- .../migration-strategy-lift-and-shift.md | 4 +-- src/current/v24.1/monitoring-and-alerting.md | 2 +- src/current/v24.1/movr-flask-deployment.md | 4 +-- .../v24.1/multiregion-scale-application.md | 4 +-- ...-local-cluster-with-kubernetes-insecure.md | 2 +- ...estrate-a-local-cluster-with-kubernetes.md | 2 +- src/current/v24.1/performance-recipes.md | 16 +++++------ src/current/v24.1/qlik.md | 4 +-- .../v24.1/query-behavior-troubleshooting.md | 2 +- src/current/v24.1/query-data.md | 2 +- .../restoring-backups-across-versions.md | 2 +- src/current/v24.1/schema-design-database.md | 2 +- src/current/v24.1/schema-design-indexes.md | 2 +- src/current/v24.1/schema-design-schema.md | 2 +- src/current/v24.1/schema-design-table.md | 2 +- src/current/v24.1/schema-design-update.md | 2 +- src/current/v24.1/sso-db-console.md | 2 +- src/current/v24.1/sso-sql.md | 6 ++-- ...feed-to-a-confluent-cloud-kafka-cluster.md | 2 +- src/current/v24.1/striim.md | 4 +-- ...take-and-restore-locality-aware-backups.md | 2 +- src/current/v24.1/troubleshooting-overview.md | 2 +- src/current/v24.1/ui-overview.md | 2 +- src/current/v24.1/update-data.md | 2 +- .../v24.1/vault-db-secrets-tutorial.md | 2 +- src/current/v24.2/api-support-policy.md | 4 +-- src/current/v24.2/authorization.md | 4 +-- src/current/v24.2/aws-dms.md | 6 ++-- src/current/v24.2/backup.md | 2 +- src/current/v24.2/bulk-delete-data.md | 2 +- src/current/v24.2/bulk-update-data.md | 2 +- .../v24.2/choose-a-deployment-option.md | 4 +-- .../v24.2/cloud-storage-authentication.md | 4 +-- .../v24.2/cockroachdb-feature-availability.md | 4 +-- src/current/v24.2/common-issues-to-monitor.md | 2 +- ...gefeed-kafka-sink-with-oauth-using-okta.md | 2 +- src/current/v24.2/connect-to-the-database.md | 12 ++++---- src/current/v24.2/connection-parameters.md | 2 +- src/current/v24.2/datadog.md | 2 +- src/current/v24.2/debezium.md | 2 +- src/current/v24.2/delete-data.md | 2 +- ...-monitoring-integrations-and-db-console.md | 6 ++-- src/current/v24.2/example-apps.md | 2 +- src/current/v24.2/explain-analyze.md | 2 +- .../v24.2/frequently-asked-questions.md | 4 +-- src/current/v24.2/goldengate.md | 2 +- src/current/v24.2/hashicorp-integration.md | 20 ++++++------- src/current/v24.2/hasura-getting-started.md | 6 ++-- .../import-performance-best-practices.md | 2 +- src/current/v24.2/insert-data.md | 2 +- src/current/v24.2/kibana.md | 2 +- src/current/v24.2/learn-cockroachdb-sql.md | 2 +- src/current/v24.2/migrate-from-mysql.md | 6 ++-- src/current/v24.2/migrate-from-postgres.md | 16 +++++------ src/current/v24.2/migration-overview.md | 28 +++++++++---------- .../migration-strategy-lift-and-shift.md | 4 +-- src/current/v24.2/monitoring-and-alerting.md | 2 +- src/current/v24.2/movr-flask-deployment.md | 4 +-- .../v24.2/multiregion-scale-application.md | 4 +-- ...-local-cluster-with-kubernetes-insecure.md | 2 +- ...estrate-a-local-cluster-with-kubernetes.md | 2 +- src/current/v24.2/performance-recipes.md | 16 +++++------ src/current/v24.2/qlik.md | 4 +-- .../v24.2/query-behavior-troubleshooting.md | 2 +- src/current/v24.2/query-data.md | 2 +- .../restoring-backups-across-versions.md | 2 +- src/current/v24.2/schema-design-database.md | 2 +- src/current/v24.2/schema-design-indexes.md | 2 +- src/current/v24.2/schema-design-schema.md | 2 +- src/current/v24.2/schema-design-table.md | 2 +- src/current/v24.2/schema-design-update.md | 2 +- src/current/v24.2/sso-db-console.md | 2 +- src/current/v24.2/sso-sql.md | 6 ++-- ...feed-to-a-confluent-cloud-kafka-cluster.md | 2 +- src/current/v24.2/striim.md | 4 +-- ...take-and-restore-locality-aware-backups.md | 2 +- src/current/v24.2/troubleshooting-overview.md | 2 +- src/current/v24.2/ui-overview.md | 2 +- src/current/v24.2/update-data.md | 2 +- .../v24.2/vault-db-secrets-tutorial.md | 2 +- 223 files changed, 471 insertions(+), 471 deletions(-) diff --git a/src/current/cockroachcloud/alerts-page.md b/src/current/cockroachcloud/alerts-page.md index 31fb8b5f095..1c8a4563d3c 100644 --- a/src/current/cockroachcloud/alerts-page.md +++ b/src/current/cockroachcloud/alerts-page.md @@ -23,7 +23,7 @@ The **Alerts** page is applicable for CockroachDB {{ site.data.products.dedicate ### 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/egress-perimeter-controls.md b/src/current/cockroachcloud/egress-perimeter-controls.md index 6842d8cf450..464f0c062a1 100644 --- a/src/current/cockroachcloud/egress-perimeter-controls.md +++ b/src/current/cockroachcloud/egress-perimeter-controls.md @@ -35,7 +35,7 @@ Regardless of user-specific Egress Perimeter Control policy, egress is always pe ## Before you begin - 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 }} advanced with [PCI-ready features]({% link cockroachcloud/cluster-management.md %}#configure-pci-ready-features-dedicated-advanced). - CockroachDB {{ site.data.products.dedicated }} [Private Cluster]({% 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 }}. diff --git a/src/current/cockroachcloud/serverless-cluster-management.md b/src/current/cockroachcloud/serverless-cluster-management.md index 82fde51945a..0bd6442d76d 100644 --- a/src/current/cockroachcloud/serverless-cluster-management.md +++ b/src/current/cockroachcloud/serverless-cluster-management.md @@ -23,7 +23,7 @@ For each cluster, the following details display: - The **Version** of CockroachDB the cluster is running - The **Action** button, which is used to: - [**Edit cluster**](#edit-cluster-capacity) - - [**Move cluster**](https://www.cockroachlabs.com/docs/cockroachcloud/folders#move-a-cluster-into-or-out-of-a-folder) + - [**Move cluster**]({% link cockroachcloud/folders.md %}#move-a-cluster-into-or-out-of-a-folder) - [**Delete cluster**](#delete-cluster) - **Get support** diff --git a/src/current/v23.1/api-support-policy.md b/src/current/v23.1/api-support-policy.md index 4bea53dca03..175b1814647 100644 --- 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 index 6eec67c32cd..3b1ce45e023 100644 --- 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 index d4aecfbbbf5..99558cfaaf8 100644 --- 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.dedicated }}, you can enable [AWS PrivateLink](https://aws.amazon.com/privatelink/) to securely connect your AWS application with your CockroachDB {{ site.data.products.dedicated }} cluster using a private endpoint. To configure AWS PrivateLink with CockroachDB {{ site.data.products.dedicated }}, see [Network Authorization](https://www.cockroachlabs.com/docs/cockroachcloud/network-authorization#aws-privatelink). +If using CockroachDB {{ site.data.products.dedicated }}, you can enable [AWS PrivateLink](https://aws.amazon.com/privatelink/) to securely connect your AWS application with your CockroachDB {{ site.data.products.dedicated }} cluster using a private endpoint. To configure AWS PrivateLink with CockroachDB {{ site.data.products.dedicated }}, 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/backup-and-restore-monitoring.md b/src/current/v23.1/backup-and-restore-monitoring.md index 72077d3bdfa..85ce7ee397b 100644 --- a/src/current/v23.1/backup-and-restore-monitoring.md +++ b/src/current/v23.1/backup-and-restore-monitoring.md @@ -18,7 +18,7 @@ We recommend setting up monitoring to alert when anomalies occur. You can then u - [`SHOW JOBS`]({% link {{ page.version.version }}/show-jobs.md %}) - [`SHOW BACKUP`]({% link {{ page.version.version }}/show-backup.md %}) -For detail on [managed-service backups](https://www.cockroachlabs.com/docs/cockroachcloud/use-managed-service-backups) that Cockroach Labs stores for your CockroachDB {{ site.data.products.cloud }} cluster, see the **Backup and Restore** page in the Cloud Console. +For detail on [managed-service backups]({% link cockroachcloud/use-managed-service-backups.md %}) that Cockroach Labs stores for your CockroachDB {{ site.data.products.cloud }} cluster, see the **Backup and Restore** page in the Cloud Console. {% include {{ page.version.version }}/backups/metrics-per-node.md %} @@ -68,8 +68,8 @@ Metric | Description To use the Datadog integration with your **CockroachDB {{ site.data.products.dedicated }}** cluster, you can: -- Export the following schedule backup metrics to Datadog using the [Cloud API](https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api). To set this up, see [Export Metrics From a CockroachDB Dedicated Cluster](https://www.cockroachlabs.com/docs/cockroachcloud/export-metrics?filters=datadog-metrics-export). -- Access the Cloud Console **Monitoring** page to enable the integration. To set this up, see [Monitor CockroachDB Dedicated with Datadog](https://www.cockroachlabs.com/docs/cockroachcloud/tools-page#monitor-cockroachdb-dedicated-with-datadog). +- Export the following schedule backup metrics to Datadog using the [Cloud API]({% link cockroachcloud/cloud-api.md %}). To set this up, see [Export Metrics From a CockroachDB Dedicated Cluster](https://www.cockroachlabs.com/docs/cockroachcloud/export-metrics?filters=datadog-metrics-export). +- Access the Cloud Console **Monitoring** page to enable the integration. To set this up, see [Monitor CockroachDB Dedicated with Datadog]({% link cockroachcloud/tools-page.md %}#monitor-cockroachdb-dedicated-with-datadog). ### Available metrics in Datadog diff --git a/src/current/v23.1/backup.md b/src/current/v23.1/backup.md index ea215317c3b..2b49bb0d4fa 100644 --- a/src/current/v23.1/backup.md +++ b/src/current/v23.1/backup.md @@ -32,7 +32,7 @@ To view the contents of an backup created with the `BACKUP` statement, use [`SHO ## Considerations -- Core users can only take [full backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#full-backups). To use the other backup features, you need an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). You can also use [CockroachDB {{ site.data.products.dedicated }}](https://cockroachlabs.cloud/signup?referralId=docs-crdb-backup), which runs [full backups daily and incremental backups hourly](https://www.cockroachlabs.com/docs/cockroachcloud/use-managed-service-backups). +- Core users can only take [full backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#full-backups). To use the other backup features, you need an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). You can also use [CockroachDB {{ site.data.products.dedicated }}](https://cockroachlabs.cloud/signup?referralId=docs-crdb-backup), which runs [full backups daily and incremental backups hourly]({% link cockroachcloud/use-managed-service-backups.md %}). - [Full cluster backups](#back-up-a-cluster) include [Enterprise license keys]({% link {{ page.version.version }}/enterprise-licensing.md %}). When you [restore]({% link {{ page.version.version }}/restore.md %}) a full cluster backup that includes an Enterprise license, the Enterprise license is also restored. - [Zone configurations]({% link {{ page.version.version }}/configure-replication-zones.md %}) present on the destination cluster prior to a restore will be **overwritten** during a [cluster restore]({% link {{ page.version.version }}/restore.md %}#full-cluster) with the zone configurations from the [backed up cluster](#back-up-a-cluster). If there were no customized zone configurations on the cluster when the backup was taken, then after the restore the destination cluster will use the zone configuration from the [`RANGE DEFAULT` configuration]({% link {{ page.version.version }}/configure-replication-zones.md %}#view-the-default-replication-zone). - You cannot restore a backup of a multi-region database into a single-region database. diff --git a/src/current/v23.1/bulk-delete-data.md b/src/current/v23.1/bulk-delete-data.md index ecb96f85216..18c6d92f4f1 100644 --- 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.serverless }} 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.serverless }} 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 index 287579230fd..afc681f2e38 100644 --- 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.serverless }} 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.serverless }} 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/choose-a-deployment-option.md b/src/current/v23.1/choose-a-deployment-option.md index 3f7e694f478..32c13b877be 100644 --- a/src/current/v23.1/choose-a-deployment-option.md +++ b/src/current/v23.1/choose-a-deployment-option.md @@ -99,7 +99,7 @@ Cockroach Labs offers four ways to deploy CockroachDB: three managed services&md - [CockroachDB deployment]({% link {{ page.version.version }}/architecture/glossary.md %}#cockroachdb-deployment-terms) - [CockroachDB pricing](https://www.cockroachlabs.com/get-started-cockroachdb/) -- [CockroachDB Cloud FAQs](https://www.cockroachlabs.com/docs/cockroachcloud/serverless-faqs) -- [CockroachDB Cloud Architecture](https://www.cockroachlabs.com/docs/cockroachcloud/architecture) +- [CockroachDB Cloud FAQs]({% link cockroachcloud/serverless-faqs.md %}) +- [CockroachDB Cloud Architecture]({% link cockroachcloud/architecture.md %}) - [Manual Deployment]({% link {{ page.version.version }}/manual-deployment.md %}) - [Kubernetes Deployment]({% link {{ page.version.version }}/kubernetes-overview.md %}) diff --git a/src/current/v23.1/cloud-storage-authentication.md b/src/current/v23.1/cloud-storage-authentication.md index 185774c9684..5c4a2dcd169 100644 --- 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 diff --git a/src/current/v23.1/common-issues-to-monitor.md b/src/current/v23.1/common-issues-to-monitor.md index 7cd2399aa05..566d55e09b5 100644 --- a/src/current/v23.1/common-issues-to-monitor.md +++ b/src/current/v23.1/common-issues-to-monitor.md @@ -327,4 +327,4 @@ Because each node needs to update a liveness record on disk, maxing out disk ban - [Troubleshoot SQL Behavior]({% link {{ page.version.version }}/query-behavior-troubleshooting.md %}) - [Admission Control]({% link {{ page.version.version }}/admission-control.md %}) - [Metrics]({% link {{ page.version.version }}/metrics.md %}) -- [Alerts Page](https://www.cockroachlabs.com/docs/cockroachcloud/alerts-page) (CockroachDB {{ site.data.products.dedicated }}) +- [Alerts Page]({% link cockroachcloud/alerts-page.md %}) (CockroachDB {{ site.data.products.dedicated }}) diff --git a/src/current/v23.1/connect-to-a-changefeed-kafka-sink-with-oauth-using-okta.md b/src/current/v23.1/connect-to-a-changefeed-kafka-sink-with-oauth-using-okta.md index 7bfa8cf52c3..053532d095a 100644 --- a/src/current/v23.1/connect-to-a-changefeed-kafka-sink-with-oauth-using-okta.md +++ b/src/current/v23.1/connect-to-a-changefeed-kafka-sink-with-oauth-using-okta.md @@ -22,7 +22,7 @@ An overview of the workflow involves: Before starting this tutorial, you will need: - A CockroachDB cluster. You can use a CockroachDB {{ site.data.products.cloud }} or CockroachDB {{ site.data.products.core }} cluster. - - If you are using CockroachDB {{ site.data.products.serverless }} or CockroachDB {{ site.data.products.dedicated }}, see the [Quickstart with CockroachDB](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart) guide. For CockroachDB {{ site.data.products.core }} clusters, see the [install]({% link {{ page.version.version }}/install-cockroachdb-mac.md %}) page. + - If you are using CockroachDB {{ site.data.products.serverless }} or CockroachDB {{ site.data.products.dedicated }}, see the [Quickstart with CockroachDB]({% link cockroachcloud/quickstart.md %}) guide. For CockroachDB {{ site.data.products.core }} clusters, see the [install]({% link {{ page.version.version }}/install-cockroachdb-mac.md %}) page. - An [Okta Developer account](https://developer.okta.com/signup/). - (Optional) A Kafka cluster. This tutorial includes [Kafka cluster setup](#step-3-create-a-kafka-sink). Note that this tutorial was tested with Kafka [version 2.8.2](https://kafka.apache.org/downloads). The Kafka cluster configuration may vary with different versions, but the Okta setup and changefeed creation will be the same. diff --git a/src/current/v23.1/connect-to-the-database.md b/src/current/v23.1/connect-to-the-database.md index d24c61b17dc..9ec0c3378f8 100644 --- a/src/current/v23.1/connect-to-the-database.md +++ b/src/current/v23.1/connect-to-the-database.md @@ -307,7 +307,7 @@ export const AppDataSource = new DataSource({ Where: - `DATABASE_URL` is an environment variable set to a valid CockroachDB connection string. -- `CA_CERT` is an environment variable set to the root certificate [downloaded from the CockroachDB Cloud Console](https://www.cockroachlabs.com/docs/cockroachcloud/authentication#node-identity-verification). +- `CA_CERT` is an environment variable set to the root certificate [downloaded from the CockroachDB Cloud Console]({% link cockroachcloud/authentication.md %}#node-identity-verification). TypeORM accepts the following format for CockroachDB connection strings: @@ -452,7 +452,7 @@ Parameter | Description `` | The host on which the CockroachDB node is running. `` | The port at which the CockroachDB node is listening. `` | The name of the (existing) database. -`` | The path to the root certificate that you [downloaded from the CockroachDB Cloud Console](https://www.cockroachlabs.com/docs/cockroachcloud/authentication#node-identity-verification). +`` | The path to the root certificate that you [downloaded from the CockroachDB Cloud Console]({% link cockroachcloud/authentication.md %}#node-identity-verification). @@ -784,7 +784,7 @@ Parameter | Description `{host}` | The host on which the CockroachDB node is running. `{port}` | The port at which the CockroachDB node is listening. `{database}` | The name of the (existing) database. -`{root-cert}` | The path to the root certificate that you [downloaded from the CockroachDB Cloud Console](https://www.cockroachlabs.com/docs/cockroachcloud/authentication#node-identity-verification). +`{root-cert}` | The path to the root certificate that you [downloaded from the CockroachDB Cloud Console]({% link cockroachcloud/authentication.md %}#node-identity-verification). @@ -1014,7 +1014,7 @@ Parameter | Description `{host}` | The host on which the CockroachDB node is running. `{port}` | The port at which the CockroachDB node is listening. `{database}` | The name of the (existing) database. -`{root-cert}` | The path to the root certificate that you [downloaded from the CockroachDB Cloud Console](https://www.cockroachlabs.com/docs/cockroachcloud/authentication#node-identity-verification). +`{root-cert}` | The path to the root certificate that you [downloaded from the CockroachDB Cloud Console]({% link cockroachcloud/authentication.md %}#node-identity-verification). @@ -1171,7 +1171,7 @@ Parameter | Description `{host}` | The host on which the CockroachDB node is running. `{port}` | The port at which the CockroachDB node is listening. `{database}` | The name of the (existing) database. -`{root-cert}` | The [URL-encoded](https://wikipedia.org/wiki/Percent-encoding) path to the root certificate that you [downloaded from the CockroachDB Cloud Console](https://www.cockroachlabs.com/docs/cockroachcloud/authentication#node-identity-verification). +`{root-cert}` | The [URL-encoded](https://wikipedia.org/wiki/Percent-encoding) path to the root certificate that you [downloaded from the CockroachDB Cloud Console]({% link cockroachcloud/authentication.md %}#node-identity-verification). @@ -1331,7 +1331,7 @@ Parameter | Description `{host}` | The host on which the CockroachDB node is running. `{port}` | The port at which the CockroachDB node is listening. `{database}` | The name of the (existing) database. -`{root-cert}` | The path to the root certificate that you [downloaded from the CockroachDB Cloud Console](https://www.cockroachlabs.com/docs/cockroachcloud/authentication#node-identity-verification). +`{root-cert}` | The path to the root certificate that you [downloaded from the CockroachDB Cloud Console]({% link cockroachcloud/authentication.md %}#node-identity-verification). diff --git a/src/current/v23.1/connection-parameters.md b/src/current/v23.1/connection-parameters.md index ba52da21d57..b7a22d63cc7 100644 --- a/src/current/v23.1/connection-parameters.md +++ b/src/current/v23.1/connection-parameters.md @@ -99,7 +99,7 @@ CockroachDB supports the following `options` parameters. After the first `option Parameter | Description ----------|------------- -`--cluster=` | Identifies your tenant cluster on a [multi-tenant host](https://www.cockroachlabs.com/docs/cockroachcloud/architecture#architecture). For example, `funny-skunk-123`. This option is deprecated. The `host` in the connection string now includes the tenant information. +`--cluster=` | Identifies your tenant cluster on a [multi-tenant host]({% link cockroachcloud/architecture.md %}#architecture). For example, `funny-skunk-123`. This option is deprecated. The `host` in the connection string now includes the tenant information. `-c =` | Sets a [session variable]({% link {{ page.version.version }}/set-vars.md %}) for the SQL session. `results_buffer_size` | Default size of the buffer that accumulates results for a statement or a batch of statements before they are sent to the client. Can also be set using the [`sql.defaults.results_buffer.size` cluster setting]({% link {{ page.version.version }}/cluster-settings.md %}#setting-sql-defaults-results-buffer-size). Can be set as a top-level query parameter or as an `options` parameter. diff --git a/src/current/v23.1/datadog.md b/src/current/v23.1/datadog.md index 17c94ea65e7..12cb16ea00a 100644 --- a/src/current/v23.1/datadog.md +++ b/src/current/v23.1/datadog.md @@ -8,7 +8,7 @@ docs_area: manage [Datadog](https://www.datadoghq.com/) is a monitoring and security platform for cloud applications. The CockroachDB {{ site.data.products.core }} integration with Datadog enables data collection and alerting on selected [CockroachDB metrics](https://docs.datadoghq.com/integrations/cockroachdb/?tab=host#data-collected) using the Datadog platform. {{site.data.alerts.callout_success}} -This tutorial explores the CockroachDB {{ site.data.products.core }} integration with Datadog. For the CockroachDB {{ site.data.products.dedicated }} integration with Datadog, refer to [Monitor CockroachDB Dedicated with Datadog](https://www.cockroachlabs.com/docs/cockroachcloud/tools-page#monitor-cockroachdb-dedicated-with-datadog) instead of this page. +This tutorial explores the CockroachDB {{ site.data.products.core }} integration with Datadog. For the CockroachDB {{ site.data.products.dedicated }} integration with Datadog, refer to [Monitor CockroachDB Dedicated with Datadog]({% link cockroachcloud/tools-page.md %}#monitor-cockroachdb-dedicated-with-datadog) instead of this page. {{site.data.alerts.end}} The CockroachDB {{ site.data.products.core }} integration with Datadog is powered by the [Datadog Agent](https://app.datadoghq.com/account/settings#agent), and supported by Datadog directly: diff --git a/src/current/v23.1/debezium.md b/src/current/v23.1/debezium.md index d35bca04a5f..b6a77d75a78 100644 --- a/src/current/v23.1/debezium.md +++ b/src/current/v23.1/debezium.md @@ -117,7 +117,7 @@ Once all of the [prerequisite steps](#before-you-begin) are completed, you can u ## 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 %}) - [Change Data Capture Overview]({% link {{ page.version.version }}/change-data-capture-overview.md %}) - [Third-Party Tools Supported by Cockroach Labs]({% link {{ page.version.version }}/third-party-database-tools.md %}) - [Stream a Changefeed to a Confluent Cloud Kafka Cluster]({% link {{ page.version.version }}/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.md %}) diff --git a/src/current/v23.1/delete-data.md b/src/current/v23.1/delete-data.md index 1a056e6685d..8217416ef92 100644 --- a/src/current/v23.1/delete-data.md +++ b/src/current/v23.1/delete-data.md @@ -11,7 +11,7 @@ This page has instructions for deleting rows of data from CockroachDB, using the Before reading this page, do the following: -- [Create a CockroachDB {{ site.data.products.serverless }} 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.serverless }} 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 %}). - [Create a database schema]({% link {{ page.version.version }}/schema-design-overview.md %}). diff --git a/src/current/v23.1/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.md b/src/current/v23.1/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.md index 026a53cfd12..0210883d4ae 100644 --- a/src/current/v23.1/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.md +++ b/src/current/v23.1/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.md @@ -4,7 +4,7 @@ summary: Learn how metrics can differ between third-party monitoring tools that toc: true --- -When using [Third-Party Monitoring Integrations]({% link {{ page.version.version }}/third-party-monitoring-tools.md %}), such as the [metrics export feature](https://www.cockroachlabs.com/docs/cockroachcloud/export-metrics), discrepancies may be seen when comparing those metrics charts to ones found on the [Metrics dashboards]({% link {{ page.version.version }}/ui-overview.md %}#metrics) or [custom charts]({% link {{ page.version.version }}/ui-custom-chart-debug-page.md %}) of the [DB Console]({% link {{ page.version.version }}/ui-overview.md %}). This page explains why these different systems may yield different results. +When using [Third-Party Monitoring Integrations]({% link {{ page.version.version }}/third-party-monitoring-tools.md %}), such as the [metrics export feature]({% link cockroachcloud/export-metrics.md %}), discrepancies may be seen when comparing those metrics charts to ones found on the [Metrics dashboards]({% link {{ page.version.version }}/ui-overview.md %}#metrics) or [custom charts]({% link {{ page.version.version }}/ui-custom-chart-debug-page.md %}) of the [DB Console]({% link {{ page.version.version }}/ui-overview.md %}). This page explains why these different systems may yield different results. ## CockroachDB’s Timeseries Database @@ -33,7 +33,7 @@ Datadog scrapes every 60s | 0 | - | - | - | - | - | 0 Since Cockroach Labs does not own the third-party systems, we can not be expected to have intimate knowledge about how each system’s different query language and timeseries database works. -The [metrics export feature](https://www.cockroachlabs.com/docs/cockroachcloud/export-metrics) scrapes the `/_status/vars` endpoint every 30 seconds, and forwards the data along to the third-party system. The metrics export does no intermediate aggregation, downsampling, or modification of the timeseries values at any point. The raw metrics export data is at a 30-second resolution, but how that data is processed once received by the third party system is unknown to us. +The [metrics export feature]({% link cockroachcloud/export-metrics.md %}) scrapes the `/_status/vars` endpoint every 30 seconds, and forwards the data along to the third-party system. The metrics export does no intermediate aggregation, downsampling, or modification of the timeseries values at any point. The raw metrics export data is at a 30-second resolution, but how that data is processed once received by the third party system is unknown to us. It is within our scope to understand and support our own timeseries database. If you have problems receiving metrics in your third-party system, [our support]({% link {{ page.version.version }}/support-resources.md %}) can help troubleshoot those problems. However, once the data is ingested into the third-party system, please contact your representative at that third-party company to support issues found on those systems. For example, assuming the raw metric data has been ingested as expected, Cockroach Labs does not support writing queries in third-party systems, such as using Datadog's Metrics Explorer or Datadog Query Language (DQL). @@ -43,4 +43,4 @@ It is within our scope to understand and support our own timeseries database. If - [DB Console Overview]({% link {{ page.version.version }}/ui-overview.md %}) - [Third-Party Monitoring Integrations]({% link {{ page.version.version }}/third-party-monitoring-tools.md %}) - [Monitor CockroachDB with Prometheus]({% link {{ page.version.version }}/monitor-cockroachdb-with-prometheus.md %}) -- [Export Metrics From a CockroachDB Dedicated Cluster](https://www.cockroachlabs.com/docs/cockroachcloud/export-metrics) \ No newline at end of file +- [Export Metrics From a CockroachDB Dedicated Cluster]({% link cockroachcloud/export-metrics.md %}) \ No newline at end of file diff --git a/src/current/v23.1/example-apps.md b/src/current/v23.1/example-apps.md index e410f1a6ade..bea3cfd1876 100644 --- a/src/current/v23.1/example-apps.md +++ b/src/current/v23.1/example-apps.md @@ -52,7 +52,7 @@ Note that tools with [**community-level** support]({% link {{ page.version.versi | Driver/ORM Framework | Support level | Example apps | |--------------------------------------------+----------------+--------------------------------------------------------| -| [JDBC](https://jdbc.postgresql.org/) | Full | [Quickstart](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart)
[Simple CRUD]({% link {{ page.version.version }}/build-a-java-app-with-cockroachdb.md %})
[Roach Data (Spring Boot App)](build-a-spring-app-with-cockroachdb-jdbc.html) +| [JDBC](https://jdbc.postgresql.org/) | Full | [Quickstart]({% link cockroachcloud/quickstart.md %})
[Simple CRUD]({% link {{ page.version.version }}/build-a-java-app-with-cockroachdb.md %})
[Roach Data (Spring Boot App)](build-a-spring-app-with-cockroachdb-jdbc.html) | [Hibernate](https://hibernate.org/orm/) | Full | [Simple CRUD]({% link {{ page.version.version }}/build-a-java-app-with-cockroachdb-hibernate.md %})
[Roach Data (Spring Boot App)](build-a-spring-app-with-cockroachdb-jpa.html) | [jOOQ](https://www.jooq.org/) | Full | [Simple CRUD]({% link {{ page.version.version }}/build-a-java-app-with-cockroachdb-jooq.md %}) diff --git a/src/current/v23.1/explain-analyze.md b/src/current/v23.1/explain-analyze.md index 1862ca7226c..b3915866ab9 100644 --- a/src/current/v23.1/explain-analyze.md +++ b/src/current/v23.1/explain-analyze.md @@ -75,7 +75,7 @@ Property | Description `sql cpu time` | The total amount of time spent in the [SQL layer]({% link {{ page.version.version }}/architecture/sql-layer.md %}). It does not include time spent in the [storage layer]({% link {{ page.version.version }}/architecture/storage-layer.md %}). `regions` | The [regions]({% link {{ page.version.version }}/show-regions.md %}) 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)](https://www.cockroachlabs.com/docs/cockroachcloud/plan-your-cluster-serverless#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)]({% link cockroachcloud/plan-your-cluster-serverless.md %}#request-units) consumed by the statement. This property is visible only on CockroachDB {{ site.data.products.serverless }} clusters. ### Statement plan tree properties diff --git a/src/current/v23.1/frequently-asked-questions.md b/src/current/v23.1/frequently-asked-questions.md index 509053e2bc3..6c4be7132a8 100644 --- a/src/current/v23.1/frequently-asked-questions.md +++ b/src/current/v23.1/frequently-asked-questions.md @@ -28,7 +28,7 @@ CockroachDB returns single-row reads in 2ms or less and single-row writes in 4ms ### How easy is it to get started with CockroachDB? -You can get started with CockroachDB with just a few clicks. Sign up for a CockroachDB {{ site.data.products.cloud }} account to create a free CockroachDB {{ site.data.products.serverless }} cluster. For more details, see [Quickstart](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart). +You can get started with CockroachDB with just a few clicks. Sign up for a CockroachDB {{ site.data.products.cloud }} account to create a free CockroachDB {{ site.data.products.serverless }} cluster. For more details, see [Quickstart]({% link cockroachcloud/quickstart.md %}). Alternatively, you can download a binary or run our official Kubernetes configurations or Docker image. For more details, see [Install CockroachDB]({% link {{ page.version.version }}/install-cockroachdb.md %}). @@ -54,7 +54,7 @@ When your cluster spans multiple nodes (physical machines, virtual machines, or For more information about scaling a CockroachDB cluster, see the following docs: -- [Plan Your Serverless Cluster - Cluster scaling](https://www.cockroachlabs.com/docs/cockroachcloud/plan-your-cluster#cluster-scaling) +- [Plan Your Serverless Cluster - Cluster scaling]({% link cockroachcloud/plan-your-cluster.md %}#cluster-scaling) - [Manage Your Dedicated Cluster - Scale your cluster](https://www.cockroachlabs.com/docs/cockroachcloud/plan-your-cluster?filters=dedicated#cluster-scaling) - [`cockroach start` - Add a node to a cluster]({% link {{ page.version.version }}/cockroach-start.md %}#add-a-node-to-a-cluster) diff --git a/src/current/v23.1/goldengate.md b/src/current/v23.1/goldengate.md index 949d4878df8..b6a6ea43599 100644 --- a/src/current/v23.1/goldengate.md +++ b/src/current/v23.1/goldengate.md @@ -515,6 +515,6 @@ Run the steps in this section on a machine and in a directory where Oracle Golde ## 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 %}) - [Change Data Capture Overview]({% link {{ page.version.version }}/change-data-capture-overview.md %}) - [Third-Party Tools Supported by Cockroach Labs]({% link {{ page.version.version }}/third-party-database-tools.md %}) diff --git a/src/current/v23.1/hashicorp-integration.md b/src/current/v23.1/hashicorp-integration.md index 145ba1e1b4a..5cf85b09e13 100644 --- a/src/current/v23.1/hashicorp-integration.md +++ b/src/current/v23.1/hashicorp-integration.md @@ -28,10 +28,10 @@ CockroachDB customers can integrate these services, using Vault's KMS secrets en Resources: -- [CMEK overview](https://www.cockroachlabs.com/docs/cockroachcloud/cmek) -- [Manage Customer-Managed Encryption Keys (CMEK) for CockroachDB Dedicated](https://www.cockroachlabs.com/docs/cockroachcloud/managing-cmek) -- [Provisioning GCP KMS Keys and Service Accounts for CMEK](https://www.cockroachlabs.com/docs/cockroachcloud/cmek-ops-gcp) -- [Provisioning AWS KMS Keys and IAM Roles for CMEK](https://www.cockroachlabs.com/docs/cockroachcloud/cmek-ops-aws) +- [CMEK overview]({% link cockroachcloud/cmek.md %}) +- [Manage Customer-Managed Encryption Keys (CMEK) for CockroachDB Dedicated]({% link cockroachcloud/managing-cmek.md %}) +- [Provisioning GCP KMS Keys and Service Accounts for CMEK]({% link cockroachcloud/cmek-ops-gcp.md %}) +- [Provisioning AWS KMS Keys and IAM Roles for CMEK]({% link cockroachcloud/cmek-ops-aws.md %}) ## Use Vault's PKI Secrets Engine to manage a CockroachDB {{ site.data.products.dedicated }} cluster's certificate authority (CA) and client certificates. @@ -41,7 +41,7 @@ By using Vault to manage certificates, you can use only certificates with short Refer to [Transport Layer Security (TLS) and Public Key Infrastructure (PKI)]({% link {{ page.version.version }}/security-reference/transport-layer-security.md %}) for an overview. -Refer to [Certificate Authentication for SQL Clients in CockroachDB Dedicated Clusters](https://www.cockroachlabs.com/docs/cockroachcloud/client-certs-dedicated) for procedures involved in administering PKI for a CockroachDB {{ site.data.products.dedicated }} cluster. +Refer to [Certificate Authentication for SQL Clients in CockroachDB Dedicated Clusters]({% link cockroachcloud/client-certs-dedicated.md %}) for procedures involved in administering PKI for a CockroachDB {{ site.data.products.dedicated }} cluster. ## Use Vault's PKI Secrets Engine to manage a CockroachDB {{ site.data.products.core }} cluster's certificate authority (CA), server, and client certificates @@ -75,12 +75,12 @@ Vault's [Transit Secrets Engine](https://www.vaultproject.io/docs/secrets/transi ## See also -- [CMEK overview](https://www.cockroachlabs.com/docs/cockroachcloud/cmek) -- [Manage Customer-Managed Encryption Keys (CMEK) for CockroachDB Dedicated](https://www.cockroachlabs.com/docs/cockroachcloud/managing-cmek) -- [Provisioning GCP KMS Keys and Service Accounts for CMEK](https://www.cockroachlabs.com/docs/cockroachcloud/cmek-ops-gcp) -- [Provisioning AWS KMS Keys and IAM Roles for CMEK](https://www.cockroachlabs.com/docs/cockroachcloud/cmek-ops-aws) +- [CMEK overview]({% link cockroachcloud/cmek.md %}) +- [Manage Customer-Managed Encryption Keys (CMEK) for CockroachDB Dedicated]({% link cockroachcloud/managing-cmek.md %}) +- [Provisioning GCP KMS Keys and Service Accounts for CMEK]({% link cockroachcloud/cmek-ops-gcp.md %}) +- [Provisioning AWS KMS Keys and IAM Roles for CMEK]({% link cockroachcloud/cmek-ops-aws.md %}) - [Transport Layer Security (TLS) and Public Key Infrastructure (PKI)]({% link {{ page.version.version }}/security-reference/transport-layer-security.md %}) -- [Certificate Authentication for SQL Clients in Dedicated Clusters](https://www.cockroachlabs.com/docs/cockroachcloud/client-certs-dedicated) +- [Certificate Authentication for SQL Clients in Dedicated Clusters]({% link cockroachcloud/client-certs-dedicated.md %}) - [Manage PKI certificates for a CockroachDB deployment with HashiCorp Vault]({% link {{ page.version.version }}/manage-certs-vault.md %}) - [Using HashiCorp Vault's Dynamic Secrets for Enhanced Database Credential Security in CockroachDB]({% link {{ page.version.version }}/vault-db-secrets-tutorial.md %}) - [Roles]({% link {{ page.version.version }}/security-reference/authorization.md %}#roles) diff --git a/src/current/v23.1/hasura-getting-started.md b/src/current/v23.1/hasura-getting-started.md index 7e129c9404c..6a79da9345f 100644 --- a/src/current/v23.1/hasura-getting-started.md +++ b/src/current/v23.1/hasura-getting-started.md @@ -21,7 +21,7 @@ This tutorial will show you how to configure a Hasura project with a CockroachDB Before you start this tutorial, you need: -- An existing [CockroachDB Cloud](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart) cluster, running CockroachDB v22.2 or later. +- An existing [CockroachDB Cloud]({% link cockroachcloud/quickstart.md %}) cluster, running CockroachDB v22.2 or later. - A [Hasura Cloud account](https://hasura.io/docs/latest/getting-started/getting-started-cloud/). ## Configure your cluster @@ -46,7 +46,7 @@ Before you start this tutorial, you need:
1. In the [CockroachDB Cloud console](https://cockroachlabs.cloud/clusters), select your cluster and click **Connect**. -1. If you have not set up [IP Allowlists](https://www.cockroachlabs.com/docs/cockroachcloud/network-authorization#ip-allowlisting) under **Network Security**, follow the instructions to add connections to your cluster from your machine. +1. If you have not set up [IP Allowlists]({% link cockroachcloud/network-authorization.md %}#ip-allowlisting) under **Network Security**, follow the instructions to add connections to your cluster from your machine. 1. Select the SQL user you want to use for the Hasura Cloud connection under **Select SQL user**. If you have not set up a SQL user for this cluster, follow the instructions to create a new SQL user. Be sure to copy and save the password to a secure location. 1. Select **General connection String**. 1. Copy the connection string under **General connection string** and paste it in a secure location. You will use this connection string later to configure Hasura GraphQL Engine with your cluster. @@ -146,7 +146,7 @@ Create a `CRDB_URL` environment variable to store the connection string. ## Add the Hasura Cloud network to your cluster allowlist -Your CockroachDB {{ site.data.products.dedicated }} cluster needs to be configured to [allow incoming client connections](https://www.cockroachlabs.com/docs/cockroachcloud/network-authorization#ip-allowlisting) from Hasura Cloud. +Your CockroachDB {{ site.data.products.dedicated }} cluster needs to be configured to [allow incoming client connections]({% link cockroachcloud/network-authorization.md %}#ip-allowlisting) from Hasura Cloud. 1. In the Hasura Cloud overview page select **Projects**, then click the **Config** icon for your project. diff --git a/src/current/v23.1/import-performance-best-practices.md b/src/current/v23.1/import-performance-best-practices.md index 45f12615eda..f141d56f139 100644 --- a/src/current/v23.1/import-performance-best-practices.md +++ b/src/current/v23.1/import-performance-best-practices.md @@ -37,7 +37,7 @@ When importing into a new table, split your dump data into two files: 1. A SQL file containing the table schema. 1. A CSV, delimited, or AVRO file containing the table data. -Convert the schema-only file using the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page). The Schema Conversion Tool automatically creates a new CockroachDB {{ site.data.products.serverless }} database with the converted schema. {% include cockroachcloud/migration/sct-self-hosted.md %} +Convert the schema-only file using the [Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}). The Schema Conversion Tool automatically creates a new CockroachDB {{ site.data.products.serverless }} database with the converted schema. {% include cockroachcloud/migration/sct-self-hosted.md %} Then use the [`IMPORT INTO`](import-into.html) statement to import the CSV data into the newly created table: diff --git a/src/current/v23.1/insert-data.md b/src/current/v23.1/insert-data.md index 5d74334c0dc..52d9b675787 100644 --- a/src/current/v23.1/insert-data.md +++ b/src/current/v23.1/insert-data.md @@ -11,7 +11,7 @@ This page has instructions for getting data into CockroachDB with various progra Before reading this page, do the following: -- [Create a CockroachDB {{ site.data.products.serverless }} 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.serverless }} 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 %}). diff --git a/src/current/v23.1/kibana.md b/src/current/v23.1/kibana.md index a1067ad7124..c9ce38943de 100644 --- a/src/current/v23.1/kibana.md +++ b/src/current/v23.1/kibana.md @@ -8,7 +8,7 @@ docs_area: manage [Kibana](https://www.elastic.co/kibana/) is a platform that visualizes data on the [Elastic Stack](https://www.elastic.co/elastic-stack/). This page shows how to use the [CockroachDB module for Metricbeat](https://www.elastic.co/guide/en/beats/metricbeat/current/metricbeat-module-cockroachdb.html) to collect metrics exposed by your CockroachDB {{ site.data.products.core }} cluster's [Prometheus endpoint]({% link {{ page.version.version }}/monitoring-and-alerting.md %}#prometheus-endpoint) in Elasticsearch and how to visualize those metrics with Kibana. {{site.data.alerts.callout_success}} -To export metrics from a CockroachDB {{ site.data.products.cloud }} cluster, refer to [Export Metrics From a CockroachDB {{ site.data.products.dedicated }} Cluster](https://www.cockroachlabs.com/docs/cockroachcloud/export-metrics) instead of this page. +To export metrics from a CockroachDB {{ site.data.products.cloud }} cluster, refer to [Export Metrics From a CockroachDB {{ site.data.products.dedicated }} Cluster]({% link cockroachcloud/export-metrics.md %}) instead of this page. {{site.data.alerts.end}} In this tutorial, you will enable the CockroachDB module for Metricbeat and visualize the data in Kibana. diff --git a/src/current/v23.1/known-limitations.md b/src/current/v23.1/known-limitations.md index b0abca21419..949e439ac1c 100644 --- a/src/current/v23.1/known-limitations.md +++ b/src/current/v23.1/known-limitations.md @@ -54,7 +54,7 @@ This page describes newly identified limitations in the CockroachDB {{page.relea ### Low estimated Request Units are rounded to zero -The [Request Units](https://www.cockroachlabs.com/docs/cockroachcloud/plan-your-cluster-serverless#request-units) (RUs) estimate surfaced in [`EXPLAIN ANALYZE`]({% link {{ page.version.version }}/explain-analyze.md %}) is displayed as an integer value. Because of this, fractional RU estimates, which represent very inexpensive queries, are rounded down to zero. +The [Request Units]({% link cockroachcloud/plan-your-cluster-serverless.md %}#request-units) (RUs) estimate surfaced in [`EXPLAIN ANALYZE`]({% link {{ page.version.version }}/explain-analyze.md %}) is displayed as an integer value. Because of this, fractional RU estimates, which represent very inexpensive queries, are rounded down to zero. [Tracking GitHub issue](https://github.com/cockroachdb/cockroach/issues/100617) diff --git a/src/current/v23.1/learn-cockroachdb-sql.md b/src/current/v23.1/learn-cockroachdb-sql.md index e5737403d19..e513ef15542 100644 --- a/src/current/v23.1/learn-cockroachdb-sql.md +++ b/src/current/v23.1/learn-cockroachdb-sql.md @@ -10,7 +10,7 @@ This tutorial guides you through some of the most essential CockroachDB SQL stat For a complete list of supported SQL statements and related details, see [SQL Statements]({% link {{ page.version.version }}/sql-statements.md %}). {{site.data.alerts.callout_info}} -This tutorial is for {{site.data.products.core}} users. If you are working with {{site.data.products.dedicated}} or {{site.data.products.serverless}}, you can run this tutorial against [a cluster running in the cloud](https://www.cockroachlabs.com/docs/cockroachcloud/learn-cockroachdb-sql). +This tutorial is for {{site.data.products.core}} users. If you are working with {{site.data.products.dedicated}} or {{site.data.products.serverless}}, you can run this tutorial against [a cluster running in the cloud]({% link cockroachcloud/learn-cockroachdb-sql.md %}). {{site.data.alerts.end}} ## Start CockroachDB diff --git a/src/current/v23.1/migrate-from-mysql.md b/src/current/v23.1/migrate-from-mysql.md index 2a1adcde9a2..b93b79b75ff 100644 --- a/src/current/v23.1/migrate-from-mysql.md +++ b/src/current/v23.1/migrate-from-mysql.md @@ -105,7 +105,7 @@ The example uses the [MySQL `world` data set](https://dev.mysql.com/doc/index-ot mysqlsh -uroot --sql --file {path}/world-db/world.sql ~~~ -1. Create a free [{{ site.data.products.cloud }} account](https://www.cockroachlabs.com/docs/cockroachcloud/create-an-account), which is used to access the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page?filters=mysql) and create the {{ site.data.products.serverless }} cluster. +1. Create a free [{{ site.data.products.cloud }} account]({% link cockroachcloud/create-an-account.md %}), which is used to access the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page?filters=mysql) and create the {{ site.data.products.serverless }} cluster. {{site.data.alerts.callout_success}} {% include cockroachcloud/migration/sct-self-hosted.md %} @@ -162,7 +162,7 @@ Use the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachclo 1. Click [**Migrate Schema**](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page?filters=mysql#migrate-the-schema) to create a new {{ site.data.products.serverless }} cluster with the converted schema. Name the database `world`. - You can view this database on the [**Databases** page](https://www.cockroachlabs.com/docs/cockroachcloud/databases-page) of the {{ site.data.products.cloud }} Console. + You can view this database on the [**Databases** page]({% link cockroachcloud/databases-page.md %}) of the {{ site.data.products.cloud }} Console. 1. Open a SQL shell to the CockroachDB `world` cluster. To find the command, open the **Connect** dialog in the {{ site.data.products.cloud }} Console and select the `world` database and **CockroachDB Client** option. It will look like: @@ -402,7 +402,7 @@ To learn more, see the [Migration Overview]({% link {{ page.version.version }}/m ## See also - [Migration Overview]({% link {{ page.version.version }}/migration-overview.md %}) -- [Use the Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) +- [Use the Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) - [Use the MOLT Verify tool]({% link molt/molt-verify.md %}) - [Import Performance Best Practices]({% link {{ page.version.version }}/import-performance-best-practices.md %}) - [Migrate from CSV]({% link {{ page.version.version }}/migrate-from-csv.md %}) diff --git a/src/current/v23.1/migrate-from-postgres.md b/src/current/v23.1/migrate-from-postgres.md index 8d35c7c7dd4..2f142eaeaca 100644 --- a/src/current/v23.1/migrate-from-postgres.md +++ b/src/current/v23.1/migrate-from-postgres.md @@ -70,7 +70,7 @@ The example uses a modified version of the PostgreSQL `french-towns-communes-fra psql frenchtowns -a -f frenchtowns.sql ~~~ -1. Create a free [{{ site.data.products.cloud }} account](https://www.cockroachlabs.com/docs/cockroachcloud/create-an-account), which is used to access the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) and create the {{ site.data.products.serverless }} cluster. +1. Create a free [{{ site.data.products.cloud }} account]({% link cockroachcloud/create-an-account.md %}), which is used to access the [Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) and create the {{ site.data.products.serverless }} cluster. {{site.data.alerts.callout_success}} {% include cockroachcloud/migration/sct-self-hosted.md %} @@ -78,7 +78,7 @@ The example uses a modified version of the PostgreSQL `french-towns-communes-fra ### Step 1. Convert the PostgreSQL schema -Use the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) to convert the `frenchtowns` schema for compatibility with CockroachDB. The schema has three tables: `regions`, `departments`, and `towns`. +Use the [Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) to convert the `frenchtowns` schema for compatibility with CockroachDB. The schema has three tables: `regions`, `departments`, and `towns`. 1. Dump the PostgreSQL `frenchtowns` schema with the following [`pg_dump`](https://www.postgresql.org/docs/15/app-pgdump.html) command: @@ -87,12 +87,12 @@ Use the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachclo pg_dump --schema-only frenchtowns > frenchtowns_schema.sql ~~~ -1. Open the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) in the {{ site.data.products.cloud }} Console and [add a new PostgreSQL schema](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page#convert-a-schema). +1. Open the [Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) in the {{ site.data.products.cloud }} Console and [add a new PostgreSQL schema]({% link cockroachcloud/migrations-page.md %}#convert-a-schema). - After conversion is complete, [review the results](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page#review-the-schema). The [**Summary Report**](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page#summary-report) shows that there are errors under **Required Fixes**. You must resolve these in order to migrate the schema to CockroachDB. + After conversion is complete, [review the results]({% link cockroachcloud/migrations-page.md %}#review-the-schema). The [**Summary Report**]({% link cockroachcloud/migrations-page.md %}#summary-report) shows that there are errors under **Required Fixes**. You must resolve these in order to migrate the schema to CockroachDB. {{site.data.alerts.callout_success}} - You can also [add your PostgreSQL database credentials](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page#use-credentials) to have the Schema Conversion Tool obtain the schema directly from the PostgreSQL database. + You can also [add your PostgreSQL database credentials]({% link cockroachcloud/migrations-page.md %}#use-credentials) to have the Schema Conversion Tool obtain the schema directly from the PostgreSQL database. {{site.data.alerts.end}} 1. `Missing user: postgres` errors indicate that the SQL user `postgres` is missing from CockroachDB. Click **Add User** to create the user. @@ -107,9 +107,9 @@ Use the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachclo This example migrates directly to a {{ site.data.products.serverless }} cluster. {% include cockroachcloud/migration/sct-self-hosted.md %} -1. Click [**Migrate Schema**](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page#migrate-the-schema) to create a new {{ site.data.products.serverless }} cluster with the converted schema. Name the database `frenchtowns`. +1. Click [**Migrate Schema**]({% link cockroachcloud/migrations-page.md %}#migrate-the-schema) to create a new {{ site.data.products.serverless }} cluster with the converted schema. Name the database `frenchtowns`. - You can view this database on the [**Databases** page](https://www.cockroachlabs.com/docs/cockroachcloud/databases-page) of the {{ site.data.products.cloud }} Console. + You can view this database on the [**Databases** page]({% link cockroachcloud/databases-page.md %}) of the {{ site.data.products.cloud }} Console. ### Step 2. Load the PostgreSQL data @@ -287,7 +287,7 @@ To learn more, see the [Migration Overview]({% link {{ page.version.version }}/m ## See also - [Migration Overview]({% link {{ page.version.version }}/migration-overview.md %}) -- [Use the Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) +- [Use the Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) - [Use the MOLT Verify tool]({% link molt/molt-verify.md %}) - [Import Performance Best Practices]({% link {{ page.version.version }}/import-performance-best-practices.md %}) - [Migrate from CSV]({% link {{ page.version.version }}/migrate-from-csv.md %}) diff --git a/src/current/v23.1/migration-overview.md b/src/current/v23.1/migration-overview.md index 3f35eef335c..cf4f5feca6a 100644 --- a/src/current/v23.1/migration-overview.md +++ b/src/current/v23.1/migration-overview.md @@ -8,7 +8,7 @@ docs_area: migrate This page provides an overview of how to migrate a database to CockroachDB. {{site.data.alerts.callout_info}} -If you need to migrate data from a CockroachDB {{ site.data.products.serverless }} cluster to a CockroachDB {{ site.data.products.dedicated }} cluster, see [Migrate data from Serverless to Dedicated](https://www.cockroachlabs.com/docs/cockroachcloud/migrate-from-serverless-to-dedicated). +If you need to migrate data from a CockroachDB {{ site.data.products.serverless }} cluster to a CockroachDB {{ site.data.products.dedicated }} cluster, see [Migrate data from Serverless to Dedicated]({% link cockroachcloud/migrate-from-serverless-to-dedicated.md %}). {{site.data.alerts.end}} A database migration broadly consists of the following phases: @@ -117,11 +117,11 @@ Determine the size of the target CockroachDB cluster. To do this, consider your - What is the total size of the data you will migrate? - How many active [application connections]({% link {{ page.version.version }}/recommended-production-settings.md %}#connection-pooling) will be running in the CockroachDB environment? -Use this information to size the CockroachDB cluster you will create. If you are migrating to a CockroachDB {{ site.data.products.cloud }} cluster, see [Plan Your Cluster](https://www.cockroachlabs.com/docs/cockroachcloud/plan-your-cluster) for details: +Use this information to size the CockroachDB cluster you will create. If you are migrating to a CockroachDB {{ site.data.products.cloud }} cluster, see [Plan Your Cluster]({% link cockroachcloud/plan-your-cluster.md %}) for details: -- For CockroachDB {{ site.data.products.dedicated }}, refer to the [example](https://www.cockroachlabs.com/docs/cockroachcloud/plan-your-cluster#dedicated-example) that shows how your data volume, storage requirements, and replication factor affect the recommended node size (number of vCPUs per node) and total number of nodes on the cluster. -- For CockroachDB {{ site.data.products.serverless }}, your cluster will scale automatically to meet your storage and usage requirements. Refer to [Choosing resource limits](https://www.cockroachlabs.com/docs/cockroachcloud/plan-your-cluster-serverless#choose-resource-limits) to learn about how to limit your resource consumption. -- For guidance on sizing for connection pools, see the CockroachDB {{ site.data.products.cloud }} [Production Checklist](https://www.cockroachlabs.com/docs/cockroachcloud/production-checklist#use-a-pool-of-persistent-connections). +- For CockroachDB {{ site.data.products.dedicated }}, refer to the [example]({% link cockroachcloud/plan-your-cluster.md %}#dedicated-example) that shows how your data volume, storage requirements, and replication factor affect the recommended node size (number of vCPUs per node) and total number of nodes on the cluster. +- For CockroachDB {{ site.data.products.serverless }}, your cluster will scale automatically to meet your storage and usage requirements. Refer to [Choosing resource limits]({% link cockroachcloud/plan-your-cluster-serverless.md %}#choose-resource-limits) to learn about how to limit your resource consumption. +- For guidance on sizing for connection pools, see the CockroachDB {{ site.data.products.cloud }} [Production Checklist]({% link cockroachcloud/production-checklist.md %}#connection-pooling). If you are migrating to a CockroachDB {{ site.data.products.core }} cluster: @@ -143,7 +143,7 @@ As you develop your migration plan, consider the application changes that you wi Follow these recommendations when [converting your schema](#convert-the-schema) for compatibility with CockroachDB. {{site.data.alerts.callout_success}} -The [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) automatically identifies potential improvements to your schema. +The [Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) automatically identifies potential improvements to your schema. {{site.data.alerts.end}} - You should define an explicit primary key on every table. For more information, see [Primary key best practices]({% link {{ page.version.version }}/schema-design-table.md %}#primary-key-best-practices). @@ -167,7 +167,7 @@ Optimize your queries against [transaction contention]({% link {{ page.version.v Update your queries to resolve differences in functionality and SQL syntax. {{site.data.alerts.callout_success}} -The [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) automatically flags syntax incompatibilities and unimplemented features in your schema. +The [Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) automatically flags syntax incompatibilities and unimplemented features in your schema. {{site.data.alerts.end}} CockroachDB supports the [PostgreSQL wire protocol](https://www.postgresql.org/docs/current/protocol.html) and is largely compatible with PostgreSQL syntax. However, the following PostgreSQL features do not yet exist in CockroachDB: @@ -215,24 +215,24 @@ In the following order: You can use the following MOLT (Migrate Off Legacy Technology) tools to simplify these steps: -- [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) +- [Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) - [MOLT Verify]({% link molt/molt-verify.md %}) #### Convert the schema First, convert your database schema to an equivalent CockroachDB schema: -- Use the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) to convert your schema line-by-line. This requires a free [CockroachDB {{ site.data.products.cloud }} account](https://www.cockroachlabs.com/docs/cockroachcloud/create-an-account). The tool will convert the syntax, identify [unimplemented features and syntax incompatibilities](#unimplemented-features-and-syntax-incompatibilities) in the schema, and suggest edits according to CockroachDB [best practices](#schema-design-best-practices). +- Use the [Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) to convert your schema line-by-line. This requires a free [CockroachDB {{ site.data.products.cloud }} account]({% link cockroachcloud/create-an-account.md %}). The tool will convert the syntax, identify [unimplemented features and syntax incompatibilities](#unimplemented-features-and-syntax-incompatibilities) in the schema, and suggest edits according to CockroachDB [best practices](#schema-design-best-practices). {{site.data.alerts.callout_info}} The Schema Conversion Tool accepts `.sql` files from PostgreSQL, MySQL, Oracle, and Microsoft SQL Server. {{site.data.alerts.end}} -- Alternatively, manually convert the schema according to our [schema design best practices](#schema-design-best-practices){% comment %}and data type mappings{% endcomment %}. You can also [export a partially converted schema](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page#export-the-schema) from the Schema Conversion Tool to finish the conversion manually. +- Alternatively, manually convert the schema according to our [schema design best practices](#schema-design-best-practices){% comment %}and data type mappings{% endcomment %}. You can also [export a partially converted schema]({% link cockroachcloud/migrations-page.md %}#export-the-schema) from the Schema Conversion Tool to finish the conversion manually. Then import the converted schema to a CockroachDB cluster: -- For CockroachDB {{ site.data.products.cloud }}, use the Schema Conversion Tool to [migrate the converted schema to a new {{ site.data.products.serverless }} or {{ site.data.products.dedicated }} database](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page#migrate-the-schema). -- For CockroachDB {{ site.data.products.core }}, pipe the [data definition language (DDL)]({% link {{ page.version.version }}/sql-statements.md %}#data-definition-statements) directly into [`cockroach sql`]({% link {{ page.version.version }}/cockroach-sql.md %}). You can [export a converted schema file](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page#export-the-schema) from the Schema Conversion Tool. +- For CockroachDB {{ site.data.products.cloud }}, use the Schema Conversion Tool to [migrate the converted schema to a new {{ site.data.products.serverless }} or {{ site.data.products.dedicated }} database]({% link cockroachcloud/migrations-page.md %}#migrate-the-schema). +- For CockroachDB {{ site.data.products.core }}, pipe the [data definition language (DDL)]({% link {{ page.version.version }}/sql-statements.md %}#data-definition-statements) directly into [`cockroach sql`]({% link {{ page.version.version }}/cockroach-sql.md %}). You can [export a converted schema file]({% link cockroachcloud/migrations-page.md %}#export-the-schema) from the Schema Conversion Tool. {{site.data.alerts.callout_success}} For the fastest performance, you can use a [local, single-node CockroachDB cluster]({% link {{ page.version.version }}/cockroach-start-single-node.md %}#start-a-single-node-cluster) to convert your schema and [check the results of queries](#test-query-results-and-performance). {{site.data.alerts.end}} @@ -263,7 +263,7 @@ Shadowing may not be necessary or practical for your workload. For example, beca You can manually validate your queries by testing a subset of "critical queries" on an otherwise idle CockroachDB cluster: -- Check the application logs for error messages and the API response time. If application requests are slower than expected, use the **SQL Activity** page on the [CockroachDB {{ site.data.products.cloud }} Console](https://www.cockroachlabs.com/docs/cockroachcloud/statements-page) or [DB Console]({% link {{ page.version.version }}/ui-statements-page.md %}) to find the longest-running queries that are part of that application request. If necessary, tune the queries according to our best practices for [SQL performance]({% link {{ page.version.version }}/performance-best-practices-overview.md %}). +- Check the application logs for error messages and the API response time. If application requests are slower than expected, use the **SQL Activity** page on the [CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/statements-page.md %}) or [DB Console]({% link {{ page.version.version }}/ui-statements-page.md %}) to find the longest-running queries that are part of that application request. If necessary, tune the queries according to our best practices for [SQL performance]({% link {{ page.version.version }}/performance-best-practices-overview.md %}). - Compare the results of the queries and check that they are identical in both the source database and CockroachDB. To do this, you can use [MOLT Verify]({% link molt/molt-verify.md %}). @@ -350,7 +350,7 @@ After you have successfully [conducted the migration](#conduct-the-migration): - [Can a PostgreSQL or MySQL application be migrated to CockroachDB?]({% link {{ page.version.version }}/frequently-asked-questions.md %}#can-a-postgresql-or-mysql-application-be-migrated-to-cockroachdb) - [PostgreSQL Compatibility]({% link {{ page.version.version }}/postgresql-compatibility.md %}) -- [Use the Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) +- [Use the Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) - [Schema Design Overview]({% link {{ page.version.version }}/schema-design-overview.md %}) - [Create a User-defined Schema]({% link {{ page.version.version }}/schema-design-schema.md %}) - [Primary key best practices]({% link {{ page.version.version }}/schema-design-table.md %}#primary-key-best-practices) diff --git a/src/current/v23.1/migration-strategy-lift-and-shift.md b/src/current/v23.1/migration-strategy-lift-and-shift.md index 8c7404f84c8..7417b4c7b3c 100644 --- a/src/current/v23.1/migration-strategy-lift-and-shift.md +++ b/src/current/v23.1/migration-strategy-lift-and-shift.md @@ -72,7 +72,7 @@ It's important to decide which data formats, storage media, and database feature Data formats that can be imported by CockroachDB include: -- [SQL]({% link {{ page.version.version }}/schema-design-overview.md %}) for the [schema import](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page). +- [SQL]({% link {{ page.version.version }}/schema-design-overview.md %}) for the [schema import]({% link cockroachcloud/migrations-page.md %}). - [CSV]({% link {{ page.version.version }}/migrate-from-csv.md %}) for table data. - [Avro]({% link {{ page.version.version }}/migrate-from-avro.md %}) for table data. @@ -121,7 +121,7 @@ For more information about import performance, see [Import Performance Best Prac ## See also - [Migration Overview]({% link {{ page.version.version }}/migration-overview.md %}) -- [Use the Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) +- [Use the Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) - [Migrate with AWS Database Migration Service (DMS)]({% link {{ page.version.version }}/aws-dms.md %}) - [AWS DMS documentation](https://docs.aws.amazon.com/dms/latest/userguide/Welcome.html) - [Migrate and Replicate Data with Qlik Replicate]({% link {{ page.version.version }}/qlik.md %}) diff --git a/src/current/v23.1/monitoring-and-alerting.md b/src/current/v23.1/monitoring-and-alerting.md index 26fb7405ef9..395915edad3 100644 --- a/src/current/v23.1/monitoring-and-alerting.md +++ b/src/current/v23.1/monitoring-and-alerting.md @@ -7,7 +7,7 @@ docs_area: manage In addition to CockroachDB's [built-in safeguards against failure]({% link {{ page.version.version }}/frequently-asked-questions.md %}#how-does-cockroachdb-survive-failures), it is critical to actively monitor the overall health and performance of a cluster running in production and to create alerting rules that promptly send notifications when there are events that require investigation or intervention. -This page describes the monitoring and observability tools that are built into CockroachDB {{ site.data.products.core }} and shows how to collect your cluster's metrics using external tools like Prometheus's AlertManager for event-based alerting. To export metrics from a CockroachDB {{ site.data.products.cloud }} cluster, refer to [Export Metrics From a CockroachDB {{ site.data.products.dedicated }} Cluster](https://www.cockroachlabs.com/docs/cockroachcloud/export-metrics) instead of this page. For more details, refer to: +This page describes the monitoring and observability tools that are built into CockroachDB {{ site.data.products.core }} and shows how to collect your cluster's metrics using external tools like Prometheus's AlertManager for event-based alerting. To export metrics from a CockroachDB {{ site.data.products.cloud }} cluster, refer to [Export Metrics From a CockroachDB {{ site.data.products.dedicated }} Cluster]({% link cockroachcloud/export-metrics.md %}) instead of this page. For more details, refer to: - [Monitor CockroachDB with Prometheus]({% link {{ page.version.version }}/monitor-cockroachdb-with-prometheus.md %}) - [Third-party Monitoring Tools]({% link {{ page.version.version }}/third-party-monitoring-tools.md %}) diff --git a/src/current/v23.1/movr-flask-deployment.md b/src/current/v23.1/movr-flask-deployment.md index 0ddb93896eb..2ce85089d43 100644 --- a/src/current/v23.1/movr-flask-deployment.md +++ b/src/current/v23.1/movr-flask-deployment.md @@ -21,7 +21,7 @@ In addition to the requirements listed in [Setting Up a Virtual Environment for ## Multi-region database deployment -In production, you want to start a secure CockroachDB cluster, with nodes on machines located in different areas of the world. To deploy CockroachDB in multiple regions, we recommend using [CockroachDB {{ site.data.products.dedicated }}](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart). +In production, you want to start a secure CockroachDB cluster, with nodes on machines located in different areas of the world. To deploy CockroachDB in multiple regions, we recommend using [CockroachDB {{ site.data.products.dedicated }}]({% link cockroachcloud/quickstart.md %}). {{site.data.alerts.callout_info}} You can also deploy CockroachDB manually. For instructions, see the [Manual Deployment]({% link {{ page.version.version }}/manual-deployment.md %}) page of the Cockroach Labs documentation site. @@ -235,7 +235,7 @@ Some time after you have deployed your application, you will likely need to push ## See also {% comment %} [MovR (live demo)](https://movr.cloud){% endcomment %} -- [CockroachDB {{ site.data.products.cloud }} documentation](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart) +- [CockroachDB {{ site.data.products.cloud }} documentation]({% link cockroachcloud/quickstart.md %}) - [Google Cloud Platform documentation](https://cloud.google.com/docs/) - [Docker documentation](https://docs.docker.com/) - [Kubernetes documentation](https://kubernetes.io/docs/home/) diff --git a/src/current/v23.1/multiregion-scale-application.md b/src/current/v23.1/multiregion-scale-application.md index 58ebda2d048..ccf9f2282f1 100644 --- a/src/current/v23.1/multiregion-scale-application.md +++ b/src/current/v23.1/multiregion-scale-application.md @@ -42,7 +42,7 @@ Scale the cluster by adding nodes to the cluster in new regions. For instructions on adding nodes to an existing cluster, see one of the following pages: -- For managed CockroachDB {{ site.data.products.cloud }} deployments, see [Cluster Management](https://www.cockroachlabs.com/docs/cockroachcloud/cluster-management). +- For managed CockroachDB {{ site.data.products.cloud }} deployments, see [Cluster Management]({% link cockroachcloud/cluster-management.md %}). - For orchestrated deployments, see [Orchestrate CockroachDB Across Multiple Kubernetes Clusters]({% link {{ page.version.version }}/orchestrate-cockroachdb-with-kubernetes-multi-cluster.md %}). - For manual deployments, see [`cockroach start`]({% link {{ page.version.version }}/cockroach-start.md %}) and [Manual Deployment]({% link {{ page.version.version }}/manual-deployment.md %}). @@ -68,7 +68,7 @@ Scaling application deployments in multiple regions can greatly improve latency For guidance on connecting to CockroachDB from an application deployment, see one of the following pages: -- For connecting to managed, CockroachDB {{ site.data.products.cloud }} deployments, see [Connect to Your CockroachDB {{ site.data.products.dedicated }} Cluster](https://www.cockroachlabs.com/docs/cockroachcloud/connect-to-your-cluster) and [Connect to the Database (CockroachDB {{ site.data.products.dedicated }})]({% link {{ page.version.version }}/connect-to-the-database.md %}?filters=dedicated). +- For connecting to managed, CockroachDB {{ site.data.products.cloud }} deployments, see [Connect to Your CockroachDB {{ site.data.products.dedicated }} Cluster]({% link cockroachcloud/connect-to-your-cluster.md %}) and [Connect to the Database (CockroachDB {{ site.data.products.dedicated }})]({% link {{ page.version.version }}/connect-to-the-database.md %}?filters=dedicated). - For connecting to a standard CockroachDB deployment, see [`cockroach sql`]({% link {{ page.version.version }}/cockroach-sql.md %}) and [Connect to the Database]({% link {{ page.version.version }}/connect-to-the-database.md %}). To limit the latency between the application and the database, each deployment of the application should communicate with the closest database deployment. For details on configuring database connections for individual application deployments, consult your cloud provider's documentation. For an example using Google Cloud services, see [Deploy a Global, Serverless Application]({% link {{ page.version.version }}/movr-flask-deployment.md %}). diff --git a/src/current/v23.1/orchestrate-a-local-cluster-with-kubernetes-insecure.md b/src/current/v23.1/orchestrate-a-local-cluster-with-kubernetes-insecure.md index 0e66c092e28..01e41b4462e 100644 --- a/src/current/v23.1/orchestrate-a-local-cluster-with-kubernetes-insecure.md +++ b/src/current/v23.1/orchestrate-a-local-cluster-with-kubernetes-insecure.md @@ -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]({% link {{ page.version.version }}/kubernetes-overview.md %}). To deploy a 30-day free CockroachDB {{ site.data.products.dedicated }} cluster instead of running CockroachDB yourself, see the [Quickstart](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart). +To orchestrate a physically distributed cluster in production, see [Orchestrated Deployments]({% link {{ page.version.version }}/kubernetes-overview.md %}). To deploy a 30-day free CockroachDB {{ site.data.products.dedicated }} cluster instead of running CockroachDB yourself, see the [Quickstart]({% link cockroachcloud/quickstart.md %}). {{site.data.alerts.end}} ## Limitations diff --git a/src/current/v23.1/orchestrate-a-local-cluster-with-kubernetes.md b/src/current/v23.1/orchestrate-a-local-cluster-with-kubernetes.md index a408f883051..4858b597d3e 100644 --- a/src/current/v23.1/orchestrate-a-local-cluster-with-kubernetes.md +++ b/src/current/v23.1/orchestrate-a-local-cluster-with-kubernetes.md @@ -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]({% link {{ page.version.version }}/kubernetes-overview.md %}). To deploy a 30-day free CockroachDB {{ site.data.products.dedicated }} cluster instead of running CockroachDB yourself, see the [Quickstart](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart). +To orchestrate a physically distributed cluster in production, see [Orchestrated Deployments]({% link {{ page.version.version }}/kubernetes-overview.md %}). To deploy a 30-day free CockroachDB {{ site.data.products.dedicated }} cluster instead of running CockroachDB yourself, see the [Quickstart]({% link cockroachcloud/quickstart.md %}). {{site.data.alerts.end}} ## Limitations diff --git a/src/current/v23.1/performance-recipes.md b/src/current/v23.1/performance-recipes.md index 2a654507996..5ec25ad4147 100644 --- a/src/current/v23.1/performance-recipes.md +++ b/src/current/v23.1/performance-recipes.md @@ -95,19 +95,19 @@ This section provides solutions for common performance issues in your applicatio These are indicators that a transaction is trying to access a row that has been ["locked"]({% link {{ page.version.version }}/architecture/transaction-layer.md %}#writing) by another, concurrent write transaction. -- The **Active Executions** table on the **Transactions** page ([CockroachDB {{ site.data.products.cloud }} Console](https://www.cockroachlabs.com/docs/cockroachcloud/transactions-page) or [DB Console]({% link {{ page.version.version }}/ui-transactions-page.md %}#active-executions-table)) shows transactions with `Waiting` in the **Status** column. You can sort the table by **Time Spent Waiting**. +- The **Active Executions** table on the **Transactions** page ([CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/transactions-page.md %}) or [DB Console]({% link {{ page.version.version }}/ui-transactions-page.md %}#active-executions-table)) shows transactions with `Waiting` in the **Status** column. You can sort the table by **Time Spent Waiting**. - Querying the [`crdb_internal.cluster_locks`]({% link {{ page.version.version }}/crdb-internal.md %}#cluster_locks) table shows transactions where [`granted`]({% link {{ page.version.version }}/crdb-internal.md %}#cluster-locks-columns) is `false`. These are indicators that lock contention occurred in the past: - Querying the [`crdb_internal.transaction_contention_events`]({% link {{ page.version.version }}/crdb-internal.md %}#transaction_contention_events) table indicates that your transactions have experienced lock contention. - - This is also shown in the **Transaction Executions** view on the **Insights** page ([CockroachDB {{ site.data.products.cloud }} Console](https://www.cockroachlabs.com/docs/cockroachcloud/insights-page#transaction-executions-view) and [DB Console]({% link {{ page.version.version }}/ui-insights-page.md %}#transaction-executions-view)). Transaction executions will display the **High Contention** insight. + - This is also shown in the **Transaction Executions** view on the **Insights** page ([CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/insights-page.md %}#transaction-executions-view) and [DB Console]({% link {{ page.version.version }}/ui-insights-page.md %}#transaction-executions-view)). Transaction executions will display the **High Contention** insight. {{site.data.alerts.callout_info}} {%- include {{ page.version.version }}/performance/sql-trace-txn-enable-threshold.md -%} {{site.data.alerts.end}} -- The **SQL Statement Contention** graph ([CockroachDB {{ site.data.products.cloud }} Console](https://www.cockroachlabs.com/docs/cockroachcloud/metrics-page#sql-statement-contention) and [DB Console]({% link {{ page.version.version }}/ui-sql-dashboard.md %}#sql-statement-contention)) is showing spikes over time. +- The **SQL Statement Contention** graph ([CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/metrics-page.md %}#sql-statement-contention) and [DB Console]({% link {{ page.version.version }}/ui-sql-dashboard.md %}#sql-statement-contention)) is showing spikes over time. SQL Statement Contention graph in DB Console If a long-running transaction is waiting due to [lock contention]({% link {{ page.version.version }}/performance-best-practices-overview.md %}#transaction-contention): @@ -127,7 +127,7 @@ These are indicators that a transaction has failed due to [contention]({% link { These are indicators that transaction retries occurred in the past: -- The **Transaction Restarts** graph ([CockroachDB {{ site.data.products.cloud }} Console](https://www.cockroachlabs.com/docs/cockroachcloud/metrics-page#transaction-restarts) and [DB Console]({% link {{ page.version.version }}/ui-sql-dashboard.md %}#transaction-restarts) is showing spikes in transaction retries over time. +- The **Transaction Restarts** graph ([CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/metrics-page.md %}#transaction-restarts) and [DB Console]({% link {{ page.version.version }}/ui-sql-dashboard.md %}#transaction-restarts) is showing spikes in transaction retries over time. {% include {{ page.version.version }}/performance/transaction-retry-error-actions.md %} @@ -139,7 +139,7 @@ In addition, implement [client-side retry handling]({% link {{ page.version.vers ##### Identify conflicting transactions -- In the **Active Executions** table on the **Transactions** page ([CockroachDB {{ site.data.products.cloud }} Console](https://www.cockroachlabs.com/docs/cockroachcloud/transactions-page) or [DB Console]({% link {{ page.version.version }}/ui-transactions-page.md %}#active-executions-table)), look for a **waiting** transaction (`Waiting` status). +- In the **Active Executions** table on the **Transactions** page ([CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/transactions-page.md %}) or [DB Console]({% link {{ page.version.version }}/ui-transactions-page.md %}#active-executions-table)), look for a **waiting** transaction (`Waiting` status). {{site.data.alerts.callout_success}} If you see many waiting transactions, a single long-running transaction may be blocking transactions that are, in turn, blocking others. In this case, sort the table by **Time Spent Waiting** to find the transaction that has been waiting for the longest amount of time. Unblocking this transaction may unblock the other transactions. {{site.data.alerts.end}} @@ -159,8 +159,8 @@ In addition, implement [client-side retry handling]({% link {{ page.version.vers To identify transactions that experienced [lock contention]({% link {{ page.version.version }}/performance-best-practices-overview.md %}#transaction-contention) in the past: -- In the **Transaction Executions** view on the **Insights** page ([CockroachDB {{ site.data.products.cloud }} Console](https://www.cockroachlabs.com/docs/cockroachcloud/insights-page#transaction-executions-view) and [DB Console]({% link {{ page.version.version }}/ui-insights-page.md %}#transaction-executions-view)), look for a transaction with the **High Contention** insight. Click the transaction's execution ID and view the transaction execution details, including the details of the blocking transaction. -- Visit the **Transactions** page ([CockroachDB {{ site.data.products.cloud }} Console](https://www.cockroachlabs.com/docs/cockroachcloud/transactions-page) and [DB Console]({% link {{ page.version.version }}/ui-transactions-page.md %})) and sort transactions by **Contention Time**. +- In the **Transaction Executions** view on the **Insights** page ([CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/insights-page.md %}#transaction-executions-view) and [DB Console]({% link {{ page.version.version }}/ui-insights-page.md %}#transaction-executions-view)), look for a transaction with the **High Contention** insight. Click the transaction's execution ID and view the transaction execution details, including the details of the blocking transaction. +- Visit the **Transactions** page ([CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/transactions-page.md %}) and [DB Console]({% link {{ page.version.version }}/ui-transactions-page.md %})) and sort transactions by **Contention Time**. To view tables and indexes that experienced [contention]({% link {{ page.version.version }}/performance-best-practices-overview.md %}#transaction-contention): diff --git a/src/current/v23.1/qlik.md b/src/current/v23.1/qlik.md index ba48ae4d92e..c8bf2b3e0ee 100644 --- a/src/current/v23.1/qlik.md +++ b/src/current/v23.1/qlik.md @@ -65,7 +65,7 @@ Complete the following items before using Qlik Replicate: - If the output of [`SHOW SCHEDULES`]({% link {{ page.version.version }}/show-schedules.md %}) shows any backup schedules, run [`ALTER BACKUP SCHEDULE {schedule_id} SET WITH revision_history = 'false'`]({% link {{ page.version.version }}/alter-backup-schedule.md %}) for each backup schedule. - If the output of `SHOW SCHEDULES` does not show backup schedules, [contact Support](https://support.cockroachlabs.com) to disable revision history for cluster backups. - Manually create all schema objects in the target CockroachDB cluster. Qlik can create a basic schema, but does not create indexes or constraints such as foreign keys and defaults. - - If you are migrating from PostgreSQL, MySQL, Oracle, or Microsoft SQL Server, [use the **Schema Conversion Tool**](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) to convert and export your schema. Ensure that any schema changes are also reflected on your tables, or add transformation rules. If you make substantial schema changes, the Qlik Replicate migration may fail. + - If you are migrating from PostgreSQL, MySQL, Oracle, or Microsoft SQL Server, [use the **Schema Conversion Tool**]({% link cockroachcloud/migrations-page.md %}) to convert and export your schema. Ensure that any schema changes are also reflected on your tables, or add transformation rules. If you make substantial schema changes, the Qlik Replicate migration may fail. {{site.data.alerts.callout_info}} 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). @@ -97,7 +97,7 @@ In the Qlik Replicate interface, CockroachDB is configured as a PostgreSQL **sou ## 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 %}) - [Change Data Capture Overview]({% link {{ page.version.version }}/change-data-capture-overview.md %}) - [Third-Party Tools Supported by Cockroach Labs]({% link {{ page.version.version }}/third-party-database-tools.md %}) - [Migrate with AWS Database Migration Service (DMS)]({% link {{ page.version.version }}/aws-dms.md %}) diff --git a/src/current/v23.1/query-behavior-troubleshooting.md b/src/current/v23.1/query-behavior-troubleshooting.md index ca47d0d079b..0c870f2ed78 100644 --- a/src/current/v23.1/query-behavior-troubleshooting.md +++ b/src/current/v23.1/query-behavior-troubleshooting.md @@ -21,7 +21,7 @@ Such long-running queries can hold intents open for (practically) unlimited dura Refer to the performance tuning recipe for [identifying and unblocking a waiting transaction]({% link {{ page.version.version }}/performance-recipes.md %}#waiting-transaction). -If you experience this issue on a CockroachDB {{ site.data.products.serverless }} cluster, your cluster may be throttled or disabled because you've reached your monthly [resource limits](https://www.cockroachlabs.com/docs/cockroachcloud/troubleshooting-page#hanging-or-stuck-queries). +If you experience this issue on a CockroachDB {{ site.data.products.serverless }} cluster, your cluster may be throttled or disabled because you've reached your monthly [resource limits]({% link cockroachcloud/troubleshooting-page.md %}#hanging-or-stuck-queries). ### Identify slow queries diff --git a/src/current/v23.1/query-data.md b/src/current/v23.1/query-data.md index 6ea76993f2a..6bb663791d9 100644 --- a/src/current/v23.1/query-data.md +++ b/src/current/v23.1/query-data.md @@ -11,7 +11,7 @@ This page has instructions for making SQL [selection queries][selection] against Before reading this page, do the following: -- [Create a CockroachDB {{ site.data.products.serverless }} 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.serverless }} 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 run queries against. diff --git a/src/current/v23.1/restoring-backups-across-versions.md b/src/current/v23.1/restoring-backups-across-versions.md index 816b406cc76..f17715f3556 100644 --- a/src/current/v23.1/restoring-backups-across-versions.md +++ b/src/current/v23.1/restoring-backups-across-versions.md @@ -29,7 +29,7 @@ Backup taken on version | Restorable into version 22.1.x | 22.1.x, 22.2.x 22.2.x | 22.2.x, 23.1.x -When a cluster is in a mixed-version state during an upgrade, [full cluster restores]({% link {{ page.version.version }}/restore.md %}#restore-a-cluster) will fail. See the [Upgrade documentation]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}) for the necessary steps to finalize your upgrade. For CockroachDB {{ site.data.products.cloud }} clusters, see the [CockroachDB Cloud Upgrade Policy](https://www.cockroachlabs.com/docs/cockroachcloud/upgrade-policy) page. +When a cluster is in a mixed-version state during an upgrade, [full cluster restores]({% link {{ page.version.version }}/restore.md %}#restore-a-cluster) will fail. See the [Upgrade documentation]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}) for the necessary steps to finalize your upgrade. For CockroachDB {{ site.data.products.cloud }} clusters, see the [CockroachDB Cloud Upgrade Policy]({% link cockroachcloud/upgrade-policy.md %}) page. {{site.data.alerts.callout_info}} Cockroach Labs does **not** support restoring backups from a higher version into a lower version. diff --git a/src/current/v23.1/schema-design-database.md b/src/current/v23.1/schema-design-database.md index 7130d3c6d88..438ffad5540 100644 --- a/src/current/v23.1/schema-design-database.md +++ b/src/current/v23.1/schema-design-database.md @@ -15,7 +15,7 @@ For reference documentation on the `CREATE DATABASE` statement, including additi Before reading this page, do the following: -- [Create a CockroachDB {{ site.data.products.serverless }} 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.serverless }} cluster]({% link cockroachcloud/quickstart.md %}) or [start a local cluster](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart?filters=local). - [Review the database schema objects]({% link {{ page.version.version }}/schema-design-overview.md %}). ## Create a database diff --git a/src/current/v23.1/schema-design-indexes.md b/src/current/v23.1/schema-design-indexes.md index 6e895315845..132d38f6444 100644 --- a/src/current/v23.1/schema-design-indexes.md +++ b/src/current/v23.1/schema-design-indexes.md @@ -18,7 +18,7 @@ This page provides best-practice guidance on creating secondary indexes, with a Before reading this page, do the following: -- [Create a CockroachDB {{ site.data.products.serverless }} 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.serverless }} cluster]({% link cockroachcloud/quickstart.md %}) or [start a local cluster](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart?filters=local). - [Review the database schema objects]({% link {{ page.version.version }}/schema-design-overview.md %}). - [Create a database]({% link {{ page.version.version }}/schema-design-database.md %}). - [Create a user-defined schema]({% link {{ page.version.version }}/schema-design-schema.md %}). diff --git a/src/current/v23.1/schema-design-schema.md b/src/current/v23.1/schema-design-schema.md index 402588aea2b..ce931d393ba 100644 --- a/src/current/v23.1/schema-design-schema.md +++ b/src/current/v23.1/schema-design-schema.md @@ -15,7 +15,7 @@ For detailed reference documentation on the `CREATE SCHEMA` statement, including Before reading this page, do the following: -- [Create a CockroachDB {{ site.data.products.serverless }} 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.serverless }} cluster]({% link cockroachcloud/quickstart.md %}) or [start a local cluster](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart?filters=local). - [Review the database schema objects]({% link {{ page.version.version }}/schema-design-overview.md %}). - [Create a database]({% link {{ page.version.version }}/schema-design-database.md %}). diff --git a/src/current/v23.1/schema-design-table.md b/src/current/v23.1/schema-design-table.md index cd18dd9c8e7..5b606adfe28 100644 --- a/src/current/v23.1/schema-design-table.md +++ b/src/current/v23.1/schema-design-table.md @@ -15,7 +15,7 @@ For detailed reference documentation on the `CREATE TABLE` statement, including Before reading this page, do the following: -- [Create a CockroachDB {{ site.data.products.serverless }} 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.serverless }} cluster]({% link cockroachcloud/quickstart.md %}) or [start a local cluster](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart?filters=local). - [Review the database schema objects]({% link {{ page.version.version }}/schema-design-overview.md %}). - [Create a database]({% link {{ page.version.version }}/schema-design-database.md %}). - [Create a user-defined schema]({% link {{ page.version.version }}/schema-design-schema.md %}). diff --git a/src/current/v23.1/schema-design-update.md b/src/current/v23.1/schema-design-update.md index de2b23b1241..37b3488d4b4 100644 --- a/src/current/v23.1/schema-design-update.md +++ b/src/current/v23.1/schema-design-update.md @@ -11,7 +11,7 @@ This page provides an overview on changing and removing the objects in a databas Before reading this page, do the following: -- [Create a CockroachDB {{ site.data.products.serverless }} 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.serverless }} cluster]({% link cockroachcloud/quickstart.md %}) or [start a local cluster](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart?filters=local). - [Review the database schema objects]({% link {{ page.version.version }}/schema-design-overview.md %}). - [Create a database]({% link {{ page.version.version }}/schema-design-database.md %}). - [Create a user-defined schema]({% link {{ page.version.version }}/schema-design-schema.md %}). diff --git a/src/current/v23.1/sso-db-console.md b/src/current/v23.1/sso-db-console.md index 30e9eee30ae..67c1b77dda6 100644 --- a/src/current/v23.1/sso-db-console.md +++ b/src/current/v23.1/sso-db-console.md @@ -28,7 +28,7 @@ This SSO implementation uses the [authorization code grant type](https://tools.i - **CockroachDB cluster**: you must have access to one of the following: - A {{ site.data.products.core }} cluster enabled with a valid [CockroachDB Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). - - A [CockroachDB {{ site.data.products.dedicated }} cluster](https://www.cockroachlabs.com/docs/cockroachcloud/create-your-cluster). + - A [CockroachDB {{ site.data.products.dedicated }} cluster]({% link cockroachcloud/create-your-cluster.md %}). ## Log in to a cluster's DB Console with SSO diff --git a/src/current/v23.1/sso-sql.md b/src/current/v23.1/sso-sql.md index 87cb19e3bd4..29f7345743d 100644 --- a/src/current/v23.1/sso-sql.md +++ b/src/current/v23.1/sso-sql.md @@ -12,7 +12,7 @@ Cluster single sign-on (SSO) enables users to access the SQL interface of a Cock {{ site.data.products.dedicated }} clusters can provision their users with JWTs via the DB Console. This allows users to authenticate to a cluster by signing in to their IdP (for example, Okta or Google) with a link embedded in the DB Console. This flow provisions a JWT that a user can copy out of the DB Console UI and use in a SQL connection string to authenticate to the cluster. {{site.data.alerts.callout_info}} -Cluster single sign-on for the DB Console is supported on {{ site.data.products.core }} {{ site.data.products.enterprise }} and {{ site.data.products.dedicated }} clusters. {{ site.data.products.serverless }} clusters do not support cluster single sign-on, because they do not have access to the DB Console. However, {{ site.data.products.serverless }} clusters can use [Cluster Single Sign-on (SSO) using `ccloud` and the CockroachDB Cloud Console](https://www.cockroachlabs.com/docs/cockroachcloud/cloud-sso-sql). +Cluster single sign-on for the DB Console is supported on {{ site.data.products.core }} {{ site.data.products.enterprise }} and {{ site.data.products.dedicated }} clusters. {{ site.data.products.serverless }} clusters do not support cluster single sign-on, because they do not have access to the DB Console. However, {{ site.data.products.serverless }} clusters can use [Cluster Single Sign-on (SSO) using `ccloud` and the CockroachDB Cloud Console]({% link cockroachcloud/cloud-sso-sql.md %}). {{site.data.alerts.end}} The page describes how to configure a cluster for cluster single sign-on using JWTs and then how users can authenticate using the JWTs. If you're a user ready to sign in to the DB Console with JWTs, you can skip the configuration section: @@ -100,7 +100,7 @@ You can also view all of your cluster settings in the DB Console. SET CLUSTER SETTING server.jwt_authentication.audience = '984901724939-njig7lkv7k724rbv2hllvr4of8ul7th7.apps.googleusercontent.com'; ~~~ -1. Set `server.jwt_authentication.claim` to the field in the JWT that the cluster will use as the identity of the [SQL user](https://www.cockroachlabs.com/docs/cockroachcloud/managing-access#manage-sql-users-on-a-cluster). To use the email field in the JWT, set `server.jwt_authentication.claim` to `email`. +1. Set `server.jwt_authentication.claim` to the field in the JWT that the cluster will use as the identity of the [SQL user]({% link cockroachcloud/managing-access.md %}#manage-sql-users-on-a-cluster). To use the email field in the JWT, set `server.jwt_authentication.claim` to `email`. {% include_cached copy-clipboard.html %} ~~~sql @@ -113,7 +113,7 @@ You can also view all of your cluster settings in the DB Console. {{ site.data.products.db }} {{ site.data.products.dedicated }} customers: - By default, your cluster's configuration will contain the CockroachDB {{ site.data.products.cloud }}'s own public key, allowing CockroachDB {{ site.data.products.cloud }} to serve as an IdP. This is required for [SSO with `ccloud`](https://www.cockroachlabs.com/docs/cockroachcloud/cloud-sso-sql). When modifying this cluster setting, you must include the CockroachDB {{ site.data.products.cloud }} public key in the key set, or SSO with `ccloud` will no longer work. + By default, your cluster's configuration will contain the CockroachDB {{ site.data.products.cloud }}'s own public key, allowing CockroachDB {{ site.data.products.cloud }} to serve as an IdP. This is required for [SSO with `ccloud`]({% link cockroachcloud/cloud-sso-sql.md %}). When modifying this cluster setting, you must include the CockroachDB {{ site.data.products.cloud }} public key in the key set, or SSO with `ccloud` will no longer work. The public key for {{ site.data.products.db }} can be found at `https://cockroachlabs.cloud/.well-known/openid-configuration`. @@ -223,7 +223,7 @@ Examples: - `https://accounts.google.com 1232316645658094244789 roach` - Maps a single external identity with the hard-coded ID to the [SQL user](https://www.cockroachlabs.com/docs/cockroachcloud/managing-access#manage-sql-users-on-a-cluster) `roach`. + Maps a single external identity with the hard-coded ID to the [SQL user]({% link cockroachcloud/managing-access.md %}#manage-sql-users-on-a-cluster) `roach`. - `https://accounts.google.com /^([9-0]*)$ gcp_\1` diff --git a/src/current/v23.1/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.md b/src/current/v23.1/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.md index 85135898e22..5a0822e52c6 100644 --- a/src/current/v23.1/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.md +++ b/src/current/v23.1/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.md @@ -21,7 +21,7 @@ An overview of the workflow involves creating and connecting the following: You will need the following set up before starting this tutorial: -- A CockroachDB cluster. You can use a CockroachDB {{ site.data.products.cloud }} or CockroachDB {{ site.data.products.core }} cluster. If you are using CockroachDB {{ site.data.products.serverless }} or CockroachDB {{ site.data.products.dedicated }}, see the [Quickstart with CockroachDB](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart) guide. For CockroachDB {{ site.data.products.core }} clusters, see the [install]({% link {{ page.version.version }}/install-cockroachdb-mac.md %}) page. +- A CockroachDB cluster. You can use a CockroachDB {{ site.data.products.cloud }} or CockroachDB {{ site.data.products.core }} cluster. If you are using CockroachDB {{ site.data.products.serverless }} or CockroachDB {{ site.data.products.dedicated }}, see the [Quickstart with CockroachDB]({% link cockroachcloud/quickstart.md %}) guide. For CockroachDB {{ site.data.products.core }} clusters, see the [install]({% link {{ page.version.version }}/install-cockroachdb-mac.md %}) page. - A Confluent Cloud account. See Confluent's [Get started](https://www.confluent.io/get-started/) page for details. - The Confluent CLI. See [Install Confluent CLI](https://docs.confluent.io/confluent-cli/current/install.html) to set this up. This tutorial uses v3.3.0 of the Confluent CLI. Note that you can also complete the steps in this tutorial in Confluent's Cloud console. diff --git a/src/current/v23.1/striim.md b/src/current/v23.1/striim.md index ffbba6d55fa..06ba43db452 100644 --- a/src/current/v23.1/striim.md +++ b/src/current/v23.1/striim.md @@ -34,7 +34,7 @@ Complete the following items before using Striim: - Ensure you have a secure, publicly available CockroachDB cluster running the latest **{{ page.version.version }}** [production release](https://www.cockroachlabs.com/docs/releases/{{ page.version.version }}), and have created a [SQL user]({% link {{ page.version.version }}/security-reference/authorization.md %}#sql-users) that you can use to configure your Striim target. - Manually create all schema objects in the target CockroachDB cluster. Although Striim offers a feature called Auto Schema Conversion, we recommend converting and importing your schema before running Striim to ensure that the data populates successfully. - - If you are migrating from PostgreSQL, MySQL, Oracle, or Microsoft SQL Server, [use the **Schema Conversion Tool**](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) to convert and export your schema. Ensure that any schema changes are also reflected on your tables. + - If you are migrating from PostgreSQL, MySQL, Oracle, or Microsoft SQL Server, [use the **Schema Conversion Tool**]({% link cockroachcloud/migrations-page.md %}) to convert and export your schema. Ensure that any schema changes are also reflected on your tables. {{site.data.alerts.callout_info}} 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). @@ -111,6 +111,6 @@ To perform continuous replication of ongoing changes, create a Striim applicatio ## 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 %}) - [Change Data Capture Overview]({% link {{ page.version.version }}/change-data-capture-overview.md %}) - [Third-Party Tools Supported by Cockroach Labs]({% link {{ page.version.version }}/third-party-database-tools.md %}) diff --git a/src/current/v23.1/troubleshooting-overview.md b/src/current/v23.1/troubleshooting-overview.md index 2573f1c9fe3..9b21e2725f0 100644 --- a/src/current/v23.1/troubleshooting-overview.md +++ b/src/current/v23.1/troubleshooting-overview.md @@ -16,7 +16,7 @@ If you experience an issue when using CockroachDB, try these steps to resolve th - [Troubleshoot Common Problems]({% link {{ page.version.version }}/query-behavior-troubleshooting.md %}) helps you handle errors and troubleshooting problems that may arise during application development. - [Troubleshoot Statement Behavior]({% link {{ page.version.version }}/query-behavior-troubleshooting.md %}) helps you with unexpected query results. -- If you are using Cockroach Cloud, see the errors and solutions in [Troubleshoot CockroachDB Cloud](https://www.cockroachlabs.com/docs/cockroachcloud/troubleshooting-page). +- If you are using Cockroach Cloud, see the errors and solutions in [Troubleshoot CockroachDB Cloud]({% link cockroachcloud/troubleshooting-page.md %}). - If you see discrepancies in metrics, refer to [Differences in Metrics between Third-Party Monitoring Integrations and DB Console]({% link {{ page.version.version }}/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.md %}). diff --git a/src/current/v23.1/ui-overview.md b/src/current/v23.1/ui-overview.md index 2ee049be705..a471268bcd5 100644 --- a/src/current/v23.1/ui-overview.md +++ b/src/current/v23.1/ui-overview.md @@ -11,7 +11,7 @@ The DB Console provides details about your cluster and database configuration, a {{site.data.alerts.callout_info}} Authorized CockroachDB {{ site.data.products.dedicated }} cluster users can visit the DB Console at a URL provisioned for the cluster. -Refer to: [Network Authorization for CockroachDB Cloud Clusters—DB Console](https://www.cockroachlabs.com/docs/cockroachcloud/network-authorization#db-console) +Refer to: [Network Authorization for CockroachDB Cloud Clusters—DB Console]({% link cockroachcloud/network-authorization.md %}#db-console) {{site.data.alerts.end}} ## Authentication diff --git a/src/current/v23.1/update-data.md b/src/current/v23.1/update-data.md index 5c0d256dd29..5db28c352f0 100644 --- a/src/current/v23.1/update-data.md +++ b/src/current/v23.1/update-data.md @@ -15,7 +15,7 @@ This page has instructions for updating existing rows of data in CockroachDB, us Before reading this page, do the following: -- [Create a CockroachDB {{ site.data.products.serverless }} 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.serverless }} 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 %}). - [Create a database schema]({% link {{ page.version.version }}/schema-design-overview.md %}). diff --git a/src/current/v23.1/vault-db-secrets-tutorial.md b/src/current/v23.1/vault-db-secrets-tutorial.md index bb846cfd37e..2f47e18de31 100644 --- a/src/current/v23.1/vault-db-secrets-tutorial.md +++ b/src/current/v23.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]({% link {{ page.version.version }}/install-cockroachdb-mac.md %}). - The Vault CLI [installed locally](https://www.vaultproject.io/downloads). -- Access to a CockroachDB cluster as [`admin` SQL user]({% link {{ page.version.version }}/security-reference/authorization.md %}#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](https://www.cockroachlabs.com/docs/cockroachcloud/create-a-serverless-cluster) 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]({% link {{ page.version.version }}/security-reference/authorization.md %}#admin-role). +- Access to a CockroachDB cluster as [`admin` SQL user]({% link {{ page.version.version }}/security-reference/authorization.md %}#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]({% link cockroachcloud/create-a-serverless-cluster.md %}) 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]({% link {{ page.version.version }}/security-reference/authorization.md %}#admin-role). - Access to a Vault cluster with an admin token. This tutorial will use HashiCorp Cloud Platform, but you may either [spin up a free cluster in HashiCorp Cloud Platform](https://learn.hashicorp.com/collections/vault/cloud) or [start a development cluster locally](https://learn.hashicorp.com/tutorials/vault/getting-started-dev-server). ## Introduction diff --git a/src/current/v23.2/api-support-policy.md b/src/current/v23.2/api-support-policy.md index 4bea53dca03..175b1814647 100644 --- a/src/current/v23.2/api-support-policy.md +++ b/src/current/v23.2/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.2/authorization.md b/src/current/v23.2/authorization.md index 6eec67c32cd..3b1ce45e023 100644 --- a/src/current/v23.2/authorization.md +++ b/src/current/v23.2/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.2/aws-dms.md b/src/current/v23.2/aws-dms.md index cd5d32a54e8..e830fd736d7 100644 --- a/src/current/v23.2/aws-dms.md +++ b/src/current/v23.2/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). @@ -211,7 +211,7 @@ If your migration failed for some reason, you can check the checkbox next to the ### AWS PrivateLink -If using CockroachDB {{ site.data.products.dedicated }}, you can enable [AWS PrivateLink](https://aws.amazon.com/privatelink/) to securely connect your AWS application with your CockroachDB {{ site.data.products.dedicated }} cluster using a private endpoint. To configure AWS PrivateLink with CockroachDB {{ site.data.products.dedicated }}, see [Network Authorization](https://www.cockroachlabs.com/docs/cockroachcloud/network-authorization#aws-privatelink). +If using CockroachDB {{ site.data.products.dedicated }}, you can enable [AWS PrivateLink](https://aws.amazon.com/privatelink/) to securely connect your AWS application with your CockroachDB {{ site.data.products.dedicated }} cluster using a private endpoint. To configure AWS PrivateLink with CockroachDB {{ site.data.products.dedicated }}, see [Network Authorization]({% link cockroachcloud/network-authorization.md %}#aws-privatelink). ### `BatchApplyEnabled` @@ -409,7 +409,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.2/backup.md b/src/current/v23.2/backup.md index 84bcbbee624..55019fc5053 100644 --- a/src/current/v23.2/backup.md +++ b/src/current/v23.2/backup.md @@ -32,7 +32,7 @@ To view the contents of an backup created with the `BACKUP` statement, use [`SHO ## Considerations -- Core users can only take [full backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#full-backups). To use the other backup features, you need an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). You can also use [CockroachDB {{ site.data.products.dedicated }}](https://cockroachlabs.cloud/signup?referralId=docs-crdb-backup), which runs [full backups daily and incremental backups hourly](https://www.cockroachlabs.com/docs/cockroachcloud/use-managed-service-backups). +- Core users can only take [full backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#full-backups). To use the other backup features, you need an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). You can also use [CockroachDB {{ site.data.products.dedicated }}](https://cockroachlabs.cloud/signup?referralId=docs-crdb-backup), which runs [full backups daily and incremental backups hourly]({% link cockroachcloud/use-managed-service-backups.md %}). - [Full cluster backups](#back-up-a-cluster) include [Enterprise license keys]({% link {{ page.version.version }}/enterprise-licensing.md %}). When you [restore]({% link {{ page.version.version }}/restore.md %}) a full cluster backup that includes an Enterprise license, the Enterprise license is also restored. - [Zone configurations]({% link {{ page.version.version }}/configure-replication-zones.md %}) present on the destination cluster prior to a restore will be **overwritten** during a [cluster restore]({% link {{ page.version.version }}/restore.md %}#full-cluster) with the zone configurations from the [backed up cluster](#back-up-a-cluster). If there were no customized zone configurations on the cluster when the backup was taken, then after the restore the destination cluster will use the zone configuration from the [`RANGE DEFAULT` configuration]({% link {{ page.version.version }}/configure-replication-zones.md %}#view-the-default-replication-zone). - You cannot restore a backup of a multi-region database into a single-region database. diff --git a/src/current/v23.2/bulk-delete-data.md b/src/current/v23.2/bulk-delete-data.md index ecb96f85216..18c6d92f4f1 100644 --- a/src/current/v23.2/bulk-delete-data.md +++ b/src/current/v23.2/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.serverless }} 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.serverless }} 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.2/bulk-update-data.md b/src/current/v23.2/bulk-update-data.md index 287579230fd..afc681f2e38 100644 --- a/src/current/v23.2/bulk-update-data.md +++ b/src/current/v23.2/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.serverless }} 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.serverless }} 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.2/choose-a-deployment-option.md b/src/current/v23.2/choose-a-deployment-option.md index 3f7e694f478..32c13b877be 100644 --- a/src/current/v23.2/choose-a-deployment-option.md +++ b/src/current/v23.2/choose-a-deployment-option.md @@ -99,7 +99,7 @@ Cockroach Labs offers four ways to deploy CockroachDB: three managed services&md - [CockroachDB deployment]({% link {{ page.version.version }}/architecture/glossary.md %}#cockroachdb-deployment-terms) - [CockroachDB pricing](https://www.cockroachlabs.com/get-started-cockroachdb/) -- [CockroachDB Cloud FAQs](https://www.cockroachlabs.com/docs/cockroachcloud/serverless-faqs) -- [CockroachDB Cloud Architecture](https://www.cockroachlabs.com/docs/cockroachcloud/architecture) +- [CockroachDB Cloud FAQs]({% link cockroachcloud/serverless-faqs.md %}) +- [CockroachDB Cloud Architecture]({% link cockroachcloud/architecture.md %}) - [Manual Deployment]({% link {{ page.version.version }}/manual-deployment.md %}) - [Kubernetes Deployment]({% link {{ page.version.version }}/kubernetes-overview.md %}) diff --git a/src/current/v23.2/cloud-storage-authentication.md b/src/current/v23.2/cloud-storage-authentication.md index 68379cdd4a7..184ee89da7b 100644 --- a/src/current/v23.2/cloud-storage-authentication.md +++ b/src/current/v23.2/cloud-storage-authentication.md @@ -297,7 +297,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 @@ -596,7 +596,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 diff --git a/src/current/v23.2/cockroachdb-feature-availability.md b/src/current/v23.2/cockroachdb-feature-availability.md index e4230ac3d0e..b9c4488e5c3 100644 --- a/src/current/v23.2/cockroachdb-feature-availability.md +++ b/src/current/v23.2/cockroachdb-feature-availability.md @@ -179,7 +179,7 @@ This example uses the `users` table from our open-source, fictional peer-to-peer ### Export metrics from CockroachDB {{ site.data.products.dedicated }} clusters -CockroachDB {{ site.data.products.dedicated }} users can use the [Cloud API](https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api) to configure [metrics export](https://www.cockroachlabs.com/docs/cockroachcloud/export-metrics) to [AWS CloudWatch](https://aws.amazon.com/cloudwatch/) or [Datadog](https://www.datadoghq.com/). Once the export is configured, metrics will flow from all nodes in all regions of your CockroachDB {{ site.data.products.dedicated }} cluster to your chosen cloud metrics sink. +CockroachDB {{ site.data.products.dedicated }} users can use the [Cloud API]({% link cockroachcloud/cloud-api.md %}) to configure [metrics export]({% link cockroachcloud/export-metrics.md %}) to [AWS CloudWatch](https://aws.amazon.com/cloudwatch/) or [Datadog](https://www.datadoghq.com/). Once the export is configured, metrics will flow from all nodes in all regions of your CockroachDB {{ site.data.products.dedicated }} cluster to your chosen cloud metrics sink. ### Show range information for a specific row diff --git a/src/current/v23.2/common-issues-to-monitor.md b/src/current/v23.2/common-issues-to-monitor.md index 26ea383862c..49fb0dd0ee4 100644 --- a/src/current/v23.2/common-issues-to-monitor.md +++ b/src/current/v23.2/common-issues-to-monitor.md @@ -331,4 +331,4 @@ Because each node needs to update a liveness record on disk, maxing out disk ban - [Troubleshoot SQL Behavior]({% link {{ page.version.version }}/query-behavior-troubleshooting.md %}) - [Admission Control]({% link {{ page.version.version }}/admission-control.md %}) - [Metrics]({% link {{ page.version.version }}/metrics.md %}) -- [Alerts Page](https://www.cockroachlabs.com/docs/cockroachcloud/alerts-page) (CockroachDB {{ site.data.products.dedicated }}) +- [Alerts Page]({% link cockroachcloud/alerts-page.md %}) (CockroachDB {{ site.data.products.dedicated }}) diff --git a/src/current/v23.2/connect-to-a-changefeed-kafka-sink-with-oauth-using-okta.md b/src/current/v23.2/connect-to-a-changefeed-kafka-sink-with-oauth-using-okta.md index cdaf916d76d..2bde95a6387 100644 --- a/src/current/v23.2/connect-to-a-changefeed-kafka-sink-with-oauth-using-okta.md +++ b/src/current/v23.2/connect-to-a-changefeed-kafka-sink-with-oauth-using-okta.md @@ -22,7 +22,7 @@ An overview of the workflow involves: Before starting this tutorial, you will need: - A CockroachDB cluster. You can use a CockroachDB {{ site.data.products.cloud }} or CockroachDB {{ site.data.products.core }} cluster. - - If you are using CockroachDB {{ site.data.products.serverless }} or CockroachDB {{ site.data.products.dedicated }}, see the [Quickstart with CockroachDB](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart) guide. For CockroachDB {{ site.data.products.core }} clusters, see the [install]({% link {{ page.version.version }}/install-cockroachdb-mac.md %}) page. + - If you are using CockroachDB {{ site.data.products.serverless }} or CockroachDB {{ site.data.products.dedicated }}, see the [Quickstart with CockroachDB]({% link cockroachcloud/quickstart.md %}) guide. For CockroachDB {{ site.data.products.core }} clusters, see the [install]({% link {{ page.version.version }}/install-cockroachdb-mac.md %}) page. - An [Okta Developer account](https://developer.okta.com/signup/). - (Optional) A Kafka cluster. This tutorial includes [Kafka cluster setup](#step-3-create-a-kafka-sink). Note that this tutorial was tested with Kafka [version 2.8.2](https://kafka.apache.org/downloads). The Kafka cluster configuration may vary with different versions, but the Okta setup and changefeed creation will be the same. - {% include {{ page.version.version }}/cdc/tutorial-privilege-check.md %} diff --git a/src/current/v23.2/connect-to-the-database.md b/src/current/v23.2/connect-to-the-database.md index d24c61b17dc..9ec0c3378f8 100644 --- a/src/current/v23.2/connect-to-the-database.md +++ b/src/current/v23.2/connect-to-the-database.md @@ -307,7 +307,7 @@ export const AppDataSource = new DataSource({ Where: - `DATABASE_URL` is an environment variable set to a valid CockroachDB connection string. -- `CA_CERT` is an environment variable set to the root certificate [downloaded from the CockroachDB Cloud Console](https://www.cockroachlabs.com/docs/cockroachcloud/authentication#node-identity-verification). +- `CA_CERT` is an environment variable set to the root certificate [downloaded from the CockroachDB Cloud Console]({% link cockroachcloud/authentication.md %}#node-identity-verification). TypeORM accepts the following format for CockroachDB connection strings: @@ -452,7 +452,7 @@ Parameter | Description `` | The host on which the CockroachDB node is running. `` | The port at which the CockroachDB node is listening. `` | The name of the (existing) database. -`` | The path to the root certificate that you [downloaded from the CockroachDB Cloud Console](https://www.cockroachlabs.com/docs/cockroachcloud/authentication#node-identity-verification). +`` | The path to the root certificate that you [downloaded from the CockroachDB Cloud Console]({% link cockroachcloud/authentication.md %}#node-identity-verification). @@ -784,7 +784,7 @@ Parameter | Description `{host}` | The host on which the CockroachDB node is running. `{port}` | The port at which the CockroachDB node is listening. `{database}` | The name of the (existing) database. -`{root-cert}` | The path to the root certificate that you [downloaded from the CockroachDB Cloud Console](https://www.cockroachlabs.com/docs/cockroachcloud/authentication#node-identity-verification). +`{root-cert}` | The path to the root certificate that you [downloaded from the CockroachDB Cloud Console]({% link cockroachcloud/authentication.md %}#node-identity-verification). @@ -1014,7 +1014,7 @@ Parameter | Description `{host}` | The host on which the CockroachDB node is running. `{port}` | The port at which the CockroachDB node is listening. `{database}` | The name of the (existing) database. -`{root-cert}` | The path to the root certificate that you [downloaded from the CockroachDB Cloud Console](https://www.cockroachlabs.com/docs/cockroachcloud/authentication#node-identity-verification). +`{root-cert}` | The path to the root certificate that you [downloaded from the CockroachDB Cloud Console]({% link cockroachcloud/authentication.md %}#node-identity-verification). @@ -1171,7 +1171,7 @@ Parameter | Description `{host}` | The host on which the CockroachDB node is running. `{port}` | The port at which the CockroachDB node is listening. `{database}` | The name of the (existing) database. -`{root-cert}` | The [URL-encoded](https://wikipedia.org/wiki/Percent-encoding) path to the root certificate that you [downloaded from the CockroachDB Cloud Console](https://www.cockroachlabs.com/docs/cockroachcloud/authentication#node-identity-verification). +`{root-cert}` | The [URL-encoded](https://wikipedia.org/wiki/Percent-encoding) path to the root certificate that you [downloaded from the CockroachDB Cloud Console]({% link cockroachcloud/authentication.md %}#node-identity-verification). @@ -1331,7 +1331,7 @@ Parameter | Description `{host}` | The host on which the CockroachDB node is running. `{port}` | The port at which the CockroachDB node is listening. `{database}` | The name of the (existing) database. -`{root-cert}` | The path to the root certificate that you [downloaded from the CockroachDB Cloud Console](https://www.cockroachlabs.com/docs/cockroachcloud/authentication#node-identity-verification). +`{root-cert}` | The path to the root certificate that you [downloaded from the CockroachDB Cloud Console]({% link cockroachcloud/authentication.md %}#node-identity-verification). diff --git a/src/current/v23.2/connection-parameters.md b/src/current/v23.2/connection-parameters.md index ba52da21d57..b7a22d63cc7 100644 --- a/src/current/v23.2/connection-parameters.md +++ b/src/current/v23.2/connection-parameters.md @@ -99,7 +99,7 @@ CockroachDB supports the following `options` parameters. After the first `option Parameter | Description ----------|------------- -`--cluster=` | Identifies your tenant cluster on a [multi-tenant host](https://www.cockroachlabs.com/docs/cockroachcloud/architecture#architecture). For example, `funny-skunk-123`. This option is deprecated. The `host` in the connection string now includes the tenant information. +`--cluster=` | Identifies your tenant cluster on a [multi-tenant host]({% link cockroachcloud/architecture.md %}#architecture). For example, `funny-skunk-123`. This option is deprecated. The `host` in the connection string now includes the tenant information. `-c =` | Sets a [session variable]({% link {{ page.version.version }}/set-vars.md %}) for the SQL session. `results_buffer_size` | Default size of the buffer that accumulates results for a statement or a batch of statements before they are sent to the client. Can also be set using the [`sql.defaults.results_buffer.size` cluster setting]({% link {{ page.version.version }}/cluster-settings.md %}#setting-sql-defaults-results-buffer-size). Can be set as a top-level query parameter or as an `options` parameter. diff --git a/src/current/v23.2/datadog.md b/src/current/v23.2/datadog.md index e6bb9bbc9a9..72e42583380 100644 --- a/src/current/v23.2/datadog.md +++ b/src/current/v23.2/datadog.md @@ -8,7 +8,7 @@ docs_area: manage [Datadog](https://www.datadoghq.com/) is a monitoring and security platform for cloud applications. The CockroachDB {{ site.data.products.core }} integration with Datadog enables data collection and alerting on selected [CockroachDB metrics](https://docs.datadoghq.com/integrations/cockroachdb/?tab=host#data-collected) using the Datadog platform. {{site.data.alerts.callout_success}} -This tutorial explores the CockroachDB {{ site.data.products.core }} integration with Datadog. For the CockroachDB {{ site.data.products.dedicated }} integration with Datadog, refer to [Monitor CockroachDB Dedicated with Datadog](https://www.cockroachlabs.com/docs/cockroachcloud/tools-page#monitor-cockroachdb-dedicated-with-datadog) instead of this page. +This tutorial explores the CockroachDB {{ site.data.products.core }} integration with Datadog. For the CockroachDB {{ site.data.products.dedicated }} integration with Datadog, refer to [Monitor CockroachDB Dedicated with Datadog]({% link cockroachcloud/tools-page.md %}#monitor-cockroachdb-dedicated-with-datadog) instead of this page. {{site.data.alerts.end}} The CockroachDB {{ site.data.products.core }} integration with Datadog is powered by the [Datadog Agent](https://app.datadoghq.com/account/settings#agent), and supported by Datadog directly: diff --git a/src/current/v23.2/debezium.md b/src/current/v23.2/debezium.md index d35bca04a5f..b6a77d75a78 100644 --- a/src/current/v23.2/debezium.md +++ b/src/current/v23.2/debezium.md @@ -117,7 +117,7 @@ Once all of the [prerequisite steps](#before-you-begin) are completed, you can u ## 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 %}) - [Change Data Capture Overview]({% link {{ page.version.version }}/change-data-capture-overview.md %}) - [Third-Party Tools Supported by Cockroach Labs]({% link {{ page.version.version }}/third-party-database-tools.md %}) - [Stream a Changefeed to a Confluent Cloud Kafka Cluster]({% link {{ page.version.version }}/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.md %}) diff --git a/src/current/v23.2/delete-data.md b/src/current/v23.2/delete-data.md index 1a056e6685d..8217416ef92 100644 --- a/src/current/v23.2/delete-data.md +++ b/src/current/v23.2/delete-data.md @@ -11,7 +11,7 @@ This page has instructions for deleting rows of data from CockroachDB, using the Before reading this page, do the following: -- [Create a CockroachDB {{ site.data.products.serverless }} 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.serverless }} 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 %}). - [Create a database schema]({% link {{ page.version.version }}/schema-design-overview.md %}). diff --git a/src/current/v23.2/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.md b/src/current/v23.2/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.md index 026a53cfd12..0210883d4ae 100644 --- a/src/current/v23.2/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.md +++ b/src/current/v23.2/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.md @@ -4,7 +4,7 @@ summary: Learn how metrics can differ between third-party monitoring tools that toc: true --- -When using [Third-Party Monitoring Integrations]({% link {{ page.version.version }}/third-party-monitoring-tools.md %}), such as the [metrics export feature](https://www.cockroachlabs.com/docs/cockroachcloud/export-metrics), discrepancies may be seen when comparing those metrics charts to ones found on the [Metrics dashboards]({% link {{ page.version.version }}/ui-overview.md %}#metrics) or [custom charts]({% link {{ page.version.version }}/ui-custom-chart-debug-page.md %}) of the [DB Console]({% link {{ page.version.version }}/ui-overview.md %}). This page explains why these different systems may yield different results. +When using [Third-Party Monitoring Integrations]({% link {{ page.version.version }}/third-party-monitoring-tools.md %}), such as the [metrics export feature]({% link cockroachcloud/export-metrics.md %}), discrepancies may be seen when comparing those metrics charts to ones found on the [Metrics dashboards]({% link {{ page.version.version }}/ui-overview.md %}#metrics) or [custom charts]({% link {{ page.version.version }}/ui-custom-chart-debug-page.md %}) of the [DB Console]({% link {{ page.version.version }}/ui-overview.md %}). This page explains why these different systems may yield different results. ## CockroachDB’s Timeseries Database @@ -33,7 +33,7 @@ Datadog scrapes every 60s | 0 | - | - | - | - | - | 0 Since Cockroach Labs does not own the third-party systems, we can not be expected to have intimate knowledge about how each system’s different query language and timeseries database works. -The [metrics export feature](https://www.cockroachlabs.com/docs/cockroachcloud/export-metrics) scrapes the `/_status/vars` endpoint every 30 seconds, and forwards the data along to the third-party system. The metrics export does no intermediate aggregation, downsampling, or modification of the timeseries values at any point. The raw metrics export data is at a 30-second resolution, but how that data is processed once received by the third party system is unknown to us. +The [metrics export feature]({% link cockroachcloud/export-metrics.md %}) scrapes the `/_status/vars` endpoint every 30 seconds, and forwards the data along to the third-party system. The metrics export does no intermediate aggregation, downsampling, or modification of the timeseries values at any point. The raw metrics export data is at a 30-second resolution, but how that data is processed once received by the third party system is unknown to us. It is within our scope to understand and support our own timeseries database. If you have problems receiving metrics in your third-party system, [our support]({% link {{ page.version.version }}/support-resources.md %}) can help troubleshoot those problems. However, once the data is ingested into the third-party system, please contact your representative at that third-party company to support issues found on those systems. For example, assuming the raw metric data has been ingested as expected, Cockroach Labs does not support writing queries in third-party systems, such as using Datadog's Metrics Explorer or Datadog Query Language (DQL). @@ -43,4 +43,4 @@ It is within our scope to understand and support our own timeseries database. If - [DB Console Overview]({% link {{ page.version.version }}/ui-overview.md %}) - [Third-Party Monitoring Integrations]({% link {{ page.version.version }}/third-party-monitoring-tools.md %}) - [Monitor CockroachDB with Prometheus]({% link {{ page.version.version }}/monitor-cockroachdb-with-prometheus.md %}) -- [Export Metrics From a CockroachDB Dedicated Cluster](https://www.cockroachlabs.com/docs/cockroachcloud/export-metrics) \ No newline at end of file +- [Export Metrics From a CockroachDB Dedicated Cluster]({% link cockroachcloud/export-metrics.md %}) \ No newline at end of file diff --git a/src/current/v23.2/example-apps.md b/src/current/v23.2/example-apps.md index e410f1a6ade..bea3cfd1876 100644 --- a/src/current/v23.2/example-apps.md +++ b/src/current/v23.2/example-apps.md @@ -52,7 +52,7 @@ Note that tools with [**community-level** support]({% link {{ page.version.versi | Driver/ORM Framework | Support level | Example apps | |--------------------------------------------+----------------+--------------------------------------------------------| -| [JDBC](https://jdbc.postgresql.org/) | Full | [Quickstart](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart)
[Simple CRUD]({% link {{ page.version.version }}/build-a-java-app-with-cockroachdb.md %})
[Roach Data (Spring Boot App)](build-a-spring-app-with-cockroachdb-jdbc.html) +| [JDBC](https://jdbc.postgresql.org/) | Full | [Quickstart]({% link cockroachcloud/quickstart.md %})
[Simple CRUD]({% link {{ page.version.version }}/build-a-java-app-with-cockroachdb.md %})
[Roach Data (Spring Boot App)](build-a-spring-app-with-cockroachdb-jdbc.html) | [Hibernate](https://hibernate.org/orm/) | Full | [Simple CRUD]({% link {{ page.version.version }}/build-a-java-app-with-cockroachdb-hibernate.md %})
[Roach Data (Spring Boot App)](build-a-spring-app-with-cockroachdb-jpa.html) | [jOOQ](https://www.jooq.org/) | Full | [Simple CRUD]({% link {{ page.version.version }}/build-a-java-app-with-cockroachdb-jooq.md %}) diff --git a/src/current/v23.2/explain-analyze.md b/src/current/v23.2/explain-analyze.md index 4411d277091..ccbc86e4faa 100644 --- a/src/current/v23.2/explain-analyze.md +++ b/src/current/v23.2/explain-analyze.md @@ -76,7 +76,7 @@ Property | Description `sql cpu time` | The total amount of time spent in the [SQL layer]({% link {{ page.version.version }}/architecture/sql-layer.md %}). It does not include time spent in the [storage layer]({% link {{ page.version.version }}/architecture/storage-layer.md %}). `regions` | The [regions]({% link {{ page.version.version }}/show-regions.md %}) 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)](https://www.cockroachlabs.com/docs/cockroachcloud/plan-your-cluster-serverless#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)]({% link cockroachcloud/plan-your-cluster-serverless.md %}#request-units) consumed by the statement. This property is visible only on CockroachDB {{ site.data.products.serverless }} clusters. ### Statement plan tree properties diff --git a/src/current/v23.2/frequently-asked-questions.md b/src/current/v23.2/frequently-asked-questions.md index 8e373452d0c..037cee8d658 100644 --- a/src/current/v23.2/frequently-asked-questions.md +++ b/src/current/v23.2/frequently-asked-questions.md @@ -28,7 +28,7 @@ CockroachDB returns single-row reads in 2ms or less and single-row writes in 4ms ### How easy is it to get started with CockroachDB? -You can get started with CockroachDB with just a few clicks. Sign up for a CockroachDB {{ site.data.products.cloud }} account to create a free CockroachDB {{ site.data.products.serverless }} cluster. For more details, see [Quickstart](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart). +You can get started with CockroachDB with just a few clicks. Sign up for a CockroachDB {{ site.data.products.cloud }} account to create a free CockroachDB {{ site.data.products.serverless }} cluster. For more details, see [Quickstart]({% link cockroachcloud/quickstart.md %}). Alternatively, you can download a binary or run our official Kubernetes configurations or Docker image. For more details, see [Install CockroachDB]({% link {{ page.version.version }}/install-cockroachdb.md %}). @@ -54,7 +54,7 @@ When your cluster spans multiple nodes (physical machines, virtual machines, or For more information about scaling a CockroachDB cluster, see the following docs: -- [Plan Your Serverless Cluster - Cluster scaling](https://www.cockroachlabs.com/docs/cockroachcloud/plan-your-cluster#cluster-scaling) +- [Plan Your Serverless Cluster - Cluster scaling]({% link cockroachcloud/plan-your-cluster.md %}#cluster-scaling) - [Manage Your Dedicated Cluster - Scale your cluster](https://www.cockroachlabs.com/docs/cockroachcloud/plan-your-cluster?filters=dedicated#cluster-scaling) - [`cockroach start` - Add a node to a cluster]({% link {{ page.version.version }}/cockroach-start.md %}#add-a-node-to-a-cluster) diff --git a/src/current/v23.2/goldengate.md b/src/current/v23.2/goldengate.md index 949d4878df8..b6a6ea43599 100644 --- a/src/current/v23.2/goldengate.md +++ b/src/current/v23.2/goldengate.md @@ -515,6 +515,6 @@ Run the steps in this section on a machine and in a directory where Oracle Golde ## 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 %}) - [Change Data Capture Overview]({% link {{ page.version.version }}/change-data-capture-overview.md %}) - [Third-Party Tools Supported by Cockroach Labs]({% link {{ page.version.version }}/third-party-database-tools.md %}) diff --git a/src/current/v23.2/hashicorp-integration.md b/src/current/v23.2/hashicorp-integration.md index a1eb1ddc438..f9ba0e07cdd 100644 --- a/src/current/v23.2/hashicorp-integration.md +++ b/src/current/v23.2/hashicorp-integration.md @@ -28,10 +28,10 @@ CockroachDB customers can integrate these services, using Vault's KMS secrets en Resources: -- [CMEK overview](https://www.cockroachlabs.com/docs/cockroachcloud/cmek) -- [Manage Customer-Managed Encryption Keys (CMEK) for CockroachDB Dedicated](https://www.cockroachlabs.com/docs/cockroachcloud/managing-cmek) -- [Provisioning GCP KMS Keys and Service Accounts for CMEK](https://www.cockroachlabs.com/docs/cockroachcloud/cmek-ops-gcp) -- [Provisioning AWS KMS Keys and IAM Roles for CMEK](https://www.cockroachlabs.com/docs/cockroachcloud/cmek-ops-aws) +- [CMEK overview]({% link cockroachcloud/cmek.md %}) +- [Manage Customer-Managed Encryption Keys (CMEK) for CockroachDB Dedicated]({% link cockroachcloud/managing-cmek.md %}) +- [Provisioning GCP KMS Keys and Service Accounts for CMEK]({% link cockroachcloud/cmek-ops-gcp.md %}) +- [Provisioning AWS KMS Keys and IAM Roles for CMEK]({% link cockroachcloud/cmek-ops-aws.md %}) ## Use Vault's PKI Secrets Engine to manage a CockroachDB {{ site.data.products.dedicated }} cluster's certificate authority (CA) and client certificates. @@ -41,7 +41,7 @@ By using Vault to manage certificates, you can use only certificates with short Refer to [Transport Layer Security (TLS) and Public Key Infrastructure (PKI)]({% link {{ page.version.version }}/security-reference/transport-layer-security.md %}) for an overview. -Refer to [Certificate Authentication for SQL Clients in CockroachDB Dedicated Clusters](https://www.cockroachlabs.com/docs/cockroachcloud/client-certs-dedicated) for procedures in involved in administering PKI for a CockroachDB {{ site.data.products.dedicated }} cluster. +Refer to [Certificate Authentication for SQL Clients in CockroachDB Dedicated Clusters]({% link cockroachcloud/client-certs-dedicated.md %}) for procedures in involved in administering PKI for a CockroachDB {{ site.data.products.dedicated }} cluster. ## Use Vault's PKI Secrets Engine to manage a CockroachDB {{ site.data.products.core }} cluster's certificate authority (CA), server, and client certificates @@ -75,12 +75,12 @@ Vault's [Transit Secrets Engine](https://www.vaultproject.io/docs/secrets/transi ## See also -- [CMEK overview](https://www.cockroachlabs.com/docs/cockroachcloud/cmek) -- [Manage Customer-Managed Encryption Keys (CMEK) for CockroachDB Dedicated](https://www.cockroachlabs.com/docs/cockroachcloud/managing-cmek) -- [Provisioning GCP KMS Keys and Service Accounts for CMEK](https://www.cockroachlabs.com/docs/cockroachcloud/cmek-ops-gcp) -- [Provisioning AWS KMS Keys and IAM Roles for CMEK](https://www.cockroachlabs.com/docs/cockroachcloud/cmek-ops-aws) +- [CMEK overview]({% link cockroachcloud/cmek.md %}) +- [Manage Customer-Managed Encryption Keys (CMEK) for CockroachDB Dedicated]({% link cockroachcloud/managing-cmek.md %}) +- [Provisioning GCP KMS Keys and Service Accounts for CMEK]({% link cockroachcloud/cmek-ops-gcp.md %}) +- [Provisioning AWS KMS Keys and IAM Roles for CMEK]({% link cockroachcloud/cmek-ops-aws.md %}) - [Transport Layer Security (TLS) and Public Key Infrastructure (PKI)]({% link {{ page.version.version }}/security-reference/transport-layer-security.md %}) -- [Certificate Authentication for SQL Clients in Dedicated Clusters](https://www.cockroachlabs.com/docs/cockroachcloud/client-certs-dedicated) +- [Certificate Authentication for SQL Clients in Dedicated Clusters]({% link cockroachcloud/client-certs-dedicated.md %}) - [Manage PKI certificates for a CockroachDB deployment with HashiCorp Vault]({% link {{ page.version.version }}/manage-certs-vault.md %}) - [Using HashiCorp Vault's Dynamic Secrets for Enhanced Database Credential Security in CockroachDB]({% link {{ page.version.version }}/vault-db-secrets-tutorial.md %}) - [Roles]({% link {{ page.version.version }}/security-reference/authorization.md %}#roles) diff --git a/src/current/v23.2/hasura-getting-started.md b/src/current/v23.2/hasura-getting-started.md index 7e129c9404c..6a79da9345f 100644 --- a/src/current/v23.2/hasura-getting-started.md +++ b/src/current/v23.2/hasura-getting-started.md @@ -21,7 +21,7 @@ This tutorial will show you how to configure a Hasura project with a CockroachDB Before you start this tutorial, you need: -- An existing [CockroachDB Cloud](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart) cluster, running CockroachDB v22.2 or later. +- An existing [CockroachDB Cloud]({% link cockroachcloud/quickstart.md %}) cluster, running CockroachDB v22.2 or later. - A [Hasura Cloud account](https://hasura.io/docs/latest/getting-started/getting-started-cloud/). ## Configure your cluster @@ -46,7 +46,7 @@ Before you start this tutorial, you need:
1. In the [CockroachDB Cloud console](https://cockroachlabs.cloud/clusters), select your cluster and click **Connect**. -1. If you have not set up [IP Allowlists](https://www.cockroachlabs.com/docs/cockroachcloud/network-authorization#ip-allowlisting) under **Network Security**, follow the instructions to add connections to your cluster from your machine. +1. If you have not set up [IP Allowlists]({% link cockroachcloud/network-authorization.md %}#ip-allowlisting) under **Network Security**, follow the instructions to add connections to your cluster from your machine. 1. Select the SQL user you want to use for the Hasura Cloud connection under **Select SQL user**. If you have not set up a SQL user for this cluster, follow the instructions to create a new SQL user. Be sure to copy and save the password to a secure location. 1. Select **General connection String**. 1. Copy the connection string under **General connection string** and paste it in a secure location. You will use this connection string later to configure Hasura GraphQL Engine with your cluster. @@ -146,7 +146,7 @@ Create a `CRDB_URL` environment variable to store the connection string. ## Add the Hasura Cloud network to your cluster allowlist -Your CockroachDB {{ site.data.products.dedicated }} cluster needs to be configured to [allow incoming client connections](https://www.cockroachlabs.com/docs/cockroachcloud/network-authorization#ip-allowlisting) from Hasura Cloud. +Your CockroachDB {{ site.data.products.dedicated }} cluster needs to be configured to [allow incoming client connections]({% link cockroachcloud/network-authorization.md %}#ip-allowlisting) from Hasura Cloud. 1. In the Hasura Cloud overview page select **Projects**, then click the **Config** icon for your project. diff --git a/src/current/v23.2/import-performance-best-practices.md b/src/current/v23.2/import-performance-best-practices.md index 45f12615eda..f141d56f139 100644 --- a/src/current/v23.2/import-performance-best-practices.md +++ b/src/current/v23.2/import-performance-best-practices.md @@ -37,7 +37,7 @@ When importing into a new table, split your dump data into two files: 1. A SQL file containing the table schema. 1. A CSV, delimited, or AVRO file containing the table data. -Convert the schema-only file using the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page). The Schema Conversion Tool automatically creates a new CockroachDB {{ site.data.products.serverless }} database with the converted schema. {% include cockroachcloud/migration/sct-self-hosted.md %} +Convert the schema-only file using the [Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}). The Schema Conversion Tool automatically creates a new CockroachDB {{ site.data.products.serverless }} database with the converted schema. {% include cockroachcloud/migration/sct-self-hosted.md %} Then use the [`IMPORT INTO`](import-into.html) statement to import the CSV data into the newly created table: diff --git a/src/current/v23.2/insert-data.md b/src/current/v23.2/insert-data.md index 5d74334c0dc..52d9b675787 100644 --- a/src/current/v23.2/insert-data.md +++ b/src/current/v23.2/insert-data.md @@ -11,7 +11,7 @@ This page has instructions for getting data into CockroachDB with various progra Before reading this page, do the following: -- [Create a CockroachDB {{ site.data.products.serverless }} 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.serverless }} 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 %}). diff --git a/src/current/v23.2/kibana.md b/src/current/v23.2/kibana.md index 1e3766117ca..9d69127c5bf 100644 --- a/src/current/v23.2/kibana.md +++ b/src/current/v23.2/kibana.md @@ -8,7 +8,7 @@ docs_area: manage [Kibana](https://www.elastic.co/kibana/) is a platform that visualizes data on the [Elastic Stack](https://www.elastic.co/elastic-stack/). This page shows how to use the [CockroachDB module for Metricbeat](https://www.elastic.co/guide/en/beats/metricbeat/current/metricbeat-module-cockroachdb.html) to collect metrics exposed by your CockroachDB {{ site.data.products.core }} cluster's [Prometheus endpoint]({% link {{ page.version.version }}/monitoring-and-alerting.md %}#prometheus-endpoint) in Elasticsearch and how to visualize those metrics with Kibana. {{site.data.alerts.callout_success}} -To export metrics from a CockroachDB {{ site.data.products.cloud }} cluster, refer to [Export Metrics From a CockroachDB {{ site.data.products.dedicated }} Cluster](https://www.cockroachlabs.com/docs/cockroachcloud/export-metrics) instead of this page. +To export metrics from a CockroachDB {{ site.data.products.cloud }} cluster, refer to [Export Metrics From a CockroachDB {{ site.data.products.dedicated }} Cluster]({% link cockroachcloud/export-metrics.md %}) instead of this page. {{site.data.alerts.end}} In this tutorial, you will enable the CockroachDB module for Metricbeat and visualize the data in Kibana. diff --git a/src/current/v23.2/learn-cockroachdb-sql.md b/src/current/v23.2/learn-cockroachdb-sql.md index e5737403d19..e513ef15542 100644 --- a/src/current/v23.2/learn-cockroachdb-sql.md +++ b/src/current/v23.2/learn-cockroachdb-sql.md @@ -10,7 +10,7 @@ This tutorial guides you through some of the most essential CockroachDB SQL stat For a complete list of supported SQL statements and related details, see [SQL Statements]({% link {{ page.version.version }}/sql-statements.md %}). {{site.data.alerts.callout_info}} -This tutorial is for {{site.data.products.core}} users. If you are working with {{site.data.products.dedicated}} or {{site.data.products.serverless}}, you can run this tutorial against [a cluster running in the cloud](https://www.cockroachlabs.com/docs/cockroachcloud/learn-cockroachdb-sql). +This tutorial is for {{site.data.products.core}} users. If you are working with {{site.data.products.dedicated}} or {{site.data.products.serverless}}, you can run this tutorial against [a cluster running in the cloud]({% link cockroachcloud/learn-cockroachdb-sql.md %}). {{site.data.alerts.end}} ## Start CockroachDB diff --git a/src/current/v23.2/migrate-from-mysql.md b/src/current/v23.2/migrate-from-mysql.md index 2a1adcde9a2..b93b79b75ff 100644 --- a/src/current/v23.2/migrate-from-mysql.md +++ b/src/current/v23.2/migrate-from-mysql.md @@ -105,7 +105,7 @@ The example uses the [MySQL `world` data set](https://dev.mysql.com/doc/index-ot mysqlsh -uroot --sql --file {path}/world-db/world.sql ~~~ -1. Create a free [{{ site.data.products.cloud }} account](https://www.cockroachlabs.com/docs/cockroachcloud/create-an-account), which is used to access the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page?filters=mysql) and create the {{ site.data.products.serverless }} cluster. +1. Create a free [{{ site.data.products.cloud }} account]({% link cockroachcloud/create-an-account.md %}), which is used to access the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page?filters=mysql) and create the {{ site.data.products.serverless }} cluster. {{site.data.alerts.callout_success}} {% include cockroachcloud/migration/sct-self-hosted.md %} @@ -162,7 +162,7 @@ Use the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachclo 1. Click [**Migrate Schema**](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page?filters=mysql#migrate-the-schema) to create a new {{ site.data.products.serverless }} cluster with the converted schema. Name the database `world`. - You can view this database on the [**Databases** page](https://www.cockroachlabs.com/docs/cockroachcloud/databases-page) of the {{ site.data.products.cloud }} Console. + You can view this database on the [**Databases** page]({% link cockroachcloud/databases-page.md %}) of the {{ site.data.products.cloud }} Console. 1. Open a SQL shell to the CockroachDB `world` cluster. To find the command, open the **Connect** dialog in the {{ site.data.products.cloud }} Console and select the `world` database and **CockroachDB Client** option. It will look like: @@ -402,7 +402,7 @@ To learn more, see the [Migration Overview]({% link {{ page.version.version }}/m ## See also - [Migration Overview]({% link {{ page.version.version }}/migration-overview.md %}) -- [Use the Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) +- [Use the Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) - [Use the MOLT Verify tool]({% link molt/molt-verify.md %}) - [Import Performance Best Practices]({% link {{ page.version.version }}/import-performance-best-practices.md %}) - [Migrate from CSV]({% link {{ page.version.version }}/migrate-from-csv.md %}) diff --git a/src/current/v23.2/migrate-from-postgres.md b/src/current/v23.2/migrate-from-postgres.md index 8d35c7c7dd4..2f142eaeaca 100644 --- a/src/current/v23.2/migrate-from-postgres.md +++ b/src/current/v23.2/migrate-from-postgres.md @@ -70,7 +70,7 @@ The example uses a modified version of the PostgreSQL `french-towns-communes-fra psql frenchtowns -a -f frenchtowns.sql ~~~ -1. Create a free [{{ site.data.products.cloud }} account](https://www.cockroachlabs.com/docs/cockroachcloud/create-an-account), which is used to access the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) and create the {{ site.data.products.serverless }} cluster. +1. Create a free [{{ site.data.products.cloud }} account]({% link cockroachcloud/create-an-account.md %}), which is used to access the [Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) and create the {{ site.data.products.serverless }} cluster. {{site.data.alerts.callout_success}} {% include cockroachcloud/migration/sct-self-hosted.md %} @@ -78,7 +78,7 @@ The example uses a modified version of the PostgreSQL `french-towns-communes-fra ### Step 1. Convert the PostgreSQL schema -Use the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) to convert the `frenchtowns` schema for compatibility with CockroachDB. The schema has three tables: `regions`, `departments`, and `towns`. +Use the [Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) to convert the `frenchtowns` schema for compatibility with CockroachDB. The schema has three tables: `regions`, `departments`, and `towns`. 1. Dump the PostgreSQL `frenchtowns` schema with the following [`pg_dump`](https://www.postgresql.org/docs/15/app-pgdump.html) command: @@ -87,12 +87,12 @@ Use the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachclo pg_dump --schema-only frenchtowns > frenchtowns_schema.sql ~~~ -1. Open the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) in the {{ site.data.products.cloud }} Console and [add a new PostgreSQL schema](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page#convert-a-schema). +1. Open the [Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) in the {{ site.data.products.cloud }} Console and [add a new PostgreSQL schema]({% link cockroachcloud/migrations-page.md %}#convert-a-schema). - After conversion is complete, [review the results](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page#review-the-schema). The [**Summary Report**](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page#summary-report) shows that there are errors under **Required Fixes**. You must resolve these in order to migrate the schema to CockroachDB. + After conversion is complete, [review the results]({% link cockroachcloud/migrations-page.md %}#review-the-schema). The [**Summary Report**]({% link cockroachcloud/migrations-page.md %}#summary-report) shows that there are errors under **Required Fixes**. You must resolve these in order to migrate the schema to CockroachDB. {{site.data.alerts.callout_success}} - You can also [add your PostgreSQL database credentials](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page#use-credentials) to have the Schema Conversion Tool obtain the schema directly from the PostgreSQL database. + You can also [add your PostgreSQL database credentials]({% link cockroachcloud/migrations-page.md %}#use-credentials) to have the Schema Conversion Tool obtain the schema directly from the PostgreSQL database. {{site.data.alerts.end}} 1. `Missing user: postgres` errors indicate that the SQL user `postgres` is missing from CockroachDB. Click **Add User** to create the user. @@ -107,9 +107,9 @@ Use the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachclo This example migrates directly to a {{ site.data.products.serverless }} cluster. {% include cockroachcloud/migration/sct-self-hosted.md %} -1. Click [**Migrate Schema**](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page#migrate-the-schema) to create a new {{ site.data.products.serverless }} cluster with the converted schema. Name the database `frenchtowns`. +1. Click [**Migrate Schema**]({% link cockroachcloud/migrations-page.md %}#migrate-the-schema) to create a new {{ site.data.products.serverless }} cluster with the converted schema. Name the database `frenchtowns`. - You can view this database on the [**Databases** page](https://www.cockroachlabs.com/docs/cockroachcloud/databases-page) of the {{ site.data.products.cloud }} Console. + You can view this database on the [**Databases** page]({% link cockroachcloud/databases-page.md %}) of the {{ site.data.products.cloud }} Console. ### Step 2. Load the PostgreSQL data @@ -287,7 +287,7 @@ To learn more, see the [Migration Overview]({% link {{ page.version.version }}/m ## See also - [Migration Overview]({% link {{ page.version.version }}/migration-overview.md %}) -- [Use the Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) +- [Use the Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) - [Use the MOLT Verify tool]({% link molt/molt-verify.md %}) - [Import Performance Best Practices]({% link {{ page.version.version }}/import-performance-best-practices.md %}) - [Migrate from CSV]({% link {{ page.version.version }}/migrate-from-csv.md %}) diff --git a/src/current/v23.2/migration-overview.md b/src/current/v23.2/migration-overview.md index 4b8718dc76e..92405f6cd05 100644 --- a/src/current/v23.2/migration-overview.md +++ b/src/current/v23.2/migration-overview.md @@ -8,7 +8,7 @@ docs_area: migrate This page provides an overview of how to migrate a database to CockroachDB. {{site.data.alerts.callout_info}} -If you need to migrate data from a CockroachDB {{ site.data.products.serverless }} cluster to a CockroachDB {{ site.data.products.dedicated }} cluster, see [Migrate data from Serverless to Dedicated](https://www.cockroachlabs.com/docs/cockroachcloud/migrate-from-serverless-to-dedicated). +If you need to migrate data from a CockroachDB {{ site.data.products.serverless }} cluster to a CockroachDB {{ site.data.products.dedicated }} cluster, see [Migrate data from Serverless to Dedicated]({% link cockroachcloud/migrate-from-serverless-to-dedicated.md %}). {{site.data.alerts.end}} A database migration broadly consists of the following phases: @@ -117,11 +117,11 @@ Determine the size of the target CockroachDB cluster. To do this, consider your - What is the total size of the data you will migrate? - How many active [application connections]({% link {{ page.version.version }}/recommended-production-settings.md %}#connection-pooling) will be running in the CockroachDB environment? -Use this information to size the CockroachDB cluster you will create. If you are migrating to a CockroachDB {{ site.data.products.cloud }} cluster, see [Plan Your Cluster](https://www.cockroachlabs.com/docs/cockroachcloud/plan-your-cluster) for details: +Use this information to size the CockroachDB cluster you will create. If you are migrating to a CockroachDB {{ site.data.products.cloud }} cluster, see [Plan Your Cluster]({% link cockroachcloud/plan-your-cluster.md %}) for details: -- For CockroachDB {{ site.data.products.dedicated }}, refer to the [example](https://www.cockroachlabs.com/docs/cockroachcloud/plan-your-cluster#dedicated-example) that shows how your data volume, storage requirements, and replication factor affect the recommended node size (number of vCPUs per node) and total number of nodes on the cluster. -- For CockroachDB {{ site.data.products.serverless }}, your cluster will scale automatically to meet your storage and usage requirements. Refer to [Choosing resource limits](https://www.cockroachlabs.com/docs/cockroachcloud/plan-your-cluster-serverless#choose-resource-limits) to learn about how to limit your resource consumption. -- For guidance on sizing for connection pools, see the CockroachDB {{ site.data.products.cloud }} [Production Checklist](https://www.cockroachlabs.com/docs/cockroachcloud/production-checklist#use-a-pool-of-persistent-connections). +- For CockroachDB {{ site.data.products.dedicated }}, refer to the [example]({% link cockroachcloud/plan-your-cluster.md %}#dedicated-example) that shows how your data volume, storage requirements, and replication factor affect the recommended node size (number of vCPUs per node) and total number of nodes on the cluster. +- For CockroachDB {{ site.data.products.serverless }}, your cluster will scale automatically to meet your storage and usage requirements. Refer to [Choosing resource limits]({% link cockroachcloud/plan-your-cluster-serverless.md %}#choose-resource-limits) to learn about how to limit your resource consumption. +- For guidance on sizing for connection pools, see the CockroachDB {{ site.data.products.cloud }} [Production Checklist]({% link cockroachcloud/production-checklist.md %}#connection-pooling). If you are migrating to a CockroachDB {{ site.data.products.core }} cluster: @@ -143,7 +143,7 @@ As you develop your migration plan, consider the application changes that you wi Follow these recommendations when [converting your schema](#convert-the-schema) for compatibility with CockroachDB. {{site.data.alerts.callout_success}} -The [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) automatically identifies potential improvements to your schema. +The [Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) automatically identifies potential improvements to your schema. {{site.data.alerts.end}} - You should define an explicit primary key on every table. For more information, see [Primary key best practices]({% link {{ page.version.version }}/schema-design-table.md %}#primary-key-best-practices). @@ -169,7 +169,7 @@ Transaction retry errors are more frequent under CockroachDB's default [`SERIALI Update your queries to resolve differences in functionality and SQL syntax. {{site.data.alerts.callout_success}} -The [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) automatically flags syntax incompatibilities and unimplemented features in your schema. +The [Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) automatically flags syntax incompatibilities and unimplemented features in your schema. {{site.data.alerts.end}} CockroachDB supports the [PostgreSQL wire protocol](https://www.postgresql.org/docs/current/protocol.html) and is largely compatible with PostgreSQL syntax. However, the following PostgreSQL features do not yet exist in CockroachDB: @@ -217,7 +217,7 @@ In the following order: You can use the following [MOLT (Migrate Off Legacy Technology) tools]({% link molt/molt-overview.md %}) to simplify these steps: -- [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) +- [Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) - [MOLT Fetch]({% link molt/molt-fetch.md %}) - [MOLT Verify]({% link molt/molt-verify.md %}) @@ -225,17 +225,17 @@ You can use the following [MOLT (Migrate Off Legacy Technology) tools]({% link m First, convert your database schema to an equivalent CockroachDB schema: -- Use the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) to convert your schema line-by-line. This requires a free [CockroachDB {{ site.data.products.cloud }} account](https://www.cockroachlabs.com/docs/cockroachcloud/create-an-account). The tool will convert the syntax, identify [unimplemented features and syntax incompatibilities](#unimplemented-features-and-syntax-incompatibilities) in the schema, and suggest edits according to CockroachDB [best practices](#schema-design-best-practices). +- Use the [Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) to convert your schema line-by-line. This requires a free [CockroachDB {{ site.data.products.cloud }} account]({% link cockroachcloud/create-an-account.md %}). The tool will convert the syntax, identify [unimplemented features and syntax incompatibilities](#unimplemented-features-and-syntax-incompatibilities) in the schema, and suggest edits according to CockroachDB [best practices](#schema-design-best-practices). {{site.data.alerts.callout_info}} The Schema Conversion Tool accepts `.sql` files from PostgreSQL, MySQL, Oracle, and Microsoft SQL Server. {{site.data.alerts.end}} -- Alternatively, manually convert the schema according to our [schema design best practices](#schema-design-best-practices){% comment %}and data type mappings{% endcomment %}. You can also [export a partially converted schema](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page#export-the-schema) from the Schema Conversion Tool to finish the conversion manually. +- Alternatively, manually convert the schema according to our [schema design best practices](#schema-design-best-practices){% comment %}and data type mappings{% endcomment %}. You can also [export a partially converted schema]({% link cockroachcloud/migrations-page.md %}#export-the-schema) from the Schema Conversion Tool to finish the conversion manually. Then import the converted schema to a CockroachDB cluster: -- For CockroachDB {{ site.data.products.cloud }}, use the Schema Conversion Tool to [migrate the converted schema to a new {{ site.data.products.serverless }} or {{ site.data.products.dedicated }} database](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page#migrate-the-schema). -- For CockroachDB {{ site.data.products.core }}, pipe the [data definition language (DDL)]({% link {{ page.version.version }}/sql-statements.md %}#data-definition-statements) directly into [`cockroach sql`]({% link {{ page.version.version }}/cockroach-sql.md %}). You can [export a converted schema file](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page#export-the-schema) from the Schema Conversion Tool. +- For CockroachDB {{ site.data.products.cloud }}, use the Schema Conversion Tool to [migrate the converted schema to a new {{ site.data.products.serverless }} or {{ site.data.products.dedicated }} database]({% link cockroachcloud/migrations-page.md %}#migrate-the-schema). +- For CockroachDB {{ site.data.products.core }}, pipe the [data definition language (DDL)]({% link {{ page.version.version }}/sql-statements.md %}#data-definition-statements) directly into [`cockroach sql`]({% link {{ page.version.version }}/cockroach-sql.md %}). You can [export a converted schema file]({% link cockroachcloud/migrations-page.md %}#export-the-schema) from the Schema Conversion Tool. {{site.data.alerts.callout_success}} For the fastest performance, you can use a [local, single-node CockroachDB cluster]({% link {{ page.version.version }}/cockroach-start-single-node.md %}#start-a-single-node-cluster) to convert your schema and [check the results of queries](#test-query-results-and-performance). {{site.data.alerts.end}} @@ -268,7 +268,7 @@ You can "shadow" your production workload by executing your source SQL statement You can manually validate your queries by testing a subset of "critical queries" on an otherwise idle CockroachDB cluster: -- Check the application logs for error messages and the API response time. If application requests are slower than expected, use the **SQL Activity** page on the [CockroachDB {{ site.data.products.cloud }} Console](https://www.cockroachlabs.com/docs/cockroachcloud/statements-page) or [DB Console]({% link {{ page.version.version }}/ui-statements-page.md %}) to find the longest-running queries that are part of that application request. If necessary, tune the queries according to our best practices for [SQL performance]({% link {{ page.version.version }}/performance-best-practices-overview.md %}). +- Check the application logs for error messages and the API response time. If application requests are slower than expected, use the **SQL Activity** page on the [CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/statements-page.md %}) or [DB Console]({% link {{ page.version.version }}/ui-statements-page.md %}) to find the longest-running queries that are part of that application request. If necessary, tune the queries according to our best practices for [SQL performance]({% link {{ page.version.version }}/performance-best-practices-overview.md %}). - Compare the results of the queries and check that they are identical in both the source database and CockroachDB. To do this, you can use [MOLT Verify]({% link molt/molt-verify.md %}). @@ -350,7 +350,7 @@ After you have successfully [conducted the migration](#conduct-the-migration): - [Can a PostgreSQL or MySQL application be migrated to CockroachDB?]({% link {{ page.version.version }}/frequently-asked-questions.md %}#can-a-postgresql-or-mysql-application-be-migrated-to-cockroachdb) - [PostgreSQL Compatibility]({% link {{ page.version.version }}/postgresql-compatibility.md %}) -- [Use the Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) +- [Use the Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) - [Schema Design Overview]({% link {{ page.version.version }}/schema-design-overview.md %}) - [Create a User-defined Schema]({% link {{ page.version.version }}/schema-design-schema.md %}) - [Primary key best practices]({% link {{ page.version.version }}/schema-design-table.md %}#primary-key-best-practices) diff --git a/src/current/v23.2/migration-strategy-lift-and-shift.md b/src/current/v23.2/migration-strategy-lift-and-shift.md index 8c7404f84c8..7417b4c7b3c 100644 --- a/src/current/v23.2/migration-strategy-lift-and-shift.md +++ b/src/current/v23.2/migration-strategy-lift-and-shift.md @@ -72,7 +72,7 @@ It's important to decide which data formats, storage media, and database feature Data formats that can be imported by CockroachDB include: -- [SQL]({% link {{ page.version.version }}/schema-design-overview.md %}) for the [schema import](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page). +- [SQL]({% link {{ page.version.version }}/schema-design-overview.md %}) for the [schema import]({% link cockroachcloud/migrations-page.md %}). - [CSV]({% link {{ page.version.version }}/migrate-from-csv.md %}) for table data. - [Avro]({% link {{ page.version.version }}/migrate-from-avro.md %}) for table data. @@ -121,7 +121,7 @@ For more information about import performance, see [Import Performance Best Prac ## See also - [Migration Overview]({% link {{ page.version.version }}/migration-overview.md %}) -- [Use the Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) +- [Use the Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) - [Migrate with AWS Database Migration Service (DMS)]({% link {{ page.version.version }}/aws-dms.md %}) - [AWS DMS documentation](https://docs.aws.amazon.com/dms/latest/userguide/Welcome.html) - [Migrate and Replicate Data with Qlik Replicate]({% link {{ page.version.version }}/qlik.md %}) diff --git a/src/current/v23.2/monitoring-and-alerting.md b/src/current/v23.2/monitoring-and-alerting.md index f7e506a62fd..513ec1e1c80 100644 --- a/src/current/v23.2/monitoring-and-alerting.md +++ b/src/current/v23.2/monitoring-and-alerting.md @@ -7,7 +7,7 @@ docs_area: manage In addition to CockroachDB's [built-in safeguards against failure]({% link {{ page.version.version }}/frequently-asked-questions.md %}#how-does-cockroachdb-survive-failures), it is critical to actively monitor the overall health and performance of a cluster running in production and to create alerting rules that promptly send notifications when there are events that require investigation or intervention. -This page describes the monitoring and observability tools that are built into CockroachDB {{ site.data.products.core }} and shows how to collect your cluster's metrics using external tools like Prometheus's AlertManager for event-based alerting. To export metrics from a CockroachDB {{ site.data.products.cloud }} cluster, refer to [Export Metrics From a CockroachDB {{ site.data.products.dedicated }} Cluster](https://www.cockroachlabs.com/docs/cockroachcloud/export-metrics) instead of this page. For more details, refer to: +This page describes the monitoring and observability tools that are built into CockroachDB {{ site.data.products.core }} and shows how to collect your cluster's metrics using external tools like Prometheus's AlertManager for event-based alerting. To export metrics from a CockroachDB {{ site.data.products.cloud }} cluster, refer to [Export Metrics From a CockroachDB {{ site.data.products.dedicated }} Cluster]({% link cockroachcloud/export-metrics.md %}) instead of this page. For more details, refer to: - [Monitor CockroachDB with Prometheus]({% link {{ page.version.version }}/monitor-cockroachdb-with-prometheus.md %}) - [Third-party Monitoring Tools]({% link {{ page.version.version }}/third-party-monitoring-tools.md %}) diff --git a/src/current/v23.2/movr-flask-deployment.md b/src/current/v23.2/movr-flask-deployment.md index 0ddb93896eb..2ce85089d43 100644 --- a/src/current/v23.2/movr-flask-deployment.md +++ b/src/current/v23.2/movr-flask-deployment.md @@ -21,7 +21,7 @@ In addition to the requirements listed in [Setting Up a Virtual Environment for ## Multi-region database deployment -In production, you want to start a secure CockroachDB cluster, with nodes on machines located in different areas of the world. To deploy CockroachDB in multiple regions, we recommend using [CockroachDB {{ site.data.products.dedicated }}](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart). +In production, you want to start a secure CockroachDB cluster, with nodes on machines located in different areas of the world. To deploy CockroachDB in multiple regions, we recommend using [CockroachDB {{ site.data.products.dedicated }}]({% link cockroachcloud/quickstart.md %}). {{site.data.alerts.callout_info}} You can also deploy CockroachDB manually. For instructions, see the [Manual Deployment]({% link {{ page.version.version }}/manual-deployment.md %}) page of the Cockroach Labs documentation site. @@ -235,7 +235,7 @@ Some time after you have deployed your application, you will likely need to push ## See also {% comment %} [MovR (live demo)](https://movr.cloud){% endcomment %} -- [CockroachDB {{ site.data.products.cloud }} documentation](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart) +- [CockroachDB {{ site.data.products.cloud }} documentation]({% link cockroachcloud/quickstart.md %}) - [Google Cloud Platform documentation](https://cloud.google.com/docs/) - [Docker documentation](https://docs.docker.com/) - [Kubernetes documentation](https://kubernetes.io/docs/home/) diff --git a/src/current/v23.2/multiregion-scale-application.md b/src/current/v23.2/multiregion-scale-application.md index 58ebda2d048..ccf9f2282f1 100644 --- a/src/current/v23.2/multiregion-scale-application.md +++ b/src/current/v23.2/multiregion-scale-application.md @@ -42,7 +42,7 @@ Scale the cluster by adding nodes to the cluster in new regions. For instructions on adding nodes to an existing cluster, see one of the following pages: -- For managed CockroachDB {{ site.data.products.cloud }} deployments, see [Cluster Management](https://www.cockroachlabs.com/docs/cockroachcloud/cluster-management). +- For managed CockroachDB {{ site.data.products.cloud }} deployments, see [Cluster Management]({% link cockroachcloud/cluster-management.md %}). - For orchestrated deployments, see [Orchestrate CockroachDB Across Multiple Kubernetes Clusters]({% link {{ page.version.version }}/orchestrate-cockroachdb-with-kubernetes-multi-cluster.md %}). - For manual deployments, see [`cockroach start`]({% link {{ page.version.version }}/cockroach-start.md %}) and [Manual Deployment]({% link {{ page.version.version }}/manual-deployment.md %}). @@ -68,7 +68,7 @@ Scaling application deployments in multiple regions can greatly improve latency For guidance on connecting to CockroachDB from an application deployment, see one of the following pages: -- For connecting to managed, CockroachDB {{ site.data.products.cloud }} deployments, see [Connect to Your CockroachDB {{ site.data.products.dedicated }} Cluster](https://www.cockroachlabs.com/docs/cockroachcloud/connect-to-your-cluster) and [Connect to the Database (CockroachDB {{ site.data.products.dedicated }})]({% link {{ page.version.version }}/connect-to-the-database.md %}?filters=dedicated). +- For connecting to managed, CockroachDB {{ site.data.products.cloud }} deployments, see [Connect to Your CockroachDB {{ site.data.products.dedicated }} Cluster]({% link cockroachcloud/connect-to-your-cluster.md %}) and [Connect to the Database (CockroachDB {{ site.data.products.dedicated }})]({% link {{ page.version.version }}/connect-to-the-database.md %}?filters=dedicated). - For connecting to a standard CockroachDB deployment, see [`cockroach sql`]({% link {{ page.version.version }}/cockroach-sql.md %}) and [Connect to the Database]({% link {{ page.version.version }}/connect-to-the-database.md %}). To limit the latency between the application and the database, each deployment of the application should communicate with the closest database deployment. For details on configuring database connections for individual application deployments, consult your cloud provider's documentation. For an example using Google Cloud services, see [Deploy a Global, Serverless Application]({% link {{ page.version.version }}/movr-flask-deployment.md %}). diff --git a/src/current/v23.2/orchestrate-a-local-cluster-with-kubernetes-insecure.md b/src/current/v23.2/orchestrate-a-local-cluster-with-kubernetes-insecure.md index 50f6edf183c..7bf7e7c4620 100644 --- a/src/current/v23.2/orchestrate-a-local-cluster-with-kubernetes-insecure.md +++ b/src/current/v23.2/orchestrate-a-local-cluster-with-kubernetes-insecure.md @@ -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]({% link {{ page.version.version }}/kubernetes-overview.md %}). To deploy a 30-day free CockroachDB {{ site.data.products.dedicated }} cluster instead of running CockroachDB yourself, see the [Quickstart](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart). +To orchestrate a physically distributed cluster in production, see [Orchestrated Deployments]({% link {{ page.version.version }}/kubernetes-overview.md %}). To deploy a 30-day free CockroachDB {{ site.data.products.dedicated }} cluster instead of running CockroachDB yourself, see the [Quickstart]({% link cockroachcloud/quickstart.md %}). {{site.data.alerts.end}} ## Limitations diff --git a/src/current/v23.2/orchestrate-a-local-cluster-with-kubernetes.md b/src/current/v23.2/orchestrate-a-local-cluster-with-kubernetes.md index a408f883051..4858b597d3e 100644 --- a/src/current/v23.2/orchestrate-a-local-cluster-with-kubernetes.md +++ b/src/current/v23.2/orchestrate-a-local-cluster-with-kubernetes.md @@ -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]({% link {{ page.version.version }}/kubernetes-overview.md %}). To deploy a 30-day free CockroachDB {{ site.data.products.dedicated }} cluster instead of running CockroachDB yourself, see the [Quickstart](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart). +To orchestrate a physically distributed cluster in production, see [Orchestrated Deployments]({% link {{ page.version.version }}/kubernetes-overview.md %}). To deploy a 30-day free CockroachDB {{ site.data.products.dedicated }} cluster instead of running CockroachDB yourself, see the [Quickstart]({% link cockroachcloud/quickstart.md %}). {{site.data.alerts.end}} ## Limitations diff --git a/src/current/v23.2/performance-recipes.md b/src/current/v23.2/performance-recipes.md index 273d1fe4631..525dd47c339 100644 --- a/src/current/v23.2/performance-recipes.md +++ b/src/current/v23.2/performance-recipes.md @@ -95,19 +95,19 @@ This section provides solutions for common performance issues in your applicatio These are indicators that a transaction is trying to access a row that has been ["locked"]({% link {{ page.version.version }}/architecture/transaction-layer.md %}#writing) by another, concurrent transaction issuing a [write]({% link {{ page.version.version }}/architecture/transaction-layer.md %}#write-intents) or [locking read]({% link {{ page.version.version }}/select-for-update.md %}#lock-strengths). -- The **Active Executions** table on the **Transactions** page ([CockroachDB {{ site.data.products.cloud }} Console](https://www.cockroachlabs.com/docs/cockroachcloud/transactions-page) or [DB Console]({% link {{ page.version.version }}/ui-transactions-page.md %}#active-executions-table)) shows transactions with `Waiting` in the **Status** column. You can sort the table by **Time Spent Waiting**. +- The **Active Executions** table on the **Transactions** page ([CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/transactions-page.md %}) or [DB Console]({% link {{ page.version.version }}/ui-transactions-page.md %}#active-executions-table)) shows transactions with `Waiting` in the **Status** column. You can sort the table by **Time Spent Waiting**. - Querying the [`crdb_internal.cluster_locks`]({% link {{ page.version.version }}/crdb-internal.md %}#cluster_locks) table shows transactions where [`granted`]({% link {{ page.version.version }}/crdb-internal.md %}#cluster-locks-columns) is `false`. These are indicators that lock contention occurred in the past: - Querying the [`crdb_internal.transaction_contention_events`]({% link {{ page.version.version }}/crdb-internal.md %}#transaction_contention_events) table `WHERE contention_type='LOCK_WAIT'` indicates that your transactions have experienced lock contention. - - This is also shown in the **Transaction Executions** view on the **Insights** page ([CockroachDB {{ site.data.products.cloud }} Console](https://www.cockroachlabs.com/docs/cockroachcloud/insights-page#transaction-executions-view) and [DB Console]({% link {{ page.version.version }}/ui-insights-page.md %}#transaction-executions-view)). Transaction executions will display the [**High Contention** insight]({% link {{ page.version.version }}/ui-insights-page.md %}#high-contention). + - This is also shown in the **Transaction Executions** view on the **Insights** page ([CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/insights-page.md %}#transaction-executions-view) and [DB Console]({% link {{ page.version.version }}/ui-insights-page.md %}#transaction-executions-view)). Transaction executions will display the [**High Contention** insight]({% link {{ page.version.version }}/ui-insights-page.md %}#high-contention). {{site.data.alerts.callout_info}} {%- include {{ page.version.version }}/performance/sql-trace-txn-enable-threshold.md -%} {{site.data.alerts.end}} -- The **SQL Statement Contention** graph ([CockroachDB {{ site.data.products.cloud }} Console](https://www.cockroachlabs.com/docs/cockroachcloud/metrics-page#sql-statement-contention) and [DB Console]({% link {{ page.version.version }}/ui-sql-dashboard.md %}#sql-statement-contention)) is showing spikes over time. +- The **SQL Statement Contention** graph ([CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/metrics-page.md %}#sql-statement-contention) and [DB Console]({% link {{ page.version.version }}/ui-sql-dashboard.md %}#sql-statement-contention)) is showing spikes over time. SQL Statement Contention graph in DB Console If a long-running transaction is waiting due to [lock contention]({% link {{ page.version.version }}/performance-best-practices-overview.md %}#transaction-contention): @@ -124,11 +124,11 @@ These are indicators that a transaction has failed due to [contention]({% link { - A [transaction retry error]({% link {{ page.version.version }}/transaction-retry-error-reference.md %}) with `SQLSTATE: 40001`, the string [`restart transaction`]({% link {{ page.version.version }}/common-errors.md %}#restart-transaction), and an error code such as [`RETRY_WRITE_TOO_OLD`]({% link {{ page.version.version }}/transaction-retry-error-reference.md %}#retry_write_too_old) or [`RETRY_SERIALIZABLE`]({% link {{ page.version.version }}/transaction-retry-error-reference.md %}#retry_serializable), is emitted to the client. - Querying the [`crdb_internal.transaction_contention_events`]({% link {{ page.version.version }}/crdb-internal.md %}#transaction_contention_events) table `WHERE contention_type='SERIALIZATION_CONFLICT'` indicates that your transactions have experienced serialization conflicts. - - This is also shown in the **Transaction Executions** view on the **Insights** page ([CockroachDB {{ site.data.products.cloud }} Console](https://www.cockroachlabs.com/docs/cockroachcloud/insights-page#transaction-executions-view) and [DB Console]({% link {{ page.version.version }}/ui-insights-page.md %}#transaction-executions-view)). Transaction executions will display the [**Failed Execution** insight due to a serialization conflict]({% link {{ page.version.version }}/ui-insights-page.md %}#serialization-conflict-due-to-transaction-contention). + - This is also shown in the **Transaction Executions** view on the **Insights** page ([CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/insights-page.md %}#transaction-executions-view) and [DB Console]({% link {{ page.version.version }}/ui-insights-page.md %}#transaction-executions-view)). Transaction executions will display the [**Failed Execution** insight due to a serialization conflict]({% link {{ page.version.version }}/ui-insights-page.md %}#serialization-conflict-due-to-transaction-contention). These are indicators that transaction retries occurred in the past: -- The **Transaction Restarts** graph ([CockroachDB {{ site.data.products.cloud }} Console](https://www.cockroachlabs.com/docs/cockroachcloud/metrics-page#transaction-restarts) and [DB Console]({% link {{ page.version.version }}/ui-sql-dashboard.md %}#transaction-restarts) is showing spikes in transaction retries over time. +- The **Transaction Restarts** graph ([CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/metrics-page.md %}#transaction-restarts) and [DB Console]({% link {{ page.version.version }}/ui-sql-dashboard.md %}#transaction-restarts) is showing spikes in transaction retries over time. {% include {{ page.version.version }}/performance/transaction-retry-error-actions.md %} @@ -140,7 +140,7 @@ In addition, implement [client-side retry handling]({% link {{ page.version.vers ##### Identify conflicting transactions -- In the **Active Executions** table on the **Transactions** page ([CockroachDB {{ site.data.products.cloud }} Console](https://www.cockroachlabs.com/docs/cockroachcloud/transactions-page) or [DB Console]({% link {{ page.version.version }}/ui-transactions-page.md %}#active-executions-table)), look for a **waiting** transaction (`Waiting` status). +- In the **Active Executions** table on the **Transactions** page ([CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/transactions-page.md %}) or [DB Console]({% link {{ page.version.version }}/ui-transactions-page.md %}#active-executions-table)), look for a **waiting** transaction (`Waiting` status). {{site.data.alerts.callout_success}} If you see many waiting transactions, a single long-running transaction may be blocking transactions that are, in turn, blocking others. In this case, sort the table by **Time Spent Waiting** to find the transaction that has been waiting for the longest amount of time. Unblocking this transaction may unblock the other transactions. {{site.data.alerts.end}} @@ -160,8 +160,8 @@ In addition, implement [client-side retry handling]({% link {{ page.version.vers To identify transactions that experienced [lock contention]({% link {{ page.version.version }}/performance-best-practices-overview.md %}#transaction-contention) in the past: -- In the **Transaction Executions** view on the **Insights** page ([CockroachDB {{ site.data.products.cloud }} Console](https://www.cockroachlabs.com/docs/cockroachcloud/insights-page#transaction-executions-view) and [DB Console]({% link {{ page.version.version }}/ui-insights-page.md %}#transaction-executions-view)), look for a transaction with the **High Contention** insight. Click the transaction's execution ID and view the transaction execution details, including the details of the blocking transaction. -- Visit the **Transactions** page ([CockroachDB {{ site.data.products.cloud }} Console](https://www.cockroachlabs.com/docs/cockroachcloud/transactions-page) and [DB Console]({% link {{ page.version.version }}/ui-transactions-page.md %})) and sort transactions by **Contention Time**. +- In the **Transaction Executions** view on the **Insights** page ([CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/insights-page.md %}#transaction-executions-view) and [DB Console]({% link {{ page.version.version }}/ui-insights-page.md %}#transaction-executions-view)), look for a transaction with the **High Contention** insight. Click the transaction's execution ID and view the transaction execution details, including the details of the blocking transaction. +- Visit the **Transactions** page ([CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/transactions-page.md %}) and [DB Console]({% link {{ page.version.version }}/ui-transactions-page.md %})) and sort transactions by **Contention Time**. To view tables and indexes that experienced [contention]({% link {{ page.version.version }}/performance-best-practices-overview.md %}#transaction-contention): diff --git a/src/current/v23.2/qlik.md b/src/current/v23.2/qlik.md index ba48ae4d92e..c8bf2b3e0ee 100644 --- a/src/current/v23.2/qlik.md +++ b/src/current/v23.2/qlik.md @@ -65,7 +65,7 @@ Complete the following items before using Qlik Replicate: - If the output of [`SHOW SCHEDULES`]({% link {{ page.version.version }}/show-schedules.md %}) shows any backup schedules, run [`ALTER BACKUP SCHEDULE {schedule_id} SET WITH revision_history = 'false'`]({% link {{ page.version.version }}/alter-backup-schedule.md %}) for each backup schedule. - If the output of `SHOW SCHEDULES` does not show backup schedules, [contact Support](https://support.cockroachlabs.com) to disable revision history for cluster backups. - Manually create all schema objects in the target CockroachDB cluster. Qlik can create a basic schema, but does not create indexes or constraints such as foreign keys and defaults. - - If you are migrating from PostgreSQL, MySQL, Oracle, or Microsoft SQL Server, [use the **Schema Conversion Tool**](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) to convert and export your schema. Ensure that any schema changes are also reflected on your tables, or add transformation rules. If you make substantial schema changes, the Qlik Replicate migration may fail. + - If you are migrating from PostgreSQL, MySQL, Oracle, or Microsoft SQL Server, [use the **Schema Conversion Tool**]({% link cockroachcloud/migrations-page.md %}) to convert and export your schema. Ensure that any schema changes are also reflected on your tables, or add transformation rules. If you make substantial schema changes, the Qlik Replicate migration may fail. {{site.data.alerts.callout_info}} 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). @@ -97,7 +97,7 @@ In the Qlik Replicate interface, CockroachDB is configured as a PostgreSQL **sou ## 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 %}) - [Change Data Capture Overview]({% link {{ page.version.version }}/change-data-capture-overview.md %}) - [Third-Party Tools Supported by Cockroach Labs]({% link {{ page.version.version }}/third-party-database-tools.md %}) - [Migrate with AWS Database Migration Service (DMS)]({% link {{ page.version.version }}/aws-dms.md %}) diff --git a/src/current/v23.2/query-behavior-troubleshooting.md b/src/current/v23.2/query-behavior-troubleshooting.md index beb3b03ff5d..46b773bba08 100644 --- a/src/current/v23.2/query-behavior-troubleshooting.md +++ b/src/current/v23.2/query-behavior-troubleshooting.md @@ -21,7 +21,7 @@ Such long-running queries can hold locks for (practically) unlimited durations. Refer to the performance tuning recipe for [identifying and unblocking a waiting transaction]({% link {{ page.version.version }}/performance-recipes.md %}#waiting-transaction). -If you experience this issue on a CockroachDB {{ site.data.products.serverless }} cluster, your cluster may be throttled or disabled because you've reached your monthly [resource limits](https://www.cockroachlabs.com/docs/cockroachcloud/troubleshooting-page#hanging-or-stuck-queries). +If you experience this issue on a CockroachDB {{ site.data.products.serverless }} cluster, your cluster may be throttled or disabled because you've reached your monthly [resource limits]({% link cockroachcloud/troubleshooting-page.md %}#hanging-or-stuck-queries). ### Identify slow queries diff --git a/src/current/v23.2/query-data.md b/src/current/v23.2/query-data.md index 6ea76993f2a..6bb663791d9 100644 --- a/src/current/v23.2/query-data.md +++ b/src/current/v23.2/query-data.md @@ -11,7 +11,7 @@ This page has instructions for making SQL [selection queries][selection] against Before reading this page, do the following: -- [Create a CockroachDB {{ site.data.products.serverless }} 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.serverless }} 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 run queries against. diff --git a/src/current/v23.2/restoring-backups-across-versions.md b/src/current/v23.2/restoring-backups-across-versions.md index 816b406cc76..f17715f3556 100644 --- a/src/current/v23.2/restoring-backups-across-versions.md +++ b/src/current/v23.2/restoring-backups-across-versions.md @@ -29,7 +29,7 @@ Backup taken on version | Restorable into version 22.1.x | 22.1.x, 22.2.x 22.2.x | 22.2.x, 23.1.x -When a cluster is in a mixed-version state during an upgrade, [full cluster restores]({% link {{ page.version.version }}/restore.md %}#restore-a-cluster) will fail. See the [Upgrade documentation]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}) for the necessary steps to finalize your upgrade. For CockroachDB {{ site.data.products.cloud }} clusters, see the [CockroachDB Cloud Upgrade Policy](https://www.cockroachlabs.com/docs/cockroachcloud/upgrade-policy) page. +When a cluster is in a mixed-version state during an upgrade, [full cluster restores]({% link {{ page.version.version }}/restore.md %}#restore-a-cluster) will fail. See the [Upgrade documentation]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}) for the necessary steps to finalize your upgrade. For CockroachDB {{ site.data.products.cloud }} clusters, see the [CockroachDB Cloud Upgrade Policy]({% link cockroachcloud/upgrade-policy.md %}) page. {{site.data.alerts.callout_info}} Cockroach Labs does **not** support restoring backups from a higher version into a lower version. diff --git a/src/current/v23.2/schema-design-database.md b/src/current/v23.2/schema-design-database.md index 7130d3c6d88..438ffad5540 100644 --- a/src/current/v23.2/schema-design-database.md +++ b/src/current/v23.2/schema-design-database.md @@ -15,7 +15,7 @@ For reference documentation on the `CREATE DATABASE` statement, including additi Before reading this page, do the following: -- [Create a CockroachDB {{ site.data.products.serverless }} 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.serverless }} cluster]({% link cockroachcloud/quickstart.md %}) or [start a local cluster](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart?filters=local). - [Review the database schema objects]({% link {{ page.version.version }}/schema-design-overview.md %}). ## Create a database diff --git a/src/current/v23.2/schema-design-indexes.md b/src/current/v23.2/schema-design-indexes.md index 6e895315845..132d38f6444 100644 --- a/src/current/v23.2/schema-design-indexes.md +++ b/src/current/v23.2/schema-design-indexes.md @@ -18,7 +18,7 @@ This page provides best-practice guidance on creating secondary indexes, with a Before reading this page, do the following: -- [Create a CockroachDB {{ site.data.products.serverless }} 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.serverless }} cluster]({% link cockroachcloud/quickstart.md %}) or [start a local cluster](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart?filters=local). - [Review the database schema objects]({% link {{ page.version.version }}/schema-design-overview.md %}). - [Create a database]({% link {{ page.version.version }}/schema-design-database.md %}). - [Create a user-defined schema]({% link {{ page.version.version }}/schema-design-schema.md %}). diff --git a/src/current/v23.2/schema-design-schema.md b/src/current/v23.2/schema-design-schema.md index 402588aea2b..ce931d393ba 100644 --- a/src/current/v23.2/schema-design-schema.md +++ b/src/current/v23.2/schema-design-schema.md @@ -15,7 +15,7 @@ For detailed reference documentation on the `CREATE SCHEMA` statement, including Before reading this page, do the following: -- [Create a CockroachDB {{ site.data.products.serverless }} 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.serverless }} cluster]({% link cockroachcloud/quickstart.md %}) or [start a local cluster](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart?filters=local). - [Review the database schema objects]({% link {{ page.version.version }}/schema-design-overview.md %}). - [Create a database]({% link {{ page.version.version }}/schema-design-database.md %}). diff --git a/src/current/v23.2/schema-design-table.md b/src/current/v23.2/schema-design-table.md index cd18dd9c8e7..5b606adfe28 100644 --- a/src/current/v23.2/schema-design-table.md +++ b/src/current/v23.2/schema-design-table.md @@ -15,7 +15,7 @@ For detailed reference documentation on the `CREATE TABLE` statement, including Before reading this page, do the following: -- [Create a CockroachDB {{ site.data.products.serverless }} 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.serverless }} cluster]({% link cockroachcloud/quickstart.md %}) or [start a local cluster](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart?filters=local). - [Review the database schema objects]({% link {{ page.version.version }}/schema-design-overview.md %}). - [Create a database]({% link {{ page.version.version }}/schema-design-database.md %}). - [Create a user-defined schema]({% link {{ page.version.version }}/schema-design-schema.md %}). diff --git a/src/current/v23.2/schema-design-update.md b/src/current/v23.2/schema-design-update.md index de2b23b1241..37b3488d4b4 100644 --- a/src/current/v23.2/schema-design-update.md +++ b/src/current/v23.2/schema-design-update.md @@ -11,7 +11,7 @@ This page provides an overview on changing and removing the objects in a databas Before reading this page, do the following: -- [Create a CockroachDB {{ site.data.products.serverless }} 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.serverless }} cluster]({% link cockroachcloud/quickstart.md %}) or [start a local cluster](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart?filters=local). - [Review the database schema objects]({% link {{ page.version.version }}/schema-design-overview.md %}). - [Create a database]({% link {{ page.version.version }}/schema-design-database.md %}). - [Create a user-defined schema]({% link {{ page.version.version }}/schema-design-schema.md %}). diff --git a/src/current/v23.2/sso-db-console.md b/src/current/v23.2/sso-db-console.md index 801b802ac2f..99db24bfdf5 100644 --- a/src/current/v23.2/sso-db-console.md +++ b/src/current/v23.2/sso-db-console.md @@ -28,7 +28,7 @@ This SSO implementation uses the [authorization code grant type](https://tools.i - **CockroachDB cluster**: you must have access to one of the following: - A {{ site.data.products.core }} cluster enabled with a valid [CockroachDB Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). - - A [CockroachDB {{ site.data.products.dedicated }} cluster](https://www.cockroachlabs.com/docs/cockroachcloud/create-your-cluster). + - A [CockroachDB {{ site.data.products.dedicated }} cluster]({% link cockroachcloud/create-your-cluster.md %}). ## Log in to a cluster's DB Console with SSO diff --git a/src/current/v23.2/sso-sql.md b/src/current/v23.2/sso-sql.md index aaf460bc01e..23223d196ea 100644 --- a/src/current/v23.2/sso-sql.md +++ b/src/current/v23.2/sso-sql.md @@ -12,7 +12,7 @@ Cluster single sign-on (SSO) enables users to access the SQL interface of a Cock {{ site.data.products.dedicated }} clusters can provision their users with JWTs via the DB Console. This allows users to authenticate to a cluster by signing in to their IdP (for example, Okta or Google) with a link embedded in the DB Console. This flow provisions a JWT that a user can copy out of the DB Console UI and use in a SQL connection string to authenticate to the cluster. {{site.data.alerts.callout_info}} -Cluster single sign-on for the DB Console is supported on {{ site.data.products.core }} {{ site.data.products.enterprise }} and {{ site.data.products.dedicated }} clusters. {{ site.data.products.serverless }} clusters do not support cluster single sign-on, because they do not have access to the DB Console. However, {{ site.data.products.serverless }} clusters can use [Cluster Single Sign-on (SSO) using `ccloud` and the CockroachDB Cloud Console](https://www.cockroachlabs.com/docs/cockroachcloud/cloud-sso-sql). +Cluster single sign-on for the DB Console is supported on {{ site.data.products.core }} {{ site.data.products.enterprise }} and {{ site.data.products.dedicated }} clusters. {{ site.data.products.serverless }} clusters do not support cluster single sign-on, because they do not have access to the DB Console. However, {{ site.data.products.serverless }} clusters can use [Cluster Single Sign-on (SSO) using `ccloud` and the CockroachDB Cloud Console]({% link cockroachcloud/cloud-sso-sql.md %}). {{site.data.alerts.end}} The page describes how to configure a cluster for cluster single sign-on using JWTs and then how users can authenticate using the JWTs. If you're a user ready to sign in to the DB Console with JWTs, you can skip the configuration section: @@ -119,7 +119,7 @@ You can also view all of your cluster settings in the DB Console. {{ site.data.products.db }} {{ site.data.products.dedicated }} customers: - By default, your cluster's configuration will contain the CockroachDB {{ site.data.products.cloud }}'s own public key, allowing CockroachDB {{ site.data.products.cloud }} to serve as an IdP. This is required for [SSO with `ccloud`](https://www.cockroachlabs.com/docs/cockroachcloud/cloud-sso-sql). When modifying this cluster setting, you must include the CockroachDB {{ site.data.products.cloud }} public key in the key set, or SSO with `ccloud` will no longer work. + By default, your cluster's configuration will contain the CockroachDB {{ site.data.products.cloud }}'s own public key, allowing CockroachDB {{ site.data.products.cloud }} to serve as an IdP. This is required for [SSO with `ccloud`]({% link cockroachcloud/cloud-sso-sql.md %}). When modifying this cluster setting, you must include the CockroachDB {{ site.data.products.cloud }} public key in the key set, or SSO with `ccloud` will no longer work. The public key for {{ site.data.products.db }} can be found at `https://cockroachlabs.cloud/.well-known/openid-configuration`. @@ -229,7 +229,7 @@ Examples: - `https://accounts.google.com 1232316645658094244789 roach` - Maps a single external identity with the hard-coded ID to the [SQL user](https://www.cockroachlabs.com/docs/cockroachcloud/managing-access#manage-sql-users-on-a-cluster) `roach`. + Maps a single external identity with the hard-coded ID to the [SQL user]({% link cockroachcloud/managing-access.md %}#manage-sql-users-on-a-cluster) `roach`. - `https://accounts.google.com /^([9-0]*)$ gcp_\1` diff --git a/src/current/v23.2/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.md b/src/current/v23.2/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.md index 0a19d9353cc..fe09c06c361 100644 --- a/src/current/v23.2/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.md +++ b/src/current/v23.2/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.md @@ -21,7 +21,7 @@ An overview of the workflow involves creating and connecting the following: You will need the following set up before starting this tutorial: -- A CockroachDB cluster. You can use a CockroachDB {{ site.data.products.cloud }} or CockroachDB {{ site.data.products.core }} cluster. If you are using CockroachDB {{ site.data.products.serverless }} or CockroachDB {{ site.data.products.dedicated }}, see the [Quickstart with CockroachDB](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart) guide. For CockroachDB {{ site.data.products.core }} clusters, see the [install]({% link {{ page.version.version }}/install-cockroachdb-mac.md %}) page. +- A CockroachDB cluster. You can use a CockroachDB {{ site.data.products.cloud }} or CockroachDB {{ site.data.products.core }} cluster. If you are using CockroachDB {{ site.data.products.serverless }} or CockroachDB {{ site.data.products.dedicated }}, see the [Quickstart with CockroachDB]({% link cockroachcloud/quickstart.md %}) guide. For CockroachDB {{ site.data.products.core }} clusters, see the [install]({% link {{ page.version.version }}/install-cockroachdb-mac.md %}) page. - A Confluent Cloud account. See Confluent's [Get started](https://www.confluent.io/get-started/) page for details. - The Confluent CLI. See [Install Confluent CLI](https://docs.confluent.io/confluent-cli/current/install.html) to set this up. This tutorial uses v3.3.0 of the Confluent CLI. Note that you can also complete the steps in this tutorial in Confluent's Cloud console. - {% include {{ page.version.version }}/cdc/tutorial-privilege-check.md %} diff --git a/src/current/v23.2/striim.md b/src/current/v23.2/striim.md index ffbba6d55fa..06ba43db452 100644 --- a/src/current/v23.2/striim.md +++ b/src/current/v23.2/striim.md @@ -34,7 +34,7 @@ Complete the following items before using Striim: - Ensure you have a secure, publicly available CockroachDB cluster running the latest **{{ page.version.version }}** [production release](https://www.cockroachlabs.com/docs/releases/{{ page.version.version }}), and have created a [SQL user]({% link {{ page.version.version }}/security-reference/authorization.md %}#sql-users) that you can use to configure your Striim target. - Manually create all schema objects in the target CockroachDB cluster. Although Striim offers a feature called Auto Schema Conversion, we recommend converting and importing your schema before running Striim to ensure that the data populates successfully. - - If you are migrating from PostgreSQL, MySQL, Oracle, or Microsoft SQL Server, [use the **Schema Conversion Tool**](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) to convert and export your schema. Ensure that any schema changes are also reflected on your tables. + - If you are migrating from PostgreSQL, MySQL, Oracle, or Microsoft SQL Server, [use the **Schema Conversion Tool**]({% link cockroachcloud/migrations-page.md %}) to convert and export your schema. Ensure that any schema changes are also reflected on your tables. {{site.data.alerts.callout_info}} 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). @@ -111,6 +111,6 @@ To perform continuous replication of ongoing changes, create a Striim applicatio ## 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 %}) - [Change Data Capture Overview]({% link {{ page.version.version }}/change-data-capture-overview.md %}) - [Third-Party Tools Supported by Cockroach Labs]({% link {{ page.version.version }}/third-party-database-tools.md %}) diff --git a/src/current/v23.2/take-and-restore-locality-aware-backups.md b/src/current/v23.2/take-and-restore-locality-aware-backups.md index 5343a847b4c..1844641b07e 100644 --- a/src/current/v23.2/take-and-restore-locality-aware-backups.md +++ b/src/current/v23.2/take-and-restore-locality-aware-backups.md @@ -25,7 +25,7 @@ For a technical overview of how a locality-aware backup works, refer to [Job coo ## Supported products -Locality-aware backups are available in **CockroachDB {{ site.data.products.dedicated }}**, **CockroachDB {{ site.data.products.serverless }}**, and **CockroachDB {{ site.data.products.core }}** clusters when you are running [customer-owned backups](https://www.cockroachlabs.com/docs/cockroachcloud/take-and-restore-customer-owned-backups). For a full list of features on CockroachDB Cloud, refer to [Backup and Restore Overview](https://www.cockroachlabs.com/docs/cockroachcloud/backup-and-restore-overview). +Locality-aware backups are available in **CockroachDB {{ site.data.products.dedicated }}**, **CockroachDB {{ site.data.products.serverless }}**, and **CockroachDB {{ site.data.products.core }}** clusters when you are running [customer-owned backups]({% link cockroachcloud/take-and-restore-customer-owned-backups.md %}). For a full list of features on CockroachDB Cloud, refer to [Backup and Restore Overview]({% link cockroachcloud/backup-and-restore-overview.md %}). {{site.data.alerts.callout_info}} {% include {{ page.version.version }}/backups/serverless-locality-aware.md %} diff --git a/src/current/v23.2/troubleshooting-overview.md b/src/current/v23.2/troubleshooting-overview.md index 2573f1c9fe3..9b21e2725f0 100644 --- a/src/current/v23.2/troubleshooting-overview.md +++ b/src/current/v23.2/troubleshooting-overview.md @@ -16,7 +16,7 @@ If you experience an issue when using CockroachDB, try these steps to resolve th - [Troubleshoot Common Problems]({% link {{ page.version.version }}/query-behavior-troubleshooting.md %}) helps you handle errors and troubleshooting problems that may arise during application development. - [Troubleshoot Statement Behavior]({% link {{ page.version.version }}/query-behavior-troubleshooting.md %}) helps you with unexpected query results. -- If you are using Cockroach Cloud, see the errors and solutions in [Troubleshoot CockroachDB Cloud](https://www.cockroachlabs.com/docs/cockroachcloud/troubleshooting-page). +- If you are using Cockroach Cloud, see the errors and solutions in [Troubleshoot CockroachDB Cloud]({% link cockroachcloud/troubleshooting-page.md %}). - If you see discrepancies in metrics, refer to [Differences in Metrics between Third-Party Monitoring Integrations and DB Console]({% link {{ page.version.version }}/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.md %}). diff --git a/src/current/v23.2/ui-overview.md b/src/current/v23.2/ui-overview.md index 6ccc7f48b8a..3320184c51c 100644 --- a/src/current/v23.2/ui-overview.md +++ b/src/current/v23.2/ui-overview.md @@ -11,7 +11,7 @@ The DB Console provides details about your cluster and database configuration, a {{site.data.alerts.callout_info}} Authorized CockroachDB {{ site.data.products.dedicated }} cluster users can visit the DB Console at a URL provisioned for the cluster. -Refer to: [Network Authorization for CockroachDB Cloud Clusters—DB Console](https://www.cockroachlabs.com/docs/cockroachcloud/network-authorization#db-console) +Refer to: [Network Authorization for CockroachDB Cloud Clusters—DB Console]({% link cockroachcloud/network-authorization.md %}#db-console) {{site.data.alerts.end}} ## Authentication diff --git a/src/current/v23.2/update-data.md b/src/current/v23.2/update-data.md index 5c0d256dd29..5db28c352f0 100644 --- a/src/current/v23.2/update-data.md +++ b/src/current/v23.2/update-data.md @@ -15,7 +15,7 @@ This page has instructions for updating existing rows of data in CockroachDB, us Before reading this page, do the following: -- [Create a CockroachDB {{ site.data.products.serverless }} 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.serverless }} 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 %}). - [Create a database schema]({% link {{ page.version.version }}/schema-design-overview.md %}). diff --git a/src/current/v23.2/vault-db-secrets-tutorial.md b/src/current/v23.2/vault-db-secrets-tutorial.md index bb846cfd37e..2f47e18de31 100644 --- a/src/current/v23.2/vault-db-secrets-tutorial.md +++ b/src/current/v23.2/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]({% link {{ page.version.version }}/install-cockroachdb-mac.md %}). - The Vault CLI [installed locally](https://www.vaultproject.io/downloads). -- Access to a CockroachDB cluster as [`admin` SQL user]({% link {{ page.version.version }}/security-reference/authorization.md %}#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](https://www.cockroachlabs.com/docs/cockroachcloud/create-a-serverless-cluster) 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]({% link {{ page.version.version }}/security-reference/authorization.md %}#admin-role). +- Access to a CockroachDB cluster as [`admin` SQL user]({% link {{ page.version.version }}/security-reference/authorization.md %}#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]({% link cockroachcloud/create-a-serverless-cluster.md %}) 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]({% link {{ page.version.version }}/security-reference/authorization.md %}#admin-role). - Access to a Vault cluster with an admin token. This tutorial will use HashiCorp Cloud Platform, but you may either [spin up a free cluster in HashiCorp Cloud Platform](https://learn.hashicorp.com/collections/vault/cloud) or [start a development cluster locally](https://learn.hashicorp.com/tutorials/vault/getting-started-dev-server). ## Introduction diff --git a/src/current/v24.1/api-support-policy.md b/src/current/v24.1/api-support-policy.md index 4bea53dca03..175b1814647 100644 --- a/src/current/v24.1/api-support-policy.md +++ b/src/current/v24.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/v24.1/authorization.md b/src/current/v24.1/authorization.md index 6eec67c32cd..3b1ce45e023 100644 --- a/src/current/v24.1/authorization.md +++ b/src/current/v24.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/v24.1/aws-dms.md b/src/current/v24.1/aws-dms.md index fdc22c8e8d7..390c2e746d2 100644 --- a/src/current/v24.1/aws-dms.md +++ b/src/current/v24.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). @@ -211,7 +211,7 @@ If your migration failed for some reason, you can check the checkbox next to the ### AWS PrivateLink -If using CockroachDB {{ site.data.products.dedicated }}, you can enable [AWS PrivateLink](https://aws.amazon.com/privatelink/) to securely connect your AWS application with your CockroachDB {{ site.data.products.dedicated }} cluster using a private endpoint. To configure AWS PrivateLink with CockroachDB {{ site.data.products.dedicated }}, see [Network Authorization](https://www.cockroachlabs.com/docs/cockroachcloud/network-authorization#aws-privatelink). +If using CockroachDB {{ site.data.products.dedicated }}, you can enable [AWS PrivateLink](https://aws.amazon.com/privatelink/) to securely connect your AWS application with your CockroachDB {{ site.data.products.dedicated }} cluster using a private endpoint. To configure AWS PrivateLink with CockroachDB {{ site.data.products.dedicated }}, see [Network Authorization]({% link cockroachcloud/network-authorization.md %}#aws-privatelink). ### `BatchApplyEnabled` @@ -407,7 +407,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/v24.1/backup.md b/src/current/v24.1/backup.md index 45bf84b0dfc..d4065c76e95 100644 --- a/src/current/v24.1/backup.md +++ b/src/current/v24.1/backup.md @@ -32,7 +32,7 @@ To view the contents of an backup created with the `BACKUP` statement, use [`SHO ## Considerations -- Core users can only take [full backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#full-backups). To use the other backup features, you need an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). You can also use [CockroachDB {{ site.data.products.dedicated }}](https://cockroachlabs.cloud/signup?referralId=docs-crdb-backup), which runs [full backups daily and incremental backups hourly](https://www.cockroachlabs.com/docs/cockroachcloud/use-managed-service-backups). +- Core users can only take [full backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#full-backups). To use the other backup features, you need an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). You can also use [CockroachDB {{ site.data.products.dedicated }}](https://cockroachlabs.cloud/signup?referralId=docs-crdb-backup), which runs [full backups daily and incremental backups hourly]({% link cockroachcloud/use-managed-service-backups.md %}). - [Full cluster backups](#back-up-a-cluster) include [Enterprise license keys]({% link {{ page.version.version }}/enterprise-licensing.md %}). When you [restore]({% link {{ page.version.version }}/restore.md %}) a full cluster backup that includes an Enterprise license, the Enterprise license is also restored. - [Zone configurations]({% link {{ page.version.version }}/configure-replication-zones.md %}) present on the destination cluster prior to a restore will be **overwritten** during a [cluster restore]({% link {{ page.version.version }}/restore.md %}#full-cluster) with the zone configurations from the [backed up cluster](#back-up-a-cluster). If there were no customized zone configurations on the cluster when the backup was taken, then after the restore the destination cluster will use the zone configuration from the [`RANGE DEFAULT` configuration]({% link {{ page.version.version }}/configure-replication-zones.md %}#view-the-default-replication-zone). - You cannot restore a backup of a multi-region database into a single-region database. diff --git a/src/current/v24.1/bulk-delete-data.md b/src/current/v24.1/bulk-delete-data.md index ecb96f85216..18c6d92f4f1 100644 --- a/src/current/v24.1/bulk-delete-data.md +++ b/src/current/v24.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.serverless }} 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.serverless }} 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/v24.1/bulk-update-data.md b/src/current/v24.1/bulk-update-data.md index 287579230fd..afc681f2e38 100644 --- a/src/current/v24.1/bulk-update-data.md +++ b/src/current/v24.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.serverless }} 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.serverless }} 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/v24.1/choose-a-deployment-option.md b/src/current/v24.1/choose-a-deployment-option.md index 3f7e694f478..32c13b877be 100644 --- a/src/current/v24.1/choose-a-deployment-option.md +++ b/src/current/v24.1/choose-a-deployment-option.md @@ -99,7 +99,7 @@ Cockroach Labs offers four ways to deploy CockroachDB: three managed services&md - [CockroachDB deployment]({% link {{ page.version.version }}/architecture/glossary.md %}#cockroachdb-deployment-terms) - [CockroachDB pricing](https://www.cockroachlabs.com/get-started-cockroachdb/) -- [CockroachDB Cloud FAQs](https://www.cockroachlabs.com/docs/cockroachcloud/serverless-faqs) -- [CockroachDB Cloud Architecture](https://www.cockroachlabs.com/docs/cockroachcloud/architecture) +- [CockroachDB Cloud FAQs]({% link cockroachcloud/serverless-faqs.md %}) +- [CockroachDB Cloud Architecture]({% link cockroachcloud/architecture.md %}) - [Manual Deployment]({% link {{ page.version.version }}/manual-deployment.md %}) - [Kubernetes Deployment]({% link {{ page.version.version }}/kubernetes-overview.md %}) diff --git a/src/current/v24.1/cloud-storage-authentication.md b/src/current/v24.1/cloud-storage-authentication.md index ff5cdb19608..b460fde8134 100644 --- a/src/current/v24.1/cloud-storage-authentication.md +++ b/src/current/v24.1/cloud-storage-authentication.md @@ -297,7 +297,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 @@ -596,7 +596,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 diff --git a/src/current/v24.1/cockroachdb-feature-availability.md b/src/current/v24.1/cockroachdb-feature-availability.md index a7bcedd54a4..9172f1e43dc 100644 --- a/src/current/v24.1/cockroachdb-feature-availability.md +++ b/src/current/v24.1/cockroachdb-feature-availability.md @@ -52,11 +52,11 @@ Any feature made available in a phase prior to GA is provided without any warran ### GCP Private Service Connect for CockroachDB Dedicated -[Connecting privately to a CockroachDB {{ site.data.products.dedicated }} cluster using GCP Private Service Connect](https://www.cockroachlabs.com/docs/cockroachcloud/connect-to-your-cluster#gcp-private-service-connect) is in preview. Private Service Connect allows you to selectively connect your cluster deployed on GCP to a VPC within your Google Cloud project. +[Connecting privately to a CockroachDB {{ site.data.products.dedicated }} cluster using GCP Private Service Connect]({% link cockroachcloud/connect-to-your-cluster.md %}#gcp-private-service-connect) is in preview. Private Service Connect allows you to selectively connect your cluster deployed on GCP to a VPC within your Google Cloud project. ### Azure Private Link for CockroachDB Dedicated -[Connecting privately to a CockroachDB {{ site.data.products.dedicated }} cluster using Azure Private Link](https://www.cockroachlabs.com/docs/cockroachcloud/connect-to-your-cluster#azure-private-link) is in preview. Azure Private Link allows you to selectively connect your cluster deployed on Azure to a virtual network within your Azure tenant. +[Connecting privately to a CockroachDB {{ site.data.products.dedicated }} cluster using Azure Private Link]({% link cockroachcloud/connect-to-your-cluster.md %}#azure-private-link) is in preview. Azure Private Link allows you to selectively connect your cluster deployed on Azure to a virtual network within your Azure tenant. ### Custom Metrics Chart page for CockroachDB {{ site.data.products.cloud }} clusters diff --git a/src/current/v24.1/common-issues-to-monitor.md b/src/current/v24.1/common-issues-to-monitor.md index 8adb21b5e9f..72007a95416 100644 --- a/src/current/v24.1/common-issues-to-monitor.md +++ b/src/current/v24.1/common-issues-to-monitor.md @@ -331,4 +331,4 @@ Because each node needs to update a liveness record on disk, maxing out disk ban - [Troubleshoot SQL Behavior]({% link {{ page.version.version }}/query-behavior-troubleshooting.md %}) - [Admission Control]({% link {{ page.version.version }}/admission-control.md %}) - [Metrics]({% link {{ page.version.version }}/metrics.md %}) -- [Alerts Page](https://www.cockroachlabs.com/docs/cockroachcloud/alerts-page) (CockroachDB {{ site.data.products.dedicated }}) +- [Alerts Page]({% link cockroachcloud/alerts-page.md %}) (CockroachDB {{ site.data.products.dedicated }}) diff --git a/src/current/v24.1/connect-to-a-changefeed-kafka-sink-with-oauth-using-okta.md b/src/current/v24.1/connect-to-a-changefeed-kafka-sink-with-oauth-using-okta.md index cdaf916d76d..2bde95a6387 100644 --- a/src/current/v24.1/connect-to-a-changefeed-kafka-sink-with-oauth-using-okta.md +++ b/src/current/v24.1/connect-to-a-changefeed-kafka-sink-with-oauth-using-okta.md @@ -22,7 +22,7 @@ An overview of the workflow involves: Before starting this tutorial, you will need: - A CockroachDB cluster. You can use a CockroachDB {{ site.data.products.cloud }} or CockroachDB {{ site.data.products.core }} cluster. - - If you are using CockroachDB {{ site.data.products.serverless }} or CockroachDB {{ site.data.products.dedicated }}, see the [Quickstart with CockroachDB](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart) guide. For CockroachDB {{ site.data.products.core }} clusters, see the [install]({% link {{ page.version.version }}/install-cockroachdb-mac.md %}) page. + - If you are using CockroachDB {{ site.data.products.serverless }} or CockroachDB {{ site.data.products.dedicated }}, see the [Quickstart with CockroachDB]({% link cockroachcloud/quickstart.md %}) guide. For CockroachDB {{ site.data.products.core }} clusters, see the [install]({% link {{ page.version.version }}/install-cockroachdb-mac.md %}) page. - An [Okta Developer account](https://developer.okta.com/signup/). - (Optional) A Kafka cluster. This tutorial includes [Kafka cluster setup](#step-3-create-a-kafka-sink). Note that this tutorial was tested with Kafka [version 2.8.2](https://kafka.apache.org/downloads). The Kafka cluster configuration may vary with different versions, but the Okta setup and changefeed creation will be the same. - {% include {{ page.version.version }}/cdc/tutorial-privilege-check.md %} diff --git a/src/current/v24.1/connect-to-the-database.md b/src/current/v24.1/connect-to-the-database.md index d24c61b17dc..9ec0c3378f8 100644 --- a/src/current/v24.1/connect-to-the-database.md +++ b/src/current/v24.1/connect-to-the-database.md @@ -307,7 +307,7 @@ export const AppDataSource = new DataSource({ Where: - `DATABASE_URL` is an environment variable set to a valid CockroachDB connection string. -- `CA_CERT` is an environment variable set to the root certificate [downloaded from the CockroachDB Cloud Console](https://www.cockroachlabs.com/docs/cockroachcloud/authentication#node-identity-verification). +- `CA_CERT` is an environment variable set to the root certificate [downloaded from the CockroachDB Cloud Console]({% link cockroachcloud/authentication.md %}#node-identity-verification). TypeORM accepts the following format for CockroachDB connection strings: @@ -452,7 +452,7 @@ Parameter | Description `` | The host on which the CockroachDB node is running. `` | The port at which the CockroachDB node is listening. `` | The name of the (existing) database. -`` | The path to the root certificate that you [downloaded from the CockroachDB Cloud Console](https://www.cockroachlabs.com/docs/cockroachcloud/authentication#node-identity-verification). +`` | The path to the root certificate that you [downloaded from the CockroachDB Cloud Console]({% link cockroachcloud/authentication.md %}#node-identity-verification). @@ -784,7 +784,7 @@ Parameter | Description `{host}` | The host on which the CockroachDB node is running. `{port}` | The port at which the CockroachDB node is listening. `{database}` | The name of the (existing) database. -`{root-cert}` | The path to the root certificate that you [downloaded from the CockroachDB Cloud Console](https://www.cockroachlabs.com/docs/cockroachcloud/authentication#node-identity-verification). +`{root-cert}` | The path to the root certificate that you [downloaded from the CockroachDB Cloud Console]({% link cockroachcloud/authentication.md %}#node-identity-verification). @@ -1014,7 +1014,7 @@ Parameter | Description `{host}` | The host on which the CockroachDB node is running. `{port}` | The port at which the CockroachDB node is listening. `{database}` | The name of the (existing) database. -`{root-cert}` | The path to the root certificate that you [downloaded from the CockroachDB Cloud Console](https://www.cockroachlabs.com/docs/cockroachcloud/authentication#node-identity-verification). +`{root-cert}` | The path to the root certificate that you [downloaded from the CockroachDB Cloud Console]({% link cockroachcloud/authentication.md %}#node-identity-verification). @@ -1171,7 +1171,7 @@ Parameter | Description `{host}` | The host on which the CockroachDB node is running. `{port}` | The port at which the CockroachDB node is listening. `{database}` | The name of the (existing) database. -`{root-cert}` | The [URL-encoded](https://wikipedia.org/wiki/Percent-encoding) path to the root certificate that you [downloaded from the CockroachDB Cloud Console](https://www.cockroachlabs.com/docs/cockroachcloud/authentication#node-identity-verification). +`{root-cert}` | The [URL-encoded](https://wikipedia.org/wiki/Percent-encoding) path to the root certificate that you [downloaded from the CockroachDB Cloud Console]({% link cockroachcloud/authentication.md %}#node-identity-verification). @@ -1331,7 +1331,7 @@ Parameter | Description `{host}` | The host on which the CockroachDB node is running. `{port}` | The port at which the CockroachDB node is listening. `{database}` | The name of the (existing) database. -`{root-cert}` | The path to the root certificate that you [downloaded from the CockroachDB Cloud Console](https://www.cockroachlabs.com/docs/cockroachcloud/authentication#node-identity-verification). +`{root-cert}` | The path to the root certificate that you [downloaded from the CockroachDB Cloud Console]({% link cockroachcloud/authentication.md %}#node-identity-verification). diff --git a/src/current/v24.1/connection-parameters.md b/src/current/v24.1/connection-parameters.md index ba52da21d57..b7a22d63cc7 100644 --- a/src/current/v24.1/connection-parameters.md +++ b/src/current/v24.1/connection-parameters.md @@ -99,7 +99,7 @@ CockroachDB supports the following `options` parameters. After the first `option Parameter | Description ----------|------------- -`--cluster=` | Identifies your tenant cluster on a [multi-tenant host](https://www.cockroachlabs.com/docs/cockroachcloud/architecture#architecture). For example, `funny-skunk-123`. This option is deprecated. The `host` in the connection string now includes the tenant information. +`--cluster=` | Identifies your tenant cluster on a [multi-tenant host]({% link cockroachcloud/architecture.md %}#architecture). For example, `funny-skunk-123`. This option is deprecated. The `host` in the connection string now includes the tenant information. `-c =` | Sets a [session variable]({% link {{ page.version.version }}/set-vars.md %}) for the SQL session. `results_buffer_size` | Default size of the buffer that accumulates results for a statement or a batch of statements before they are sent to the client. Can also be set using the [`sql.defaults.results_buffer.size` cluster setting]({% link {{ page.version.version }}/cluster-settings.md %}#setting-sql-defaults-results-buffer-size). Can be set as a top-level query parameter or as an `options` parameter. diff --git a/src/current/v24.1/datadog.md b/src/current/v24.1/datadog.md index ca92fe0ed67..c2c9a0d1ed5 100644 --- a/src/current/v24.1/datadog.md +++ b/src/current/v24.1/datadog.md @@ -8,7 +8,7 @@ docs_area: manage [Datadog](https://www.datadoghq.com/) is a monitoring and security platform for cloud applications. The CockroachDB {{ site.data.products.core }} integration with Datadog enables data collection and alerting on selected [CockroachDB metrics](https://docs.datadoghq.com/integrations/cockroachdb/?tab=host#data-collected) using the Datadog platform. {{site.data.alerts.callout_success}} -This tutorial explores the CockroachDB {{ site.data.products.core }} integration with Datadog. For the CockroachDB {{ site.data.products.dedicated }} integration with Datadog, refer to [Monitor CockroachDB Dedicated with Datadog](https://www.cockroachlabs.com/docs/cockroachcloud/tools-page#monitor-cockroachdb-dedicated-with-datadog) instead of this page. +This tutorial explores the CockroachDB {{ site.data.products.core }} integration with Datadog. For the CockroachDB {{ site.data.products.dedicated }} integration with Datadog, refer to [Monitor CockroachDB Dedicated with Datadog]({% link cockroachcloud/tools-page.md %}#monitor-cockroachdb-dedicated-with-datadog) instead of this page. {{site.data.alerts.end}} The CockroachDB {{ site.data.products.core }} integration with Datadog is powered by the [Datadog Agent](https://app.datadoghq.com/account/settings#agent), and supported by Datadog directly: diff --git a/src/current/v24.1/debezium.md b/src/current/v24.1/debezium.md index d35bca04a5f..b6a77d75a78 100644 --- a/src/current/v24.1/debezium.md +++ b/src/current/v24.1/debezium.md @@ -117,7 +117,7 @@ Once all of the [prerequisite steps](#before-you-begin) are completed, you can u ## 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 %}) - [Change Data Capture Overview]({% link {{ page.version.version }}/change-data-capture-overview.md %}) - [Third-Party Tools Supported by Cockroach Labs]({% link {{ page.version.version }}/third-party-database-tools.md %}) - [Stream a Changefeed to a Confluent Cloud Kafka Cluster]({% link {{ page.version.version }}/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.md %}) diff --git a/src/current/v24.1/delete-data.md b/src/current/v24.1/delete-data.md index 1a056e6685d..8217416ef92 100644 --- a/src/current/v24.1/delete-data.md +++ b/src/current/v24.1/delete-data.md @@ -11,7 +11,7 @@ This page has instructions for deleting rows of data from CockroachDB, using the Before reading this page, do the following: -- [Create a CockroachDB {{ site.data.products.serverless }} 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.serverless }} 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 %}). - [Create a database schema]({% link {{ page.version.version }}/schema-design-overview.md %}). diff --git a/src/current/v24.1/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.md b/src/current/v24.1/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.md index 026a53cfd12..0210883d4ae 100644 --- a/src/current/v24.1/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.md +++ b/src/current/v24.1/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.md @@ -4,7 +4,7 @@ summary: Learn how metrics can differ between third-party monitoring tools that toc: true --- -When using [Third-Party Monitoring Integrations]({% link {{ page.version.version }}/third-party-monitoring-tools.md %}), such as the [metrics export feature](https://www.cockroachlabs.com/docs/cockroachcloud/export-metrics), discrepancies may be seen when comparing those metrics charts to ones found on the [Metrics dashboards]({% link {{ page.version.version }}/ui-overview.md %}#metrics) or [custom charts]({% link {{ page.version.version }}/ui-custom-chart-debug-page.md %}) of the [DB Console]({% link {{ page.version.version }}/ui-overview.md %}). This page explains why these different systems may yield different results. +When using [Third-Party Monitoring Integrations]({% link {{ page.version.version }}/third-party-monitoring-tools.md %}), such as the [metrics export feature]({% link cockroachcloud/export-metrics.md %}), discrepancies may be seen when comparing those metrics charts to ones found on the [Metrics dashboards]({% link {{ page.version.version }}/ui-overview.md %}#metrics) or [custom charts]({% link {{ page.version.version }}/ui-custom-chart-debug-page.md %}) of the [DB Console]({% link {{ page.version.version }}/ui-overview.md %}). This page explains why these different systems may yield different results. ## CockroachDB’s Timeseries Database @@ -33,7 +33,7 @@ Datadog scrapes every 60s | 0 | - | - | - | - | - | 0 Since Cockroach Labs does not own the third-party systems, we can not be expected to have intimate knowledge about how each system’s different query language and timeseries database works. -The [metrics export feature](https://www.cockroachlabs.com/docs/cockroachcloud/export-metrics) scrapes the `/_status/vars` endpoint every 30 seconds, and forwards the data along to the third-party system. The metrics export does no intermediate aggregation, downsampling, or modification of the timeseries values at any point. The raw metrics export data is at a 30-second resolution, but how that data is processed once received by the third party system is unknown to us. +The [metrics export feature]({% link cockroachcloud/export-metrics.md %}) scrapes the `/_status/vars` endpoint every 30 seconds, and forwards the data along to the third-party system. The metrics export does no intermediate aggregation, downsampling, or modification of the timeseries values at any point. The raw metrics export data is at a 30-second resolution, but how that data is processed once received by the third party system is unknown to us. It is within our scope to understand and support our own timeseries database. If you have problems receiving metrics in your third-party system, [our support]({% link {{ page.version.version }}/support-resources.md %}) can help troubleshoot those problems. However, once the data is ingested into the third-party system, please contact your representative at that third-party company to support issues found on those systems. For example, assuming the raw metric data has been ingested as expected, Cockroach Labs does not support writing queries in third-party systems, such as using Datadog's Metrics Explorer or Datadog Query Language (DQL). @@ -43,4 +43,4 @@ It is within our scope to understand and support our own timeseries database. If - [DB Console Overview]({% link {{ page.version.version }}/ui-overview.md %}) - [Third-Party Monitoring Integrations]({% link {{ page.version.version }}/third-party-monitoring-tools.md %}) - [Monitor CockroachDB with Prometheus]({% link {{ page.version.version }}/monitor-cockroachdb-with-prometheus.md %}) -- [Export Metrics From a CockroachDB Dedicated Cluster](https://www.cockroachlabs.com/docs/cockroachcloud/export-metrics) \ No newline at end of file +- [Export Metrics From a CockroachDB Dedicated Cluster]({% link cockroachcloud/export-metrics.md %}) \ No newline at end of file diff --git a/src/current/v24.1/example-apps.md b/src/current/v24.1/example-apps.md index e410f1a6ade..bea3cfd1876 100644 --- a/src/current/v24.1/example-apps.md +++ b/src/current/v24.1/example-apps.md @@ -52,7 +52,7 @@ Note that tools with [**community-level** support]({% link {{ page.version.versi | Driver/ORM Framework | Support level | Example apps | |--------------------------------------------+----------------+--------------------------------------------------------| -| [JDBC](https://jdbc.postgresql.org/) | Full | [Quickstart](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart)
[Simple CRUD]({% link {{ page.version.version }}/build-a-java-app-with-cockroachdb.md %})
[Roach Data (Spring Boot App)](build-a-spring-app-with-cockroachdb-jdbc.html) +| [JDBC](https://jdbc.postgresql.org/) | Full | [Quickstart]({% link cockroachcloud/quickstart.md %})
[Simple CRUD]({% link {{ page.version.version }}/build-a-java-app-with-cockroachdb.md %})
[Roach Data (Spring Boot App)](build-a-spring-app-with-cockroachdb-jdbc.html) | [Hibernate](https://hibernate.org/orm/) | Full | [Simple CRUD]({% link {{ page.version.version }}/build-a-java-app-with-cockroachdb-hibernate.md %})
[Roach Data (Spring Boot App)](build-a-spring-app-with-cockroachdb-jpa.html) | [jOOQ](https://www.jooq.org/) | Full | [Simple CRUD]({% link {{ page.version.version }}/build-a-java-app-with-cockroachdb-jooq.md %}) diff --git a/src/current/v24.1/explain-analyze.md b/src/current/v24.1/explain-analyze.md index 68cb8e8c7d5..a323c63cde9 100644 --- a/src/current/v24.1/explain-analyze.md +++ b/src/current/v24.1/explain-analyze.md @@ -76,7 +76,7 @@ Property | Description `sql cpu time` | The total amount of time spent in the [SQL layer]({% link {{ page.version.version }}/architecture/sql-layer.md %}). It does not include time spent in the [storage layer]({% link {{ page.version.version }}/architecture/storage-layer.md %}). `regions` | The [regions]({% link {{ page.version.version }}/show-regions.md %}) 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)](https://www.cockroachlabs.com/docs/cockroachcloud/plan-your-cluster-serverless#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)]({% link cockroachcloud/plan-your-cluster-serverless.md %}#request-units) consumed by the statement. This property is visible only on CockroachDB {{ site.data.products.serverless }} clusters. ### Statement plan tree properties diff --git a/src/current/v24.1/frequently-asked-questions.md b/src/current/v24.1/frequently-asked-questions.md index d4da65508cf..8b9acb67a5a 100644 --- a/src/current/v24.1/frequently-asked-questions.md +++ b/src/current/v24.1/frequently-asked-questions.md @@ -28,7 +28,7 @@ CockroachDB returns single-row reads in 2ms or less and single-row writes in 4ms ### How easy is it to get started with CockroachDB? -You can get started with CockroachDB with just a few clicks. Sign up for a CockroachDB {{ site.data.products.cloud }} account to create a free CockroachDB {{ site.data.products.serverless }} cluster. For more details, see [Quickstart](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart). +You can get started with CockroachDB with just a few clicks. Sign up for a CockroachDB {{ site.data.products.cloud }} account to create a free CockroachDB {{ site.data.products.serverless }} cluster. For more details, see [Quickstart]({% link cockroachcloud/quickstart.md %}). Alternatively, you can download a binary or run our official Kubernetes configurations or Docker image. For more details, see [Install CockroachDB]({% link {{ page.version.version }}/install-cockroachdb.md %}). @@ -54,7 +54,7 @@ When your cluster spans multiple nodes (physical machines, virtual machines, or For more information about scaling a CockroachDB cluster, see the following docs: -- [Plan Your Serverless Cluster - Cluster scaling](https://www.cockroachlabs.com/docs/cockroachcloud/plan-your-cluster#cluster-scaling) +- [Plan Your Serverless Cluster - Cluster scaling]({% link cockroachcloud/plan-your-cluster.md %}#cluster-scaling) - [Manage Your Dedicated Cluster - Scale your cluster](https://www.cockroachlabs.com/docs/cockroachcloud/plan-your-cluster?filters=dedicated#cluster-scaling) - [`cockroach start` - Add a node to a cluster]({% link {{ page.version.version }}/cockroach-start.md %}#add-a-node-to-a-cluster) diff --git a/src/current/v24.1/goldengate.md b/src/current/v24.1/goldengate.md index 949d4878df8..b6a6ea43599 100644 --- a/src/current/v24.1/goldengate.md +++ b/src/current/v24.1/goldengate.md @@ -515,6 +515,6 @@ Run the steps in this section on a machine and in a directory where Oracle Golde ## 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 %}) - [Change Data Capture Overview]({% link {{ page.version.version }}/change-data-capture-overview.md %}) - [Third-Party Tools Supported by Cockroach Labs]({% link {{ page.version.version }}/third-party-database-tools.md %}) diff --git a/src/current/v24.1/hashicorp-integration.md b/src/current/v24.1/hashicorp-integration.md index 76a482a071f..7c9f61e8d61 100644 --- a/src/current/v24.1/hashicorp-integration.md +++ b/src/current/v24.1/hashicorp-integration.md @@ -28,10 +28,10 @@ CockroachDB customers can integrate these services, using Vault's KMS secrets en Resources: -- [CMEK overview](https://www.cockroachlabs.com/docs/cockroachcloud/cmek) -- [Manage Customer-Managed Encryption Keys (CMEK) for CockroachDB Dedicated](https://www.cockroachlabs.com/docs/cockroachcloud/managing-cmek) -- [Provisioning GCP KMS Keys and Service Accounts for CMEK](https://www.cockroachlabs.com/docs/cockroachcloud/cmek-ops-gcp) -- [Provisioning AWS KMS Keys and IAM Roles for CMEK](https://www.cockroachlabs.com/docs/cockroachcloud/cmek-ops-aws) +- [CMEK overview]({% link cockroachcloud/cmek.md %}) +- [Manage Customer-Managed Encryption Keys (CMEK) for CockroachDB Dedicated]({% link cockroachcloud/managing-cmek.md %}) +- [Provisioning GCP KMS Keys and Service Accounts for CMEK]({% link cockroachcloud/cmek-ops-gcp.md %}) +- [Provisioning AWS KMS Keys and IAM Roles for CMEK]({% link cockroachcloud/cmek-ops-aws.md %}) ## Use Vault's PKI Secrets Engine to manage a CockroachDB {{ site.data.products.dedicated }} cluster's certificate authority (CA) and client certificates. @@ -41,7 +41,7 @@ By using Vault to manage certificates, you can use only certificates with short Refer to [Transport Layer Security (TLS) and Public Key Infrastructure (PKI)]({% link {{ page.version.version }}/security-reference/transport-layer-security.md %}) for an overview. -Refer to [Certificate Authentication for SQL Clients in CockroachDB Dedicated Clusters](https://www.cockroachlabs.com/docs/cockroachcloud/client-certs-dedicated) for procedures in involved in administering PKI for a CockroachDB {{ site.data.products.dedicated }} cluster. +Refer to [Certificate Authentication for SQL Clients in CockroachDB Dedicated Clusters]({% link cockroachcloud/client-certs-dedicated.md %}) for procedures in involved in administering PKI for a CockroachDB {{ site.data.products.dedicated }} cluster. ## Use Vault's PKI Secrets Engine to manage a CockroachDB {{ site.data.products.core }} cluster's certificate authority (CA), server, and client certificates @@ -75,12 +75,12 @@ Vault's [Transit Secrets Engine](https://www.vaultproject.io/docs/secrets/transi ## See also -- [CMEK overview](https://www.cockroachlabs.com/docs/cockroachcloud/cmek) -- [Manage Customer-Managed Encryption Keys (CMEK) for CockroachDB Dedicated](https://www.cockroachlabs.com/docs/cockroachcloud/managing-cmek) -- [Provisioning GCP KMS Keys and Service Accounts for CMEK](https://www.cockroachlabs.com/docs/cockroachcloud/cmek-ops-gcp) -- [Provisioning AWS KMS Keys and IAM Roles for CMEK](https://www.cockroachlabs.com/docs/cockroachcloud/cmek-ops-aws) +- [CMEK overview]({% link cockroachcloud/cmek.md %}) +- [Manage Customer-Managed Encryption Keys (CMEK) for CockroachDB Dedicated]({% link cockroachcloud/managing-cmek.md %}) +- [Provisioning GCP KMS Keys and Service Accounts for CMEK]({% link cockroachcloud/cmek-ops-gcp.md %}) +- [Provisioning AWS KMS Keys and IAM Roles for CMEK]({% link cockroachcloud/cmek-ops-aws.md %}) - [Transport Layer Security (TLS) and Public Key Infrastructure (PKI)]({% link {{ page.version.version }}/security-reference/transport-layer-security.md %}) -- [Certificate Authentication for SQL Clients in Dedicated Clusters](https://www.cockroachlabs.com/docs/cockroachcloud/client-certs-dedicated) +- [Certificate Authentication for SQL Clients in Dedicated Clusters]({% link cockroachcloud/client-certs-dedicated.md %}) - [Manage PKI certificates for a CockroachDB deployment with HashiCorp Vault]({% link {{ page.version.version }}/manage-certs-vault.md %}) - [Using HashiCorp Vault's Dynamic Secrets for Enhanced Database Credential Security in CockroachDB]({% link {{ page.version.version }}/vault-db-secrets-tutorial.md %}) - [Roles]({% link {{ page.version.version }}/security-reference/authorization.md %}#roles) diff --git a/src/current/v24.1/hasura-getting-started.md b/src/current/v24.1/hasura-getting-started.md index 7e129c9404c..6a79da9345f 100644 --- a/src/current/v24.1/hasura-getting-started.md +++ b/src/current/v24.1/hasura-getting-started.md @@ -21,7 +21,7 @@ This tutorial will show you how to configure a Hasura project with a CockroachDB Before you start this tutorial, you need: -- An existing [CockroachDB Cloud](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart) cluster, running CockroachDB v22.2 or later. +- An existing [CockroachDB Cloud]({% link cockroachcloud/quickstart.md %}) cluster, running CockroachDB v22.2 or later. - A [Hasura Cloud account](https://hasura.io/docs/latest/getting-started/getting-started-cloud/). ## Configure your cluster @@ -46,7 +46,7 @@ Before you start this tutorial, you need:
1. In the [CockroachDB Cloud console](https://cockroachlabs.cloud/clusters), select your cluster and click **Connect**. -1. If you have not set up [IP Allowlists](https://www.cockroachlabs.com/docs/cockroachcloud/network-authorization#ip-allowlisting) under **Network Security**, follow the instructions to add connections to your cluster from your machine. +1. If you have not set up [IP Allowlists]({% link cockroachcloud/network-authorization.md %}#ip-allowlisting) under **Network Security**, follow the instructions to add connections to your cluster from your machine. 1. Select the SQL user you want to use for the Hasura Cloud connection under **Select SQL user**. If you have not set up a SQL user for this cluster, follow the instructions to create a new SQL user. Be sure to copy and save the password to a secure location. 1. Select **General connection String**. 1. Copy the connection string under **General connection string** and paste it in a secure location. You will use this connection string later to configure Hasura GraphQL Engine with your cluster. @@ -146,7 +146,7 @@ Create a `CRDB_URL` environment variable to store the connection string. ## Add the Hasura Cloud network to your cluster allowlist -Your CockroachDB {{ site.data.products.dedicated }} cluster needs to be configured to [allow incoming client connections](https://www.cockroachlabs.com/docs/cockroachcloud/network-authorization#ip-allowlisting) from Hasura Cloud. +Your CockroachDB {{ site.data.products.dedicated }} cluster needs to be configured to [allow incoming client connections]({% link cockroachcloud/network-authorization.md %}#ip-allowlisting) from Hasura Cloud. 1. In the Hasura Cloud overview page select **Projects**, then click the **Config** icon for your project. diff --git a/src/current/v24.1/import-performance-best-practices.md b/src/current/v24.1/import-performance-best-practices.md index 8d69fe1ee73..95ca362a14a 100644 --- a/src/current/v24.1/import-performance-best-practices.md +++ b/src/current/v24.1/import-performance-best-practices.md @@ -35,7 +35,7 @@ When importing into a new table, split your dump data into two files: 1. A SQL file containing the table schema. 1. A CSV, delimited, or AVRO file containing the table data. -Convert the schema-only file using the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page). The Schema Conversion Tool automatically creates a new CockroachDB {{ site.data.products.serverless }} database with the converted schema. {% include cockroachcloud/migration/sct-self-hosted.md %} +Convert the schema-only file using the [Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}). The Schema Conversion Tool automatically creates a new CockroachDB {{ site.data.products.serverless }} database with the converted schema. {% include cockroachcloud/migration/sct-self-hosted.md %} Then use the [`IMPORT INTO`](import-into.html) statement to import the CSV data into the newly created table: diff --git a/src/current/v24.1/insert-data.md b/src/current/v24.1/insert-data.md index 725936d5212..1e44969642f 100644 --- a/src/current/v24.1/insert-data.md +++ b/src/current/v24.1/insert-data.md @@ -11,7 +11,7 @@ This page has instructions for getting data into CockroachDB with various progra Before reading this page, do the following: -- [Create a CockroachDB {{ site.data.products.serverless }} 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.serverless }} 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 %}). diff --git a/src/current/v24.1/kibana.md b/src/current/v24.1/kibana.md index bbc1e9e9f86..90697dd9439 100644 --- a/src/current/v24.1/kibana.md +++ b/src/current/v24.1/kibana.md @@ -8,7 +8,7 @@ docs_area: manage [Kibana](https://www.elastic.co/kibana/) is a platform that visualizes data on the [Elastic Stack](https://www.elastic.co/elastic-stack/). This page shows how to use the [CockroachDB module for Metricbeat](https://www.elastic.co/guide/en/beats/metricbeat/current/metricbeat-module-cockroachdb.html) to collect metrics exposed by your CockroachDB {{ site.data.products.core }} cluster's [Prometheus endpoint]({% link {{ page.version.version }}/monitoring-and-alerting.md %}#prometheus-endpoint) in Elasticsearch and how to visualize those metrics with Kibana. {{site.data.alerts.callout_success}} -To export metrics from a CockroachDB {{ site.data.products.cloud }} cluster, refer to [Export Metrics From a CockroachDB {{ site.data.products.dedicated }} Cluster](https://www.cockroachlabs.com/docs/cockroachcloud/export-metrics) instead of this page. +To export metrics from a CockroachDB {{ site.data.products.cloud }} cluster, refer to [Export Metrics From a CockroachDB {{ site.data.products.dedicated }} Cluster]({% link cockroachcloud/export-metrics.md %}) instead of this page. {{site.data.alerts.end}} In this tutorial, you will enable the CockroachDB module for Metricbeat and visualize the data in Kibana. diff --git a/src/current/v24.1/learn-cockroachdb-sql.md b/src/current/v24.1/learn-cockroachdb-sql.md index e5737403d19..e513ef15542 100644 --- a/src/current/v24.1/learn-cockroachdb-sql.md +++ b/src/current/v24.1/learn-cockroachdb-sql.md @@ -10,7 +10,7 @@ This tutorial guides you through some of the most essential CockroachDB SQL stat For a complete list of supported SQL statements and related details, see [SQL Statements]({% link {{ page.version.version }}/sql-statements.md %}). {{site.data.alerts.callout_info}} -This tutorial is for {{site.data.products.core}} users. If you are working with {{site.data.products.dedicated}} or {{site.data.products.serverless}}, you can run this tutorial against [a cluster running in the cloud](https://www.cockroachlabs.com/docs/cockroachcloud/learn-cockroachdb-sql). +This tutorial is for {{site.data.products.core}} users. If you are working with {{site.data.products.dedicated}} or {{site.data.products.serverless}}, you can run this tutorial against [a cluster running in the cloud]({% link cockroachcloud/learn-cockroachdb-sql.md %}). {{site.data.alerts.end}} ## Start CockroachDB diff --git a/src/current/v24.1/migrate-from-mysql.md b/src/current/v24.1/migrate-from-mysql.md index 2a1adcde9a2..b93b79b75ff 100644 --- a/src/current/v24.1/migrate-from-mysql.md +++ b/src/current/v24.1/migrate-from-mysql.md @@ -105,7 +105,7 @@ The example uses the [MySQL `world` data set](https://dev.mysql.com/doc/index-ot mysqlsh -uroot --sql --file {path}/world-db/world.sql ~~~ -1. Create a free [{{ site.data.products.cloud }} account](https://www.cockroachlabs.com/docs/cockroachcloud/create-an-account), which is used to access the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page?filters=mysql) and create the {{ site.data.products.serverless }} cluster. +1. Create a free [{{ site.data.products.cloud }} account]({% link cockroachcloud/create-an-account.md %}), which is used to access the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page?filters=mysql) and create the {{ site.data.products.serverless }} cluster. {{site.data.alerts.callout_success}} {% include cockroachcloud/migration/sct-self-hosted.md %} @@ -162,7 +162,7 @@ Use the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachclo 1. Click [**Migrate Schema**](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page?filters=mysql#migrate-the-schema) to create a new {{ site.data.products.serverless }} cluster with the converted schema. Name the database `world`. - You can view this database on the [**Databases** page](https://www.cockroachlabs.com/docs/cockroachcloud/databases-page) of the {{ site.data.products.cloud }} Console. + You can view this database on the [**Databases** page]({% link cockroachcloud/databases-page.md %}) of the {{ site.data.products.cloud }} Console. 1. Open a SQL shell to the CockroachDB `world` cluster. To find the command, open the **Connect** dialog in the {{ site.data.products.cloud }} Console and select the `world` database and **CockroachDB Client** option. It will look like: @@ -402,7 +402,7 @@ To learn more, see the [Migration Overview]({% link {{ page.version.version }}/m ## See also - [Migration Overview]({% link {{ page.version.version }}/migration-overview.md %}) -- [Use the Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) +- [Use the Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) - [Use the MOLT Verify tool]({% link molt/molt-verify.md %}) - [Import Performance Best Practices]({% link {{ page.version.version }}/import-performance-best-practices.md %}) - [Migrate from CSV]({% link {{ page.version.version }}/migrate-from-csv.md %}) diff --git a/src/current/v24.1/migrate-from-postgres.md b/src/current/v24.1/migrate-from-postgres.md index 8d35c7c7dd4..2f142eaeaca 100644 --- a/src/current/v24.1/migrate-from-postgres.md +++ b/src/current/v24.1/migrate-from-postgres.md @@ -70,7 +70,7 @@ The example uses a modified version of the PostgreSQL `french-towns-communes-fra psql frenchtowns -a -f frenchtowns.sql ~~~ -1. Create a free [{{ site.data.products.cloud }} account](https://www.cockroachlabs.com/docs/cockroachcloud/create-an-account), which is used to access the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) and create the {{ site.data.products.serverless }} cluster. +1. Create a free [{{ site.data.products.cloud }} account]({% link cockroachcloud/create-an-account.md %}), which is used to access the [Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) and create the {{ site.data.products.serverless }} cluster. {{site.data.alerts.callout_success}} {% include cockroachcloud/migration/sct-self-hosted.md %} @@ -78,7 +78,7 @@ The example uses a modified version of the PostgreSQL `french-towns-communes-fra ### Step 1. Convert the PostgreSQL schema -Use the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) to convert the `frenchtowns` schema for compatibility with CockroachDB. The schema has three tables: `regions`, `departments`, and `towns`. +Use the [Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) to convert the `frenchtowns` schema for compatibility with CockroachDB. The schema has three tables: `regions`, `departments`, and `towns`. 1. Dump the PostgreSQL `frenchtowns` schema with the following [`pg_dump`](https://www.postgresql.org/docs/15/app-pgdump.html) command: @@ -87,12 +87,12 @@ Use the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachclo pg_dump --schema-only frenchtowns > frenchtowns_schema.sql ~~~ -1. Open the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) in the {{ site.data.products.cloud }} Console and [add a new PostgreSQL schema](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page#convert-a-schema). +1. Open the [Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) in the {{ site.data.products.cloud }} Console and [add a new PostgreSQL schema]({% link cockroachcloud/migrations-page.md %}#convert-a-schema). - After conversion is complete, [review the results](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page#review-the-schema). The [**Summary Report**](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page#summary-report) shows that there are errors under **Required Fixes**. You must resolve these in order to migrate the schema to CockroachDB. + After conversion is complete, [review the results]({% link cockroachcloud/migrations-page.md %}#review-the-schema). The [**Summary Report**]({% link cockroachcloud/migrations-page.md %}#summary-report) shows that there are errors under **Required Fixes**. You must resolve these in order to migrate the schema to CockroachDB. {{site.data.alerts.callout_success}} - You can also [add your PostgreSQL database credentials](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page#use-credentials) to have the Schema Conversion Tool obtain the schema directly from the PostgreSQL database. + You can also [add your PostgreSQL database credentials]({% link cockroachcloud/migrations-page.md %}#use-credentials) to have the Schema Conversion Tool obtain the schema directly from the PostgreSQL database. {{site.data.alerts.end}} 1. `Missing user: postgres` errors indicate that the SQL user `postgres` is missing from CockroachDB. Click **Add User** to create the user. @@ -107,9 +107,9 @@ Use the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachclo This example migrates directly to a {{ site.data.products.serverless }} cluster. {% include cockroachcloud/migration/sct-self-hosted.md %} -1. Click [**Migrate Schema**](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page#migrate-the-schema) to create a new {{ site.data.products.serverless }} cluster with the converted schema. Name the database `frenchtowns`. +1. Click [**Migrate Schema**]({% link cockroachcloud/migrations-page.md %}#migrate-the-schema) to create a new {{ site.data.products.serverless }} cluster with the converted schema. Name the database `frenchtowns`. - You can view this database on the [**Databases** page](https://www.cockroachlabs.com/docs/cockroachcloud/databases-page) of the {{ site.data.products.cloud }} Console. + You can view this database on the [**Databases** page]({% link cockroachcloud/databases-page.md %}) of the {{ site.data.products.cloud }} Console. ### Step 2. Load the PostgreSQL data @@ -287,7 +287,7 @@ To learn more, see the [Migration Overview]({% link {{ page.version.version }}/m ## See also - [Migration Overview]({% link {{ page.version.version }}/migration-overview.md %}) -- [Use the Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) +- [Use the Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) - [Use the MOLT Verify tool]({% link molt/molt-verify.md %}) - [Import Performance Best Practices]({% link {{ page.version.version }}/import-performance-best-practices.md %}) - [Migrate from CSV]({% link {{ page.version.version }}/migrate-from-csv.md %}) diff --git a/src/current/v24.1/migration-overview.md b/src/current/v24.1/migration-overview.md index 4b8718dc76e..92405f6cd05 100644 --- a/src/current/v24.1/migration-overview.md +++ b/src/current/v24.1/migration-overview.md @@ -8,7 +8,7 @@ docs_area: migrate This page provides an overview of how to migrate a database to CockroachDB. {{site.data.alerts.callout_info}} -If you need to migrate data from a CockroachDB {{ site.data.products.serverless }} cluster to a CockroachDB {{ site.data.products.dedicated }} cluster, see [Migrate data from Serverless to Dedicated](https://www.cockroachlabs.com/docs/cockroachcloud/migrate-from-serverless-to-dedicated). +If you need to migrate data from a CockroachDB {{ site.data.products.serverless }} cluster to a CockroachDB {{ site.data.products.dedicated }} cluster, see [Migrate data from Serverless to Dedicated]({% link cockroachcloud/migrate-from-serverless-to-dedicated.md %}). {{site.data.alerts.end}} A database migration broadly consists of the following phases: @@ -117,11 +117,11 @@ Determine the size of the target CockroachDB cluster. To do this, consider your - What is the total size of the data you will migrate? - How many active [application connections]({% link {{ page.version.version }}/recommended-production-settings.md %}#connection-pooling) will be running in the CockroachDB environment? -Use this information to size the CockroachDB cluster you will create. If you are migrating to a CockroachDB {{ site.data.products.cloud }} cluster, see [Plan Your Cluster](https://www.cockroachlabs.com/docs/cockroachcloud/plan-your-cluster) for details: +Use this information to size the CockroachDB cluster you will create. If you are migrating to a CockroachDB {{ site.data.products.cloud }} cluster, see [Plan Your Cluster]({% link cockroachcloud/plan-your-cluster.md %}) for details: -- For CockroachDB {{ site.data.products.dedicated }}, refer to the [example](https://www.cockroachlabs.com/docs/cockroachcloud/plan-your-cluster#dedicated-example) that shows how your data volume, storage requirements, and replication factor affect the recommended node size (number of vCPUs per node) and total number of nodes on the cluster. -- For CockroachDB {{ site.data.products.serverless }}, your cluster will scale automatically to meet your storage and usage requirements. Refer to [Choosing resource limits](https://www.cockroachlabs.com/docs/cockroachcloud/plan-your-cluster-serverless#choose-resource-limits) to learn about how to limit your resource consumption. -- For guidance on sizing for connection pools, see the CockroachDB {{ site.data.products.cloud }} [Production Checklist](https://www.cockroachlabs.com/docs/cockroachcloud/production-checklist#use-a-pool-of-persistent-connections). +- For CockroachDB {{ site.data.products.dedicated }}, refer to the [example]({% link cockroachcloud/plan-your-cluster.md %}#dedicated-example) that shows how your data volume, storage requirements, and replication factor affect the recommended node size (number of vCPUs per node) and total number of nodes on the cluster. +- For CockroachDB {{ site.data.products.serverless }}, your cluster will scale automatically to meet your storage and usage requirements. Refer to [Choosing resource limits]({% link cockroachcloud/plan-your-cluster-serverless.md %}#choose-resource-limits) to learn about how to limit your resource consumption. +- For guidance on sizing for connection pools, see the CockroachDB {{ site.data.products.cloud }} [Production Checklist]({% link cockroachcloud/production-checklist.md %}#connection-pooling). If you are migrating to a CockroachDB {{ site.data.products.core }} cluster: @@ -143,7 +143,7 @@ As you develop your migration plan, consider the application changes that you wi Follow these recommendations when [converting your schema](#convert-the-schema) for compatibility with CockroachDB. {{site.data.alerts.callout_success}} -The [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) automatically identifies potential improvements to your schema. +The [Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) automatically identifies potential improvements to your schema. {{site.data.alerts.end}} - You should define an explicit primary key on every table. For more information, see [Primary key best practices]({% link {{ page.version.version }}/schema-design-table.md %}#primary-key-best-practices). @@ -169,7 +169,7 @@ Transaction retry errors are more frequent under CockroachDB's default [`SERIALI Update your queries to resolve differences in functionality and SQL syntax. {{site.data.alerts.callout_success}} -The [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) automatically flags syntax incompatibilities and unimplemented features in your schema. +The [Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) automatically flags syntax incompatibilities and unimplemented features in your schema. {{site.data.alerts.end}} CockroachDB supports the [PostgreSQL wire protocol](https://www.postgresql.org/docs/current/protocol.html) and is largely compatible with PostgreSQL syntax. However, the following PostgreSQL features do not yet exist in CockroachDB: @@ -217,7 +217,7 @@ In the following order: You can use the following [MOLT (Migrate Off Legacy Technology) tools]({% link molt/molt-overview.md %}) to simplify these steps: -- [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) +- [Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) - [MOLT Fetch]({% link molt/molt-fetch.md %}) - [MOLT Verify]({% link molt/molt-verify.md %}) @@ -225,17 +225,17 @@ You can use the following [MOLT (Migrate Off Legacy Technology) tools]({% link m First, convert your database schema to an equivalent CockroachDB schema: -- Use the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) to convert your schema line-by-line. This requires a free [CockroachDB {{ site.data.products.cloud }} account](https://www.cockroachlabs.com/docs/cockroachcloud/create-an-account). The tool will convert the syntax, identify [unimplemented features and syntax incompatibilities](#unimplemented-features-and-syntax-incompatibilities) in the schema, and suggest edits according to CockroachDB [best practices](#schema-design-best-practices). +- Use the [Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) to convert your schema line-by-line. This requires a free [CockroachDB {{ site.data.products.cloud }} account]({% link cockroachcloud/create-an-account.md %}). The tool will convert the syntax, identify [unimplemented features and syntax incompatibilities](#unimplemented-features-and-syntax-incompatibilities) in the schema, and suggest edits according to CockroachDB [best practices](#schema-design-best-practices). {{site.data.alerts.callout_info}} The Schema Conversion Tool accepts `.sql` files from PostgreSQL, MySQL, Oracle, and Microsoft SQL Server. {{site.data.alerts.end}} -- Alternatively, manually convert the schema according to our [schema design best practices](#schema-design-best-practices){% comment %}and data type mappings{% endcomment %}. You can also [export a partially converted schema](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page#export-the-schema) from the Schema Conversion Tool to finish the conversion manually. +- Alternatively, manually convert the schema according to our [schema design best practices](#schema-design-best-practices){% comment %}and data type mappings{% endcomment %}. You can also [export a partially converted schema]({% link cockroachcloud/migrations-page.md %}#export-the-schema) from the Schema Conversion Tool to finish the conversion manually. Then import the converted schema to a CockroachDB cluster: -- For CockroachDB {{ site.data.products.cloud }}, use the Schema Conversion Tool to [migrate the converted schema to a new {{ site.data.products.serverless }} or {{ site.data.products.dedicated }} database](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page#migrate-the-schema). -- For CockroachDB {{ site.data.products.core }}, pipe the [data definition language (DDL)]({% link {{ page.version.version }}/sql-statements.md %}#data-definition-statements) directly into [`cockroach sql`]({% link {{ page.version.version }}/cockroach-sql.md %}). You can [export a converted schema file](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page#export-the-schema) from the Schema Conversion Tool. +- For CockroachDB {{ site.data.products.cloud }}, use the Schema Conversion Tool to [migrate the converted schema to a new {{ site.data.products.serverless }} or {{ site.data.products.dedicated }} database]({% link cockroachcloud/migrations-page.md %}#migrate-the-schema). +- For CockroachDB {{ site.data.products.core }}, pipe the [data definition language (DDL)]({% link {{ page.version.version }}/sql-statements.md %}#data-definition-statements) directly into [`cockroach sql`]({% link {{ page.version.version }}/cockroach-sql.md %}). You can [export a converted schema file]({% link cockroachcloud/migrations-page.md %}#export-the-schema) from the Schema Conversion Tool. {{site.data.alerts.callout_success}} For the fastest performance, you can use a [local, single-node CockroachDB cluster]({% link {{ page.version.version }}/cockroach-start-single-node.md %}#start-a-single-node-cluster) to convert your schema and [check the results of queries](#test-query-results-and-performance). {{site.data.alerts.end}} @@ -268,7 +268,7 @@ You can "shadow" your production workload by executing your source SQL statement You can manually validate your queries by testing a subset of "critical queries" on an otherwise idle CockroachDB cluster: -- Check the application logs for error messages and the API response time. If application requests are slower than expected, use the **SQL Activity** page on the [CockroachDB {{ site.data.products.cloud }} Console](https://www.cockroachlabs.com/docs/cockroachcloud/statements-page) or [DB Console]({% link {{ page.version.version }}/ui-statements-page.md %}) to find the longest-running queries that are part of that application request. If necessary, tune the queries according to our best practices for [SQL performance]({% link {{ page.version.version }}/performance-best-practices-overview.md %}). +- Check the application logs for error messages and the API response time. If application requests are slower than expected, use the **SQL Activity** page on the [CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/statements-page.md %}) or [DB Console]({% link {{ page.version.version }}/ui-statements-page.md %}) to find the longest-running queries that are part of that application request. If necessary, tune the queries according to our best practices for [SQL performance]({% link {{ page.version.version }}/performance-best-practices-overview.md %}). - Compare the results of the queries and check that they are identical in both the source database and CockroachDB. To do this, you can use [MOLT Verify]({% link molt/molt-verify.md %}). @@ -350,7 +350,7 @@ After you have successfully [conducted the migration](#conduct-the-migration): - [Can a PostgreSQL or MySQL application be migrated to CockroachDB?]({% link {{ page.version.version }}/frequently-asked-questions.md %}#can-a-postgresql-or-mysql-application-be-migrated-to-cockroachdb) - [PostgreSQL Compatibility]({% link {{ page.version.version }}/postgresql-compatibility.md %}) -- [Use the Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) +- [Use the Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) - [Schema Design Overview]({% link {{ page.version.version }}/schema-design-overview.md %}) - [Create a User-defined Schema]({% link {{ page.version.version }}/schema-design-schema.md %}) - [Primary key best practices]({% link {{ page.version.version }}/schema-design-table.md %}#primary-key-best-practices) diff --git a/src/current/v24.1/migration-strategy-lift-and-shift.md b/src/current/v24.1/migration-strategy-lift-and-shift.md index 8c7404f84c8..7417b4c7b3c 100644 --- a/src/current/v24.1/migration-strategy-lift-and-shift.md +++ b/src/current/v24.1/migration-strategy-lift-and-shift.md @@ -72,7 +72,7 @@ It's important to decide which data formats, storage media, and database feature Data formats that can be imported by CockroachDB include: -- [SQL]({% link {{ page.version.version }}/schema-design-overview.md %}) for the [schema import](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page). +- [SQL]({% link {{ page.version.version }}/schema-design-overview.md %}) for the [schema import]({% link cockroachcloud/migrations-page.md %}). - [CSV]({% link {{ page.version.version }}/migrate-from-csv.md %}) for table data. - [Avro]({% link {{ page.version.version }}/migrate-from-avro.md %}) for table data. @@ -121,7 +121,7 @@ For more information about import performance, see [Import Performance Best Prac ## See also - [Migration Overview]({% link {{ page.version.version }}/migration-overview.md %}) -- [Use the Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) +- [Use the Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) - [Migrate with AWS Database Migration Service (DMS)]({% link {{ page.version.version }}/aws-dms.md %}) - [AWS DMS documentation](https://docs.aws.amazon.com/dms/latest/userguide/Welcome.html) - [Migrate and Replicate Data with Qlik Replicate]({% link {{ page.version.version }}/qlik.md %}) diff --git a/src/current/v24.1/monitoring-and-alerting.md b/src/current/v24.1/monitoring-and-alerting.md index 5d85952ae7c..eebde1ce00f 100644 --- a/src/current/v24.1/monitoring-and-alerting.md +++ b/src/current/v24.1/monitoring-and-alerting.md @@ -7,7 +7,7 @@ docs_area: manage In addition to CockroachDB's [built-in safeguards against failure]({% link {{ page.version.version }}/frequently-asked-questions.md %}#how-does-cockroachdb-survive-failures), it is critical to actively monitor the overall health and performance of a cluster running in production and to create alerting rules that promptly send notifications when there are events that require investigation or intervention. -This page describes the monitoring and observability tools that are built into CockroachDB {{ site.data.products.core }} and shows how to collect your cluster's metrics using external tools like Prometheus's AlertManager for event-based alerting. To export metrics from a CockroachDB {{ site.data.products.cloud }} cluster, refer to [Export Metrics From a CockroachDB {{ site.data.products.dedicated }} Cluster](https://www.cockroachlabs.com/docs/cockroachcloud/export-metrics) instead of this page. For more details, refer to: +This page describes the monitoring and observability tools that are built into CockroachDB {{ site.data.products.core }} and shows how to collect your cluster's metrics using external tools like Prometheus's AlertManager for event-based alerting. To export metrics from a CockroachDB {{ site.data.products.cloud }} cluster, refer to [Export Metrics From a CockroachDB {{ site.data.products.dedicated }} Cluster]({% link cockroachcloud/export-metrics.md %}) instead of this page. For more details, refer to: - [Monitor CockroachDB with Prometheus]({% link {{ page.version.version }}/monitor-cockroachdb-with-prometheus.md %}) - [Third-party Monitoring Tools]({% link {{ page.version.version }}/third-party-monitoring-tools.md %}) diff --git a/src/current/v24.1/movr-flask-deployment.md b/src/current/v24.1/movr-flask-deployment.md index 0ddb93896eb..2ce85089d43 100644 --- a/src/current/v24.1/movr-flask-deployment.md +++ b/src/current/v24.1/movr-flask-deployment.md @@ -21,7 +21,7 @@ In addition to the requirements listed in [Setting Up a Virtual Environment for ## Multi-region database deployment -In production, you want to start a secure CockroachDB cluster, with nodes on machines located in different areas of the world. To deploy CockroachDB in multiple regions, we recommend using [CockroachDB {{ site.data.products.dedicated }}](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart). +In production, you want to start a secure CockroachDB cluster, with nodes on machines located in different areas of the world. To deploy CockroachDB in multiple regions, we recommend using [CockroachDB {{ site.data.products.dedicated }}]({% link cockroachcloud/quickstart.md %}). {{site.data.alerts.callout_info}} You can also deploy CockroachDB manually. For instructions, see the [Manual Deployment]({% link {{ page.version.version }}/manual-deployment.md %}) page of the Cockroach Labs documentation site. @@ -235,7 +235,7 @@ Some time after you have deployed your application, you will likely need to push ## See also {% comment %} [MovR (live demo)](https://movr.cloud){% endcomment %} -- [CockroachDB {{ site.data.products.cloud }} documentation](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart) +- [CockroachDB {{ site.data.products.cloud }} documentation]({% link cockroachcloud/quickstart.md %}) - [Google Cloud Platform documentation](https://cloud.google.com/docs/) - [Docker documentation](https://docs.docker.com/) - [Kubernetes documentation](https://kubernetes.io/docs/home/) diff --git a/src/current/v24.1/multiregion-scale-application.md b/src/current/v24.1/multiregion-scale-application.md index 58ebda2d048..ccf9f2282f1 100644 --- a/src/current/v24.1/multiregion-scale-application.md +++ b/src/current/v24.1/multiregion-scale-application.md @@ -42,7 +42,7 @@ Scale the cluster by adding nodes to the cluster in new regions. For instructions on adding nodes to an existing cluster, see one of the following pages: -- For managed CockroachDB {{ site.data.products.cloud }} deployments, see [Cluster Management](https://www.cockroachlabs.com/docs/cockroachcloud/cluster-management). +- For managed CockroachDB {{ site.data.products.cloud }} deployments, see [Cluster Management]({% link cockroachcloud/cluster-management.md %}). - For orchestrated deployments, see [Orchestrate CockroachDB Across Multiple Kubernetes Clusters]({% link {{ page.version.version }}/orchestrate-cockroachdb-with-kubernetes-multi-cluster.md %}). - For manual deployments, see [`cockroach start`]({% link {{ page.version.version }}/cockroach-start.md %}) and [Manual Deployment]({% link {{ page.version.version }}/manual-deployment.md %}). @@ -68,7 +68,7 @@ Scaling application deployments in multiple regions can greatly improve latency For guidance on connecting to CockroachDB from an application deployment, see one of the following pages: -- For connecting to managed, CockroachDB {{ site.data.products.cloud }} deployments, see [Connect to Your CockroachDB {{ site.data.products.dedicated }} Cluster](https://www.cockroachlabs.com/docs/cockroachcloud/connect-to-your-cluster) and [Connect to the Database (CockroachDB {{ site.data.products.dedicated }})]({% link {{ page.version.version }}/connect-to-the-database.md %}?filters=dedicated). +- For connecting to managed, CockroachDB {{ site.data.products.cloud }} deployments, see [Connect to Your CockroachDB {{ site.data.products.dedicated }} Cluster]({% link cockroachcloud/connect-to-your-cluster.md %}) and [Connect to the Database (CockroachDB {{ site.data.products.dedicated }})]({% link {{ page.version.version }}/connect-to-the-database.md %}?filters=dedicated). - For connecting to a standard CockroachDB deployment, see [`cockroach sql`]({% link {{ page.version.version }}/cockroach-sql.md %}) and [Connect to the Database]({% link {{ page.version.version }}/connect-to-the-database.md %}). To limit the latency between the application and the database, each deployment of the application should communicate with the closest database deployment. For details on configuring database connections for individual application deployments, consult your cloud provider's documentation. For an example using Google Cloud services, see [Deploy a Global, Serverless Application]({% link {{ page.version.version }}/movr-flask-deployment.md %}). diff --git a/src/current/v24.1/orchestrate-a-local-cluster-with-kubernetes-insecure.md b/src/current/v24.1/orchestrate-a-local-cluster-with-kubernetes-insecure.md index 11383548467..570e3615d41 100644 --- a/src/current/v24.1/orchestrate-a-local-cluster-with-kubernetes-insecure.md +++ b/src/current/v24.1/orchestrate-a-local-cluster-with-kubernetes-insecure.md @@ -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]({% link {{ page.version.version }}/kubernetes-overview.md %}). To deploy a 30-day free CockroachDB {{ site.data.products.dedicated }} cluster instead of running CockroachDB yourself, see the [Quickstart](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart). +To orchestrate a physically distributed cluster in production, see [Orchestrated Deployments]({% link {{ page.version.version }}/kubernetes-overview.md %}). To deploy a 30-day free CockroachDB {{ site.data.products.dedicated }} cluster instead of running CockroachDB yourself, see the [Quickstart]({% link cockroachcloud/quickstart.md %}). {{site.data.alerts.end}} ## Best practices diff --git a/src/current/v24.1/orchestrate-a-local-cluster-with-kubernetes.md b/src/current/v24.1/orchestrate-a-local-cluster-with-kubernetes.md index c30d7019aa9..7c2b9e6b162 100644 --- a/src/current/v24.1/orchestrate-a-local-cluster-with-kubernetes.md +++ b/src/current/v24.1/orchestrate-a-local-cluster-with-kubernetes.md @@ -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]({% link {{ page.version.version }}/kubernetes-overview.md %}). To deploy a 30-day free CockroachDB {{ site.data.products.dedicated }} cluster instead of running CockroachDB yourself, see the [Quickstart](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart). +To orchestrate a physically distributed cluster in production, see [Orchestrated Deployments]({% link {{ page.version.version }}/kubernetes-overview.md %}). To deploy a 30-day free CockroachDB {{ site.data.products.dedicated }} cluster instead of running CockroachDB yourself, see the [Quickstart]({% link cockroachcloud/quickstart.md %}). {{site.data.alerts.end}} ## Best practices diff --git a/src/current/v24.1/performance-recipes.md b/src/current/v24.1/performance-recipes.md index 34364d6924f..b8f53cb2767 100644 --- a/src/current/v24.1/performance-recipes.md +++ b/src/current/v24.1/performance-recipes.md @@ -95,19 +95,19 @@ This section provides solutions for common performance issues in your applicatio These are indicators that a transaction is trying to access a row that has been ["locked"]({% link {{ page.version.version }}/architecture/transaction-layer.md %}#writing) by another, concurrent transaction issuing a [write]({% link {{ page.version.version }}/architecture/transaction-layer.md %}#write-intents) or [locking read]({% link {{ page.version.version }}/select-for-update.md %}#lock-strengths). -- The **Active Executions** table on the **Transactions** page ([CockroachDB {{ site.data.products.cloud }} Console](https://www.cockroachlabs.com/docs/cockroachcloud/transactions-page) or [DB Console]({% link {{ page.version.version }}/ui-transactions-page.md %}#active-executions-table)) shows transactions with `Waiting` in the **Status** column. You can sort the table by **Time Spent Waiting**. +- The **Active Executions** table on the **Transactions** page ([CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/transactions-page.md %}) or [DB Console]({% link {{ page.version.version }}/ui-transactions-page.md %}#active-executions-table)) shows transactions with `Waiting` in the **Status** column. You can sort the table by **Time Spent Waiting**. - Querying the [`crdb_internal.cluster_locks`]({% link {{ page.version.version }}/crdb-internal.md %}#cluster_locks) table shows transactions where [`granted`]({% link {{ page.version.version }}/crdb-internal.md %}#cluster-locks-columns) is `false`. These are indicators that lock contention occurred in the past: - Querying the [`crdb_internal.transaction_contention_events`]({% link {{ page.version.version }}/crdb-internal.md %}#transaction_contention_events) table `WHERE contention_type='LOCK_WAIT'` indicates that your transactions have experienced lock contention. - - This is also shown in the **Transaction Executions** view on the **Insights** page ([CockroachDB {{ site.data.products.cloud }} Console](https://www.cockroachlabs.com/docs/cockroachcloud/insights-page#transaction-executions-view) and [DB Console]({% link {{ page.version.version }}/ui-insights-page.md %}#transaction-executions-view)). Transaction executions will display the [**High Contention** insight]({% link {{ page.version.version }}/ui-insights-page.md %}#high-contention). + - This is also shown in the **Transaction Executions** view on the **Insights** page ([CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/insights-page.md %}#transaction-executions-view) and [DB Console]({% link {{ page.version.version }}/ui-insights-page.md %}#transaction-executions-view)). Transaction executions will display the [**High Contention** insight]({% link {{ page.version.version }}/ui-insights-page.md %}#high-contention). {{site.data.alerts.callout_info}} {%- include {{ page.version.version }}/performance/sql-trace-txn-enable-threshold.md -%} {{site.data.alerts.end}} -- The **SQL Statement Contention** graph ([CockroachDB {{ site.data.products.cloud }} Console](https://www.cockroachlabs.com/docs/cockroachcloud/metrics-page#sql-statement-contention) and [DB Console]({% link {{ page.version.version }}/ui-sql-dashboard.md %}#sql-statement-contention)) is showing spikes over time. +- The **SQL Statement Contention** graph ([CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/metrics-page.md %}#sql-statement-contention) and [DB Console]({% link {{ page.version.version }}/ui-sql-dashboard.md %}#sql-statement-contention)) is showing spikes over time. SQL Statement Contention graph in DB Console If a long-running transaction is waiting due to [lock contention]({% link {{ page.version.version }}/performance-best-practices-overview.md %}#transaction-contention): @@ -124,11 +124,11 @@ These are indicators that a transaction has failed due to [contention]({% link { - A [transaction retry error]({% link {{ page.version.version }}/transaction-retry-error-reference.md %}) with `SQLSTATE: 40001`, the string [`restart transaction`]({% link {{ page.version.version }}/common-errors.md %}#restart-transaction), and an error code such as [`RETRY_WRITE_TOO_OLD`]({% link {{ page.version.version }}/transaction-retry-error-reference.md %}#retry_write_too_old) or [`RETRY_SERIALIZABLE`]({% link {{ page.version.version }}/transaction-retry-error-reference.md %}#retry_serializable), is emitted to the client. These errors are typically seen under [`SERIALIZABLE`]({% link {{ page.version.version }}/demo-serializable.md %}) and not [`READ COMMITTED`]({% link {{ page.version.version }}/read-committed.md %}) isolation. - Querying the [`crdb_internal.transaction_contention_events`]({% link {{ page.version.version }}/crdb-internal.md %}#transaction_contention_events) table `WHERE contention_type='SERIALIZATION_CONFLICT'` indicates that your transactions have experienced serialization conflicts. - - This is also shown in the **Transaction Executions** view on the **Insights** page ([CockroachDB {{ site.data.products.cloud }} Console](https://www.cockroachlabs.com/docs/cockroachcloud/insights-page#transaction-executions-view) and [DB Console]({% link {{ page.version.version }}/ui-insights-page.md %}#transaction-executions-view)). Transaction executions will display the [**Failed Execution** insight due to a serialization conflict]({% link {{ page.version.version }}/ui-insights-page.md %}#serialization-conflict-due-to-transaction-contention). + - This is also shown in the **Transaction Executions** view on the **Insights** page ([CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/insights-page.md %}#transaction-executions-view) and [DB Console]({% link {{ page.version.version }}/ui-insights-page.md %}#transaction-executions-view)). Transaction executions will display the [**Failed Execution** insight due to a serialization conflict]({% link {{ page.version.version }}/ui-insights-page.md %}#serialization-conflict-due-to-transaction-contention). These are indicators that transaction retries occurred in the past: -- The **Transaction Restarts** graph ([CockroachDB {{ site.data.products.cloud }} Console](https://www.cockroachlabs.com/docs/cockroachcloud/metrics-page#transaction-restarts) and [DB Console]({% link {{ page.version.version }}/ui-sql-dashboard.md %}#transaction-restarts) is showing spikes in transaction retries over time. +- The **Transaction Restarts** graph ([CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/metrics-page.md %}#transaction-restarts) and [DB Console]({% link {{ page.version.version }}/ui-sql-dashboard.md %}#transaction-restarts) is showing spikes in transaction retries over time. {% include {{ page.version.version }}/performance/transaction-retry-error-actions.md %} @@ -140,7 +140,7 @@ When running under `SERIALIZABLE` isolation, implement [client-side retry handli ##### Identify conflicting transactions -- In the **Active Executions** table on the **Transactions** page ([CockroachDB {{ site.data.products.cloud }} Console](https://www.cockroachlabs.com/docs/cockroachcloud/transactions-page) or [DB Console]({% link {{ page.version.version }}/ui-transactions-page.md %}#active-executions-table)), look for a **waiting** transaction (`Waiting` status). +- In the **Active Executions** table on the **Transactions** page ([CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/transactions-page.md %}) or [DB Console]({% link {{ page.version.version }}/ui-transactions-page.md %}#active-executions-table)), look for a **waiting** transaction (`Waiting` status). {{site.data.alerts.callout_success}} If you see many waiting transactions, a single long-running transaction may be blocking transactions that are, in turn, blocking others. In this case, sort the table by **Time Spent Waiting** to find the transaction that has been waiting for the longest amount of time. Unblocking this transaction may unblock the other transactions. {{site.data.alerts.end}} @@ -160,8 +160,8 @@ When running under `SERIALIZABLE` isolation, implement [client-side retry handli To identify transactions that experienced [lock contention]({% link {{ page.version.version }}/performance-best-practices-overview.md %}#transaction-contention) in the past: -- In the **Transaction Executions** view on the **Insights** page ([CockroachDB {{ site.data.products.cloud }} Console](https://www.cockroachlabs.com/docs/cockroachcloud/insights-page#transaction-executions-view) and [DB Console]({% link {{ page.version.version }}/ui-insights-page.md %}#transaction-executions-view)), look for a transaction with the **High Contention** insight. Click the transaction's execution ID and view the transaction execution details, including the details of the blocking transaction. -- Visit the **Transactions** page ([CockroachDB {{ site.data.products.cloud }} Console](https://www.cockroachlabs.com/docs/cockroachcloud/transactions-page) and [DB Console]({% link {{ page.version.version }}/ui-transactions-page.md %})) and sort transactions by **Contention Time**. +- In the **Transaction Executions** view on the **Insights** page ([CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/insights-page.md %}#transaction-executions-view) and [DB Console]({% link {{ page.version.version }}/ui-insights-page.md %}#transaction-executions-view)), look for a transaction with the **High Contention** insight. Click the transaction's execution ID and view the transaction execution details, including the details of the blocking transaction. +- Visit the **Transactions** page ([CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/transactions-page.md %}) and [DB Console]({% link {{ page.version.version }}/ui-transactions-page.md %})) and sort transactions by **Contention Time**. To view tables and indexes that experienced [contention]({% link {{ page.version.version }}/performance-best-practices-overview.md %}#transaction-contention): diff --git a/src/current/v24.1/qlik.md b/src/current/v24.1/qlik.md index ba48ae4d92e..c8bf2b3e0ee 100644 --- a/src/current/v24.1/qlik.md +++ b/src/current/v24.1/qlik.md @@ -65,7 +65,7 @@ Complete the following items before using Qlik Replicate: - If the output of [`SHOW SCHEDULES`]({% link {{ page.version.version }}/show-schedules.md %}) shows any backup schedules, run [`ALTER BACKUP SCHEDULE {schedule_id} SET WITH revision_history = 'false'`]({% link {{ page.version.version }}/alter-backup-schedule.md %}) for each backup schedule. - If the output of `SHOW SCHEDULES` does not show backup schedules, [contact Support](https://support.cockroachlabs.com) to disable revision history for cluster backups. - Manually create all schema objects in the target CockroachDB cluster. Qlik can create a basic schema, but does not create indexes or constraints such as foreign keys and defaults. - - If you are migrating from PostgreSQL, MySQL, Oracle, or Microsoft SQL Server, [use the **Schema Conversion Tool**](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) to convert and export your schema. Ensure that any schema changes are also reflected on your tables, or add transformation rules. If you make substantial schema changes, the Qlik Replicate migration may fail. + - If you are migrating from PostgreSQL, MySQL, Oracle, or Microsoft SQL Server, [use the **Schema Conversion Tool**]({% link cockroachcloud/migrations-page.md %}) to convert and export your schema. Ensure that any schema changes are also reflected on your tables, or add transformation rules. If you make substantial schema changes, the Qlik Replicate migration may fail. {{site.data.alerts.callout_info}} 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). @@ -97,7 +97,7 @@ In the Qlik Replicate interface, CockroachDB is configured as a PostgreSQL **sou ## 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 %}) - [Change Data Capture Overview]({% link {{ page.version.version }}/change-data-capture-overview.md %}) - [Third-Party Tools Supported by Cockroach Labs]({% link {{ page.version.version }}/third-party-database-tools.md %}) - [Migrate with AWS Database Migration Service (DMS)]({% link {{ page.version.version }}/aws-dms.md %}) diff --git a/src/current/v24.1/query-behavior-troubleshooting.md b/src/current/v24.1/query-behavior-troubleshooting.md index 6f169e9d241..6384ffd2a37 100644 --- a/src/current/v24.1/query-behavior-troubleshooting.md +++ b/src/current/v24.1/query-behavior-troubleshooting.md @@ -21,7 +21,7 @@ Such long-running queries can hold locks for (practically) unlimited durations. Refer to the performance tuning recipe for [identifying and unblocking a waiting transaction]({% link {{ page.version.version }}/performance-recipes.md %}#waiting-transaction). -If you experience this issue on a CockroachDB {{ site.data.products.serverless }} cluster, your cluster may be throttled or disabled because you've reached your monthly [resource limits](https://www.cockroachlabs.com/docs/cockroachcloud/troubleshooting-page#hanging-or-stuck-queries). +If you experience this issue on a CockroachDB {{ site.data.products.serverless }} cluster, your cluster may be throttled or disabled because you've reached your monthly [resource limits]({% link cockroachcloud/troubleshooting-page.md %}#hanging-or-stuck-queries). ### Identify slow queries diff --git a/src/current/v24.1/query-data.md b/src/current/v24.1/query-data.md index 6ea76993f2a..6bb663791d9 100644 --- a/src/current/v24.1/query-data.md +++ b/src/current/v24.1/query-data.md @@ -11,7 +11,7 @@ This page has instructions for making SQL [selection queries][selection] against Before reading this page, do the following: -- [Create a CockroachDB {{ site.data.products.serverless }} 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.serverless }} 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 run queries against. diff --git a/src/current/v24.1/restoring-backups-across-versions.md b/src/current/v24.1/restoring-backups-across-versions.md index 816b406cc76..f17715f3556 100644 --- a/src/current/v24.1/restoring-backups-across-versions.md +++ b/src/current/v24.1/restoring-backups-across-versions.md @@ -29,7 +29,7 @@ Backup taken on version | Restorable into version 22.1.x | 22.1.x, 22.2.x 22.2.x | 22.2.x, 23.1.x -When a cluster is in a mixed-version state during an upgrade, [full cluster restores]({% link {{ page.version.version }}/restore.md %}#restore-a-cluster) will fail. See the [Upgrade documentation]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}) for the necessary steps to finalize your upgrade. For CockroachDB {{ site.data.products.cloud }} clusters, see the [CockroachDB Cloud Upgrade Policy](https://www.cockroachlabs.com/docs/cockroachcloud/upgrade-policy) page. +When a cluster is in a mixed-version state during an upgrade, [full cluster restores]({% link {{ page.version.version }}/restore.md %}#restore-a-cluster) will fail. See the [Upgrade documentation]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}) for the necessary steps to finalize your upgrade. For CockroachDB {{ site.data.products.cloud }} clusters, see the [CockroachDB Cloud Upgrade Policy]({% link cockroachcloud/upgrade-policy.md %}) page. {{site.data.alerts.callout_info}} Cockroach Labs does **not** support restoring backups from a higher version into a lower version. diff --git a/src/current/v24.1/schema-design-database.md b/src/current/v24.1/schema-design-database.md index 7130d3c6d88..438ffad5540 100644 --- a/src/current/v24.1/schema-design-database.md +++ b/src/current/v24.1/schema-design-database.md @@ -15,7 +15,7 @@ For reference documentation on the `CREATE DATABASE` statement, including additi Before reading this page, do the following: -- [Create a CockroachDB {{ site.data.products.serverless }} 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.serverless }} cluster]({% link cockroachcloud/quickstart.md %}) or [start a local cluster](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart?filters=local). - [Review the database schema objects]({% link {{ page.version.version }}/schema-design-overview.md %}). ## Create a database diff --git a/src/current/v24.1/schema-design-indexes.md b/src/current/v24.1/schema-design-indexes.md index 6e895315845..132d38f6444 100644 --- a/src/current/v24.1/schema-design-indexes.md +++ b/src/current/v24.1/schema-design-indexes.md @@ -18,7 +18,7 @@ This page provides best-practice guidance on creating secondary indexes, with a Before reading this page, do the following: -- [Create a CockroachDB {{ site.data.products.serverless }} 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.serverless }} cluster]({% link cockroachcloud/quickstart.md %}) or [start a local cluster](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart?filters=local). - [Review the database schema objects]({% link {{ page.version.version }}/schema-design-overview.md %}). - [Create a database]({% link {{ page.version.version }}/schema-design-database.md %}). - [Create a user-defined schema]({% link {{ page.version.version }}/schema-design-schema.md %}). diff --git a/src/current/v24.1/schema-design-schema.md b/src/current/v24.1/schema-design-schema.md index 402588aea2b..ce931d393ba 100644 --- a/src/current/v24.1/schema-design-schema.md +++ b/src/current/v24.1/schema-design-schema.md @@ -15,7 +15,7 @@ For detailed reference documentation on the `CREATE SCHEMA` statement, including Before reading this page, do the following: -- [Create a CockroachDB {{ site.data.products.serverless }} 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.serverless }} cluster]({% link cockroachcloud/quickstart.md %}) or [start a local cluster](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart?filters=local). - [Review the database schema objects]({% link {{ page.version.version }}/schema-design-overview.md %}). - [Create a database]({% link {{ page.version.version }}/schema-design-database.md %}). diff --git a/src/current/v24.1/schema-design-table.md b/src/current/v24.1/schema-design-table.md index cd18dd9c8e7..5b606adfe28 100644 --- a/src/current/v24.1/schema-design-table.md +++ b/src/current/v24.1/schema-design-table.md @@ -15,7 +15,7 @@ For detailed reference documentation on the `CREATE TABLE` statement, including Before reading this page, do the following: -- [Create a CockroachDB {{ site.data.products.serverless }} 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.serverless }} cluster]({% link cockroachcloud/quickstart.md %}) or [start a local cluster](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart?filters=local). - [Review the database schema objects]({% link {{ page.version.version }}/schema-design-overview.md %}). - [Create a database]({% link {{ page.version.version }}/schema-design-database.md %}). - [Create a user-defined schema]({% link {{ page.version.version }}/schema-design-schema.md %}). diff --git a/src/current/v24.1/schema-design-update.md b/src/current/v24.1/schema-design-update.md index de2b23b1241..37b3488d4b4 100644 --- a/src/current/v24.1/schema-design-update.md +++ b/src/current/v24.1/schema-design-update.md @@ -11,7 +11,7 @@ This page provides an overview on changing and removing the objects in a databas Before reading this page, do the following: -- [Create a CockroachDB {{ site.data.products.serverless }} 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.serverless }} cluster]({% link cockroachcloud/quickstart.md %}) or [start a local cluster](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart?filters=local). - [Review the database schema objects]({% link {{ page.version.version }}/schema-design-overview.md %}). - [Create a database]({% link {{ page.version.version }}/schema-design-database.md %}). - [Create a user-defined schema]({% link {{ page.version.version }}/schema-design-schema.md %}). diff --git a/src/current/v24.1/sso-db-console.md b/src/current/v24.1/sso-db-console.md index 996ada9a495..d747c1f5005 100644 --- a/src/current/v24.1/sso-db-console.md +++ b/src/current/v24.1/sso-db-console.md @@ -28,7 +28,7 @@ This SSO implementation uses the [authorization code grant type](https://tools.i - **CockroachDB cluster**: you must have access to one of the following: - A {{ site.data.products.core }} cluster enabled with a valid [CockroachDB Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). - - A [CockroachDB {{ site.data.products.dedicated }} cluster](https://www.cockroachlabs.com/docs/cockroachcloud/create-your-cluster). + - A [CockroachDB {{ site.data.products.dedicated }} cluster]({% link cockroachcloud/create-your-cluster.md %}). ## Log in to a cluster's DB Console with SSO diff --git a/src/current/v24.1/sso-sql.md b/src/current/v24.1/sso-sql.md index aaf460bc01e..23223d196ea 100644 --- a/src/current/v24.1/sso-sql.md +++ b/src/current/v24.1/sso-sql.md @@ -12,7 +12,7 @@ Cluster single sign-on (SSO) enables users to access the SQL interface of a Cock {{ site.data.products.dedicated }} clusters can provision their users with JWTs via the DB Console. This allows users to authenticate to a cluster by signing in to their IdP (for example, Okta or Google) with a link embedded in the DB Console. This flow provisions a JWT that a user can copy out of the DB Console UI and use in a SQL connection string to authenticate to the cluster. {{site.data.alerts.callout_info}} -Cluster single sign-on for the DB Console is supported on {{ site.data.products.core }} {{ site.data.products.enterprise }} and {{ site.data.products.dedicated }} clusters. {{ site.data.products.serverless }} clusters do not support cluster single sign-on, because they do not have access to the DB Console. However, {{ site.data.products.serverless }} clusters can use [Cluster Single Sign-on (SSO) using `ccloud` and the CockroachDB Cloud Console](https://www.cockroachlabs.com/docs/cockroachcloud/cloud-sso-sql). +Cluster single sign-on for the DB Console is supported on {{ site.data.products.core }} {{ site.data.products.enterprise }} and {{ site.data.products.dedicated }} clusters. {{ site.data.products.serverless }} clusters do not support cluster single sign-on, because they do not have access to the DB Console. However, {{ site.data.products.serverless }} clusters can use [Cluster Single Sign-on (SSO) using `ccloud` and the CockroachDB Cloud Console]({% link cockroachcloud/cloud-sso-sql.md %}). {{site.data.alerts.end}} The page describes how to configure a cluster for cluster single sign-on using JWTs and then how users can authenticate using the JWTs. If you're a user ready to sign in to the DB Console with JWTs, you can skip the configuration section: @@ -119,7 +119,7 @@ You can also view all of your cluster settings in the DB Console. {{ site.data.products.db }} {{ site.data.products.dedicated }} customers: - By default, your cluster's configuration will contain the CockroachDB {{ site.data.products.cloud }}'s own public key, allowing CockroachDB {{ site.data.products.cloud }} to serve as an IdP. This is required for [SSO with `ccloud`](https://www.cockroachlabs.com/docs/cockroachcloud/cloud-sso-sql). When modifying this cluster setting, you must include the CockroachDB {{ site.data.products.cloud }} public key in the key set, or SSO with `ccloud` will no longer work. + By default, your cluster's configuration will contain the CockroachDB {{ site.data.products.cloud }}'s own public key, allowing CockroachDB {{ site.data.products.cloud }} to serve as an IdP. This is required for [SSO with `ccloud`]({% link cockroachcloud/cloud-sso-sql.md %}). When modifying this cluster setting, you must include the CockroachDB {{ site.data.products.cloud }} public key in the key set, or SSO with `ccloud` will no longer work. The public key for {{ site.data.products.db }} can be found at `https://cockroachlabs.cloud/.well-known/openid-configuration`. @@ -229,7 +229,7 @@ Examples: - `https://accounts.google.com 1232316645658094244789 roach` - Maps a single external identity with the hard-coded ID to the [SQL user](https://www.cockroachlabs.com/docs/cockroachcloud/managing-access#manage-sql-users-on-a-cluster) `roach`. + Maps a single external identity with the hard-coded ID to the [SQL user]({% link cockroachcloud/managing-access.md %}#manage-sql-users-on-a-cluster) `roach`. - `https://accounts.google.com /^([9-0]*)$ gcp_\1` diff --git a/src/current/v24.1/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.md b/src/current/v24.1/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.md index 775aaa9c6fe..44d338490a8 100644 --- a/src/current/v24.1/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.md +++ b/src/current/v24.1/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.md @@ -21,7 +21,7 @@ An overview of the workflow involves creating and connecting the following: You will need the following set up before starting this tutorial: -- A CockroachDB cluster. You can use a CockroachDB {{ site.data.products.cloud }} or CockroachDB {{ site.data.products.core }} cluster. If you are using CockroachDB {{ site.data.products.serverless }} or CockroachDB {{ site.data.products.dedicated }}, see the [Quickstart with CockroachDB](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart) guide. For CockroachDB {{ site.data.products.core }} clusters, see the [install]({% link {{ page.version.version }}/install-cockroachdb-mac.md %}) page. +- A CockroachDB cluster. You can use a CockroachDB {{ site.data.products.cloud }} or CockroachDB {{ site.data.products.core }} cluster. If you are using CockroachDB {{ site.data.products.serverless }} or CockroachDB {{ site.data.products.dedicated }}, see the [Quickstart with CockroachDB]({% link cockroachcloud/quickstart.md %}) guide. For CockroachDB {{ site.data.products.core }} clusters, see the [install]({% link {{ page.version.version }}/install-cockroachdb-mac.md %}) page. - A Confluent Cloud account. See Confluent's [Get started](https://www.confluent.io/get-started/) page for details. - The Confluent CLI. See [Install Confluent CLI](https://docs.confluent.io/confluent-cli/current/install.html) to set this up. This tutorial uses v3.3.0 of the Confluent CLI. Note that you can also complete the steps in this tutorial in Confluent's Cloud console. - {% include {{ page.version.version }}/cdc/tutorial-privilege-check.md %} diff --git a/src/current/v24.1/striim.md b/src/current/v24.1/striim.md index ffbba6d55fa..06ba43db452 100644 --- a/src/current/v24.1/striim.md +++ b/src/current/v24.1/striim.md @@ -34,7 +34,7 @@ Complete the following items before using Striim: - Ensure you have a secure, publicly available CockroachDB cluster running the latest **{{ page.version.version }}** [production release](https://www.cockroachlabs.com/docs/releases/{{ page.version.version }}), and have created a [SQL user]({% link {{ page.version.version }}/security-reference/authorization.md %}#sql-users) that you can use to configure your Striim target. - Manually create all schema objects in the target CockroachDB cluster. Although Striim offers a feature called Auto Schema Conversion, we recommend converting and importing your schema before running Striim to ensure that the data populates successfully. - - If you are migrating from PostgreSQL, MySQL, Oracle, or Microsoft SQL Server, [use the **Schema Conversion Tool**](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) to convert and export your schema. Ensure that any schema changes are also reflected on your tables. + - If you are migrating from PostgreSQL, MySQL, Oracle, or Microsoft SQL Server, [use the **Schema Conversion Tool**]({% link cockroachcloud/migrations-page.md %}) to convert and export your schema. Ensure that any schema changes are also reflected on your tables. {{site.data.alerts.callout_info}} 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). @@ -111,6 +111,6 @@ To perform continuous replication of ongoing changes, create a Striim applicatio ## 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 %}) - [Change Data Capture Overview]({% link {{ page.version.version }}/change-data-capture-overview.md %}) - [Third-Party Tools Supported by Cockroach Labs]({% link {{ page.version.version }}/third-party-database-tools.md %}) diff --git a/src/current/v24.1/take-and-restore-locality-aware-backups.md b/src/current/v24.1/take-and-restore-locality-aware-backups.md index 149ae4adfb0..7044d524d60 100644 --- a/src/current/v24.1/take-and-restore-locality-aware-backups.md +++ b/src/current/v24.1/take-and-restore-locality-aware-backups.md @@ -25,7 +25,7 @@ For a technical overview of how a locality-aware backup works, refer to [Job coo ## Supported products -Locality-aware backups are available in **CockroachDB {{ site.data.products.dedicated }}**, **CockroachDB {{ site.data.products.serverless }}**, and **CockroachDB {{ site.data.products.core }}** clusters when you are running [customer-owned backups](https://www.cockroachlabs.com/docs/cockroachcloud/take-and-restore-customer-owned-backups). For a full list of features on CockroachDB Cloud, refer to [Backup and Restore Overview](https://www.cockroachlabs.com/docs/cockroachcloud/backup-and-restore-overview). +Locality-aware backups are available in **CockroachDB {{ site.data.products.dedicated }}**, **CockroachDB {{ site.data.products.serverless }}**, and **CockroachDB {{ site.data.products.core }}** clusters when you are running [customer-owned backups]({% link cockroachcloud/take-and-restore-customer-owned-backups.md %}). For a full list of features on CockroachDB Cloud, refer to [Backup and Restore Overview]({% link cockroachcloud/backup-and-restore-overview.md %}). {{site.data.alerts.callout_info}} {% include {{ page.version.version }}/backups/serverless-locality-aware.md %} diff --git a/src/current/v24.1/troubleshooting-overview.md b/src/current/v24.1/troubleshooting-overview.md index 2573f1c9fe3..9b21e2725f0 100644 --- a/src/current/v24.1/troubleshooting-overview.md +++ b/src/current/v24.1/troubleshooting-overview.md @@ -16,7 +16,7 @@ If you experience an issue when using CockroachDB, try these steps to resolve th - [Troubleshoot Common Problems]({% link {{ page.version.version }}/query-behavior-troubleshooting.md %}) helps you handle errors and troubleshooting problems that may arise during application development. - [Troubleshoot Statement Behavior]({% link {{ page.version.version }}/query-behavior-troubleshooting.md %}) helps you with unexpected query results. -- If you are using Cockroach Cloud, see the errors and solutions in [Troubleshoot CockroachDB Cloud](https://www.cockroachlabs.com/docs/cockroachcloud/troubleshooting-page). +- If you are using Cockroach Cloud, see the errors and solutions in [Troubleshoot CockroachDB Cloud]({% link cockroachcloud/troubleshooting-page.md %}). - If you see discrepancies in metrics, refer to [Differences in Metrics between Third-Party Monitoring Integrations and DB Console]({% link {{ page.version.version }}/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.md %}). diff --git a/src/current/v24.1/ui-overview.md b/src/current/v24.1/ui-overview.md index 5d83e9a805c..1930147952c 100644 --- a/src/current/v24.1/ui-overview.md +++ b/src/current/v24.1/ui-overview.md @@ -11,7 +11,7 @@ The DB Console provides details about your cluster and database configuration, a {{site.data.alerts.callout_info}} Authorized CockroachDB {{ site.data.products.dedicated }} cluster users can visit the DB Console at a URL provisioned for the cluster. -Refer to: [Network Authorization for CockroachDB Cloud Clusters—DB Console](https://www.cockroachlabs.com/docs/cockroachcloud/network-authorization#db-console) +Refer to: [Network Authorization for CockroachDB Cloud Clusters—DB Console]({% link cockroachcloud/network-authorization.md %}#db-console) {{site.data.alerts.end}} ## Authentication diff --git a/src/current/v24.1/update-data.md b/src/current/v24.1/update-data.md index 5c0d256dd29..5db28c352f0 100644 --- a/src/current/v24.1/update-data.md +++ b/src/current/v24.1/update-data.md @@ -15,7 +15,7 @@ This page has instructions for updating existing rows of data in CockroachDB, us Before reading this page, do the following: -- [Create a CockroachDB {{ site.data.products.serverless }} 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.serverless }} 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 %}). - [Create a database schema]({% link {{ page.version.version }}/schema-design-overview.md %}). diff --git a/src/current/v24.1/vault-db-secrets-tutorial.md b/src/current/v24.1/vault-db-secrets-tutorial.md index bb846cfd37e..2f47e18de31 100644 --- a/src/current/v24.1/vault-db-secrets-tutorial.md +++ b/src/current/v24.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]({% link {{ page.version.version }}/install-cockroachdb-mac.md %}). - The Vault CLI [installed locally](https://www.vaultproject.io/downloads). -- Access to a CockroachDB cluster as [`admin` SQL user]({% link {{ page.version.version }}/security-reference/authorization.md %}#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](https://www.cockroachlabs.com/docs/cockroachcloud/create-a-serverless-cluster) 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]({% link {{ page.version.version }}/security-reference/authorization.md %}#admin-role). +- Access to a CockroachDB cluster as [`admin` SQL user]({% link {{ page.version.version }}/security-reference/authorization.md %}#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]({% link cockroachcloud/create-a-serverless-cluster.md %}) 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]({% link {{ page.version.version }}/security-reference/authorization.md %}#admin-role). - Access to a Vault cluster with an admin token. This tutorial will use HashiCorp Cloud Platform, but you may either [spin up a free cluster in HashiCorp Cloud Platform](https://learn.hashicorp.com/collections/vault/cloud) or [start a development cluster locally](https://learn.hashicorp.com/tutorials/vault/getting-started-dev-server). ## Introduction diff --git a/src/current/v24.2/api-support-policy.md b/src/current/v24.2/api-support-policy.md index 4bea53dca03..175b1814647 100644 --- a/src/current/v24.2/api-support-policy.md +++ b/src/current/v24.2/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/v24.2/authorization.md b/src/current/v24.2/authorization.md index 6eec67c32cd..3b1ce45e023 100644 --- a/src/current/v24.2/authorization.md +++ b/src/current/v24.2/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/v24.2/aws-dms.md b/src/current/v24.2/aws-dms.md index 8b4585ab024..03af08b5973 100644 --- a/src/current/v24.2/aws-dms.md +++ b/src/current/v24.2/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). @@ -211,7 +211,7 @@ If your migration failed for some reason, you can check the checkbox next to the ### AWS PrivateLink -If using CockroachDB {{ site.data.products.dedicated }}, you can enable [AWS PrivateLink](https://aws.amazon.com/privatelink/) to securely connect your AWS application with your CockroachDB {{ site.data.products.dedicated }} cluster using a private endpoint. To configure AWS PrivateLink with CockroachDB {{ site.data.products.dedicated }}, see [Network Authorization](https://www.cockroachlabs.com/docs/cockroachcloud/network-authorization#aws-privatelink). +If using CockroachDB {{ site.data.products.dedicated }}, you can enable [AWS PrivateLink](https://aws.amazon.com/privatelink/) to securely connect your AWS application with your CockroachDB {{ site.data.products.dedicated }} cluster using a private endpoint. To configure AWS PrivateLink with CockroachDB {{ site.data.products.dedicated }}, see [Network Authorization]({% link cockroachcloud/network-authorization.md %}#aws-privatelink). ### `BatchApplyEnabled` @@ -407,7 +407,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/v24.2/backup.md b/src/current/v24.2/backup.md index 45bf84b0dfc..d4065c76e95 100644 --- a/src/current/v24.2/backup.md +++ b/src/current/v24.2/backup.md @@ -32,7 +32,7 @@ To view the contents of an backup created with the `BACKUP` statement, use [`SHO ## Considerations -- Core users can only take [full backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#full-backups). To use the other backup features, you need an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). You can also use [CockroachDB {{ site.data.products.dedicated }}](https://cockroachlabs.cloud/signup?referralId=docs-crdb-backup), which runs [full backups daily and incremental backups hourly](https://www.cockroachlabs.com/docs/cockroachcloud/use-managed-service-backups). +- Core users can only take [full backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#full-backups). To use the other backup features, you need an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). You can also use [CockroachDB {{ site.data.products.dedicated }}](https://cockroachlabs.cloud/signup?referralId=docs-crdb-backup), which runs [full backups daily and incremental backups hourly]({% link cockroachcloud/use-managed-service-backups.md %}). - [Full cluster backups](#back-up-a-cluster) include [Enterprise license keys]({% link {{ page.version.version }}/enterprise-licensing.md %}). When you [restore]({% link {{ page.version.version }}/restore.md %}) a full cluster backup that includes an Enterprise license, the Enterprise license is also restored. - [Zone configurations]({% link {{ page.version.version }}/configure-replication-zones.md %}) present on the destination cluster prior to a restore will be **overwritten** during a [cluster restore]({% link {{ page.version.version }}/restore.md %}#full-cluster) with the zone configurations from the [backed up cluster](#back-up-a-cluster). If there were no customized zone configurations on the cluster when the backup was taken, then after the restore the destination cluster will use the zone configuration from the [`RANGE DEFAULT` configuration]({% link {{ page.version.version }}/configure-replication-zones.md %}#view-the-default-replication-zone). - You cannot restore a backup of a multi-region database into a single-region database. diff --git a/src/current/v24.2/bulk-delete-data.md b/src/current/v24.2/bulk-delete-data.md index ecb96f85216..18c6d92f4f1 100644 --- a/src/current/v24.2/bulk-delete-data.md +++ b/src/current/v24.2/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.serverless }} 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.serverless }} 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/v24.2/bulk-update-data.md b/src/current/v24.2/bulk-update-data.md index 287579230fd..afc681f2e38 100644 --- a/src/current/v24.2/bulk-update-data.md +++ b/src/current/v24.2/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.serverless }} 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.serverless }} 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/v24.2/choose-a-deployment-option.md b/src/current/v24.2/choose-a-deployment-option.md index 3f7e694f478..32c13b877be 100644 --- a/src/current/v24.2/choose-a-deployment-option.md +++ b/src/current/v24.2/choose-a-deployment-option.md @@ -99,7 +99,7 @@ Cockroach Labs offers four ways to deploy CockroachDB: three managed services&md - [CockroachDB deployment]({% link {{ page.version.version }}/architecture/glossary.md %}#cockroachdb-deployment-terms) - [CockroachDB pricing](https://www.cockroachlabs.com/get-started-cockroachdb/) -- [CockroachDB Cloud FAQs](https://www.cockroachlabs.com/docs/cockroachcloud/serverless-faqs) -- [CockroachDB Cloud Architecture](https://www.cockroachlabs.com/docs/cockroachcloud/architecture) +- [CockroachDB Cloud FAQs]({% link cockroachcloud/serverless-faqs.md %}) +- [CockroachDB Cloud Architecture]({% link cockroachcloud/architecture.md %}) - [Manual Deployment]({% link {{ page.version.version }}/manual-deployment.md %}) - [Kubernetes Deployment]({% link {{ page.version.version }}/kubernetes-overview.md %}) diff --git a/src/current/v24.2/cloud-storage-authentication.md b/src/current/v24.2/cloud-storage-authentication.md index db565f246da..7eb14234dfd 100644 --- a/src/current/v24.2/cloud-storage-authentication.md +++ b/src/current/v24.2/cloud-storage-authentication.md @@ -297,7 +297,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 @@ -596,7 +596,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 diff --git a/src/current/v24.2/cockroachdb-feature-availability.md b/src/current/v24.2/cockroachdb-feature-availability.md index 241767ac582..81d45b5542c 100644 --- a/src/current/v24.2/cockroachdb-feature-availability.md +++ b/src/current/v24.2/cockroachdb-feature-availability.md @@ -60,11 +60,11 @@ The [`VECTOR`]({% link {{ page.version.version }}/vector.md %}) data type stores ### GCP Private Service Connect for CockroachDB Dedicated -[Connecting privately to a CockroachDB {{ site.data.products.dedicated }} cluster using GCP Private Service Connect](https://www.cockroachlabs.com/docs/cockroachcloud/connect-to-your-cluster#gcp-private-service-connect) is in preview. Private Service Connect allows you to selectively connect your cluster deployed on GCP to a VPC within your Google Cloud project. +[Connecting privately to a CockroachDB {{ site.data.products.dedicated }} cluster using GCP Private Service Connect]({% link cockroachcloud/connect-to-your-cluster.md %}#gcp-private-service-connect) is in preview. Private Service Connect allows you to selectively connect your cluster deployed on GCP to a VPC within your Google Cloud project. ### Azure Private Link for CockroachDB Dedicated -[Connecting privately to a CockroachDB {{ site.data.products.dedicated }} cluster using Azure Private Link](https://www.cockroachlabs.com/docs/cockroachcloud/connect-to-your-cluster#azure-private-link) is in preview. Azure Private Link allows you to selectively connect your cluster deployed on Azure to a virtual network within your Azure tenant. +[Connecting privately to a CockroachDB {{ site.data.products.dedicated }} cluster using Azure Private Link]({% link cockroachcloud/connect-to-your-cluster.md %}#azure-private-link) is in preview. Azure Private Link allows you to selectively connect your cluster deployed on Azure to a virtual network within your Azure tenant. ### Custom Metrics Chart page for CockroachDB {{ site.data.products.cloud }} clusters diff --git a/src/current/v24.2/common-issues-to-monitor.md b/src/current/v24.2/common-issues-to-monitor.md index 8adb21b5e9f..72007a95416 100644 --- a/src/current/v24.2/common-issues-to-monitor.md +++ b/src/current/v24.2/common-issues-to-monitor.md @@ -331,4 +331,4 @@ Because each node needs to update a liveness record on disk, maxing out disk ban - [Troubleshoot SQL Behavior]({% link {{ page.version.version }}/query-behavior-troubleshooting.md %}) - [Admission Control]({% link {{ page.version.version }}/admission-control.md %}) - [Metrics]({% link {{ page.version.version }}/metrics.md %}) -- [Alerts Page](https://www.cockroachlabs.com/docs/cockroachcloud/alerts-page) (CockroachDB {{ site.data.products.dedicated }}) +- [Alerts Page]({% link cockroachcloud/alerts-page.md %}) (CockroachDB {{ site.data.products.dedicated }}) diff --git a/src/current/v24.2/connect-to-a-changefeed-kafka-sink-with-oauth-using-okta.md b/src/current/v24.2/connect-to-a-changefeed-kafka-sink-with-oauth-using-okta.md index cdaf916d76d..2bde95a6387 100644 --- a/src/current/v24.2/connect-to-a-changefeed-kafka-sink-with-oauth-using-okta.md +++ b/src/current/v24.2/connect-to-a-changefeed-kafka-sink-with-oauth-using-okta.md @@ -22,7 +22,7 @@ An overview of the workflow involves: Before starting this tutorial, you will need: - A CockroachDB cluster. You can use a CockroachDB {{ site.data.products.cloud }} or CockroachDB {{ site.data.products.core }} cluster. - - If you are using CockroachDB {{ site.data.products.serverless }} or CockroachDB {{ site.data.products.dedicated }}, see the [Quickstart with CockroachDB](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart) guide. For CockroachDB {{ site.data.products.core }} clusters, see the [install]({% link {{ page.version.version }}/install-cockroachdb-mac.md %}) page. + - If you are using CockroachDB {{ site.data.products.serverless }} or CockroachDB {{ site.data.products.dedicated }}, see the [Quickstart with CockroachDB]({% link cockroachcloud/quickstart.md %}) guide. For CockroachDB {{ site.data.products.core }} clusters, see the [install]({% link {{ page.version.version }}/install-cockroachdb-mac.md %}) page. - An [Okta Developer account](https://developer.okta.com/signup/). - (Optional) A Kafka cluster. This tutorial includes [Kafka cluster setup](#step-3-create-a-kafka-sink). Note that this tutorial was tested with Kafka [version 2.8.2](https://kafka.apache.org/downloads). The Kafka cluster configuration may vary with different versions, but the Okta setup and changefeed creation will be the same. - {% include {{ page.version.version }}/cdc/tutorial-privilege-check.md %} diff --git a/src/current/v24.2/connect-to-the-database.md b/src/current/v24.2/connect-to-the-database.md index d24c61b17dc..9ec0c3378f8 100644 --- a/src/current/v24.2/connect-to-the-database.md +++ b/src/current/v24.2/connect-to-the-database.md @@ -307,7 +307,7 @@ export const AppDataSource = new DataSource({ Where: - `DATABASE_URL` is an environment variable set to a valid CockroachDB connection string. -- `CA_CERT` is an environment variable set to the root certificate [downloaded from the CockroachDB Cloud Console](https://www.cockroachlabs.com/docs/cockroachcloud/authentication#node-identity-verification). +- `CA_CERT` is an environment variable set to the root certificate [downloaded from the CockroachDB Cloud Console]({% link cockroachcloud/authentication.md %}#node-identity-verification). TypeORM accepts the following format for CockroachDB connection strings: @@ -452,7 +452,7 @@ Parameter | Description `` | The host on which the CockroachDB node is running. `` | The port at which the CockroachDB node is listening. `` | The name of the (existing) database. -`` | The path to the root certificate that you [downloaded from the CockroachDB Cloud Console](https://www.cockroachlabs.com/docs/cockroachcloud/authentication#node-identity-verification). +`` | The path to the root certificate that you [downloaded from the CockroachDB Cloud Console]({% link cockroachcloud/authentication.md %}#node-identity-verification). @@ -784,7 +784,7 @@ Parameter | Description `{host}` | The host on which the CockroachDB node is running. `{port}` | The port at which the CockroachDB node is listening. `{database}` | The name of the (existing) database. -`{root-cert}` | The path to the root certificate that you [downloaded from the CockroachDB Cloud Console](https://www.cockroachlabs.com/docs/cockroachcloud/authentication#node-identity-verification). +`{root-cert}` | The path to the root certificate that you [downloaded from the CockroachDB Cloud Console]({% link cockroachcloud/authentication.md %}#node-identity-verification). @@ -1014,7 +1014,7 @@ Parameter | Description `{host}` | The host on which the CockroachDB node is running. `{port}` | The port at which the CockroachDB node is listening. `{database}` | The name of the (existing) database. -`{root-cert}` | The path to the root certificate that you [downloaded from the CockroachDB Cloud Console](https://www.cockroachlabs.com/docs/cockroachcloud/authentication#node-identity-verification). +`{root-cert}` | The path to the root certificate that you [downloaded from the CockroachDB Cloud Console]({% link cockroachcloud/authentication.md %}#node-identity-verification). @@ -1171,7 +1171,7 @@ Parameter | Description `{host}` | The host on which the CockroachDB node is running. `{port}` | The port at which the CockroachDB node is listening. `{database}` | The name of the (existing) database. -`{root-cert}` | The [URL-encoded](https://wikipedia.org/wiki/Percent-encoding) path to the root certificate that you [downloaded from the CockroachDB Cloud Console](https://www.cockroachlabs.com/docs/cockroachcloud/authentication#node-identity-verification). +`{root-cert}` | The [URL-encoded](https://wikipedia.org/wiki/Percent-encoding) path to the root certificate that you [downloaded from the CockroachDB Cloud Console]({% link cockroachcloud/authentication.md %}#node-identity-verification). @@ -1331,7 +1331,7 @@ Parameter | Description `{host}` | The host on which the CockroachDB node is running. `{port}` | The port at which the CockroachDB node is listening. `{database}` | The name of the (existing) database. -`{root-cert}` | The path to the root certificate that you [downloaded from the CockroachDB Cloud Console](https://www.cockroachlabs.com/docs/cockroachcloud/authentication#node-identity-verification). +`{root-cert}` | The path to the root certificate that you [downloaded from the CockroachDB Cloud Console]({% link cockroachcloud/authentication.md %}#node-identity-verification). diff --git a/src/current/v24.2/connection-parameters.md b/src/current/v24.2/connection-parameters.md index ba52da21d57..b7a22d63cc7 100644 --- a/src/current/v24.2/connection-parameters.md +++ b/src/current/v24.2/connection-parameters.md @@ -99,7 +99,7 @@ CockroachDB supports the following `options` parameters. After the first `option Parameter | Description ----------|------------- -`--cluster=` | Identifies your tenant cluster on a [multi-tenant host](https://www.cockroachlabs.com/docs/cockroachcloud/architecture#architecture). For example, `funny-skunk-123`. This option is deprecated. The `host` in the connection string now includes the tenant information. +`--cluster=` | Identifies your tenant cluster on a [multi-tenant host]({% link cockroachcloud/architecture.md %}#architecture). For example, `funny-skunk-123`. This option is deprecated. The `host` in the connection string now includes the tenant information. `-c =` | Sets a [session variable]({% link {{ page.version.version }}/set-vars.md %}) for the SQL session. `results_buffer_size` | Default size of the buffer that accumulates results for a statement or a batch of statements before they are sent to the client. Can also be set using the [`sql.defaults.results_buffer.size` cluster setting]({% link {{ page.version.version }}/cluster-settings.md %}#setting-sql-defaults-results-buffer-size). Can be set as a top-level query parameter or as an `options` parameter. diff --git a/src/current/v24.2/datadog.md b/src/current/v24.2/datadog.md index 4b47a2203da..4f76cede214 100644 --- a/src/current/v24.2/datadog.md +++ b/src/current/v24.2/datadog.md @@ -8,7 +8,7 @@ docs_area: manage [Datadog](https://www.datadoghq.com/) is a monitoring and security platform for cloud applications. The CockroachDB {{ site.data.products.core }} integration with Datadog enables data collection and alerting on selected [CockroachDB metrics](https://docs.datadoghq.com/integrations/cockroachdb/?tab=host#data-collected) using the Datadog platform. {{site.data.alerts.callout_success}} -This tutorial explores the CockroachDB {{ site.data.products.core }} integration with Datadog. For the CockroachDB {{ site.data.products.dedicated }} integration with Datadog, refer to [Monitor CockroachDB Dedicated with Datadog](https://www.cockroachlabs.com/docs/cockroachcloud/tools-page#monitor-cockroachdb-dedicated-with-datadog) instead of this page. +This tutorial explores the CockroachDB {{ site.data.products.core }} integration with Datadog. For the CockroachDB {{ site.data.products.dedicated }} integration with Datadog, refer to [Monitor CockroachDB Dedicated with Datadog]({% link cockroachcloud/tools-page.md %}#monitor-cockroachdb-dedicated-with-datadog) instead of this page. {{site.data.alerts.end}} The CockroachDB {{ site.data.products.core }} integration with Datadog is powered by the [Datadog Agent](https://app.datadoghq.com/account/settings#agent), and supported by Datadog directly: diff --git a/src/current/v24.2/debezium.md b/src/current/v24.2/debezium.md index d35bca04a5f..b6a77d75a78 100644 --- a/src/current/v24.2/debezium.md +++ b/src/current/v24.2/debezium.md @@ -117,7 +117,7 @@ Once all of the [prerequisite steps](#before-you-begin) are completed, you can u ## 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 %}) - [Change Data Capture Overview]({% link {{ page.version.version }}/change-data-capture-overview.md %}) - [Third-Party Tools Supported by Cockroach Labs]({% link {{ page.version.version }}/third-party-database-tools.md %}) - [Stream a Changefeed to a Confluent Cloud Kafka Cluster]({% link {{ page.version.version }}/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.md %}) diff --git a/src/current/v24.2/delete-data.md b/src/current/v24.2/delete-data.md index 1a056e6685d..8217416ef92 100644 --- a/src/current/v24.2/delete-data.md +++ b/src/current/v24.2/delete-data.md @@ -11,7 +11,7 @@ This page has instructions for deleting rows of data from CockroachDB, using the Before reading this page, do the following: -- [Create a CockroachDB {{ site.data.products.serverless }} 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.serverless }} 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 %}). - [Create a database schema]({% link {{ page.version.version }}/schema-design-overview.md %}). diff --git a/src/current/v24.2/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.md b/src/current/v24.2/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.md index 026a53cfd12..0210883d4ae 100644 --- a/src/current/v24.2/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.md +++ b/src/current/v24.2/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.md @@ -4,7 +4,7 @@ summary: Learn how metrics can differ between third-party monitoring tools that toc: true --- -When using [Third-Party Monitoring Integrations]({% link {{ page.version.version }}/third-party-monitoring-tools.md %}), such as the [metrics export feature](https://www.cockroachlabs.com/docs/cockroachcloud/export-metrics), discrepancies may be seen when comparing those metrics charts to ones found on the [Metrics dashboards]({% link {{ page.version.version }}/ui-overview.md %}#metrics) or [custom charts]({% link {{ page.version.version }}/ui-custom-chart-debug-page.md %}) of the [DB Console]({% link {{ page.version.version }}/ui-overview.md %}). This page explains why these different systems may yield different results. +When using [Third-Party Monitoring Integrations]({% link {{ page.version.version }}/third-party-monitoring-tools.md %}), such as the [metrics export feature]({% link cockroachcloud/export-metrics.md %}), discrepancies may be seen when comparing those metrics charts to ones found on the [Metrics dashboards]({% link {{ page.version.version }}/ui-overview.md %}#metrics) or [custom charts]({% link {{ page.version.version }}/ui-custom-chart-debug-page.md %}) of the [DB Console]({% link {{ page.version.version }}/ui-overview.md %}). This page explains why these different systems may yield different results. ## CockroachDB’s Timeseries Database @@ -33,7 +33,7 @@ Datadog scrapes every 60s | 0 | - | - | - | - | - | 0 Since Cockroach Labs does not own the third-party systems, we can not be expected to have intimate knowledge about how each system’s different query language and timeseries database works. -The [metrics export feature](https://www.cockroachlabs.com/docs/cockroachcloud/export-metrics) scrapes the `/_status/vars` endpoint every 30 seconds, and forwards the data along to the third-party system. The metrics export does no intermediate aggregation, downsampling, or modification of the timeseries values at any point. The raw metrics export data is at a 30-second resolution, but how that data is processed once received by the third party system is unknown to us. +The [metrics export feature]({% link cockroachcloud/export-metrics.md %}) scrapes the `/_status/vars` endpoint every 30 seconds, and forwards the data along to the third-party system. The metrics export does no intermediate aggregation, downsampling, or modification of the timeseries values at any point. The raw metrics export data is at a 30-second resolution, but how that data is processed once received by the third party system is unknown to us. It is within our scope to understand and support our own timeseries database. If you have problems receiving metrics in your third-party system, [our support]({% link {{ page.version.version }}/support-resources.md %}) can help troubleshoot those problems. However, once the data is ingested into the third-party system, please contact your representative at that third-party company to support issues found on those systems. For example, assuming the raw metric data has been ingested as expected, Cockroach Labs does not support writing queries in third-party systems, such as using Datadog's Metrics Explorer or Datadog Query Language (DQL). @@ -43,4 +43,4 @@ It is within our scope to understand and support our own timeseries database. If - [DB Console Overview]({% link {{ page.version.version }}/ui-overview.md %}) - [Third-Party Monitoring Integrations]({% link {{ page.version.version }}/third-party-monitoring-tools.md %}) - [Monitor CockroachDB with Prometheus]({% link {{ page.version.version }}/monitor-cockroachdb-with-prometheus.md %}) -- [Export Metrics From a CockroachDB Dedicated Cluster](https://www.cockroachlabs.com/docs/cockroachcloud/export-metrics) \ No newline at end of file +- [Export Metrics From a CockroachDB Dedicated Cluster]({% link cockroachcloud/export-metrics.md %}) \ No newline at end of file diff --git a/src/current/v24.2/example-apps.md b/src/current/v24.2/example-apps.md index e410f1a6ade..bea3cfd1876 100644 --- a/src/current/v24.2/example-apps.md +++ b/src/current/v24.2/example-apps.md @@ -52,7 +52,7 @@ Note that tools with [**community-level** support]({% link {{ page.version.versi | Driver/ORM Framework | Support level | Example apps | |--------------------------------------------+----------------+--------------------------------------------------------| -| [JDBC](https://jdbc.postgresql.org/) | Full | [Quickstart](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart)
[Simple CRUD]({% link {{ page.version.version }}/build-a-java-app-with-cockroachdb.md %})
[Roach Data (Spring Boot App)](build-a-spring-app-with-cockroachdb-jdbc.html) +| [JDBC](https://jdbc.postgresql.org/) | Full | [Quickstart]({% link cockroachcloud/quickstart.md %})
[Simple CRUD]({% link {{ page.version.version }}/build-a-java-app-with-cockroachdb.md %})
[Roach Data (Spring Boot App)](build-a-spring-app-with-cockroachdb-jdbc.html) | [Hibernate](https://hibernate.org/orm/) | Full | [Simple CRUD]({% link {{ page.version.version }}/build-a-java-app-with-cockroachdb-hibernate.md %})
[Roach Data (Spring Boot App)](build-a-spring-app-with-cockroachdb-jpa.html) | [jOOQ](https://www.jooq.org/) | Full | [Simple CRUD]({% link {{ page.version.version }}/build-a-java-app-with-cockroachdb-jooq.md %}) diff --git a/src/current/v24.2/explain-analyze.md b/src/current/v24.2/explain-analyze.md index 2ed8ddce396..19b4e85a535 100644 --- a/src/current/v24.2/explain-analyze.md +++ b/src/current/v24.2/explain-analyze.md @@ -76,7 +76,7 @@ Property | Description `sql cpu time` | The total amount of time spent in the [SQL layer]({% link {{ page.version.version }}/architecture/sql-layer.md %}). It does not include time spent in the [storage layer]({% link {{ page.version.version }}/architecture/storage-layer.md %}). `regions` | The [regions]({% link {{ page.version.version }}/show-regions.md %}) 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)](https://www.cockroachlabs.com/docs/cockroachcloud/plan-your-cluster-serverless#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)]({% link cockroachcloud/plan-your-cluster-serverless.md %}#request-units) consumed by the statement. This property is visible only on CockroachDB {{ site.data.products.serverless }} clusters. ### Statement plan tree properties diff --git a/src/current/v24.2/frequently-asked-questions.md b/src/current/v24.2/frequently-asked-questions.md index d4da65508cf..8b9acb67a5a 100644 --- a/src/current/v24.2/frequently-asked-questions.md +++ b/src/current/v24.2/frequently-asked-questions.md @@ -28,7 +28,7 @@ CockroachDB returns single-row reads in 2ms or less and single-row writes in 4ms ### How easy is it to get started with CockroachDB? -You can get started with CockroachDB with just a few clicks. Sign up for a CockroachDB {{ site.data.products.cloud }} account to create a free CockroachDB {{ site.data.products.serverless }} cluster. For more details, see [Quickstart](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart). +You can get started with CockroachDB with just a few clicks. Sign up for a CockroachDB {{ site.data.products.cloud }} account to create a free CockroachDB {{ site.data.products.serverless }} cluster. For more details, see [Quickstart]({% link cockroachcloud/quickstart.md %}). Alternatively, you can download a binary or run our official Kubernetes configurations or Docker image. For more details, see [Install CockroachDB]({% link {{ page.version.version }}/install-cockroachdb.md %}). @@ -54,7 +54,7 @@ When your cluster spans multiple nodes (physical machines, virtual machines, or For more information about scaling a CockroachDB cluster, see the following docs: -- [Plan Your Serverless Cluster - Cluster scaling](https://www.cockroachlabs.com/docs/cockroachcloud/plan-your-cluster#cluster-scaling) +- [Plan Your Serverless Cluster - Cluster scaling]({% link cockroachcloud/plan-your-cluster.md %}#cluster-scaling) - [Manage Your Dedicated Cluster - Scale your cluster](https://www.cockroachlabs.com/docs/cockroachcloud/plan-your-cluster?filters=dedicated#cluster-scaling) - [`cockroach start` - Add a node to a cluster]({% link {{ page.version.version }}/cockroach-start.md %}#add-a-node-to-a-cluster) diff --git a/src/current/v24.2/goldengate.md b/src/current/v24.2/goldengate.md index 949d4878df8..b6a6ea43599 100644 --- a/src/current/v24.2/goldengate.md +++ b/src/current/v24.2/goldengate.md @@ -515,6 +515,6 @@ Run the steps in this section on a machine and in a directory where Oracle Golde ## 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 %}) - [Change Data Capture Overview]({% link {{ page.version.version }}/change-data-capture-overview.md %}) - [Third-Party Tools Supported by Cockroach Labs]({% link {{ page.version.version }}/third-party-database-tools.md %}) diff --git a/src/current/v24.2/hashicorp-integration.md b/src/current/v24.2/hashicorp-integration.md index 76a482a071f..7c9f61e8d61 100644 --- a/src/current/v24.2/hashicorp-integration.md +++ b/src/current/v24.2/hashicorp-integration.md @@ -28,10 +28,10 @@ CockroachDB customers can integrate these services, using Vault's KMS secrets en Resources: -- [CMEK overview](https://www.cockroachlabs.com/docs/cockroachcloud/cmek) -- [Manage Customer-Managed Encryption Keys (CMEK) for CockroachDB Dedicated](https://www.cockroachlabs.com/docs/cockroachcloud/managing-cmek) -- [Provisioning GCP KMS Keys and Service Accounts for CMEK](https://www.cockroachlabs.com/docs/cockroachcloud/cmek-ops-gcp) -- [Provisioning AWS KMS Keys and IAM Roles for CMEK](https://www.cockroachlabs.com/docs/cockroachcloud/cmek-ops-aws) +- [CMEK overview]({% link cockroachcloud/cmek.md %}) +- [Manage Customer-Managed Encryption Keys (CMEK) for CockroachDB Dedicated]({% link cockroachcloud/managing-cmek.md %}) +- [Provisioning GCP KMS Keys and Service Accounts for CMEK]({% link cockroachcloud/cmek-ops-gcp.md %}) +- [Provisioning AWS KMS Keys and IAM Roles for CMEK]({% link cockroachcloud/cmek-ops-aws.md %}) ## Use Vault's PKI Secrets Engine to manage a CockroachDB {{ site.data.products.dedicated }} cluster's certificate authority (CA) and client certificates. @@ -41,7 +41,7 @@ By using Vault to manage certificates, you can use only certificates with short Refer to [Transport Layer Security (TLS) and Public Key Infrastructure (PKI)]({% link {{ page.version.version }}/security-reference/transport-layer-security.md %}) for an overview. -Refer to [Certificate Authentication for SQL Clients in CockroachDB Dedicated Clusters](https://www.cockroachlabs.com/docs/cockroachcloud/client-certs-dedicated) for procedures in involved in administering PKI for a CockroachDB {{ site.data.products.dedicated }} cluster. +Refer to [Certificate Authentication for SQL Clients in CockroachDB Dedicated Clusters]({% link cockroachcloud/client-certs-dedicated.md %}) for procedures in involved in administering PKI for a CockroachDB {{ site.data.products.dedicated }} cluster. ## Use Vault's PKI Secrets Engine to manage a CockroachDB {{ site.data.products.core }} cluster's certificate authority (CA), server, and client certificates @@ -75,12 +75,12 @@ Vault's [Transit Secrets Engine](https://www.vaultproject.io/docs/secrets/transi ## See also -- [CMEK overview](https://www.cockroachlabs.com/docs/cockroachcloud/cmek) -- [Manage Customer-Managed Encryption Keys (CMEK) for CockroachDB Dedicated](https://www.cockroachlabs.com/docs/cockroachcloud/managing-cmek) -- [Provisioning GCP KMS Keys and Service Accounts for CMEK](https://www.cockroachlabs.com/docs/cockroachcloud/cmek-ops-gcp) -- [Provisioning AWS KMS Keys and IAM Roles for CMEK](https://www.cockroachlabs.com/docs/cockroachcloud/cmek-ops-aws) +- [CMEK overview]({% link cockroachcloud/cmek.md %}) +- [Manage Customer-Managed Encryption Keys (CMEK) for CockroachDB Dedicated]({% link cockroachcloud/managing-cmek.md %}) +- [Provisioning GCP KMS Keys and Service Accounts for CMEK]({% link cockroachcloud/cmek-ops-gcp.md %}) +- [Provisioning AWS KMS Keys and IAM Roles for CMEK]({% link cockroachcloud/cmek-ops-aws.md %}) - [Transport Layer Security (TLS) and Public Key Infrastructure (PKI)]({% link {{ page.version.version }}/security-reference/transport-layer-security.md %}) -- [Certificate Authentication for SQL Clients in Dedicated Clusters](https://www.cockroachlabs.com/docs/cockroachcloud/client-certs-dedicated) +- [Certificate Authentication for SQL Clients in Dedicated Clusters]({% link cockroachcloud/client-certs-dedicated.md %}) - [Manage PKI certificates for a CockroachDB deployment with HashiCorp Vault]({% link {{ page.version.version }}/manage-certs-vault.md %}) - [Using HashiCorp Vault's Dynamic Secrets for Enhanced Database Credential Security in CockroachDB]({% link {{ page.version.version }}/vault-db-secrets-tutorial.md %}) - [Roles]({% link {{ page.version.version }}/security-reference/authorization.md %}#roles) diff --git a/src/current/v24.2/hasura-getting-started.md b/src/current/v24.2/hasura-getting-started.md index 7e129c9404c..6a79da9345f 100644 --- a/src/current/v24.2/hasura-getting-started.md +++ b/src/current/v24.2/hasura-getting-started.md @@ -21,7 +21,7 @@ This tutorial will show you how to configure a Hasura project with a CockroachDB Before you start this tutorial, you need: -- An existing [CockroachDB Cloud](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart) cluster, running CockroachDB v22.2 or later. +- An existing [CockroachDB Cloud]({% link cockroachcloud/quickstart.md %}) cluster, running CockroachDB v22.2 or later. - A [Hasura Cloud account](https://hasura.io/docs/latest/getting-started/getting-started-cloud/). ## Configure your cluster @@ -46,7 +46,7 @@ Before you start this tutorial, you need:
1. In the [CockroachDB Cloud console](https://cockroachlabs.cloud/clusters), select your cluster and click **Connect**. -1. If you have not set up [IP Allowlists](https://www.cockroachlabs.com/docs/cockroachcloud/network-authorization#ip-allowlisting) under **Network Security**, follow the instructions to add connections to your cluster from your machine. +1. If you have not set up [IP Allowlists]({% link cockroachcloud/network-authorization.md %}#ip-allowlisting) under **Network Security**, follow the instructions to add connections to your cluster from your machine. 1. Select the SQL user you want to use for the Hasura Cloud connection under **Select SQL user**. If you have not set up a SQL user for this cluster, follow the instructions to create a new SQL user. Be sure to copy and save the password to a secure location. 1. Select **General connection String**. 1. Copy the connection string under **General connection string** and paste it in a secure location. You will use this connection string later to configure Hasura GraphQL Engine with your cluster. @@ -146,7 +146,7 @@ Create a `CRDB_URL` environment variable to store the connection string. ## Add the Hasura Cloud network to your cluster allowlist -Your CockroachDB {{ site.data.products.dedicated }} cluster needs to be configured to [allow incoming client connections](https://www.cockroachlabs.com/docs/cockroachcloud/network-authorization#ip-allowlisting) from Hasura Cloud. +Your CockroachDB {{ site.data.products.dedicated }} cluster needs to be configured to [allow incoming client connections]({% link cockroachcloud/network-authorization.md %}#ip-allowlisting) from Hasura Cloud. 1. In the Hasura Cloud overview page select **Projects**, then click the **Config** icon for your project. diff --git a/src/current/v24.2/import-performance-best-practices.md b/src/current/v24.2/import-performance-best-practices.md index 8d69fe1ee73..95ca362a14a 100644 --- a/src/current/v24.2/import-performance-best-practices.md +++ b/src/current/v24.2/import-performance-best-practices.md @@ -35,7 +35,7 @@ When importing into a new table, split your dump data into two files: 1. A SQL file containing the table schema. 1. A CSV, delimited, or AVRO file containing the table data. -Convert the schema-only file using the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page). The Schema Conversion Tool automatically creates a new CockroachDB {{ site.data.products.serverless }} database with the converted schema. {% include cockroachcloud/migration/sct-self-hosted.md %} +Convert the schema-only file using the [Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}). The Schema Conversion Tool automatically creates a new CockroachDB {{ site.data.products.serverless }} database with the converted schema. {% include cockroachcloud/migration/sct-self-hosted.md %} Then use the [`IMPORT INTO`](import-into.html) statement to import the CSV data into the newly created table: diff --git a/src/current/v24.2/insert-data.md b/src/current/v24.2/insert-data.md index 725936d5212..1e44969642f 100644 --- a/src/current/v24.2/insert-data.md +++ b/src/current/v24.2/insert-data.md @@ -11,7 +11,7 @@ This page has instructions for getting data into CockroachDB with various progra Before reading this page, do the following: -- [Create a CockroachDB {{ site.data.products.serverless }} 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.serverless }} 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 %}). diff --git a/src/current/v24.2/kibana.md b/src/current/v24.2/kibana.md index 89ca122908a..0218767163c 100644 --- a/src/current/v24.2/kibana.md +++ b/src/current/v24.2/kibana.md @@ -8,7 +8,7 @@ docs_area: manage [Kibana](https://www.elastic.co/kibana/) is a platform that visualizes data on the [Elastic Stack](https://www.elastic.co/elastic-stack/). This page shows how to use the [CockroachDB module for Metricbeat](https://www.elastic.co/guide/en/beats/metricbeat/current/metricbeat-module-cockroachdb.html) to collect metrics exposed by your CockroachDB {{ site.data.products.core }} cluster's [Prometheus endpoint]({% link {{ page.version.version }}/monitoring-and-alerting.md %}#prometheus-endpoint) in Elasticsearch and how to visualize those metrics with Kibana. {{site.data.alerts.callout_success}} -To export metrics from a CockroachDB {{ site.data.products.cloud }} cluster, refer to [Export Metrics From a CockroachDB {{ site.data.products.dedicated }} Cluster](https://www.cockroachlabs.com/docs/cockroachcloud/export-metrics) instead of this page. +To export metrics from a CockroachDB {{ site.data.products.cloud }} cluster, refer to [Export Metrics From a CockroachDB {{ site.data.products.dedicated }} Cluster]({% link cockroachcloud/export-metrics.md %}) instead of this page. {{site.data.alerts.end}} In this tutorial, you will enable the CockroachDB module for Metricbeat and visualize the data in Kibana. diff --git a/src/current/v24.2/learn-cockroachdb-sql.md b/src/current/v24.2/learn-cockroachdb-sql.md index e5737403d19..e513ef15542 100644 --- a/src/current/v24.2/learn-cockroachdb-sql.md +++ b/src/current/v24.2/learn-cockroachdb-sql.md @@ -10,7 +10,7 @@ This tutorial guides you through some of the most essential CockroachDB SQL stat For a complete list of supported SQL statements and related details, see [SQL Statements]({% link {{ page.version.version }}/sql-statements.md %}). {{site.data.alerts.callout_info}} -This tutorial is for {{site.data.products.core}} users. If you are working with {{site.data.products.dedicated}} or {{site.data.products.serverless}}, you can run this tutorial against [a cluster running in the cloud](https://www.cockroachlabs.com/docs/cockroachcloud/learn-cockroachdb-sql). +This tutorial is for {{site.data.products.core}} users. If you are working with {{site.data.products.dedicated}} or {{site.data.products.serverless}}, you can run this tutorial against [a cluster running in the cloud]({% link cockroachcloud/learn-cockroachdb-sql.md %}). {{site.data.alerts.end}} ## Start CockroachDB diff --git a/src/current/v24.2/migrate-from-mysql.md b/src/current/v24.2/migrate-from-mysql.md index 2a1adcde9a2..b93b79b75ff 100644 --- a/src/current/v24.2/migrate-from-mysql.md +++ b/src/current/v24.2/migrate-from-mysql.md @@ -105,7 +105,7 @@ The example uses the [MySQL `world` data set](https://dev.mysql.com/doc/index-ot mysqlsh -uroot --sql --file {path}/world-db/world.sql ~~~ -1. Create a free [{{ site.data.products.cloud }} account](https://www.cockroachlabs.com/docs/cockroachcloud/create-an-account), which is used to access the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page?filters=mysql) and create the {{ site.data.products.serverless }} cluster. +1. Create a free [{{ site.data.products.cloud }} account]({% link cockroachcloud/create-an-account.md %}), which is used to access the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page?filters=mysql) and create the {{ site.data.products.serverless }} cluster. {{site.data.alerts.callout_success}} {% include cockroachcloud/migration/sct-self-hosted.md %} @@ -162,7 +162,7 @@ Use the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachclo 1. Click [**Migrate Schema**](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page?filters=mysql#migrate-the-schema) to create a new {{ site.data.products.serverless }} cluster with the converted schema. Name the database `world`. - You can view this database on the [**Databases** page](https://www.cockroachlabs.com/docs/cockroachcloud/databases-page) of the {{ site.data.products.cloud }} Console. + You can view this database on the [**Databases** page]({% link cockroachcloud/databases-page.md %}) of the {{ site.data.products.cloud }} Console. 1. Open a SQL shell to the CockroachDB `world` cluster. To find the command, open the **Connect** dialog in the {{ site.data.products.cloud }} Console and select the `world` database and **CockroachDB Client** option. It will look like: @@ -402,7 +402,7 @@ To learn more, see the [Migration Overview]({% link {{ page.version.version }}/m ## See also - [Migration Overview]({% link {{ page.version.version }}/migration-overview.md %}) -- [Use the Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) +- [Use the Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) - [Use the MOLT Verify tool]({% link molt/molt-verify.md %}) - [Import Performance Best Practices]({% link {{ page.version.version }}/import-performance-best-practices.md %}) - [Migrate from CSV]({% link {{ page.version.version }}/migrate-from-csv.md %}) diff --git a/src/current/v24.2/migrate-from-postgres.md b/src/current/v24.2/migrate-from-postgres.md index 8d35c7c7dd4..2f142eaeaca 100644 --- a/src/current/v24.2/migrate-from-postgres.md +++ b/src/current/v24.2/migrate-from-postgres.md @@ -70,7 +70,7 @@ The example uses a modified version of the PostgreSQL `french-towns-communes-fra psql frenchtowns -a -f frenchtowns.sql ~~~ -1. Create a free [{{ site.data.products.cloud }} account](https://www.cockroachlabs.com/docs/cockroachcloud/create-an-account), which is used to access the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) and create the {{ site.data.products.serverless }} cluster. +1. Create a free [{{ site.data.products.cloud }} account]({% link cockroachcloud/create-an-account.md %}), which is used to access the [Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) and create the {{ site.data.products.serverless }} cluster. {{site.data.alerts.callout_success}} {% include cockroachcloud/migration/sct-self-hosted.md %} @@ -78,7 +78,7 @@ The example uses a modified version of the PostgreSQL `french-towns-communes-fra ### Step 1. Convert the PostgreSQL schema -Use the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) to convert the `frenchtowns` schema for compatibility with CockroachDB. The schema has three tables: `regions`, `departments`, and `towns`. +Use the [Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) to convert the `frenchtowns` schema for compatibility with CockroachDB. The schema has three tables: `regions`, `departments`, and `towns`. 1. Dump the PostgreSQL `frenchtowns` schema with the following [`pg_dump`](https://www.postgresql.org/docs/15/app-pgdump.html) command: @@ -87,12 +87,12 @@ Use the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachclo pg_dump --schema-only frenchtowns > frenchtowns_schema.sql ~~~ -1. Open the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) in the {{ site.data.products.cloud }} Console and [add a new PostgreSQL schema](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page#convert-a-schema). +1. Open the [Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) in the {{ site.data.products.cloud }} Console and [add a new PostgreSQL schema]({% link cockroachcloud/migrations-page.md %}#convert-a-schema). - After conversion is complete, [review the results](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page#review-the-schema). The [**Summary Report**](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page#summary-report) shows that there are errors under **Required Fixes**. You must resolve these in order to migrate the schema to CockroachDB. + After conversion is complete, [review the results]({% link cockroachcloud/migrations-page.md %}#review-the-schema). The [**Summary Report**]({% link cockroachcloud/migrations-page.md %}#summary-report) shows that there are errors under **Required Fixes**. You must resolve these in order to migrate the schema to CockroachDB. {{site.data.alerts.callout_success}} - You can also [add your PostgreSQL database credentials](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page#use-credentials) to have the Schema Conversion Tool obtain the schema directly from the PostgreSQL database. + You can also [add your PostgreSQL database credentials]({% link cockroachcloud/migrations-page.md %}#use-credentials) to have the Schema Conversion Tool obtain the schema directly from the PostgreSQL database. {{site.data.alerts.end}} 1. `Missing user: postgres` errors indicate that the SQL user `postgres` is missing from CockroachDB. Click **Add User** to create the user. @@ -107,9 +107,9 @@ Use the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachclo This example migrates directly to a {{ site.data.products.serverless }} cluster. {% include cockroachcloud/migration/sct-self-hosted.md %} -1. Click [**Migrate Schema**](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page#migrate-the-schema) to create a new {{ site.data.products.serverless }} cluster with the converted schema. Name the database `frenchtowns`. +1. Click [**Migrate Schema**]({% link cockroachcloud/migrations-page.md %}#migrate-the-schema) to create a new {{ site.data.products.serverless }} cluster with the converted schema. Name the database `frenchtowns`. - You can view this database on the [**Databases** page](https://www.cockroachlabs.com/docs/cockroachcloud/databases-page) of the {{ site.data.products.cloud }} Console. + You can view this database on the [**Databases** page]({% link cockroachcloud/databases-page.md %}) of the {{ site.data.products.cloud }} Console. ### Step 2. Load the PostgreSQL data @@ -287,7 +287,7 @@ To learn more, see the [Migration Overview]({% link {{ page.version.version }}/m ## See also - [Migration Overview]({% link {{ page.version.version }}/migration-overview.md %}) -- [Use the Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) +- [Use the Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) - [Use the MOLT Verify tool]({% link molt/molt-verify.md %}) - [Import Performance Best Practices]({% link {{ page.version.version }}/import-performance-best-practices.md %}) - [Migrate from CSV]({% link {{ page.version.version }}/migrate-from-csv.md %}) diff --git a/src/current/v24.2/migration-overview.md b/src/current/v24.2/migration-overview.md index 4b8718dc76e..92405f6cd05 100644 --- a/src/current/v24.2/migration-overview.md +++ b/src/current/v24.2/migration-overview.md @@ -8,7 +8,7 @@ docs_area: migrate This page provides an overview of how to migrate a database to CockroachDB. {{site.data.alerts.callout_info}} -If you need to migrate data from a CockroachDB {{ site.data.products.serverless }} cluster to a CockroachDB {{ site.data.products.dedicated }} cluster, see [Migrate data from Serverless to Dedicated](https://www.cockroachlabs.com/docs/cockroachcloud/migrate-from-serverless-to-dedicated). +If you need to migrate data from a CockroachDB {{ site.data.products.serverless }} cluster to a CockroachDB {{ site.data.products.dedicated }} cluster, see [Migrate data from Serverless to Dedicated]({% link cockroachcloud/migrate-from-serverless-to-dedicated.md %}). {{site.data.alerts.end}} A database migration broadly consists of the following phases: @@ -117,11 +117,11 @@ Determine the size of the target CockroachDB cluster. To do this, consider your - What is the total size of the data you will migrate? - How many active [application connections]({% link {{ page.version.version }}/recommended-production-settings.md %}#connection-pooling) will be running in the CockroachDB environment? -Use this information to size the CockroachDB cluster you will create. If you are migrating to a CockroachDB {{ site.data.products.cloud }} cluster, see [Plan Your Cluster](https://www.cockroachlabs.com/docs/cockroachcloud/plan-your-cluster) for details: +Use this information to size the CockroachDB cluster you will create. If you are migrating to a CockroachDB {{ site.data.products.cloud }} cluster, see [Plan Your Cluster]({% link cockroachcloud/plan-your-cluster.md %}) for details: -- For CockroachDB {{ site.data.products.dedicated }}, refer to the [example](https://www.cockroachlabs.com/docs/cockroachcloud/plan-your-cluster#dedicated-example) that shows how your data volume, storage requirements, and replication factor affect the recommended node size (number of vCPUs per node) and total number of nodes on the cluster. -- For CockroachDB {{ site.data.products.serverless }}, your cluster will scale automatically to meet your storage and usage requirements. Refer to [Choosing resource limits](https://www.cockroachlabs.com/docs/cockroachcloud/plan-your-cluster-serverless#choose-resource-limits) to learn about how to limit your resource consumption. -- For guidance on sizing for connection pools, see the CockroachDB {{ site.data.products.cloud }} [Production Checklist](https://www.cockroachlabs.com/docs/cockroachcloud/production-checklist#use-a-pool-of-persistent-connections). +- For CockroachDB {{ site.data.products.dedicated }}, refer to the [example]({% link cockroachcloud/plan-your-cluster.md %}#dedicated-example) that shows how your data volume, storage requirements, and replication factor affect the recommended node size (number of vCPUs per node) and total number of nodes on the cluster. +- For CockroachDB {{ site.data.products.serverless }}, your cluster will scale automatically to meet your storage and usage requirements. Refer to [Choosing resource limits]({% link cockroachcloud/plan-your-cluster-serverless.md %}#choose-resource-limits) to learn about how to limit your resource consumption. +- For guidance on sizing for connection pools, see the CockroachDB {{ site.data.products.cloud }} [Production Checklist]({% link cockroachcloud/production-checklist.md %}#connection-pooling). If you are migrating to a CockroachDB {{ site.data.products.core }} cluster: @@ -143,7 +143,7 @@ As you develop your migration plan, consider the application changes that you wi Follow these recommendations when [converting your schema](#convert-the-schema) for compatibility with CockroachDB. {{site.data.alerts.callout_success}} -The [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) automatically identifies potential improvements to your schema. +The [Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) automatically identifies potential improvements to your schema. {{site.data.alerts.end}} - You should define an explicit primary key on every table. For more information, see [Primary key best practices]({% link {{ page.version.version }}/schema-design-table.md %}#primary-key-best-practices). @@ -169,7 +169,7 @@ Transaction retry errors are more frequent under CockroachDB's default [`SERIALI Update your queries to resolve differences in functionality and SQL syntax. {{site.data.alerts.callout_success}} -The [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) automatically flags syntax incompatibilities and unimplemented features in your schema. +The [Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) automatically flags syntax incompatibilities and unimplemented features in your schema. {{site.data.alerts.end}} CockroachDB supports the [PostgreSQL wire protocol](https://www.postgresql.org/docs/current/protocol.html) and is largely compatible with PostgreSQL syntax. However, the following PostgreSQL features do not yet exist in CockroachDB: @@ -217,7 +217,7 @@ In the following order: You can use the following [MOLT (Migrate Off Legacy Technology) tools]({% link molt/molt-overview.md %}) to simplify these steps: -- [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) +- [Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) - [MOLT Fetch]({% link molt/molt-fetch.md %}) - [MOLT Verify]({% link molt/molt-verify.md %}) @@ -225,17 +225,17 @@ You can use the following [MOLT (Migrate Off Legacy Technology) tools]({% link m First, convert your database schema to an equivalent CockroachDB schema: -- Use the [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) to convert your schema line-by-line. This requires a free [CockroachDB {{ site.data.products.cloud }} account](https://www.cockroachlabs.com/docs/cockroachcloud/create-an-account). The tool will convert the syntax, identify [unimplemented features and syntax incompatibilities](#unimplemented-features-and-syntax-incompatibilities) in the schema, and suggest edits according to CockroachDB [best practices](#schema-design-best-practices). +- Use the [Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) to convert your schema line-by-line. This requires a free [CockroachDB {{ site.data.products.cloud }} account]({% link cockroachcloud/create-an-account.md %}). The tool will convert the syntax, identify [unimplemented features and syntax incompatibilities](#unimplemented-features-and-syntax-incompatibilities) in the schema, and suggest edits according to CockroachDB [best practices](#schema-design-best-practices). {{site.data.alerts.callout_info}} The Schema Conversion Tool accepts `.sql` files from PostgreSQL, MySQL, Oracle, and Microsoft SQL Server. {{site.data.alerts.end}} -- Alternatively, manually convert the schema according to our [schema design best practices](#schema-design-best-practices){% comment %}and data type mappings{% endcomment %}. You can also [export a partially converted schema](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page#export-the-schema) from the Schema Conversion Tool to finish the conversion manually. +- Alternatively, manually convert the schema according to our [schema design best practices](#schema-design-best-practices){% comment %}and data type mappings{% endcomment %}. You can also [export a partially converted schema]({% link cockroachcloud/migrations-page.md %}#export-the-schema) from the Schema Conversion Tool to finish the conversion manually. Then import the converted schema to a CockroachDB cluster: -- For CockroachDB {{ site.data.products.cloud }}, use the Schema Conversion Tool to [migrate the converted schema to a new {{ site.data.products.serverless }} or {{ site.data.products.dedicated }} database](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page#migrate-the-schema). -- For CockroachDB {{ site.data.products.core }}, pipe the [data definition language (DDL)]({% link {{ page.version.version }}/sql-statements.md %}#data-definition-statements) directly into [`cockroach sql`]({% link {{ page.version.version }}/cockroach-sql.md %}). You can [export a converted schema file](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page#export-the-schema) from the Schema Conversion Tool. +- For CockroachDB {{ site.data.products.cloud }}, use the Schema Conversion Tool to [migrate the converted schema to a new {{ site.data.products.serverless }} or {{ site.data.products.dedicated }} database]({% link cockroachcloud/migrations-page.md %}#migrate-the-schema). +- For CockroachDB {{ site.data.products.core }}, pipe the [data definition language (DDL)]({% link {{ page.version.version }}/sql-statements.md %}#data-definition-statements) directly into [`cockroach sql`]({% link {{ page.version.version }}/cockroach-sql.md %}). You can [export a converted schema file]({% link cockroachcloud/migrations-page.md %}#export-the-schema) from the Schema Conversion Tool. {{site.data.alerts.callout_success}} For the fastest performance, you can use a [local, single-node CockroachDB cluster]({% link {{ page.version.version }}/cockroach-start-single-node.md %}#start-a-single-node-cluster) to convert your schema and [check the results of queries](#test-query-results-and-performance). {{site.data.alerts.end}} @@ -268,7 +268,7 @@ You can "shadow" your production workload by executing your source SQL statement You can manually validate your queries by testing a subset of "critical queries" on an otherwise idle CockroachDB cluster: -- Check the application logs for error messages and the API response time. If application requests are slower than expected, use the **SQL Activity** page on the [CockroachDB {{ site.data.products.cloud }} Console](https://www.cockroachlabs.com/docs/cockroachcloud/statements-page) or [DB Console]({% link {{ page.version.version }}/ui-statements-page.md %}) to find the longest-running queries that are part of that application request. If necessary, tune the queries according to our best practices for [SQL performance]({% link {{ page.version.version }}/performance-best-practices-overview.md %}). +- Check the application logs for error messages and the API response time. If application requests are slower than expected, use the **SQL Activity** page on the [CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/statements-page.md %}) or [DB Console]({% link {{ page.version.version }}/ui-statements-page.md %}) to find the longest-running queries that are part of that application request. If necessary, tune the queries according to our best practices for [SQL performance]({% link {{ page.version.version }}/performance-best-practices-overview.md %}). - Compare the results of the queries and check that they are identical in both the source database and CockroachDB. To do this, you can use [MOLT Verify]({% link molt/molt-verify.md %}). @@ -350,7 +350,7 @@ After you have successfully [conducted the migration](#conduct-the-migration): - [Can a PostgreSQL or MySQL application be migrated to CockroachDB?]({% link {{ page.version.version }}/frequently-asked-questions.md %}#can-a-postgresql-or-mysql-application-be-migrated-to-cockroachdb) - [PostgreSQL Compatibility]({% link {{ page.version.version }}/postgresql-compatibility.md %}) -- [Use the Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) +- [Use the Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) - [Schema Design Overview]({% link {{ page.version.version }}/schema-design-overview.md %}) - [Create a User-defined Schema]({% link {{ page.version.version }}/schema-design-schema.md %}) - [Primary key best practices]({% link {{ page.version.version }}/schema-design-table.md %}#primary-key-best-practices) diff --git a/src/current/v24.2/migration-strategy-lift-and-shift.md b/src/current/v24.2/migration-strategy-lift-and-shift.md index 8c7404f84c8..7417b4c7b3c 100644 --- a/src/current/v24.2/migration-strategy-lift-and-shift.md +++ b/src/current/v24.2/migration-strategy-lift-and-shift.md @@ -72,7 +72,7 @@ It's important to decide which data formats, storage media, and database feature Data formats that can be imported by CockroachDB include: -- [SQL]({% link {{ page.version.version }}/schema-design-overview.md %}) for the [schema import](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page). +- [SQL]({% link {{ page.version.version }}/schema-design-overview.md %}) for the [schema import]({% link cockroachcloud/migrations-page.md %}). - [CSV]({% link {{ page.version.version }}/migrate-from-csv.md %}) for table data. - [Avro]({% link {{ page.version.version }}/migrate-from-avro.md %}) for table data. @@ -121,7 +121,7 @@ For more information about import performance, see [Import Performance Best Prac ## See also - [Migration Overview]({% link {{ page.version.version }}/migration-overview.md %}) -- [Use the Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) +- [Use the Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %}) - [Migrate with AWS Database Migration Service (DMS)]({% link {{ page.version.version }}/aws-dms.md %}) - [AWS DMS documentation](https://docs.aws.amazon.com/dms/latest/userguide/Welcome.html) - [Migrate and Replicate Data with Qlik Replicate]({% link {{ page.version.version }}/qlik.md %}) diff --git a/src/current/v24.2/monitoring-and-alerting.md b/src/current/v24.2/monitoring-and-alerting.md index 7bf1255a704..a7880f7c02a 100644 --- a/src/current/v24.2/monitoring-and-alerting.md +++ b/src/current/v24.2/monitoring-and-alerting.md @@ -7,7 +7,7 @@ docs_area: manage In addition to CockroachDB's [built-in safeguards against failure]({% link {{ page.version.version }}/frequently-asked-questions.md %}#how-does-cockroachdb-survive-failures), it is critical to actively monitor the overall health and performance of a cluster running in production and to create alerting rules that promptly send notifications when there are events that require investigation or intervention. -This page describes the monitoring and observability tools that are built into CockroachDB {{ site.data.products.core }} and shows how to collect your cluster's metrics using external tools like Prometheus's AlertManager for event-based alerting. To export metrics from a CockroachDB {{ site.data.products.cloud }} cluster, refer to [Export Metrics From a CockroachDB {{ site.data.products.dedicated }} Cluster](https://www.cockroachlabs.com/docs/cockroachcloud/export-metrics) instead of this page. For more details, refer to: +This page describes the monitoring and observability tools that are built into CockroachDB {{ site.data.products.core }} and shows how to collect your cluster's metrics using external tools like Prometheus's AlertManager for event-based alerting. To export metrics from a CockroachDB {{ site.data.products.cloud }} cluster, refer to [Export Metrics From a CockroachDB {{ site.data.products.dedicated }} Cluster]({% link cockroachcloud/export-metrics.md %}) instead of this page. For more details, refer to: - [Monitor CockroachDB with Prometheus]({% link {{ page.version.version }}/monitor-cockroachdb-with-prometheus.md %}) - [Third-party Monitoring Tools]({% link {{ page.version.version }}/third-party-monitoring-tools.md %}) diff --git a/src/current/v24.2/movr-flask-deployment.md b/src/current/v24.2/movr-flask-deployment.md index 0ddb93896eb..2ce85089d43 100644 --- a/src/current/v24.2/movr-flask-deployment.md +++ b/src/current/v24.2/movr-flask-deployment.md @@ -21,7 +21,7 @@ In addition to the requirements listed in [Setting Up a Virtual Environment for ## Multi-region database deployment -In production, you want to start a secure CockroachDB cluster, with nodes on machines located in different areas of the world. To deploy CockroachDB in multiple regions, we recommend using [CockroachDB {{ site.data.products.dedicated }}](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart). +In production, you want to start a secure CockroachDB cluster, with nodes on machines located in different areas of the world. To deploy CockroachDB in multiple regions, we recommend using [CockroachDB {{ site.data.products.dedicated }}]({% link cockroachcloud/quickstart.md %}). {{site.data.alerts.callout_info}} You can also deploy CockroachDB manually. For instructions, see the [Manual Deployment]({% link {{ page.version.version }}/manual-deployment.md %}) page of the Cockroach Labs documentation site. @@ -235,7 +235,7 @@ Some time after you have deployed your application, you will likely need to push ## See also {% comment %} [MovR (live demo)](https://movr.cloud){% endcomment %} -- [CockroachDB {{ site.data.products.cloud }} documentation](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart) +- [CockroachDB {{ site.data.products.cloud }} documentation]({% link cockroachcloud/quickstart.md %}) - [Google Cloud Platform documentation](https://cloud.google.com/docs/) - [Docker documentation](https://docs.docker.com/) - [Kubernetes documentation](https://kubernetes.io/docs/home/) diff --git a/src/current/v24.2/multiregion-scale-application.md b/src/current/v24.2/multiregion-scale-application.md index 58ebda2d048..ccf9f2282f1 100644 --- a/src/current/v24.2/multiregion-scale-application.md +++ b/src/current/v24.2/multiregion-scale-application.md @@ -42,7 +42,7 @@ Scale the cluster by adding nodes to the cluster in new regions. For instructions on adding nodes to an existing cluster, see one of the following pages: -- For managed CockroachDB {{ site.data.products.cloud }} deployments, see [Cluster Management](https://www.cockroachlabs.com/docs/cockroachcloud/cluster-management). +- For managed CockroachDB {{ site.data.products.cloud }} deployments, see [Cluster Management]({% link cockroachcloud/cluster-management.md %}). - For orchestrated deployments, see [Orchestrate CockroachDB Across Multiple Kubernetes Clusters]({% link {{ page.version.version }}/orchestrate-cockroachdb-with-kubernetes-multi-cluster.md %}). - For manual deployments, see [`cockroach start`]({% link {{ page.version.version }}/cockroach-start.md %}) and [Manual Deployment]({% link {{ page.version.version }}/manual-deployment.md %}). @@ -68,7 +68,7 @@ Scaling application deployments in multiple regions can greatly improve latency For guidance on connecting to CockroachDB from an application deployment, see one of the following pages: -- For connecting to managed, CockroachDB {{ site.data.products.cloud }} deployments, see [Connect to Your CockroachDB {{ site.data.products.dedicated }} Cluster](https://www.cockroachlabs.com/docs/cockroachcloud/connect-to-your-cluster) and [Connect to the Database (CockroachDB {{ site.data.products.dedicated }})]({% link {{ page.version.version }}/connect-to-the-database.md %}?filters=dedicated). +- For connecting to managed, CockroachDB {{ site.data.products.cloud }} deployments, see [Connect to Your CockroachDB {{ site.data.products.dedicated }} Cluster]({% link cockroachcloud/connect-to-your-cluster.md %}) and [Connect to the Database (CockroachDB {{ site.data.products.dedicated }})]({% link {{ page.version.version }}/connect-to-the-database.md %}?filters=dedicated). - For connecting to a standard CockroachDB deployment, see [`cockroach sql`]({% link {{ page.version.version }}/cockroach-sql.md %}) and [Connect to the Database]({% link {{ page.version.version }}/connect-to-the-database.md %}). To limit the latency between the application and the database, each deployment of the application should communicate with the closest database deployment. For details on configuring database connections for individual application deployments, consult your cloud provider's documentation. For an example using Google Cloud services, see [Deploy a Global, Serverless Application]({% link {{ page.version.version }}/movr-flask-deployment.md %}). diff --git a/src/current/v24.2/orchestrate-a-local-cluster-with-kubernetes-insecure.md b/src/current/v24.2/orchestrate-a-local-cluster-with-kubernetes-insecure.md index 11383548467..570e3615d41 100644 --- a/src/current/v24.2/orchestrate-a-local-cluster-with-kubernetes-insecure.md +++ b/src/current/v24.2/orchestrate-a-local-cluster-with-kubernetes-insecure.md @@ -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]({% link {{ page.version.version }}/kubernetes-overview.md %}). To deploy a 30-day free CockroachDB {{ site.data.products.dedicated }} cluster instead of running CockroachDB yourself, see the [Quickstart](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart). +To orchestrate a physically distributed cluster in production, see [Orchestrated Deployments]({% link {{ page.version.version }}/kubernetes-overview.md %}). To deploy a 30-day free CockroachDB {{ site.data.products.dedicated }} cluster instead of running CockroachDB yourself, see the [Quickstart]({% link cockroachcloud/quickstart.md %}). {{site.data.alerts.end}} ## Best practices diff --git a/src/current/v24.2/orchestrate-a-local-cluster-with-kubernetes.md b/src/current/v24.2/orchestrate-a-local-cluster-with-kubernetes.md index c30d7019aa9..7c2b9e6b162 100644 --- a/src/current/v24.2/orchestrate-a-local-cluster-with-kubernetes.md +++ b/src/current/v24.2/orchestrate-a-local-cluster-with-kubernetes.md @@ -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]({% link {{ page.version.version }}/kubernetes-overview.md %}). To deploy a 30-day free CockroachDB {{ site.data.products.dedicated }} cluster instead of running CockroachDB yourself, see the [Quickstart](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart). +To orchestrate a physically distributed cluster in production, see [Orchestrated Deployments]({% link {{ page.version.version }}/kubernetes-overview.md %}). To deploy a 30-day free CockroachDB {{ site.data.products.dedicated }} cluster instead of running CockroachDB yourself, see the [Quickstart]({% link cockroachcloud/quickstart.md %}). {{site.data.alerts.end}} ## Best practices diff --git a/src/current/v24.2/performance-recipes.md b/src/current/v24.2/performance-recipes.md index 3447b25cf31..256273a3736 100644 --- a/src/current/v24.2/performance-recipes.md +++ b/src/current/v24.2/performance-recipes.md @@ -95,19 +95,19 @@ This section provides solutions for common performance issues in your applicatio These are indicators that a transaction is trying to access a row that has been ["locked"]({% link {{ page.version.version }}/architecture/transaction-layer.md %}#writing) by another, concurrent transaction issuing a [write]({% link {{ page.version.version }}/architecture/transaction-layer.md %}#write-intents) or [locking read]({% link {{ page.version.version }}/select-for-update.md %}#lock-strengths). -- The **Active Executions** table on the **Transactions** page ([CockroachDB {{ site.data.products.cloud }} Console](https://www.cockroachlabs.com/docs/cockroachcloud/transactions-page) or [DB Console]({% link {{ page.version.version }}/ui-transactions-page.md %}#active-executions-table)) shows transactions with `Waiting` in the **Status** column. You can sort the table by **Time Spent Waiting**. +- The **Active Executions** table on the **Transactions** page ([CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/transactions-page.md %}) or [DB Console]({% link {{ page.version.version }}/ui-transactions-page.md %}#active-executions-table)) shows transactions with `Waiting` in the **Status** column. You can sort the table by **Time Spent Waiting**. - Querying the [`crdb_internal.cluster_locks`]({% link {{ page.version.version }}/crdb-internal.md %}#cluster_locks) table shows transactions where [`granted`]({% link {{ page.version.version }}/crdb-internal.md %}#cluster-locks-columns) is `false`. These are indicators that lock contention occurred in the past: - Querying the [`crdb_internal.transaction_contention_events`]({% link {{ page.version.version }}/crdb-internal.md %}#transaction_contention_events) table `WHERE contention_type='LOCK_WAIT'` indicates that your transactions have experienced lock contention. - - This is also shown in the **Transaction Executions** view on the **Insights** page ([CockroachDB {{ site.data.products.cloud }} Console](https://www.cockroachlabs.com/docs/cockroachcloud/insights-page#transaction-executions-view) and [DB Console]({% link {{ page.version.version }}/ui-insights-page.md %}#transaction-executions-view)). Transaction executions will display the [**High Contention** insight]({% link {{ page.version.version }}/ui-insights-page.md %}#high-contention). + - This is also shown in the **Transaction Executions** view on the **Insights** page ([CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/insights-page.md %}#transaction-executions-view) and [DB Console]({% link {{ page.version.version }}/ui-insights-page.md %}#transaction-executions-view)). Transaction executions will display the [**High Contention** insight]({% link {{ page.version.version }}/ui-insights-page.md %}#high-contention). {{site.data.alerts.callout_info}} {%- include {{ page.version.version }}/performance/sql-trace-txn-enable-threshold.md -%} {{site.data.alerts.end}} -- The **SQL Statement Contention** graph ([CockroachDB {{ site.data.products.cloud }} Console](https://www.cockroachlabs.com/docs/cockroachcloud/metrics-page#sql-statement-contention) and [DB Console]({% link {{ page.version.version }}/ui-sql-dashboard.md %}#sql-statement-contention)) is showing spikes over time. +- The **SQL Statement Contention** graph ([CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/metrics-page.md %}#sql-statement-contention) and [DB Console]({% link {{ page.version.version }}/ui-sql-dashboard.md %}#sql-statement-contention)) is showing spikes over time. SQL Statement Contention graph in DB Console If a long-running transaction is waiting due to [lock contention]({% link {{ page.version.version }}/performance-best-practices-overview.md %}#transaction-contention): @@ -124,11 +124,11 @@ These are indicators that a transaction has failed due to [contention]({% link { - A [transaction retry error]({% link {{ page.version.version }}/transaction-retry-error-reference.md %}) with `SQLSTATE: 40001`, the string [`restart transaction`]({% link {{ page.version.version }}/common-errors.md %}#restart-transaction), and an error code such as [`RETRY_WRITE_TOO_OLD`]({% link {{ page.version.version }}/transaction-retry-error-reference.md %}#retry_write_too_old) or [`RETRY_SERIALIZABLE`]({% link {{ page.version.version }}/transaction-retry-error-reference.md %}#retry_serializable), is emitted to the client. These errors are typically seen under [`SERIALIZABLE`]({% link {{ page.version.version }}/demo-serializable.md %}) and not [`READ COMMITTED`]({% link {{ page.version.version }}/read-committed.md %}) isolation. - Querying the [`crdb_internal.transaction_contention_events`]({% link {{ page.version.version }}/crdb-internal.md %}#transaction_contention_events) table `WHERE contention_type='SERIALIZATION_CONFLICT'` indicates that your transactions have experienced serialization conflicts. - - This is also shown in the **Transaction Executions** view on the **Insights** page ([CockroachDB {{ site.data.products.cloud }} Console](https://www.cockroachlabs.com/docs/cockroachcloud/insights-page#transaction-executions-view) and [DB Console]({% link {{ page.version.version }}/ui-insights-page.md %}#transaction-executions-view)). Transaction executions will display the [**Failed Execution** insight due to a serialization conflict]({% link {{ page.version.version }}/ui-insights-page.md %}#serialization-conflict-due-to-transaction-contention). + - This is also shown in the **Transaction Executions** view on the **Insights** page ([CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/insights-page.md %}#transaction-executions-view) and [DB Console]({% link {{ page.version.version }}/ui-insights-page.md %}#transaction-executions-view)). Transaction executions will display the [**Failed Execution** insight due to a serialization conflict]({% link {{ page.version.version }}/ui-insights-page.md %}#serialization-conflict-due-to-transaction-contention). These are indicators that transaction retries occurred in the past: -- The **Transaction Restarts** graph ([CockroachDB {{ site.data.products.cloud }} Console](https://www.cockroachlabs.com/docs/cockroachcloud/metrics-page#transaction-restarts) and [DB Console]({% link {{ page.version.version }}/ui-sql-dashboard.md %}#transaction-restarts) is showing spikes in transaction retries over time. +- The **Transaction Restarts** graph ([CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/metrics-page.md %}#transaction-restarts) and [DB Console]({% link {{ page.version.version }}/ui-sql-dashboard.md %}#transaction-restarts) is showing spikes in transaction retries over time. {% include {{ page.version.version }}/performance/transaction-retry-error-actions.md %} @@ -140,7 +140,7 @@ When running under `SERIALIZABLE` isolation, implement [client-side retry handli ##### Identify conflicting transactions -- In the **Active Executions** table on the **Transactions** page ([CockroachDB {{ site.data.products.cloud }} Console](https://www.cockroachlabs.com/docs/cockroachcloud/transactions-page) or [DB Console]({% link {{ page.version.version }}/ui-transactions-page.md %}#active-executions-table)), look for a **waiting** transaction (`Waiting` status). +- In the **Active Executions** table on the **Transactions** page ([CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/transactions-page.md %}) or [DB Console]({% link {{ page.version.version }}/ui-transactions-page.md %}#active-executions-table)), look for a **waiting** transaction (`Waiting` status). {{site.data.alerts.callout_success}} If you see many waiting transactions, a single long-running transaction may be blocking transactions that are, in turn, blocking others. In this case, sort the table by **Time Spent Waiting** to find the transaction that has been waiting for the longest amount of time. Unblocking this transaction may unblock the other transactions. {{site.data.alerts.end}} @@ -160,8 +160,8 @@ When running under `SERIALIZABLE` isolation, implement [client-side retry handli To identify transactions that experienced [lock contention]({% link {{ page.version.version }}/performance-best-practices-overview.md %}#transaction-contention) in the past: -- In the **Transaction Executions** view on the **Insights** page ([CockroachDB {{ site.data.products.cloud }} Console](https://www.cockroachlabs.com/docs/cockroachcloud/insights-page#transaction-executions-view) and [DB Console]({% link {{ page.version.version }}/ui-insights-page.md %}#transaction-executions-view)), look for a transaction with the **High Contention** insight. Click the transaction's execution ID and view the transaction execution details, including the details of the blocking transaction. -- Visit the **Transactions** page ([CockroachDB {{ site.data.products.cloud }} Console](https://www.cockroachlabs.com/docs/cockroachcloud/transactions-page) and [DB Console]({% link {{ page.version.version }}/ui-transactions-page.md %})) and sort transactions by **Contention Time**. +- In the **Transaction Executions** view on the **Insights** page ([CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/insights-page.md %}#transaction-executions-view) and [DB Console]({% link {{ page.version.version }}/ui-insights-page.md %}#transaction-executions-view)), look for a transaction with the **High Contention** insight. Click the transaction's execution ID and view the transaction execution details, including the details of the blocking transaction. +- Visit the **Transactions** page ([CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/transactions-page.md %}) and [DB Console]({% link {{ page.version.version }}/ui-transactions-page.md %})) and sort transactions by **Contention Time**. To view tables and indexes that experienced [contention]({% link {{ page.version.version }}/performance-best-practices-overview.md %}#transaction-contention): diff --git a/src/current/v24.2/qlik.md b/src/current/v24.2/qlik.md index ba48ae4d92e..c8bf2b3e0ee 100644 --- a/src/current/v24.2/qlik.md +++ b/src/current/v24.2/qlik.md @@ -65,7 +65,7 @@ Complete the following items before using Qlik Replicate: - If the output of [`SHOW SCHEDULES`]({% link {{ page.version.version }}/show-schedules.md %}) shows any backup schedules, run [`ALTER BACKUP SCHEDULE {schedule_id} SET WITH revision_history = 'false'`]({% link {{ page.version.version }}/alter-backup-schedule.md %}) for each backup schedule. - If the output of `SHOW SCHEDULES` does not show backup schedules, [contact Support](https://support.cockroachlabs.com) to disable revision history for cluster backups. - Manually create all schema objects in the target CockroachDB cluster. Qlik can create a basic schema, but does not create indexes or constraints such as foreign keys and defaults. - - If you are migrating from PostgreSQL, MySQL, Oracle, or Microsoft SQL Server, [use the **Schema Conversion Tool**](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) to convert and export your schema. Ensure that any schema changes are also reflected on your tables, or add transformation rules. If you make substantial schema changes, the Qlik Replicate migration may fail. + - If you are migrating from PostgreSQL, MySQL, Oracle, or Microsoft SQL Server, [use the **Schema Conversion Tool**]({% link cockroachcloud/migrations-page.md %}) to convert and export your schema. Ensure that any schema changes are also reflected on your tables, or add transformation rules. If you make substantial schema changes, the Qlik Replicate migration may fail. {{site.data.alerts.callout_info}} 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). @@ -97,7 +97,7 @@ In the Qlik Replicate interface, CockroachDB is configured as a PostgreSQL **sou ## 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 %}) - [Change Data Capture Overview]({% link {{ page.version.version }}/change-data-capture-overview.md %}) - [Third-Party Tools Supported by Cockroach Labs]({% link {{ page.version.version }}/third-party-database-tools.md %}) - [Migrate with AWS Database Migration Service (DMS)]({% link {{ page.version.version }}/aws-dms.md %}) diff --git a/src/current/v24.2/query-behavior-troubleshooting.md b/src/current/v24.2/query-behavior-troubleshooting.md index 64733694cd0..0aa4b7bd2a9 100644 --- a/src/current/v24.2/query-behavior-troubleshooting.md +++ b/src/current/v24.2/query-behavior-troubleshooting.md @@ -21,7 +21,7 @@ Such long-running queries can hold locks for (practically) unlimited durations. Refer to the performance tuning recipe for [identifying and unblocking a waiting transaction]({% link {{ page.version.version }}/performance-recipes.md %}#waiting-transaction). -If you experience this issue on a CockroachDB {{ site.data.products.serverless }} cluster, your cluster may be throttled or disabled because you've reached your monthly [resource limits](https://www.cockroachlabs.com/docs/cockroachcloud/troubleshooting-page#hanging-or-stuck-queries). +If you experience this issue on a CockroachDB {{ site.data.products.serverless }} cluster, your cluster may be throttled or disabled because you've reached your monthly [resource limits]({% link cockroachcloud/troubleshooting-page.md %}#hanging-or-stuck-queries). ### Identify slow queries diff --git a/src/current/v24.2/query-data.md b/src/current/v24.2/query-data.md index 6ea76993f2a..6bb663791d9 100644 --- a/src/current/v24.2/query-data.md +++ b/src/current/v24.2/query-data.md @@ -11,7 +11,7 @@ This page has instructions for making SQL [selection queries][selection] against Before reading this page, do the following: -- [Create a CockroachDB {{ site.data.products.serverless }} 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.serverless }} 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 run queries against. diff --git a/src/current/v24.2/restoring-backups-across-versions.md b/src/current/v24.2/restoring-backups-across-versions.md index 816b406cc76..f17715f3556 100644 --- a/src/current/v24.2/restoring-backups-across-versions.md +++ b/src/current/v24.2/restoring-backups-across-versions.md @@ -29,7 +29,7 @@ Backup taken on version | Restorable into version 22.1.x | 22.1.x, 22.2.x 22.2.x | 22.2.x, 23.1.x -When a cluster is in a mixed-version state during an upgrade, [full cluster restores]({% link {{ page.version.version }}/restore.md %}#restore-a-cluster) will fail. See the [Upgrade documentation]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}) for the necessary steps to finalize your upgrade. For CockroachDB {{ site.data.products.cloud }} clusters, see the [CockroachDB Cloud Upgrade Policy](https://www.cockroachlabs.com/docs/cockroachcloud/upgrade-policy) page. +When a cluster is in a mixed-version state during an upgrade, [full cluster restores]({% link {{ page.version.version }}/restore.md %}#restore-a-cluster) will fail. See the [Upgrade documentation]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}) for the necessary steps to finalize your upgrade. For CockroachDB {{ site.data.products.cloud }} clusters, see the [CockroachDB Cloud Upgrade Policy]({% link cockroachcloud/upgrade-policy.md %}) page. {{site.data.alerts.callout_info}} Cockroach Labs does **not** support restoring backups from a higher version into a lower version. diff --git a/src/current/v24.2/schema-design-database.md b/src/current/v24.2/schema-design-database.md index 7130d3c6d88..438ffad5540 100644 --- a/src/current/v24.2/schema-design-database.md +++ b/src/current/v24.2/schema-design-database.md @@ -15,7 +15,7 @@ For reference documentation on the `CREATE DATABASE` statement, including additi Before reading this page, do the following: -- [Create a CockroachDB {{ site.data.products.serverless }} 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.serverless }} cluster]({% link cockroachcloud/quickstart.md %}) or [start a local cluster](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart?filters=local). - [Review the database schema objects]({% link {{ page.version.version }}/schema-design-overview.md %}). ## Create a database diff --git a/src/current/v24.2/schema-design-indexes.md b/src/current/v24.2/schema-design-indexes.md index 6e895315845..132d38f6444 100644 --- a/src/current/v24.2/schema-design-indexes.md +++ b/src/current/v24.2/schema-design-indexes.md @@ -18,7 +18,7 @@ This page provides best-practice guidance on creating secondary indexes, with a Before reading this page, do the following: -- [Create a CockroachDB {{ site.data.products.serverless }} 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.serverless }} cluster]({% link cockroachcloud/quickstart.md %}) or [start a local cluster](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart?filters=local). - [Review the database schema objects]({% link {{ page.version.version }}/schema-design-overview.md %}). - [Create a database]({% link {{ page.version.version }}/schema-design-database.md %}). - [Create a user-defined schema]({% link {{ page.version.version }}/schema-design-schema.md %}). diff --git a/src/current/v24.2/schema-design-schema.md b/src/current/v24.2/schema-design-schema.md index 402588aea2b..ce931d393ba 100644 --- a/src/current/v24.2/schema-design-schema.md +++ b/src/current/v24.2/schema-design-schema.md @@ -15,7 +15,7 @@ For detailed reference documentation on the `CREATE SCHEMA` statement, including Before reading this page, do the following: -- [Create a CockroachDB {{ site.data.products.serverless }} 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.serverless }} cluster]({% link cockroachcloud/quickstart.md %}) or [start a local cluster](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart?filters=local). - [Review the database schema objects]({% link {{ page.version.version }}/schema-design-overview.md %}). - [Create a database]({% link {{ page.version.version }}/schema-design-database.md %}). diff --git a/src/current/v24.2/schema-design-table.md b/src/current/v24.2/schema-design-table.md index cd18dd9c8e7..5b606adfe28 100644 --- a/src/current/v24.2/schema-design-table.md +++ b/src/current/v24.2/schema-design-table.md @@ -15,7 +15,7 @@ For detailed reference documentation on the `CREATE TABLE` statement, including Before reading this page, do the following: -- [Create a CockroachDB {{ site.data.products.serverless }} 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.serverless }} cluster]({% link cockroachcloud/quickstart.md %}) or [start a local cluster](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart?filters=local). - [Review the database schema objects]({% link {{ page.version.version }}/schema-design-overview.md %}). - [Create a database]({% link {{ page.version.version }}/schema-design-database.md %}). - [Create a user-defined schema]({% link {{ page.version.version }}/schema-design-schema.md %}). diff --git a/src/current/v24.2/schema-design-update.md b/src/current/v24.2/schema-design-update.md index de2b23b1241..37b3488d4b4 100644 --- a/src/current/v24.2/schema-design-update.md +++ b/src/current/v24.2/schema-design-update.md @@ -11,7 +11,7 @@ This page provides an overview on changing and removing the objects in a databas Before reading this page, do the following: -- [Create a CockroachDB {{ site.data.products.serverless }} 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.serverless }} cluster]({% link cockroachcloud/quickstart.md %}) or [start a local cluster](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart?filters=local). - [Review the database schema objects]({% link {{ page.version.version }}/schema-design-overview.md %}). - [Create a database]({% link {{ page.version.version }}/schema-design-database.md %}). - [Create a user-defined schema]({% link {{ page.version.version }}/schema-design-schema.md %}). diff --git a/src/current/v24.2/sso-db-console.md b/src/current/v24.2/sso-db-console.md index 996ada9a495..d747c1f5005 100644 --- a/src/current/v24.2/sso-db-console.md +++ b/src/current/v24.2/sso-db-console.md @@ -28,7 +28,7 @@ This SSO implementation uses the [authorization code grant type](https://tools.i - **CockroachDB cluster**: you must have access to one of the following: - A {{ site.data.products.core }} cluster enabled with a valid [CockroachDB Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). - - A [CockroachDB {{ site.data.products.dedicated }} cluster](https://www.cockroachlabs.com/docs/cockroachcloud/create-your-cluster). + - A [CockroachDB {{ site.data.products.dedicated }} cluster]({% link cockroachcloud/create-your-cluster.md %}). ## Log in to a cluster's DB Console with SSO diff --git a/src/current/v24.2/sso-sql.md b/src/current/v24.2/sso-sql.md index aaf460bc01e..23223d196ea 100644 --- a/src/current/v24.2/sso-sql.md +++ b/src/current/v24.2/sso-sql.md @@ -12,7 +12,7 @@ Cluster single sign-on (SSO) enables users to access the SQL interface of a Cock {{ site.data.products.dedicated }} clusters can provision their users with JWTs via the DB Console. This allows users to authenticate to a cluster by signing in to their IdP (for example, Okta or Google) with a link embedded in the DB Console. This flow provisions a JWT that a user can copy out of the DB Console UI and use in a SQL connection string to authenticate to the cluster. {{site.data.alerts.callout_info}} -Cluster single sign-on for the DB Console is supported on {{ site.data.products.core }} {{ site.data.products.enterprise }} and {{ site.data.products.dedicated }} clusters. {{ site.data.products.serverless }} clusters do not support cluster single sign-on, because they do not have access to the DB Console. However, {{ site.data.products.serverless }} clusters can use [Cluster Single Sign-on (SSO) using `ccloud` and the CockroachDB Cloud Console](https://www.cockroachlabs.com/docs/cockroachcloud/cloud-sso-sql). +Cluster single sign-on for the DB Console is supported on {{ site.data.products.core }} {{ site.data.products.enterprise }} and {{ site.data.products.dedicated }} clusters. {{ site.data.products.serverless }} clusters do not support cluster single sign-on, because they do not have access to the DB Console. However, {{ site.data.products.serverless }} clusters can use [Cluster Single Sign-on (SSO) using `ccloud` and the CockroachDB Cloud Console]({% link cockroachcloud/cloud-sso-sql.md %}). {{site.data.alerts.end}} The page describes how to configure a cluster for cluster single sign-on using JWTs and then how users can authenticate using the JWTs. If you're a user ready to sign in to the DB Console with JWTs, you can skip the configuration section: @@ -119,7 +119,7 @@ You can also view all of your cluster settings in the DB Console. {{ site.data.products.db }} {{ site.data.products.dedicated }} customers: - By default, your cluster's configuration will contain the CockroachDB {{ site.data.products.cloud }}'s own public key, allowing CockroachDB {{ site.data.products.cloud }} to serve as an IdP. This is required for [SSO with `ccloud`](https://www.cockroachlabs.com/docs/cockroachcloud/cloud-sso-sql). When modifying this cluster setting, you must include the CockroachDB {{ site.data.products.cloud }} public key in the key set, or SSO with `ccloud` will no longer work. + By default, your cluster's configuration will contain the CockroachDB {{ site.data.products.cloud }}'s own public key, allowing CockroachDB {{ site.data.products.cloud }} to serve as an IdP. This is required for [SSO with `ccloud`]({% link cockroachcloud/cloud-sso-sql.md %}). When modifying this cluster setting, you must include the CockroachDB {{ site.data.products.cloud }} public key in the key set, or SSO with `ccloud` will no longer work. The public key for {{ site.data.products.db }} can be found at `https://cockroachlabs.cloud/.well-known/openid-configuration`. @@ -229,7 +229,7 @@ Examples: - `https://accounts.google.com 1232316645658094244789 roach` - Maps a single external identity with the hard-coded ID to the [SQL user](https://www.cockroachlabs.com/docs/cockroachcloud/managing-access#manage-sql-users-on-a-cluster) `roach`. + Maps a single external identity with the hard-coded ID to the [SQL user]({% link cockroachcloud/managing-access.md %}#manage-sql-users-on-a-cluster) `roach`. - `https://accounts.google.com /^([9-0]*)$ gcp_\1` diff --git a/src/current/v24.2/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.md b/src/current/v24.2/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.md index cf316e4d542..3b2ba5f8148 100644 --- a/src/current/v24.2/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.md +++ b/src/current/v24.2/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.md @@ -21,7 +21,7 @@ An overview of the workflow involves creating and connecting the following: You will need the following set up before starting this tutorial: -- A CockroachDB cluster. You can use a CockroachDB {{ site.data.products.cloud }} or CockroachDB {{ site.data.products.core }} cluster. If you are using CockroachDB {{ site.data.products.serverless }} or CockroachDB {{ site.data.products.dedicated }}, see the [Quickstart with CockroachDB](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart) guide. For CockroachDB {{ site.data.products.core }} clusters, see the [install]({% link {{ page.version.version }}/install-cockroachdb-mac.md %}) page. +- A CockroachDB cluster. You can use a CockroachDB {{ site.data.products.cloud }} or CockroachDB {{ site.data.products.core }} cluster. If you are using CockroachDB {{ site.data.products.serverless }} or CockroachDB {{ site.data.products.dedicated }}, see the [Quickstart with CockroachDB]({% link cockroachcloud/quickstart.md %}) guide. For CockroachDB {{ site.data.products.core }} clusters, see the [install]({% link {{ page.version.version }}/install-cockroachdb-mac.md %}) page. - A Confluent Cloud account. See Confluent's [Get started](https://www.confluent.io/get-started/) page for details. - The Confluent CLI. See [Install Confluent CLI](https://docs.confluent.io/confluent-cli/current/install.html) to set this up. This tutorial uses v3.3.0 of the Confluent CLI. Note that you can also complete the steps in this tutorial in Confluent's Cloud console. - {% include {{ page.version.version }}/cdc/tutorial-privilege-check.md %} diff --git a/src/current/v24.2/striim.md b/src/current/v24.2/striim.md index ffbba6d55fa..06ba43db452 100644 --- a/src/current/v24.2/striim.md +++ b/src/current/v24.2/striim.md @@ -34,7 +34,7 @@ Complete the following items before using Striim: - Ensure you have a secure, publicly available CockroachDB cluster running the latest **{{ page.version.version }}** [production release](https://www.cockroachlabs.com/docs/releases/{{ page.version.version }}), and have created a [SQL user]({% link {{ page.version.version }}/security-reference/authorization.md %}#sql-users) that you can use to configure your Striim target. - Manually create all schema objects in the target CockroachDB cluster. Although Striim offers a feature called Auto Schema Conversion, we recommend converting and importing your schema before running Striim to ensure that the data populates successfully. - - If you are migrating from PostgreSQL, MySQL, Oracle, or Microsoft SQL Server, [use the **Schema Conversion Tool**](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) to convert and export your schema. Ensure that any schema changes are also reflected on your tables. + - If you are migrating from PostgreSQL, MySQL, Oracle, or Microsoft SQL Server, [use the **Schema Conversion Tool**]({% link cockroachcloud/migrations-page.md %}) to convert and export your schema. Ensure that any schema changes are also reflected on your tables. {{site.data.alerts.callout_info}} 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). @@ -111,6 +111,6 @@ To perform continuous replication of ongoing changes, create a Striim applicatio ## 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 %}) - [Change Data Capture Overview]({% link {{ page.version.version }}/change-data-capture-overview.md %}) - [Third-Party Tools Supported by Cockroach Labs]({% link {{ page.version.version }}/third-party-database-tools.md %}) diff --git a/src/current/v24.2/take-and-restore-locality-aware-backups.md b/src/current/v24.2/take-and-restore-locality-aware-backups.md index 149ae4adfb0..7044d524d60 100644 --- a/src/current/v24.2/take-and-restore-locality-aware-backups.md +++ b/src/current/v24.2/take-and-restore-locality-aware-backups.md @@ -25,7 +25,7 @@ For a technical overview of how a locality-aware backup works, refer to [Job coo ## Supported products -Locality-aware backups are available in **CockroachDB {{ site.data.products.dedicated }}**, **CockroachDB {{ site.data.products.serverless }}**, and **CockroachDB {{ site.data.products.core }}** clusters when you are running [customer-owned backups](https://www.cockroachlabs.com/docs/cockroachcloud/take-and-restore-customer-owned-backups). For a full list of features on CockroachDB Cloud, refer to [Backup and Restore Overview](https://www.cockroachlabs.com/docs/cockroachcloud/backup-and-restore-overview). +Locality-aware backups are available in **CockroachDB {{ site.data.products.dedicated }}**, **CockroachDB {{ site.data.products.serverless }}**, and **CockroachDB {{ site.data.products.core }}** clusters when you are running [customer-owned backups]({% link cockroachcloud/take-and-restore-customer-owned-backups.md %}). For a full list of features on CockroachDB Cloud, refer to [Backup and Restore Overview]({% link cockroachcloud/backup-and-restore-overview.md %}). {{site.data.alerts.callout_info}} {% include {{ page.version.version }}/backups/serverless-locality-aware.md %} diff --git a/src/current/v24.2/troubleshooting-overview.md b/src/current/v24.2/troubleshooting-overview.md index 2573f1c9fe3..9b21e2725f0 100644 --- a/src/current/v24.2/troubleshooting-overview.md +++ b/src/current/v24.2/troubleshooting-overview.md @@ -16,7 +16,7 @@ If you experience an issue when using CockroachDB, try these steps to resolve th - [Troubleshoot Common Problems]({% link {{ page.version.version }}/query-behavior-troubleshooting.md %}) helps you handle errors and troubleshooting problems that may arise during application development. - [Troubleshoot Statement Behavior]({% link {{ page.version.version }}/query-behavior-troubleshooting.md %}) helps you with unexpected query results. -- If you are using Cockroach Cloud, see the errors and solutions in [Troubleshoot CockroachDB Cloud](https://www.cockroachlabs.com/docs/cockroachcloud/troubleshooting-page). +- If you are using Cockroach Cloud, see the errors and solutions in [Troubleshoot CockroachDB Cloud]({% link cockroachcloud/troubleshooting-page.md %}). - If you see discrepancies in metrics, refer to [Differences in Metrics between Third-Party Monitoring Integrations and DB Console]({% link {{ page.version.version }}/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.md %}). diff --git a/src/current/v24.2/ui-overview.md b/src/current/v24.2/ui-overview.md index 5d83e9a805c..1930147952c 100644 --- a/src/current/v24.2/ui-overview.md +++ b/src/current/v24.2/ui-overview.md @@ -11,7 +11,7 @@ The DB Console provides details about your cluster and database configuration, a {{site.data.alerts.callout_info}} Authorized CockroachDB {{ site.data.products.dedicated }} cluster users can visit the DB Console at a URL provisioned for the cluster. -Refer to: [Network Authorization for CockroachDB Cloud Clusters—DB Console](https://www.cockroachlabs.com/docs/cockroachcloud/network-authorization#db-console) +Refer to: [Network Authorization for CockroachDB Cloud Clusters—DB Console]({% link cockroachcloud/network-authorization.md %}#db-console) {{site.data.alerts.end}} ## Authentication diff --git a/src/current/v24.2/update-data.md b/src/current/v24.2/update-data.md index 5c0d256dd29..5db28c352f0 100644 --- a/src/current/v24.2/update-data.md +++ b/src/current/v24.2/update-data.md @@ -15,7 +15,7 @@ This page has instructions for updating existing rows of data in CockroachDB, us Before reading this page, do the following: -- [Create a CockroachDB {{ site.data.products.serverless }} 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.serverless }} 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 %}). - [Create a database schema]({% link {{ page.version.version }}/schema-design-overview.md %}). diff --git a/src/current/v24.2/vault-db-secrets-tutorial.md b/src/current/v24.2/vault-db-secrets-tutorial.md index bb846cfd37e..2f47e18de31 100644 --- a/src/current/v24.2/vault-db-secrets-tutorial.md +++ b/src/current/v24.2/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]({% link {{ page.version.version }}/install-cockroachdb-mac.md %}). - The Vault CLI [installed locally](https://www.vaultproject.io/downloads). -- Access to a CockroachDB cluster as [`admin` SQL user]({% link {{ page.version.version }}/security-reference/authorization.md %}#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](https://www.cockroachlabs.com/docs/cockroachcloud/create-a-serverless-cluster) 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]({% link {{ page.version.version }}/security-reference/authorization.md %}#admin-role). +- Access to a CockroachDB cluster as [`admin` SQL user]({% link {{ page.version.version }}/security-reference/authorization.md %}#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]({% link cockroachcloud/create-a-serverless-cluster.md %}) 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]({% link {{ page.version.version }}/security-reference/authorization.md %}#admin-role). - Access to a Vault cluster with an admin token. This tutorial will use HashiCorp Cloud Platform, but you may either [spin up a free cluster in HashiCorp Cloud Platform](https://learn.hashicorp.com/collections/vault/cloud) or [start a development cluster locally](https://learn.hashicorp.com/tutorials/vault/getting-started-dev-server). ## Introduction