Skip to content

Commit 225b60d

Browse files
committed
Add cross-references to new operator content
1 parent 74020df commit 225b60d

12 files changed

+59
-14
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{{site.data.alerts.callout_success}}
2+
The 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 [CockroachDB operator documentation]({% link {{page.version.version}}/kubernetes-operator-overview.md %}).
3+
4+
New deployments of CockroachDB on Kubernetes are recommended to use the CockroachDB operator. To migrate an existing deployment to use the CockroachDB operator, read the [Helm]({% link {{page.version.version}}/migrate-cockroachdb-kubernetes-helm.md %}) and [public operator]({% link {{page.version.version}}/migrate-cockroachdb-kubernetes-operator.md %}) migration guides.
5+
{{site.data.alerts.end}}

src/current/v25.2/configure-cockroachdb-kubernetes.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,17 @@ docs_area: deploy
99

1010
{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %}
1111

12-
This page explains how to configure Kubernetes cluster resources such as memory, CPU, and storage.
12+
This page explains how to configure Kubernetes cluster resources such as memory, CPU, and storage.
13+
14+
This page is for Kubernetes deployments that are not using the CockroachDB operator. For guidance specific to the CockroachDB operator, read [Resource management with the CockroachDB operator]({% link {{ page.version.version }}/configure-cockroachdb-kubernetes-operator.md %}).
15+
16+
{% include {{ page.version.version }}/cockroachdb-operator-recommendation.md %}
1317

1418
These settings override the defaults used when [deploying CockroachDB on Kubernetes]({% link {{ page.version.version }}/deploy-cockroachdb-with-kubernetes.md %}).
1519

1620
<div class="filters filters-big clearfix">
17-
<button class="filter-button" data-scope="operator">Operator</button>
18-
<button class="filter-button" data-scope="manual">Manual Configs</button>
21+
<button class="filter-button" data-scope="operator">Public operator</button>
22+
<button class="filter-button" data-scope="manual">Manual configs</button>
1923
<button class="filter-button" data-scope="helm">Helm</button>
2024
</div>
2125

src/current/v25.2/deploy-cockroachdb-with-kubernetes-openshift.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ docs_area:
88

99
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).
1010

11+
{% include {{ page.version.version }}/cockroachdb-operator-recommendation.md %}
12+
1113
## Before you begin
1214

1315
You must have the following set up before proceeding with this tutorial:

src/current/v25.2/deploy-cockroachdb-with-kubernetes.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,11 @@ docs_area:
99

1010
{% include {{ page.version.version }}/filter-tabs/crdb-single-kubernetes.md %}
1111

