Skip to content

CRDB Operator docs improvements #22037

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jhlodin merged 5 commits into from
Jan 16, 2026
Merged

CRDB Operator docs improvements #22037

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b486181
Clarify multi-region deployment recommendations
jhlodin Jan 6, 2026
3bb03d9
Fix broken Red Hat marketplace link
jhlodin Jan 6, 2026
b980531
Clarify recommended kubernetes deployment docs
jhlodin Jan 6, 2026
6ace585
Eng review comments
jhlodin Jan 13, 2026
1f494b6
Backport to supported docs versions
jhlodin Jan 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 4 additions & 8 deletions src/current/_includes/v25.2/cockroachdb-operator-recommendation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 %}
156 changes: 78 additions & 78 deletions src/current/_includes/v25.2/sidebar-data/self-hosted-deployments.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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": [
Expand Down
12 changes: 4 additions & 8 deletions src/current/_includes/v25.3/cockroachdb-operator-recommendation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 %}
156 changes: 78 additions & 78 deletions src/current/_includes/v25.3/sidebar-data/self-hosted-deployments.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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": [
Expand Down
Loading
Loading