diff --git a/src/current/_includes/v25.2/cockroachdb-operator-recommendation.md b/src/current/_includes/v25.2/cockroachdb-operator-recommendation.md index bfb0d5efb4b..ea4c6c1f7bc 100644 --- a/src/current/_includes/v25.2/cockroachdb-operator-recommendation.md +++ b/src/current/_includes/v25.2/cockroachdb-operator-recommendation.md @@ -1,13 +1,9 @@ {% if page.name == "kubernetes-operator.md" %} -{{ site.data.alerts.callout_success }} -The {{ site.data.products.cockroachdb-operator }} is a fully-featured Kubernetes operator that is designed for ease of deployment and scaling of both single-region and multi-region clusters. To learn more, read the [{{ site.data.products.cockroachdb-operator }} documentation]({% link {{ site.versions["stable"] }}/cockroachdb-operator-overview.md %}). - -Cockroach Labs recommends that new deployments of CockroachDB on Kubernetes use the {{ site.data.products.cockroachdb-operator }}. To migrate an existing deployment to use the {{ site.data.products.cockroachdb-operator }}, read the [Helm]({% link {{ site.versions["stable"] }}/migrate-cockroachdb-kubernetes-helm.md %}) and [{{ site.data.products.public-operator }}]({% link {{ site.versions["stable"] }}/migrate-cockroachdb-kubernetes-operator.md %}) migration guides. +{{ site.data.alerts.callout_danger }} +New deployments of CockroachDB on Kubernetes are recommended to use the newer, fully-featured {{ site.data.products.cockroachdb-operator }} that's easier to deploy and supports scaling of multi-region clusters. To migrate an existing deployment to use the {{ site.data.products.cockroachdb-operator }}, read the [Helm]({% link {{ site.versions["stable"] }}/migrate-cockroachdb-kubernetes-helm.md %}) and [{{ site.data.products.public-operator }}]({% link {{ site.versions["stable"] }}/migrate-cockroachdb-kubernetes-operator.md %}) migration guides. {{ site.data.alerts.end }} {% else %} -{{ site.data.alerts.callout_success }} -The {{ site.data.products.cockroachdb-operator }} is a fully-featured Kubernetes operator that is designed for ease of deployment and scaling of multi-region clusters. To learn more, read the [{{ site.data.products.cockroachdb-operator }} documentation]({% link {{ page.version.version }}/cockroachdb-operator-overview.md %}). - -Cockroach Labs recommends that new deployments of CockroachDB on Kubernetes use the {{ site.data.products.cockroachdb-operator }}. To migrate an existing deployment to use the {{ site.data.products.cockroachdb-operator }}, read the [Helm]({% link {{ page.version.version }}/migrate-cockroachdb-kubernetes-helm.md %}) and [{{ site.data.products.public-operator }}]({% link {{ page.version.version }}/migrate-cockroachdb-kubernetes-operator.md %}) migration guides. +{{ site.data.alerts.callout_danger }} +New deployments of CockroachDB on Kubernetes are recommended to use the newer, fully-featured {{ site.data.products.cockroachdb-operator }} that's easier to deploy and supports scaling of multi-region clusters. To migrate an existing deployment to use the {{ site.data.products.cockroachdb-operator }}, read the [Helm]({% link {{ page.version.version }}/migrate-cockroachdb-kubernetes-helm.md %}) and [{{ site.data.products.public-operator }}]({% link {{ page.version.version }}/migrate-cockroachdb-kubernetes-operator.md %}) migration guides. {{ site.data.alerts.end }} {% endif %} \ No newline at end of file diff --git a/src/current/_includes/v25.2/sidebar-data/self-hosted-deployments.json b/src/current/_includes/v25.2/sidebar-data/self-hosted-deployments.json index 6f152167c08..5d01837c5c8 100644 --- a/src/current/_includes/v25.2/sidebar-data/self-hosted-deployments.json +++ b/src/current/_includes/v25.2/sidebar-data/self-hosted-deployments.json @@ -94,84 +94,7 @@ ] }, { - "title": "Deploy on Kubernetes", - "items": [ - { - "title": "Overview", - "urls": [ - "/${VERSION}/kubernetes-overview.html" - ] - }, - { - "title": "Single-Cluster Deployment", - "urls": [ - "/${VERSION}/deploy-cockroachdb-with-kubernetes.html", - "/${VERSION}/deploy-cockroachdb-with-kubernetes-insecure.html" - ] - }, - { - "title": "OpenShift Deployment", - "urls": [ - "/${VERSION}/deploy-cockroachdb-with-kubernetes-openshift.html" - ] - }, - { - "title": "Multi-Cluster Deployment", - "urls": [ - "/${VERSION}/orchestrate-cockroachdb-with-kubernetes-multi-cluster.html" - ] - }, - { - "title": "Operate on Kubernetes", - "items": [ - { - "title": "Pod Scheduling", - "urls": [ - "/${VERSION}/schedule-cockroachdb-kubernetes.html" - ] - }, - { - "title": "Resource Management", - "urls": [ - "/${VERSION}/configure-cockroachdb-kubernetes.html" - ] - }, - { - "title": "Certificate Management", - "urls": [ - "/${VERSION}/secure-cockroachdb-kubernetes.html" - ] - }, - { - "title": "Cluster Scaling", - "urls": [ - "/${VERSION}/scale-cockroachdb-kubernetes.html" - ] - }, - { - "title": "Cluster Monitoring", - "urls": [ - "/${VERSION}/monitor-cockroachdb-kubernetes.html" - ] - }, - { - "title": "Cluster Upgrades", - "urls": [ - "/${VERSION}/upgrade-cockroachdb-kubernetes.html" - ] - }, - { - "title": "Kubernetes Performance", - "urls": [ - "/${VERSION}/kubernetes-performance.html" - ] - } - ] - } - ] - }, - { - "title": "Deploy in Kubernetes with CockroachDB Operator", + "title": "Deploy in Kubernetes with CockroachDB Operator (Recommended)", "items": [ { "title": "Overview", @@ -257,6 +180,83 @@ } ] }, + { + "title": "Deploy on Kubernetes with Other Technologies", + "items": [ + { + "title": "Overview", + "urls": [ + "/${VERSION}/kubernetes-overview.html" + ] + }, + { + "title": "Single-Cluster Deployment", + "urls": [ + "/${VERSION}/deploy-cockroachdb-with-kubernetes.html", + "/${VERSION}/deploy-cockroachdb-with-kubernetes-insecure.html" + ] + }, + { + "title": "OpenShift Deployment", + "urls": [ + "/${VERSION}/deploy-cockroachdb-with-kubernetes-openshift.html" + ] + }, + { + "title": "Multi-Cluster Deployment", + "urls": [ + "/${VERSION}/orchestrate-cockroachdb-with-kubernetes-multi-cluster.html" + ] + }, + { + "title": "Operate on Kubernetes", + "items": [ + { + "title": "Pod Scheduling", + "urls": [ + "/${VERSION}/schedule-cockroachdb-kubernetes.html" + ] + }, + { + "title": "Resource Management", + "urls": [ + "/${VERSION}/configure-cockroachdb-kubernetes.html" + ] + }, + { + "title": "Certificate Management", + "urls": [ + "/${VERSION}/secure-cockroachdb-kubernetes.html" + ] + }, + { + "title": "Cluster Scaling", + "urls": [ + "/${VERSION}/scale-cockroachdb-kubernetes.html" + ] + }, + { + "title": "Cluster Monitoring", + "urls": [ + "/${VERSION}/monitor-cockroachdb-kubernetes.html" + ] + }, + { + "title": "Cluster Upgrades", + "urls": [ + "/${VERSION}/upgrade-cockroachdb-kubernetes.html" + ] + }, + { + "title": "Kubernetes Performance", + "urls": [ + "/${VERSION}/kubernetes-performance.html" + ] + } + ] + } + ] + }, { "title": "Multi-Region for Self-Hosted Deployments", "items": [ diff --git a/src/current/_includes/v25.3/cockroachdb-operator-recommendation.md b/src/current/_includes/v25.3/cockroachdb-operator-recommendation.md index 1b37c88d6da..ea4c6c1f7bc 100644 --- a/src/current/_includes/v25.3/cockroachdb-operator-recommendation.md +++ b/src/current/_includes/v25.3/cockroachdb-operator-recommendation.md @@ -1,13 +1,9 @@ {% if page.name == "kubernetes-operator.md" %} -{{ site.data.alerts.callout_success }} -The {{ site.data.products.cockroachdb-operator }} is a fully-featured Kubernetes operator that is designed for ease of deployment and scaling of multi-region clusters. To learn more, read the [{{ site.data.products.cockroachdb-operator }} documentation]({% link {{ site.versions["stable"] }}/cockroachdb-operator-overview.md %}). - -New deployments of CockroachDB on Kubernetes are recommended to use the {{ site.data.products.cockroachdb-operator }}. To migrate an existing deployment to use the {{ site.data.products.cockroachdb-operator }}, read the [Helm]({% link {{ site.versions["stable"] }}/migrate-cockroachdb-kubernetes-helm.md %}) and [{{ site.data.products.public-operator }}]({% link {{ site.versions["stable"] }}/migrate-cockroachdb-kubernetes-operator.md %}) migration guides. +{{ site.data.alerts.callout_danger }} +New deployments of CockroachDB on Kubernetes are recommended to use the newer, fully-featured {{ site.data.products.cockroachdb-operator }} that's easier to deploy and supports scaling of multi-region clusters. To migrate an existing deployment to use the {{ site.data.products.cockroachdb-operator }}, read the [Helm]({% link {{ site.versions["stable"] }}/migrate-cockroachdb-kubernetes-helm.md %}) and [{{ site.data.products.public-operator }}]({% link {{ site.versions["stable"] }}/migrate-cockroachdb-kubernetes-operator.md %}) migration guides. {{ site.data.alerts.end }} {% else %} -{{ site.data.alerts.callout_success }} -The {{ site.data.products.cockroachdb-operator }} is a fully-featured Kubernetes operator that is designed for ease of deployment and scaling of multi-region clusters. To learn more, read the [{{ site.data.products.cockroachdb-operator }} documentation]({% link {{ page.version.version }}/cockroachdb-operator-overview.md %}). - -New deployments of CockroachDB on Kubernetes are recommended to use the {{ site.data.products.cockroachdb-operator }}. To migrate an existing deployment to use the {{ site.data.products.cockroachdb-operator }}, read the [Helm]({% link {{ page.version.version }}/migrate-cockroachdb-kubernetes-helm.md %}) and [{{ site.data.products.public-operator }}]({% link {{ page.version.version }}/migrate-cockroachdb-kubernetes-operator.md %}) migration guides. +{{ site.data.alerts.callout_danger }} +New deployments of CockroachDB on Kubernetes are recommended to use the newer, fully-featured {{ site.data.products.cockroachdb-operator }} that's easier to deploy and supports scaling of multi-region clusters. To migrate an existing deployment to use the {{ site.data.products.cockroachdb-operator }}, read the [Helm]({% link {{ page.version.version }}/migrate-cockroachdb-kubernetes-helm.md %}) and [{{ site.data.products.public-operator }}]({% link {{ page.version.version }}/migrate-cockroachdb-kubernetes-operator.md %}) migration guides. {{ site.data.alerts.end }} {% endif %} \ No newline at end of file diff --git a/src/current/_includes/v25.3/sidebar-data/self-hosted-deployments.json b/src/current/_includes/v25.3/sidebar-data/self-hosted-deployments.json index d603be44fc9..c06043f7143 100644 --- a/src/current/_includes/v25.3/sidebar-data/self-hosted-deployments.json +++ b/src/current/_includes/v25.3/sidebar-data/self-hosted-deployments.json @@ -94,84 +94,7 @@ ] }, { - "title": "Deploy on Kubernetes", - "items": [ - { - "title": "Overview", - "urls": [ - "/${VERSION}/kubernetes-overview.html" - ] - }, - { - "title": "Single-Cluster Deployment", - "urls": [ - "/${VERSION}/deploy-cockroachdb-with-kubernetes.html", - "/${VERSION}/deploy-cockroachdb-with-kubernetes-insecure.html" - ] - }, - { - "title": "OpenShift Deployment", - "urls": [ - "/${VERSION}/deploy-cockroachdb-with-kubernetes-openshift.html" - ] - }, - { - "title": "Multi-Cluster Deployment", - "urls": [ - "/${VERSION}/orchestrate-cockroachdb-with-kubernetes-multi-cluster.html" - ] - }, - { - "title": "Operate on Kubernetes", - "items": [ - { - "title": "Pod Scheduling", - "urls": [ - "/${VERSION}/schedule-cockroachdb-kubernetes.html" - ] - }, - { - "title": "Resource Management", - "urls": [ - "/${VERSION}/configure-cockroachdb-kubernetes.html" - ] - }, - { - "title": "Certificate Management", - "urls": [ - "/${VERSION}/secure-cockroachdb-kubernetes.html" - ] - }, - { - "title": "Cluster Scaling", - "urls": [ - "/${VERSION}/scale-cockroachdb-kubernetes.html" - ] - }, - { - "title": "Cluster Monitoring", - "urls": [ - "/${VERSION}/monitor-cockroachdb-kubernetes.html" - ] - }, - { - "title": "Cluster Upgrades", - "urls": [ - "/${VERSION}/upgrade-cockroachdb-kubernetes.html" - ] - }, - { - "title": "Kubernetes Performance", - "urls": [ - "/${VERSION}/kubernetes-performance.html" - ] - } - ] - } - ] - }, - { - "title": "Deploy in Kubernetes with CockroachDB Operator", + "title": "Deploy in Kubernetes with CockroachDB Operator (Recommended)", "items": [ { "title": "Overview", @@ -257,6 +180,83 @@ } ] }, + { + "title": "Deploy on Kubernetes with Other Technologies", + "items": [ + { + "title": "Overview", + "urls": [ + "/${VERSION}/kubernetes-overview.html" + ] + }, + { + "title": "Single-Cluster Deployment", + "urls": [ + "/${VERSION}/deploy-cockroachdb-with-kubernetes.html", + "/${VERSION}/deploy-cockroachdb-with-kubernetes-insecure.html" + ] + }, + { + "title": "OpenShift Deployment", + "urls": [ + "/${VERSION}/deploy-cockroachdb-with-kubernetes-openshift.html" + ] + }, + { + "title": "Multi-Cluster Deployment", + "urls": [ + "/${VERSION}/orchestrate-cockroachdb-with-kubernetes-multi-cluster.html" + ] + }, + { + "title": "Operate on Kubernetes", + "items": [ + { + "title": "Pod Scheduling", + "urls": [ + "/${VERSION}/schedule-cockroachdb-kubernetes.html" + ] + }, + { + "title": "Resource Management", + "urls": [ + "/${VERSION}/configure-cockroachdb-kubernetes.html" + ] + }, + { + "title": "Certificate Management", + "urls": [ + "/${VERSION}/secure-cockroachdb-kubernetes.html" + ] + }, + { + "title": "Cluster Scaling", + "urls": [ + "/${VERSION}/scale-cockroachdb-kubernetes.html" + ] + }, + { + "title": "Cluster Monitoring", + "urls": [ + "/${VERSION}/monitor-cockroachdb-kubernetes.html" + ] + }, + { + "title": "Cluster Upgrades", + "urls": [ + "/${VERSION}/upgrade-cockroachdb-kubernetes.html" + ] + }, + { + "title": "Kubernetes Performance", + "urls": [ + "/${VERSION}/kubernetes-performance.html" + ] + } + ] + } + ] + }, { "title": "Multi-Region for Self-Hosted Deployments", "items": [ diff --git a/src/current/_includes/v25.4/cockroachdb-operator-recommendation.md b/src/current/_includes/v25.4/cockroachdb-operator-recommendation.md index 1b37c88d6da..ea4c6c1f7bc 100644 --- a/src/current/_includes/v25.4/cockroachdb-operator-recommendation.md +++ b/src/current/_includes/v25.4/cockroachdb-operator-recommendation.md @@ -1,13 +1,9 @@ {% if page.name == "kubernetes-operator.md" %} -{{ site.data.alerts.callout_success }} -The {{ site.data.products.cockroachdb-operator }} is a fully-featured Kubernetes operator that is designed for ease of deployment and scaling of multi-region clusters. To learn more, read the [{{ site.data.products.cockroachdb-operator }} documentation]({% link {{ site.versions["stable"] }}/cockroachdb-operator-overview.md %}). - -New deployments of CockroachDB on Kubernetes are recommended to use the {{ site.data.products.cockroachdb-operator }}. To migrate an existing deployment to use the {{ site.data.products.cockroachdb-operator }}, read the [Helm]({% link {{ site.versions["stable"] }}/migrate-cockroachdb-kubernetes-helm.md %}) and [{{ site.data.products.public-operator }}]({% link {{ site.versions["stable"] }}/migrate-cockroachdb-kubernetes-operator.md %}) migration guides. +{{ site.data.alerts.callout_danger }} +New deployments of CockroachDB on Kubernetes are recommended to use the newer, fully-featured {{ site.data.products.cockroachdb-operator }} that's easier to deploy and supports scaling of multi-region clusters. To migrate an existing deployment to use the {{ site.data.products.cockroachdb-operator }}, read the [Helm]({% link {{ site.versions["stable"] }}/migrate-cockroachdb-kubernetes-helm.md %}) and [{{ site.data.products.public-operator }}]({% link {{ site.versions["stable"] }}/migrate-cockroachdb-kubernetes-operator.md %}) migration guides. {{ site.data.alerts.end }} {% else %} -{{ site.data.alerts.callout_success }} -The {{ site.data.products.cockroachdb-operator }} is a fully-featured Kubernetes operator that is designed for ease of deployment and scaling of multi-region clusters. To learn more, read the [{{ site.data.products.cockroachdb-operator }} documentation]({% link {{ page.version.version }}/cockroachdb-operator-overview.md %}). - -New deployments of CockroachDB on Kubernetes are recommended to use the {{ site.data.products.cockroachdb-operator }}. To migrate an existing deployment to use the {{ site.data.products.cockroachdb-operator }}, read the [Helm]({% link {{ page.version.version }}/migrate-cockroachdb-kubernetes-helm.md %}) and [{{ site.data.products.public-operator }}]({% link {{ page.version.version }}/migrate-cockroachdb-kubernetes-operator.md %}) migration guides. +{{ site.data.alerts.callout_danger }} +New deployments of CockroachDB on Kubernetes are recommended to use the newer, fully-featured {{ site.data.products.cockroachdb-operator }} that's easier to deploy and supports scaling of multi-region clusters. To migrate an existing deployment to use the {{ site.data.products.cockroachdb-operator }}, read the [Helm]({% link {{ page.version.version }}/migrate-cockroachdb-kubernetes-helm.md %}) and [{{ site.data.products.public-operator }}]({% link {{ page.version.version }}/migrate-cockroachdb-kubernetes-operator.md %}) migration guides. {{ site.data.alerts.end }} {% endif %} \ No newline at end of file diff --git a/src/current/_includes/v25.4/sidebar-data/self-hosted-deployments.json b/src/current/_includes/v25.4/sidebar-data/self-hosted-deployments.json index bff951ef797..805d608107e 100644 --- a/src/current/_includes/v25.4/sidebar-data/self-hosted-deployments.json +++ b/src/current/_includes/v25.4/sidebar-data/self-hosted-deployments.json @@ -94,84 +94,7 @@ ] }, { - "title": "Deploy on Kubernetes", - "items": [ - { - "title": "Overview", - "urls": [ - "/${VERSION}/kubernetes-overview.html" - ] - }, - { - "title": "Single-Cluster Deployment", - "urls": [ - "/${VERSION}/deploy-cockroachdb-with-kubernetes.html", - "/${VERSION}/deploy-cockroachdb-with-kubernetes-insecure.html" - ] - }, - { - "title": "OpenShift Deployment", - "urls": [ - "/${VERSION}/deploy-cockroachdb-with-kubernetes-openshift.html" - ] - }, - { - "title": "Multi-Cluster Deployment", - "urls": [ - "/${VERSION}/orchestrate-cockroachdb-with-kubernetes-multi-cluster.html" - ] - }, - { - "title": "Operate on Kubernetes", - "items": [ - { - "title": "Pod Scheduling", - "urls": [ - "/${VERSION}/schedule-cockroachdb-kubernetes.html" - ] - }, - { - "title": "Resource Management", - "urls": [ - "/${VERSION}/configure-cockroachdb-kubernetes.html" - ] - }, - { - "title": "Certificate Management", - "urls": [ - "/${VERSION}/secure-cockroachdb-kubernetes.html" - ] - }, - { - "title": "Cluster Scaling", - "urls": [ - "/${VERSION}/scale-cockroachdb-kubernetes.html" - ] - }, - { - "title": "Cluster Monitoring", - "urls": [ - "/${VERSION}/monitor-cockroachdb-kubernetes.html" - ] - }, - { - "title": "Cluster Upgrades", - "urls": [ - "/${VERSION}/upgrade-cockroachdb-kubernetes.html" - ] - }, - { - "title": "Kubernetes Performance", - "urls": [ - "/${VERSION}/kubernetes-performance.html" - ] - } - ] - } - ] - }, - { - "title": "Deploy in Kubernetes with CockroachDB Operator", + "title": "Deploy in Kubernetes with CockroachDB Operator (Recommended)", "items": [ { "title": "Overview", @@ -257,6 +180,83 @@ } ] }, + { + "title": "Deploy on Kubernetes with Other Technologies", + "items": [ + { + "title": "Overview", + "urls": [ + "/${VERSION}/kubernetes-overview.html" + ] + }, + { + "title": "Single-Cluster Deployment", + "urls": [ + "/${VERSION}/deploy-cockroachdb-with-kubernetes.html", + "/${VERSION}/deploy-cockroachdb-with-kubernetes-insecure.html" + ] + }, + { + "title": "OpenShift Deployment", + "urls": [ + "/${VERSION}/deploy-cockroachdb-with-kubernetes-openshift.html" + ] + }, + { + "title": "Multi-Cluster Deployment", + "urls": [ + "/${VERSION}/orchestrate-cockroachdb-with-kubernetes-multi-cluster.html" + ] + }, + { + "title": "Operate on Kubernetes", + "items": [ + { + "title": "Pod Scheduling", + "urls": [ + "/${VERSION}/schedule-cockroachdb-kubernetes.html" + ] + }, + { + "title": "Resource Management", + "urls": [ + "/${VERSION}/configure-cockroachdb-kubernetes.html" + ] + }, + { + "title": "Certificate Management", + "urls": [ + "/${VERSION}/secure-cockroachdb-kubernetes.html" + ] + }, + { + "title": "Cluster Scaling", + "urls": [ + "/${VERSION}/scale-cockroachdb-kubernetes.html" + ] + }, + { + "title": "Cluster Monitoring", + "urls": [ + "/${VERSION}/monitor-cockroachdb-kubernetes.html" + ] + }, + { + "title": "Cluster Upgrades", + "urls": [ + "/${VERSION}/upgrade-cockroachdb-kubernetes.html" + ] + }, + { + "title": "Kubernetes Performance", + "urls": [ + "/${VERSION}/kubernetes-performance.html" + ] + } + ] + } + ] + }, { "title": "Multi-Region for Self-Hosted Deployments", "items": [ diff --git a/src/current/_includes/v26.1/cockroachdb-operator-recommendation.md b/src/current/_includes/v26.1/cockroachdb-operator-recommendation.md index 1b37c88d6da..ea4c6c1f7bc 100644 --- a/src/current/_includes/v26.1/cockroachdb-operator-recommendation.md +++ b/src/current/_includes/v26.1/cockroachdb-operator-recommendation.md @@ -1,13 +1,9 @@ {% if page.name == "kubernetes-operator.md" %} -{{ site.data.alerts.callout_success }} -The {{ site.data.products.cockroachdb-operator }} is a fully-featured Kubernetes operator that is designed for ease of deployment and scaling of multi-region clusters. To learn more, read the [{{ site.data.products.cockroachdb-operator }} documentation]({% link {{ site.versions["stable"] }}/cockroachdb-operator-overview.md %}). - -New deployments of CockroachDB on Kubernetes are recommended to use the {{ site.data.products.cockroachdb-operator }}. To migrate an existing deployment to use the {{ site.data.products.cockroachdb-operator }}, read the [Helm]({% link {{ site.versions["stable"] }}/migrate-cockroachdb-kubernetes-helm.md %}) and [{{ site.data.products.public-operator }}]({% link {{ site.versions["stable"] }}/migrate-cockroachdb-kubernetes-operator.md %}) migration guides. +{{ site.data.alerts.callout_danger }} +New deployments of CockroachDB on Kubernetes are recommended to use the newer, fully-featured {{ site.data.products.cockroachdb-operator }} that's easier to deploy and supports scaling of multi-region clusters. To migrate an existing deployment to use the {{ site.data.products.cockroachdb-operator }}, read the [Helm]({% link {{ site.versions["stable"] }}/migrate-cockroachdb-kubernetes-helm.md %}) and [{{ site.data.products.public-operator }}]({% link {{ site.versions["stable"] }}/migrate-cockroachdb-kubernetes-operator.md %}) migration guides. {{ site.data.alerts.end }} {% else %} -{{ site.data.alerts.callout_success }} -The {{ site.data.products.cockroachdb-operator }} is a fully-featured Kubernetes operator that is designed for ease of deployment and scaling of multi-region clusters. To learn more, read the [{{ site.data.products.cockroachdb-operator }} documentation]({% link {{ page.version.version }}/cockroachdb-operator-overview.md %}). - -New deployments of CockroachDB on Kubernetes are recommended to use the {{ site.data.products.cockroachdb-operator }}. To migrate an existing deployment to use the {{ site.data.products.cockroachdb-operator }}, read the [Helm]({% link {{ page.version.version }}/migrate-cockroachdb-kubernetes-helm.md %}) and [{{ site.data.products.public-operator }}]({% link {{ page.version.version }}/migrate-cockroachdb-kubernetes-operator.md %}) migration guides. +{{ site.data.alerts.callout_danger }} +New deployments of CockroachDB on Kubernetes are recommended to use the newer, fully-featured {{ site.data.products.cockroachdb-operator }} that's easier to deploy and supports scaling of multi-region clusters. To migrate an existing deployment to use the {{ site.data.products.cockroachdb-operator }}, read the [Helm]({% link {{ page.version.version }}/migrate-cockroachdb-kubernetes-helm.md %}) and [{{ site.data.products.public-operator }}]({% link {{ page.version.version }}/migrate-cockroachdb-kubernetes-operator.md %}) migration guides. {{ site.data.alerts.end }} {% endif %} \ No newline at end of file diff --git a/src/current/_includes/v26.1/sidebar-data/self-hosted-deployments.json b/src/current/_includes/v26.1/sidebar-data/self-hosted-deployments.json index bff951ef797..805d608107e 100644 --- a/src/current/_includes/v26.1/sidebar-data/self-hosted-deployments.json +++ b/src/current/_includes/v26.1/sidebar-data/self-hosted-deployments.json @@ -94,84 +94,7 @@ ] }, { - "title": "Deploy on Kubernetes", - "items": [ - { - "title": "Overview", - "urls": [ - "/${VERSION}/kubernetes-overview.html" - ] - }, - { - "title": "Single-Cluster Deployment", - "urls": [ - "/${VERSION}/deploy-cockroachdb-with-kubernetes.html", - "/${VERSION}/deploy-cockroachdb-with-kubernetes-insecure.html" - ] - }, - { - "title": "OpenShift Deployment", - "urls": [ - "/${VERSION}/deploy-cockroachdb-with-kubernetes-openshift.html" - ] - }, - { - "title": "Multi-Cluster Deployment", - "urls": [ - "/${VERSION}/orchestrate-cockroachdb-with-kubernetes-multi-cluster.html" - ] - }, - { - "title": "Operate on Kubernetes", - "items": [ - { - "title": "Pod Scheduling", - "urls": [ - "/${VERSION}/schedule-cockroachdb-kubernetes.html" - ] - }, - { - "title": "Resource Management", - "urls": [ - "/${VERSION}/configure-cockroachdb-kubernetes.html" - ] - }, - { - "title": "Certificate Management", - "urls": [ - "/${VERSION}/secure-cockroachdb-kubernetes.html" - ] - }, - { - "title": "Cluster Scaling", - "urls": [ - "/${VERSION}/scale-cockroachdb-kubernetes.html" - ] - }, - { - "title": "Cluster Monitoring", - "urls": [ - "/${VERSION}/monitor-cockroachdb-kubernetes.html" - ] - }, - { - "title": "Cluster Upgrades", - "urls": [ - "/${VERSION}/upgrade-cockroachdb-kubernetes.html" - ] - }, - { - "title": "Kubernetes Performance", - "urls": [ - "/${VERSION}/kubernetes-performance.html" - ] - } - ] - } - ] - }, - { - "title": "Deploy in Kubernetes with CockroachDB Operator", + "title": "Deploy in Kubernetes with CockroachDB Operator (Recommended)", "items": [ { "title": "Overview", @@ -257,6 +180,83 @@ } ] }, + { + "title": "Deploy on Kubernetes with Other Technologies", + "items": [ + { + "title": "Overview", + "urls": [ + "/${VERSION}/kubernetes-overview.html" + ] + }, + { + "title": "Single-Cluster Deployment", + "urls": [ + "/${VERSION}/deploy-cockroachdb-with-kubernetes.html", + "/${VERSION}/deploy-cockroachdb-with-kubernetes-insecure.html" + ] + }, + { + "title": "OpenShift Deployment", + "urls": [ + "/${VERSION}/deploy-cockroachdb-with-kubernetes-openshift.html" + ] + }, + { + "title": "Multi-Cluster Deployment", + "urls": [ + "/${VERSION}/orchestrate-cockroachdb-with-kubernetes-multi-cluster.html" + ] + }, + { + "title": "Operate on Kubernetes", + "items": [ + { + "title": "Pod Scheduling", + "urls": [ + "/${VERSION}/schedule-cockroachdb-kubernetes.html" + ] + }, + { + "title": "Resource Management", + "urls": [ + "/${VERSION}/configure-cockroachdb-kubernetes.html" + ] + }, + { + "title": "Certificate Management", + "urls": [ + "/${VERSION}/secure-cockroachdb-kubernetes.html" + ] + }, + { + "title": "Cluster Scaling", + "urls": [ + "/${VERSION}/scale-cockroachdb-kubernetes.html" + ] + }, + { + "title": "Cluster Monitoring", + "urls": [ + "/${VERSION}/monitor-cockroachdb-kubernetes.html" + ] + }, + { + "title": "Cluster Upgrades", + "urls": [ + "/${VERSION}/upgrade-cockroachdb-kubernetes.html" + ] + }, + { + "title": "Kubernetes Performance", + "urls": [ + "/${VERSION}/kubernetes-performance.html" + ] + } + ] + } + ] + }, { "title": "Multi-Region for Self-Hosted Deployments", "items": [ diff --git a/src/current/v24.3/deploy-cockroachdb-with-kubernetes-openshift.md b/src/current/v24.3/deploy-cockroachdb-with-kubernetes-openshift.md index d7e6c371842..0e13aaad04f 100644 --- a/src/current/v24.3/deploy-cockroachdb-with-kubernetes-openshift.md +++ b/src/current/v24.3/deploy-cockroachdb-with-kubernetes-openshift.md @@ -6,7 +6,7 @@ secure: true docs_area: --- -This page shows you how to start and stop a secure 3-node CockroachDB cluster on the Red Hat OpenShift platform, using the [CockroachDB Kubernetes Operator](https://marketplace.redhat.com/en-us/products/cockroachdb-operator). +This page shows you how to start and stop a secure 3-node CockroachDB cluster on the Red Hat OpenShift platform, using the [CockroachDB Kubernetes Operator](https://catalog.redhat.com/software/containers/cockroachdb/cockroachdb-operator/5d9cbed3ecb5240ff271264f). ## Before you begin diff --git a/src/current/v25.1/deploy-cockroachdb-with-kubernetes-openshift.md b/src/current/v25.1/deploy-cockroachdb-with-kubernetes-openshift.md index 59a32a9ff78..49e1fab6ca5 100644 --- a/src/current/v25.1/deploy-cockroachdb-with-kubernetes-openshift.md +++ b/src/current/v25.1/deploy-cockroachdb-with-kubernetes-openshift.md @@ -6,7 +6,7 @@ secure: true docs_area: --- -This page shows you how to start and stop a secure 3-node CockroachDB cluster on the Red Hat OpenShift platform, using the [CockroachDB Kubernetes Operator](https://marketplace.redhat.com/en-us/products/cockroachdb-operator). +This page shows you how to start and stop a secure 3-node CockroachDB cluster on the Red Hat OpenShift platform, using the [CockroachDB Kubernetes Operator](https://catalog.redhat.com/software/containers/cockroachdb/cockroachdb-operator/5d9cbed3ecb5240ff271264f). ## Before you begin diff --git a/src/current/v25.2/deploy-cockroachdb-with-cockroachdb-operator.md b/src/current/v25.2/deploy-cockroachdb-with-cockroachdb-operator.md index 44758d974f5..4c6d8428a10 100644 --- a/src/current/v25.2/deploy-cockroachdb-with-cockroachdb-operator.md +++ b/src/current/v25.2/deploy-cockroachdb-with-cockroachdb-operator.md @@ -42,7 +42,7 @@ If you want to secure your cluster to use TLS certificates for all network commu ### Localities -CockroachDB clusters use localities to efficiently distribute replicas. This is especially important in multi-region deployments. With the {{ site.data.products.cockroachdb-operator }}, you specify mappings between locality levels and the location on a Kubernetes node where the value for that locality can be found. +CockroachDB clusters use localities to efficiently distribute replicas. This is especially important for [multi-region deployments](#multi-region-deployments). With the {{ site.data.products.cockroachdb-operator }}, you specify mappings between locality levels and the location on a Kubernetes node where the value for that locality can be found. In cloud provider deployments (e.g., [GKE](#hosted-gke), [EKS](#hosted-eks), or [AKS](#hosted-aks)), the [`topology.kubernetes.io/region`](https://kubernetes.io/docs/reference/labels-annotations-taints/#topologykubernetesioregion) and [`topology.kubernetes.io/zone`](https://kubernetes.io/docs/reference/labels-annotations-taints/#topologykubernetesiozone) values on Kubernetes nodes are populated by cloud provider. For further granularity, you can define arbitrary locality labels (e.g., `province`, `datacenter`, `rack`), but these need to be applied individually to the Kubernetes node when initialized so that CockroachDB can understand where the node lives and distribute replicas accordingly. @@ -62,6 +62,15 @@ When starting Kubernetes, select machines with at least 4 vCPUs and 16 GiB of me Kubernetes deployments use external persistent volumes that are often replicated by the provider. CockroachDB replicates data automatically, and this redundant layer of [replication]({% link {{ page.version.version }}/architecture/overview.md %}#replication) can impact performance. Using [local volumes](https://kubernetes.io/docs/concepts/storage/volumes/#local) may improve performance. +### Multi-region deployments + +The following deployment requirements and best practices apply to multi-region deployments with the {{ site.data.products.cockroachdb-operator }}: + +- Plan an operator deployment in each region. Each operator handles CockroachDB node management in its own region, so you must factor that there are multiple operator deployments into your upgrade and maintenance strategy to ensure availability. +- VPC peering and CoreDNS are needed to resolve services and discovery across regions. Refer to the documentation for your cloud solution to configure your cross-region network accordingly. +- Make sure that region is part of your [locality](#localities) configuration and nodes are tagged consistently with their deployment region. For deployments with a cloud service provider this is handled automatically, but must be applied manually for bare metal deployments. +- A single certificate authority (CA) across all regions is required. One namespace per region is recommended to simplify certificate management. + ## Step 1. Start Kubernetes You can use the hosted [Google Kubernetes Engine (GKE)](#hosted-gke) service, hosted [Amazon Elastic Kubernetes Service (EKS)](#hosted-eks), or [Microsoft Azure Kubernetes Service (AKS)](#hosted-aks) to quickly start Kubernetes. @@ -483,12 +492,9 @@ For bare metal deployments, the specific Kubernetes infrastructure deployment st #### Deploy across multiple regions -The Helm chart supports specifying multiple region definitions in `cockroachdb.crdbCluster.regions` with their respective node counts. You must ensure the required networking is set up to allow for service discovery across regions. Also, ensure that the same CA cert is used across all the regions. +The Helm chart supports specifying multiple region definitions in `cockroachdb.crdbCluster.regions` with their respective node counts. Make sure to review the prerequisites and best practices for a [multi-region deployment](#multi-region-deployments). -For each region, modify the `regions` configuration as described in [Initialize the cluster](#initialize-the-cluster) and perform `helm install` against the respective Kubernetes cluster. While applying the installation in a given region, do the following: - -- Verify that the domain matches `cockroachdb.clusterDomain` in the values file. -- Ensure that `cockroachdb.crdbCluster.regions` captures the information for regions that have already been deployed, including the current region. This allows CockroachDB in the current region to connect to clusters deployed in the existing regions. +For each region, modify the `regions` configuration as described in [Initialize the cluster](#initialize-the-cluster) and perform `helm install` against the respective Kubernetes cluster. The following example shows a configuration across two regions, `us-central1` and `us-east1`, with 3 nodes in each cluster: @@ -509,6 +515,10 @@ cockroachdb: namespace: cockroach-ns ~~~ +While applying the installation in a given region, do the following: +- Verify that the domain matches `cockroachdb.clusterDomain` in the values file. +- Ensure that `cockroachdb.crdbCluster.regions` captures the information for regions that have already been deployed, including the current region. This allows CockroachDB in the current region to connect to clusters deployed in the existing regions. + ## Step 3. Use the built-in SQL client To use the CockroachDB SQL client, follow these steps to launch a secure pod running the `cockroach` binary. diff --git a/src/current/v25.2/deploy-cockroachdb-with-kubernetes-openshift.md b/src/current/v25.2/deploy-cockroachdb-with-kubernetes-openshift.md index 50ba14aac86..dc5120c6342 100644 --- a/src/current/v25.2/deploy-cockroachdb-with-kubernetes-openshift.md +++ b/src/current/v25.2/deploy-cockroachdb-with-kubernetes-openshift.md @@ -6,7 +6,7 @@ secure: true docs_area: --- -This page shows you how to start and stop a secure 3-node CockroachDB cluster on the Red Hat OpenShift platform, using the [{{ site.data.products.public-operator }}](https://marketplace.redhat.com/en-us/products/cockroachdb-operator). +This page shows you how to start and stop a secure 3-node CockroachDB cluster on the Red Hat OpenShift platform, using the [{{ site.data.products.public-operator }}](https://catalog.redhat.com/software/containers/cockroachdb/cockroachdb-operator/5d9cbed3ecb5240ff271264f). {% include {{ page.version.version }}/cockroachdb-operator-recommendation.md %} diff --git a/src/current/v25.3/deploy-cockroachdb-with-cockroachdb-operator.md b/src/current/v25.3/deploy-cockroachdb-with-cockroachdb-operator.md index a90fb7fb5a1..cbf9e553240 100644 --- a/src/current/v25.3/deploy-cockroachdb-with-cockroachdb-operator.md +++ b/src/current/v25.3/deploy-cockroachdb-with-cockroachdb-operator.md @@ -42,7 +42,7 @@ If you want to secure your cluster to use TLS certificates for all network commu ### Localities -CockroachDB clusters use localities to efficiently distribute replicas. This is especially important in multi-region deployments. With the {{ site.data.products.cockroachdb-operator }}, you specify mappings between locality levels and the location on a Kubernetes node where the value for that locality can be found. +CockroachDB clusters use localities to efficiently distribute replicas. This is especially important for [multi-region deployments](#multi-region-deployments). With the {{ site.data.products.cockroachdb-operator }}, you specify mappings between locality levels and the location on a Kubernetes node where the value for that locality can be found. In cloud provider deployments (e.g., [GKE](#hosted-gke), [EKS](#hosted-eks), or [AKS](#hosted-aks)), the [`topology.kubernetes.io/region`](https://kubernetes.io/docs/reference/labels-annotations-taints/#topologykubernetesioregion) and [`topology.kubernetes.io/zone`](https://kubernetes.io/docs/reference/labels-annotations-taints/#topologykubernetesiozone) values on Kubernetes nodes are populated by cloud provider. For further granularity, you can define arbitrary locality labels (e.g., `province`, `datacenter`, `rack`), but these need to be applied individually to the Kubernetes node when initialized so that CockroachDB can understand where the node lives and distribute replicas accordingly. @@ -62,6 +62,15 @@ When starting Kubernetes, select machines with at least 4 vCPUs and 16 GiB of me Kubernetes deployments use external persistent volumes that are often replicated by the provider. CockroachDB replicates data automatically, and this redundant layer of [replication]({% link {{ page.version.version }}/architecture/overview.md %}#replication) can impact performance. Using [local volumes](https://kubernetes.io/docs/concepts/storage/volumes/#local) may improve performance. +### Multi-region deployments + +The following deployment requirements and best practices apply to multi-region deployments with the {{ site.data.products.cockroachdb-operator }}: + +- Plan an operator deployment in each region. Each operator handles CockroachDB node management in its own region, so you must factor that there are multiple operator deployments into your upgrade and maintenance strategy to ensure availability. +- VPC peering and CoreDNS are needed to resolve services and discovery across regions. Refer to the documentation for your cloud solution to configure your cross-region network accordingly. +- Make sure that region is part of your [locality](#localities) configuration and nodes are tagged consistently with their deployment region. For deployments with a cloud service provider this is handled automatically, but must be applied manually for bare metal deployments. +- A single certificate authority (CA) across all regions is required. One namespace per region is recommended to simplify certificate management. + ## Step 1. Start Kubernetes You can use the hosted [Google Kubernetes Engine (GKE)](#hosted-gke) service, hosted [Amazon Elastic Kubernetes Service (EKS)](#hosted-eks), or [Microsoft Azure Kubernetes Service (AKS)](#hosted-aks) to quickly start Kubernetes. @@ -497,12 +506,9 @@ For bare metal deployments, the specific Kubernetes infrastructure deployment st #### Deploy across multiple regions -The Helm chart supports specifying multiple region definitions in `cockroachdb.crdbCluster.regions` with their respective node counts. You must ensure the required networking is set up to allow for service discovery across regions. Also, ensure that the same CA cert is used across all the regions. +The Helm chart supports specifying multiple region definitions in `cockroachdb.crdbCluster.regions` with their respective node counts. Make sure to review the prerequisites and best practices for a [multi-region deployment](#multi-region-deployments). -For each region, modify the `regions` configuration as described in [Initialize the cluster](#initialize-the-cluster) and perform `helm install` against the respective Kubernetes cluster. While applying the installation in a given region, do the following: - -- Verify that the domain matches `cockroachdb.clusterDomain` in the values file. -- Ensure that `cockroachdb.crdbCluster.regions` captures the information for regions that have already been deployed, including the current region. This allows CockroachDB in the current region to connect to clusters deployed in the existing regions. +For each region, modify the `regions` configuration as described in [Initialize the cluster](#initialize-the-cluster) and perform `helm install` against the respective Kubernetes cluster. The following example shows a configuration across two regions, `us-central1` and `us-east1`, with 3 nodes in each cluster: @@ -523,6 +529,10 @@ cockroachdb: namespace: cockroach-ns ~~~ +While applying the installation in a given region, do the following: +- Verify that the domain matches `cockroachdb.clusterDomain` in the values file. +- Ensure that `cockroachdb.crdbCluster.regions` captures the information for regions that have already been deployed, including the current region. This allows CockroachDB in the current region to connect to clusters deployed in the existing regions. + ## Step 3. Use the built-in SQL client To use the CockroachDB SQL client, follow these steps to launch a secure pod running the `cockroach` binary. diff --git a/src/current/v25.3/deploy-cockroachdb-with-kubernetes-openshift.md b/src/current/v25.3/deploy-cockroachdb-with-kubernetes-openshift.md index 2ae415693dc..0ea67eb1c8d 100644 --- a/src/current/v25.3/deploy-cockroachdb-with-kubernetes-openshift.md +++ b/src/current/v25.3/deploy-cockroachdb-with-kubernetes-openshift.md @@ -6,7 +6,7 @@ secure: true docs_area: --- -This page shows you how to start and stop a secure 3-node CockroachDB cluster on the Red Hat OpenShift platform, using the [{{ site.data.products.public-operator }}](https://marketplace.redhat.com/en-us/products/cockroachdb-operator). +This page shows you how to start and stop a secure 3-node CockroachDB cluster on the Red Hat OpenShift platform, using the [{{ site.data.products.public-operator }}](https://catalog.redhat.com/software/containers/cockroachdb/cockroachdb-operator/5d9cbed3ecb5240ff271264f). {% include {{ page.version.version }}/cockroachdb-operator-recommendation.md %} diff --git a/src/current/v25.4/deploy-cockroachdb-with-cockroachdb-operator.md b/src/current/v25.4/deploy-cockroachdb-with-cockroachdb-operator.md index c946f0a294e..37684bb63ec 100644 --- a/src/current/v25.4/deploy-cockroachdb-with-cockroachdb-operator.md +++ b/src/current/v25.4/deploy-cockroachdb-with-cockroachdb-operator.md @@ -42,7 +42,7 @@ If you want to secure your cluster to use TLS certificates for all network commu ### Localities -CockroachDB clusters use localities to efficiently distribute replicas. This is especially important in multi-region deployments. With the {{ site.data.products.cockroachdb-operator }}, you specify mappings between locality levels and the location on a Kubernetes node where the value for that locality can be found. +CockroachDB clusters use localities to efficiently distribute replicas. This is especially important for [multi-region deployments](#multi-region-deployments). With the {{ site.data.products.cockroachdb-operator }}, you specify mappings between locality levels and the location on a Kubernetes node where the value for that locality can be found. In cloud provider deployments (e.g., [GKE](#hosted-gke), [EKS](#hosted-eks), or [AKS](#hosted-aks)), the [`topology.kubernetes.io/region`](https://kubernetes.io/docs/reference/labels-annotations-taints/#topologykubernetesioregion) and [`topology.kubernetes.io/zone`](https://kubernetes.io/docs/reference/labels-annotations-taints/#topologykubernetesiozone) values on Kubernetes nodes are populated by cloud provider. For further granularity, you can define arbitrary locality labels (e.g., `province`, `datacenter`, `rack`), but these need to be applied individually to the Kubernetes node when initialized so that CockroachDB can understand where the node lives and distribute replicas accordingly. @@ -62,6 +62,15 @@ When starting Kubernetes, select machines with at least 4 vCPUs and 16 GiB of me Kubernetes deployments use external persistent volumes that are often replicated by the provider. CockroachDB replicates data automatically, and this redundant layer of [replication]({% link {{ page.version.version }}/architecture/overview.md %}#replication) can impact performance. Using [local volumes](https://kubernetes.io/docs/concepts/storage/volumes/#local) may improve performance. +### Multi-region deployments + +The following deployment requirements and best practices apply to multi-region deployments with the {{ site.data.products.cockroachdb-operator }}: + +- Plan an operator deployment in each region. Each operator handles CockroachDB node management in its own region, so you must factor that there are multiple operator deployments into your upgrade and maintenance strategy to ensure availability. +- VPC peering and CoreDNS are needed to resolve services and discovery across regions. Refer to the documentation for your cloud solution to configure your cross-region network accordingly. +- Make sure that region is part of your [locality](#localities) configuration and nodes are tagged consistently with their deployment region. For deployments with a cloud service provider this is handled automatically, but must be applied manually for bare metal deployments. +- A single certificate authority (CA) across all regions is required. One namespace per region is recommended to simplify certificate management. + ## Step 1. Start Kubernetes You can use the hosted [Google Kubernetes Engine (GKE)](#hosted-gke) service, hosted [Amazon Elastic Kubernetes Service (EKS)](#hosted-eks), or [Microsoft Azure Kubernetes Service (AKS)](#hosted-aks) to quickly start Kubernetes. @@ -364,12 +373,9 @@ For bare metal deployments, the specific Kubernetes infrastructure deployment st #### Deploy across multiple regions -The Helm chart supports specifying multiple region definitions in `cockroachdb.crdbCluster.regions` with their respective node counts. You must ensure the required networking is set up to allow for service discovery across regions. Also, ensure that the same CA cert is used across all the regions. +The Helm chart supports specifying multiple region definitions in `cockroachdb.crdbCluster.regions` with their respective node counts. Make sure to review the prerequisites and best practices for a [multi-region deployment](#multi-region-deployments). -For each region, modify the `regions` configuration as described in [Initialize the cluster](#initialize-the-cluster) and perform `helm install` against the respective Kubernetes cluster. While applying the installation in a given region, do the following: - -- Verify that the domain matches `cockroachdb.clusterDomain` in the values file. -- Ensure that `cockroachdb.crdbCluster.regions` captures the information for regions that have already been deployed, including the current region. This allows CockroachDB in the current region to connect to clusters deployed in the existing regions. +For each region, modify the `regions` configuration as described in [Initialize the cluster](#initialize-the-cluster) and perform `helm install` against the respective Kubernetes cluster. The following example shows a configuration across two regions, `us-central1` and `us-east1`, with 3 nodes in each cluster: @@ -390,6 +396,10 @@ cockroachdb: namespace: cockroach-ns ~~~ +While applying the installation in a given region, do the following: +- Verify that the domain matches `cockroachdb.clusterDomain` in the values file. +- Ensure that `cockroachdb.crdbCluster.regions` captures the information for regions that have already been deployed, including the current region. This allows CockroachDB in the current region to connect to clusters deployed in the existing regions. + ## Step 3. Use the built-in SQL client To use the CockroachDB SQL client, follow these steps to launch a secure pod running the `cockroach` binary. diff --git a/src/current/v25.4/deploy-cockroachdb-with-kubernetes-openshift.md b/src/current/v25.4/deploy-cockroachdb-with-kubernetes-openshift.md index 62839a38838..2f88e50b23d 100644 --- a/src/current/v25.4/deploy-cockroachdb-with-kubernetes-openshift.md +++ b/src/current/v25.4/deploy-cockroachdb-with-kubernetes-openshift.md @@ -6,7 +6,7 @@ secure: true docs_area: --- -This page shows you how to start and stop a secure 3-node CockroachDB cluster on the Red Hat OpenShift platform, using the [{{ site.data.products.public-operator }}](https://marketplace.redhat.com/en-us/products/cockroachdb-operator). +This page shows you how to start and stop a secure 3-node CockroachDB cluster on the Red Hat OpenShift platform, using the [{{ site.data.products.public-operator }}](https://catalog.redhat.com/software/containers/cockroachdb/cockroachdb-operator/5d9cbed3ecb5240ff271264f). {% include {{ page.version.version }}/cockroachdb-operator-recommendation.md %} diff --git a/src/current/v26.1/deploy-cockroachdb-with-cockroachdb-operator.md b/src/current/v26.1/deploy-cockroachdb-with-cockroachdb-operator.md index c946f0a294e..2d54ac178b0 100644 --- a/src/current/v26.1/deploy-cockroachdb-with-cockroachdb-operator.md +++ b/src/current/v26.1/deploy-cockroachdb-with-cockroachdb-operator.md @@ -42,7 +42,7 @@ If you want to secure your cluster to use TLS certificates for all network commu ### Localities -CockroachDB clusters use localities to efficiently distribute replicas. This is especially important in multi-region deployments. With the {{ site.data.products.cockroachdb-operator }}, you specify mappings between locality levels and the location on a Kubernetes node where the value for that locality can be found. +CockroachDB clusters use localities to efficiently distribute replicas. This is especially important for [multi-region deployments](#multi-region-deployments). With the {{ site.data.products.cockroachdb-operator }}, you specify mappings between locality levels and the location on a Kubernetes node where the value for that locality can be found. In cloud provider deployments (e.g., [GKE](#hosted-gke), [EKS](#hosted-eks), or [AKS](#hosted-aks)), the [`topology.kubernetes.io/region`](https://kubernetes.io/docs/reference/labels-annotations-taints/#topologykubernetesioregion) and [`topology.kubernetes.io/zone`](https://kubernetes.io/docs/reference/labels-annotations-taints/#topologykubernetesiozone) values on Kubernetes nodes are populated by cloud provider. For further granularity, you can define arbitrary locality labels (e.g., `province`, `datacenter`, `rack`), but these need to be applied individually to the Kubernetes node when initialized so that CockroachDB can understand where the node lives and distribute replicas accordingly. @@ -62,6 +62,15 @@ When starting Kubernetes, select machines with at least 4 vCPUs and 16 GiB of me Kubernetes deployments use external persistent volumes that are often replicated by the provider. CockroachDB replicates data automatically, and this redundant layer of [replication]({% link {{ page.version.version }}/architecture/overview.md %}#replication) can impact performance. Using [local volumes](https://kubernetes.io/docs/concepts/storage/volumes/#local) may improve performance. +### Multi-region deployments + +The following deployment requirements and best practices apply to multi-region deployments with the {{ site.data.products.cockroachdb-operator }}: + +- Plan an operator deployment in each region. Each operator handles CockroachDB node management in its own region, so you must factor that there are multiple operator deployments into your upgrade and maintenance strategy to ensure availability. +- VPC peering and CoreDNS are needed to resolve services and discovery across regions. Refer to the documentation for your cloud solution to configure your cross-region network accordingly. +- Make sure that region is part of your [locality](#localities) configuration and nodes are tagged consistently with their deployment region. For deployments with a cloud service provider this is handled automatically, but must be applied manually for bare metal deployments. +- A single certificate authority (CA) across all regions is required. One namespace per region is recommended to simplify certificate management. + ## Step 1. Start Kubernetes You can use the hosted [Google Kubernetes Engine (GKE)](#hosted-gke) service, hosted [Amazon Elastic Kubernetes Service (EKS)](#hosted-eks), or [Microsoft Azure Kubernetes Service (AKS)](#hosted-aks) to quickly start Kubernetes. @@ -364,12 +373,9 @@ For bare metal deployments, the specific Kubernetes infrastructure deployment st #### Deploy across multiple regions -The Helm chart supports specifying multiple region definitions in `cockroachdb.crdbCluster.regions` with their respective node counts. You must ensure the required networking is set up to allow for service discovery across regions. Also, ensure that the same CA cert is used across all the regions. +The Helm chart supports specifying multiple region definitions in `cockroachdb.crdbCluster.regions` with their respective node counts. Make sure to review the prerequisites and best practices for a [multi-region deployment](#multi-region-deployments). -For each region, modify the `regions` configuration as described in [Initialize the cluster](#initialize-the-cluster) and perform `helm install` against the respective Kubernetes cluster. While applying the installation in a given region, do the following: - -- Verify that the domain matches `cockroachdb.clusterDomain` in the values file. -- Ensure that `cockroachdb.crdbCluster.regions` captures the information for regions that have already been deployed, including the current region. This allows CockroachDB in the current region to connect to clusters deployed in the existing regions. +For each region, modify the `regions` configuration as described in [Initialize the cluster](#initialize-the-cluster) and perform `helm install` against the respective Kubernetes cluster. The following example shows a configuration across two regions, `us-central1` and `us-east1`, with 3 nodes in each cluster: @@ -390,6 +396,11 @@ cockroachdb: namespace: cockroach-ns ~~~ +While applying the installation in a given region, do the following: + +- Verify that the domain matches `cockroachdb.clusterDomain` in the values file. +- Ensure that `cockroachdb.crdbCluster.regions` captures the information for regions that have already been deployed, including the current region. This allows CockroachDB in the current region to connect to clusters deployed in the existing regions. + ## Step 3. Use the built-in SQL client To use the CockroachDB SQL client, follow these steps to launch a secure pod running the `cockroach` binary. diff --git a/src/current/v26.1/deploy-cockroachdb-with-kubernetes-openshift.md b/src/current/v26.1/deploy-cockroachdb-with-kubernetes-openshift.md index 5308531be3c..163b9c15d3e 100644 --- a/src/current/v26.1/deploy-cockroachdb-with-kubernetes-openshift.md +++ b/src/current/v26.1/deploy-cockroachdb-with-kubernetes-openshift.md @@ -6,7 +6,7 @@ secure: true docs_area: --- -This page shows you how to start and stop a secure 3-node CockroachDB cluster on the Red Hat OpenShift platform, using the [{{ site.data.products.public-operator }}](https://marketplace.redhat.com/en-us/products/cockroachdb-operator). +This page shows you how to start and stop a secure 3-node CockroachDB cluster on the Red Hat OpenShift platform, using the [{{ site.data.products.public-operator }}](https://catalog.redhat.com/software/containers/cockroachdb/cockroachdb-operator/5d9cbed3ecb5240ff271264f). {% include {{ page.version.version }}/cockroachdb-operator-recommendation.md %}