Skip to content

Commit 6e2d630

Browse files
committed
Make operator naming consistent and tokenized
1 parent 0a34ca4 commit 6e2d630

File tree

44 files changed

+240
-207
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+240
-207
lines changed

src/current/_data/products.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,7 @@ basic: Basic
1515
standard: Standard
1616

1717
advanced: Advanced
18+
19+
public-operator: Public operator
20+
21+
cockroachdb-operator: CockroachDB operator

src/current/_includes/sidebar-all-releases.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@
6363
]
6464
},
6565
{
66-
"title": "Kubernetes Operator",
66+
"title": "Public Kubernetes Operator",
6767
"urls": [
6868
"/releases/kubernetes-operator.html"
6969
]

src/current/_includes/sidebar-releases.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@
6565
]
6666
},
6767
{
68-
"title": "CockroachDB Kubernetes Operator",
68+
"title": "Public Kubernetes Operator",
6969
"urls": [
7070
"/releases/kubernetes-operator.html"
7171
]

src/current/_includes/v23.1/orchestration/kubernetes-limitations.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
To deploy CockroachDB {{page.version.version}}, Kubernetes 1.18 or higher is required. Cockroach Labs strongly recommends that you use a Kubernetes version that is [eligible for patch support by the Kubernetes project](https://kubernetes.io/releases/).
44

5-
#### Kubernetes Operator
5+
#### Public kubernetes Operator
66

7-
- The CockroachDB Kubernetes Operator currently deploys clusters in a single region. For multi-region deployments using manual configs, see [Orchestrate CockroachDB Across Multiple Kubernetes Clusters]({% link {{ page.version.version }}/orchestrate-cockroachdb-with-kubernetes-multi-cluster.md %}).
7+
- The {{ site.data.products.public-operator }} currently deploys clusters in a single region. For multi-region deployments using manual configs, see [Orchestrate CockroachDB Across Multiple Kubernetes Clusters]({% link {{ page.version.version }}/orchestrate-cockroachdb-with-kubernetes-multi-cluster.md %}).
88

99
- Using the Operator, you can give a new cluster an arbitrary number of [labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/). However, a cluster's labels cannot be modified after it is deployed. To track the status of this limitation, refer to [#993](https://github.com/cockroachdb/cockroach-operator/issues/993) in the Operator project's issue tracker.
1010

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
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 %}).
1+
{% if page.name == "kubernetes-operator.md" %}
2+
{{ site.data.alerts.callout_success }}
3+
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 v25.2/kubernetes-operator-overview.md %}).
34

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}}
5+
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 v25.2/migrate-cockroachdb-kubernetes-helm.md %}) and [{{ site.data.products.public-operator }}]({% link v25.2/migrate-cockroachdb-kubernetes-operator.md %}) migration guides.
6+
{{ site.data.alerts.end }}
7+
{% else %}
8+
{{ site.data.alerts.callout_success }}
9+
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 }}/kubernetes-operator-overview.md %}).
10+
11+
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.
12+
{{ site.data.alerts.end }}
13+
{% endif %}