12-
This page shows you how to start and stop a secure 3-node CockroachDB cluster in a single [Kubernetes](http://kubernetes.io/) cluster. You can use any of the following approaches:
12+
{% include {{ page.version.version }}/cockroachdb-operator-recommendation.md %}
1313

14-
- [Public Kubernetes operator](https://github.com/cockroachdb/cockroach-operator)
14+
This page shows you how to start and stop a secure 3-node CockroachDB cluster in a single [Kubernetes](http://kubernetes.io/) cluster using the following approaches:
15+
16+
- [Public operator](https://github.com/cockroachdb/cockroach-operator)
1517

1618
{{site.data.alerts.callout_info}}
1719
The CockroachDB Kubernetes Operator is also available on platforms such as [Red Hat OpenShift]({% link {{ page.version.version }}/deploy-cockroachdb-with-kubernetes-openshift.md %}) and [IBM Cloud Pak for Data](https://www.ibm.com/products/cloud-pak-for-data).

src/current/v25.2/kubernetes-overview.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,14 @@ key: operate-cockroachdb-kubernetes.html
1010

1111
Kubernetes is a portable, extensible, open source platform for managing containerized workloads and services. For a given workload, you provide Kubernetes with a configuration, and Kubernetes applies that configuration to all Kubernetes nodes that are running the application.
1212

13-
CockroachDB can be deployed and managed on Kubernetes using the following methods:
13+
{% include {{ page.version.version }}/cockroachdb-operator-recommendation.md %}
1414

15-
- [CockroachDB Kubernetes Operator](https://github.com/cockroachdb/cockroach-operator)
15+
You can also deploy CockroachDB on Kubernetes using the following methods:
16+
17+
- [Public operator](https://github.com/cockroachdb/cockroach-operator)
1618

1719
{{site.data.alerts.callout_info}}
18-
The CockroachDB Kubernetes Operator is also available on platforms such as [Red Hat OpenShift]({% link {{ page.version.version }}/deploy-cockroachdb-with-kubernetes-openshift.md %}) and [IBM Cloud Pak for Data](https://www.ibm.com/products/cloud-pak-for-data).
20+
The public operator is also available on platforms such as [Red Hat OpenShift]({% link {{ page.version.version }}/deploy-cockroachdb-with-kubernetes-openshift.md %}) and [IBM Cloud Pak for Data](https://www.ibm.com/products/cloud-pak-for-data).
1921
{{site.data.alerts.end}}
2022

2123
- Manual [StatefulSet](http://kubernetes.io/docs/concepts/abstractions/controllers/statefulsets/) configuration

src/current/v25.2/kubernetes-performance.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ docs_area: deploy
77

88
Kubernetes provides many useful abstractions for deploying and operating distributed systems, but some of the abstractions come with a performance overhead and an increase in underlying system complexity. This page explains potential bottlenecks to be aware of when [running CockroachDB in Kubernetes]({% link {{ page.version.version }}/kubernetes-overview.md %}) and shows you how to optimize your deployment for better performance.
99

10+
This page is for Kubernetes deployments that are not using the CockroachDB operator. For guidance specific to the CockroachDB operator, read [CockroachDB Performance on Kubernetes with the CockroachDB Operator]({% link {{ page.version.version }}/kubernetes-operator-performance.md %}).
11+
12+
{% include {{ page.version.version }}/cockroachdb-operator-recommendation.md %}
13+
1014
<div id="toc"></div>
1115

1216
## Before you begin

src/current/v25.2/monitor-cockroachdb-kubernetes.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ This article assumes you have already [deployed CockroachDB on a single Kubernet
1212

1313
Despite CockroachDB's various [built-in safeguards against failure]({% link {{ page.version.version }}/architecture/replication-layer.md %}), 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.
1414

15+
This page is for Kubernetes deployments that are not using the CockroachDB operator. For guidance specific to the CockroachDB operator, read [Cluster Monitoring with the CockroachDB Operator]({% link {{ page.version.version }}/monitor-cockroachdb-kubernetes-operator.md %}).
16+
17+
{% include {{ page.version.version }}/cockroachdb-operator-recommendation.md %}
18+
1519
<div class="filters filters-big clearfix">
1620
<button class="filter-button" data-scope="operator">Use Operator</button>
1721
<button class="filter-button" data-scope="manual">Use Configs</button>

src/current/v25.2/orchestrate-cockroachdb-with-kubernetes-multi-cluster.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ docs_area: deploy
1515

1616
This page shows you how to orchestrate a secure CockroachDB deployment across three [Kubernetes](http://kubernetes.io/) clusters, each in a different geographic region, using [StatefulSets](http://kubernetes.io/docs/concepts/abstractions/controllers/statefulsets/) to manage the containers within each cluster and linking them together via DNS. This will result in a single, multi-region CockroachDB cluster running on Kubernetes.
1717

18-
{{site.data.alerts.callout_success}}
18+
{% include {{ page.version.version }}/cockroachdb-operator-recommendation.md %}
19+
1920
To deploy CockroachDB in a single Kubernetes cluster instead, see [Kubernetes Single-Cluster Deployment]({% link {{ page.version.version }}/deploy-cockroachdb-with-kubernetes.md %}). Also, for details about potential performance bottlenecks to be aware of when running CockroachDB in Kubernetes and guidance on how to optimize your deployment for better performance, see [CockroachDB Performance on Kubernetes]({% link {{ page.version.version }}/kubernetes-performance.md %}).
20-
{{site.data.alerts.end}}
2121

2222
## Before you begin
2323

src/current/v25.2/scale-cockroachdb-kubernetes.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,12 @@ This article assumes you have already [deployed CockroachDB on a single Kubernet
1313

1414
This page explains how to add and remove CockroachDB nodes on Kubernetes.
1515

16+
This page is for Kubernetes deployments that are not using the CockroachDB operator. For guidance specific to the CockroachDB operator, read [Cluster Scaling with the CockroachDB Operator]({% link {{ page.version.version }}/scale-cockroachdb-kubernetes-operator.md %}).
17+
18+
{% include {{ page.version.version }}/cockroachdb-operator-recommendation.md %}
19+
1620
<div class="filters filters-big clearfix">
17-
<button class="filter-button" data-scope="operator">Operator</button>
21+
<button class="filter-button" data-scope="operator">Public operator</button>
1822
<button class="filter-button" data-scope="manual">Manual Configs</button>
1923
<button class="filter-button" data-scope="helm">Helm</button>
2024
</div>

src/current/v25.2/schedule-cockroachdb-kubernetes.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,25 @@ secure: true
77
docs_area: deploy
88
---
99

10-
This page describes how to configure the following, using the [Operator](https://github.com/cockroachdb/cockroach-operator):
10+
This page describes how to configure the following, using the [public operator](https://github.com/cockroachdb/cockroach-operator):
1111

12+
- [Enable feature gates](#enable-feature-gates)
1213
- [Node selectors](#node-selectors)
13-
- [Node affinities](#add-a-node-affinity)
14-
- [Pod affinities and anti-affinities](#add-a-pod-affinity-or-anti-affinity)
14+
- [Affinities and anti-affinities](#affinities-and-anti-affinities)
15+
- [Add a node affinity](#add-a-node-affinity)
16+
- [Add a pod affinity or anti-affinity](#add-a-pod-affinity-or-anti-affinity)
17+
- [Example: Scheduling CockroachDB onto labeled nodes](#example-scheduling-cockroachdb-onto-labeled-nodes)
1518
- [Taints and tolerations](#taints-and-tolerations)
19+
- [Add a toleration](#add-a-toleration)
20+
- [Example: Evicting CockroachDB from a running worker node](#example-evicting-cockroachdb-from-a-running-worker-node)
1621
- [Topology spread constraints](#topology-spread-constraints)
22+
- [Add a topology spread constraint](#add-a-topology-spread-constraint)
1723
- [Resource labels and annotations](#resource-labels-and-annotations)
1824

25+
This page is for Kubernetes deployments that are not using the CockroachDB operator. For guidance specific to the CockroachDB operator, read [Pod Scheduling with the CockroachDB Operator]({% link {{ page.version.version }}/schedule-cockroachdb-kubernetes-operator.md %}).
26+
27+
{% include {{ page.version.version }}/cockroachdb-operator-recommendation.md %}
28+
1929
These settings control how CockroachDB pods can be identified or scheduled onto worker nodes.
2030

2131
{% include {{ page.version.version }}/orchestration/operator-check-namespace.md %}

0 commit comments

Comments
 (0)