src/current/_includes/v25.2/orchestration/kubernetes-limitations.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
To deploy CockroachDB {{page.version.version}}, Kubernetes 1.18 or higher is required. Cockroach Labs strongly recommends that you use a Kubernetes version that is [eligible for patch support by the Kubernetes project](https://kubernetes.io/releases/).
44

5-
#### Kubernetes Operator
5+
#### {{ site.data.products.public-operator }}
66

7-
- The CockroachDB Kubernetes Operator currently deploys clusters in a single region. For multi-region deployments using manual configs, see [Orchestrate CockroachDB Across Multiple Kubernetes Clusters]({% link {{ page.version.version }}/orchestrate-cockroachdb-with-kubernetes-multi-cluster.md %}).
7+
- The {{ site.data.products.public-operator }} deploys clusters in a single region. For multi-region deployments using manual configs, Cockroach Labs recommends using the [{{ site.data.products.cockroachdb-operator }}]({% link {{ page.version.version }}/kubernetes-operator-overview.md %}) which is designed to support multi-region deployments. For guidance on how to force multi-region support with the {{ site.data.products.public-operator }}, see [Orchestrate CockroachDB Across Multiple Kubernetes Clusters]({% link {{ page.version.version }}/orchestrate-cockroachdb-with-kubernetes-multi-cluster.md %}).
88

9-
- Using the Operator, you can give a new cluster an arbitrary number of [labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/). However, a cluster's labels cannot be modified after it is deployed. To track the status of this limitation, refer to [#993](https://github.com/cockroachdb/cockroach-operator/issues/993) in the Operator project's issue tracker.
9+
- Using the {{ site.data.products.public-operator }}, you can give a new cluster an arbitrary number of [labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/). However, a cluster's labels cannot be modified after it is deployed. To track the status of this limitation, refer to [#993](https://github.com/cockroachdb/cockroach-operator/issues/993) in the {{ site.data.products.public-operator }} project's issue tracker.
1010

1111
{% unless page.name == "orchestrate-cockroachdb-with-kubernetes-multi-cluster.md" %}
1212
#### Helm version
@@ -17,9 +17,9 @@ The CockroachDB Helm chart requires Helm 3.0 or higher. If you attempt to use an
1717
Error: UPGRADE FAILED: template: cockroachdb/templates/tests/client.yaml:6:14: executing "cockroachdb/templates/tests/client.yaml" at <.Values.networkPolicy.enabled>: nil pointer evaluating interface {}.enabled
1818
~~~
1919

20-
The CockroachDB Helm chart is currently not under active development, and no new features are planned. However, Cockroach Labs remains committed to fully supporting the Helm chart by addressing defects, providing security patches, and addressing breaking changes due to deprecations in Kubernetes APIs.
20+
The public Helm chart is currently not under active development, and no new features are planned. However, Cockroach Labs remains committed to fully supporting the Helm chart by addressing defects, providing security patches, and addressing breaking changes due to deprecations in Kubernetes APIs.
2121

22-
A deprecation notice for the Helm chart will be provided to customers a minimum of 6 months in advance of actual deprecation.
22+
A deprecation notice for the public Helm chart will be provided to customers a minimum of 6 months in advance of actual deprecation.
2323
{% endunless %}
2424

2525
#### Network

src/current/_includes/v25.2/orchestration/kubernetes-stop-cluster.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ To shut down the CockroachDB cluster:
1010
kubectl delete -f example.yaml
1111
~~~
1212

13-
1. Remove the Operator:
13+
1. Remove the {{ site.data.products.public-operator }}:
1414

1515
{% include_cached copy-clipboard.html %}
1616
~~~ shell
1717
kubectl delete -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml
1818
~~~
1919

20-
This will delete the CockroachDB cluster being run by the Operator. It intentionally does **not** delete:
20+
This will delete the CockroachDB cluster being run by the {{ site.data.products.public-operator }}. It intentionally does **not** delete:
2121
- The persistent volumes that were attached to the pods, to avoid the risk of data loss. Before deleting a cluster's persistent volumes, be sure to back them up. For more information, refer to [Delete a Cluster's Persistent Volumes](#delete-a-clusters-persistent-volumes) in the Kubernetes project's documentation.
2222
- Any secrets you may have created. For more information on managing secrets, refer to [Managing Secrets Using `kubectl`](https://kubernetes.io/docs/tasks/configmap-secret/managing-secret-using-kubectl) in the Kubernetes project's documentation.
2323
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
{{site.data.alerts.callout_info}}
2-
All `kubectl` steps should be performed in the [namespace where you installed the Operator]({% link {{ page.version.version }}/deploy-cockroachdb-with-kubernetes.md %}#install-the-operator). By default, this is `cockroach-operator-system`.
2+
All `kubectl` steps should be performed in the [namespace where you installed the operator]({% link {{ page.version.version }}/deploy-cockroachdb-with-kubernetes.md %}#install-the-operator). By default, this is `cockroach-operator-system`.
33
{{site.data.alerts.end}}

src/current/_includes/v25.2/orchestration/start-cockroachdb-operator-secure.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### Install the Operator
1+
### Install the {{ site.data.products.public-operator }}
22

33
{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %}
44
{% capture apply_default_operator_manifest_command %}{% include_cached copy-clipboard.html %}
@@ -28,7 +28,7 @@
2828
~~~
2929
{% endcapture %}
3030

31-
1. Apply the [custom resource definition (CRD)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions) for the Operator:
31+
1. Apply the [custom resource definition (CRD)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions) for the {{ site.data.products.public-operator }}:
3232

3333
{% include_cached copy-clipboard.html %}
3434
~~~ shell
@@ -39,16 +39,16 @@
3939
customresourcedefinition.apiextensions.k8s.io/crdbclusters.crdb.cockroachlabs.com created
4040
~~~
4141

42-
1. By default, the Operator is configured to install in the `cockroach-operator-system` namespace and to manage CockroachDB instances for all namespaces on the cluster.<ul><li>To use these defaults, apply the Operator manifest without modifying it: {{ apply_default_operator_manifest_command }}</li><li>To change these defaults:<ol><li>Download the Operator manifest: {{ download_operator_manifest_command }}</li><li>To use a custom namespace, edit all instances of <code>namespace: cockroach-operator-system</code> with your desired namespace.</code></li><li>To limit the namespaces that will be monitored, set the <code>WATCH_NAMESPACE</code> environment variable in the <code>Deployment</code> pod spec. This can be set to a single namespace or a comma-delimited set of namespaces. When set, only those <code>CrdbCluster</code> resources in the supplied namespace(s) will be reconciled.</li><li>Apply your local version of the Operator manifest to the cluster: {{ apply_local_operator_manifest_command }}</li></ol></li></ul>
42+
1. By default, the {{ site.data.products.public-operator }} is configured to install in the `cockroach-operator-system` namespace and to manage CockroachDB instances for all namespaces on the cluster.<ul><li>To use these defaults, apply the {{ site.data.products.public-operator }} manifest without modifying it: {{ apply_default_operator_manifest_command }}</li><li>To change these defaults:<ol><li>Download the {{ site.data.products.public-operator }} manifest: {{ download_operator_manifest_command }}</li><li>To use a custom namespace, edit all instances of <code>namespace: cockroach-operator-system</code> with your desired namespace.</code></li><li>To limit the namespaces that will be monitored, set the <code>WATCH_NAMESPACE</code> environment variable in the <code>Deployment</code> pod spec. This can be set to a single namespace or a comma-delimited set of namespaces. When set, only those <code>CrdbCluster</code> resources in the supplied namespace(s) will be reconciled.</li><li>Apply your local version of the {{ site.data.products.public-operator }} manifest to the cluster: {{ apply_local_operator_manifest_command }}</li></ol></li></ul>
4343

44-
1. Set your current namespace to the one used by the Operator. For example, to use the Operator's default namespace:
44+
1. Set your current namespace to the one used by the {{ site.data.products.public-operator }}. For example, to use the {{ site.data.products.public-operator }}'s default namespace:
4545
4646
{% include_cached copy-clipboard.html %}
4747
~~~ shell
4848
$ kubectl config set-context --current --namespace=cockroach-operator-system
4949
~~~
5050
51-
1. Validate that the Operator is running:
51+
1. Validate that the operator is running:
5252
5353
{% include_cached copy-clipboard.html %}
5454
~~~ shell
@@ -66,7 +66,7 @@
6666
After a cluster managed by the Kubernetes operator is initialized, its Kubernetes labels cannot be modified. For more details, refer to [Best practices](#best-practices).
6767
{{site.data.alerts.end}}
6868
69-
1. Download `example.yaml`, a custom resource that tells the Operator how to configure the Kubernetes cluster.
69+
1. Download `example.yaml`, a custom resource that tells the operator how to configure the Kubernetes cluster.
7070
7171
{% include_cached copy-clipboard.html %}
7272
~~~ shell
@@ -76,7 +76,7 @@ After a cluster managed by the Kubernetes operator is initialized, its Kubernete
7676
By default, this custom resource specifies CPU and memory resources that are appropriate for the virtual machines used in this deployment example. On a production cluster, you should substitute values that are appropriate for your machines and workload. For details on configuring your deployment, see [Configure the Cluster](configure-cockroachdb-kubernetes.html).
7777
7878
{{site.data.alerts.callout_info}}
79-
By default, the Operator will generate and sign 1 client and 1 node certificate to secure the cluster. This means that if you do not provide a CA, a `cockroach`-generated CA is used. If you want to authenticate using your own CA, [specify the generated secrets in the custom resource](secure-cockroachdb-kubernetes.html#use-a-custom-ca) **before** proceeding to the next step.
79+
By default, the operator will generate and sign 1 client and 1 node certificate to secure the cluster. This means that if you do not provide a CA, a `cockroach`-generated CA is used. If you want to authenticate using your own CA, [specify the generated secrets in the custom resource](secure-cockroachdb-kubernetes.html#use-a-custom-ca) **before** proceeding to the next step.
8080
{{site.data.alerts.end}}
8181
8282
1. Apply `example.yaml`:
@@ -86,7 +86,7 @@ After a cluster managed by the Kubernetes operator is initialized, its Kubernete
8686
$ kubectl apply -f example.yaml
8787
~~~
8888
89-
The Operator will create a StatefulSet and initialize the nodes as a cluster.
89+
The operator will create a StatefulSet and initialize the nodes as a cluster.
9090
9191
~~~
9292
crdbcluster.crdb.cockroachlabs.com/cockroachdb created

src/current/_includes/v25.2/sidebar-data/self-hosted-deployments.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@
195195
]
196196
},
197197
{
198-
"title": "Migrate from Public Operator",
198+
"title": "Migrate from {{ site.data.products.public-operator }}",
199199
"urls": [
200200
"/${VERSION}/migrate-cockroachdb-kubernetes-operator.html"
201201
]

0 commit comments

Comments
 (0)