diff --git a/src/current/_includes/latest_operator_version.md b/src/current/_includes/latest_operator_version.md deleted file mode 100644 index a9610347727..00000000000 --- a/src/current/_includes/latest_operator_version.md +++ /dev/null @@ -1 +0,0 @@ -{%- capture latest_operator_version -%}{%- remote_include https://raw.githubusercontent.com/cockroachdb/cockroach-operator/master/version.txt -%}{%- endcapture -%}{{- latest_operator_version | strip_newlines -}} diff --git a/src/current/_includes/v20.2/orchestration/kubernetes-stop-cluster.md b/src/current/_includes/v20.2/orchestration/kubernetes-stop-cluster.md index 5150ea4daad..4850056013a 100644 --- a/src/current/_includes/v20.2/orchestration/kubernetes-stop-cluster.md +++ b/src/current/_includes/v20.2/orchestration/kubernetes-stop-cluster.md @@ -2,7 +2,7 @@ To shut down the CockroachDB cluster:
-{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. Delete the previously created custom resource: @@ -15,7 +15,7 @@ To shut down the CockroachDB cluster: {% include_cached copy-clipboard.html %} ~~~ shell - $ kubectl delete -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + $ kubectl delete -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ This will delete the StatefulSet but will not delete the persistent volumes that were attached to the pods. diff --git a/src/current/_includes/v20.2/orchestration/start-cockroachdb-operator-secure.md b/src/current/_includes/v20.2/orchestration/start-cockroachdb-operator-secure.md index a9707284b42..259d1c43647 100644 --- a/src/current/_includes/v20.2/orchestration/start-cockroachdb-operator-secure.md +++ b/src/current/_includes/v20.2/orchestration/start-cockroachdb-operator-secure.md @@ -4,13 +4,13 @@ The Operator is currently supported for GKE only. ### Install the Operator -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. Apply the [CustomResourceDefinition (CRD)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions) for the Operator: {% include copy-clipboard.html %} ~~~ shell - $ kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/crds.yaml + $ kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/crds.yaml ~~~ ~~~ @@ -21,7 +21,7 @@ The Operator is currently supported for GKE only. {% include copy-clipboard.html %} ~~~ shell - $ kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + $ kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ ~~~ @@ -51,7 +51,7 @@ On a production cluster, you will need to modify the StatefulSet configuration w {% include copy-clipboard.html %} ~~~ shell - $ curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/examples/example.yaml + $ curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/examples/example.yaml ~~~ {% include copy-clipboard.html %} diff --git a/src/current/_includes/v23.1/orchestration/kubernetes-stop-cluster.md b/src/current/_includes/v23.1/orchestration/kubernetes-stop-cluster.md index e818e28ceb3..355aa58859d 100644 --- a/src/current/_includes/v23.1/orchestration/kubernetes-stop-cluster.md +++ b/src/current/_includes/v23.1/orchestration/kubernetes-stop-cluster.md @@ -1,7 +1,7 @@ To shut down the CockroachDB cluster:
-{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. Delete the previously created custom resource: @@ -14,7 +14,7 @@ To shut down the CockroachDB cluster: {% include_cached copy-clipboard.html %} ~~~ shell - kubectl delete -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + kubectl delete -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ This will delete the CockroachDB cluster being run by the Operator. It intentionally does **not** delete: diff --git a/src/current/_includes/v23.1/orchestration/start-cockroachdb-operator-secure.md b/src/current/_includes/v23.1/orchestration/start-cockroachdb-operator-secure.md index eafd4b7999e..25b5572757b 100644 --- a/src/current/_includes/v23.1/orchestration/start-cockroachdb-operator-secure.md +++ b/src/current/_includes/v23.1/orchestration/start-cockroachdb-operator-secure.md @@ -1,11 +1,11 @@ ### Install the Operator -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + {% capture apply_default_operator_manifest_command %} {% include_cached copy-clipboard.html %} ~~~ shell - kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ ~~~ clusterrole.rbac.authorization.k8s.io/cockroach-database-role created @@ -23,7 +23,7 @@ {% include_cached copy-clipboard.html %} ~~~ shell - curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ {% endcapture %} {% capture apply_local_operator_manifest_command %} @@ -38,7 +38,7 @@ {% include_cached copy-clipboard.html %} ~~~ shell - $ kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/crds.yaml + $ kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/crds.yaml ~~~ ~~~ @@ -76,7 +76,7 @@ After a cluster managed by the Kubernetes operator is initialized, its Kubernete {% include_cached copy-clipboard.html %} ~~~ shell - $ curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/examples/example.yaml + $ curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/examples/example.yaml ~~~ 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). diff --git a/src/current/_includes/v23.1/orchestration/test-cluster-secure.md b/src/current/_includes/v23.1/orchestration/test-cluster-secure.md index f96d779fd0a..56128c3dd4b 100644 --- a/src/current/_includes/v23.1/orchestration/test-cluster-secure.md +++ b/src/current/_includes/v23.1/orchestration/test-cluster-secure.md @@ -1,13 +1,13 @@
-{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. To use the CockroachDB SQL client, first launch a secure pod running the `cockroach` binary. {% include_cached copy-clipboard.html %} ~~~ shell $ kubectl create \ - -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/examples/client-secure-operator.yaml + -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/examples/client-secure-operator.yaml ~~~ 1. Get a shell into the pod and start the CockroachDB [built-in SQL client](cockroach-sql.html): diff --git a/src/current/_includes/v23.2/orchestration/kubernetes-stop-cluster.md b/src/current/_includes/v23.2/orchestration/kubernetes-stop-cluster.md index 734ef48885c..071acca486c 100644 --- a/src/current/_includes/v23.2/orchestration/kubernetes-stop-cluster.md +++ b/src/current/_includes/v23.2/orchestration/kubernetes-stop-cluster.md @@ -1,7 +1,7 @@ To shut down the CockroachDB cluster:
-{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. Delete the previously created custom resource: @@ -14,7 +14,7 @@ To shut down the CockroachDB cluster: {% include_cached copy-clipboard.html %} ~~~ shell - kubectl delete -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + kubectl delete -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ This will delete the CockroachDB cluster being run by the Operator. It intentionally does **not** delete: diff --git a/src/current/_includes/v23.2/orchestration/start-cockroachdb-operator-secure.md b/src/current/_includes/v23.2/orchestration/start-cockroachdb-operator-secure.md index eafd4b7999e..25b5572757b 100644 --- a/src/current/_includes/v23.2/orchestration/start-cockroachdb-operator-secure.md +++ b/src/current/_includes/v23.2/orchestration/start-cockroachdb-operator-secure.md @@ -1,11 +1,11 @@ ### Install the Operator -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + {% capture apply_default_operator_manifest_command %} {% include_cached copy-clipboard.html %} ~~~ shell - kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ ~~~ clusterrole.rbac.authorization.k8s.io/cockroach-database-role created @@ -23,7 +23,7 @@ {% include_cached copy-clipboard.html %} ~~~ shell - curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ {% endcapture %} {% capture apply_local_operator_manifest_command %} @@ -38,7 +38,7 @@ {% include_cached copy-clipboard.html %} ~~~ shell - $ kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/crds.yaml + $ kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/crds.yaml ~~~ ~~~ @@ -76,7 +76,7 @@ After a cluster managed by the Kubernetes operator is initialized, its Kubernete {% include_cached copy-clipboard.html %} ~~~ shell - $ curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/examples/example.yaml + $ curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/examples/example.yaml ~~~ 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). diff --git a/src/current/_includes/v23.2/orchestration/test-cluster-secure.md b/src/current/_includes/v23.2/orchestration/test-cluster-secure.md index f255d8d62fc..8b9963a54eb 100644 --- a/src/current/_includes/v23.2/orchestration/test-cluster-secure.md +++ b/src/current/_includes/v23.2/orchestration/test-cluster-secure.md @@ -2,12 +2,12 @@ To use the CockroachDB SQL client, first launch a secure pod running the `cockro
-{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + {% include_cached copy-clipboard.html %} ~~~ shell $ kubectl create \ --f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/examples/client-secure-operator.yaml +-f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/examples/client-secure-operator.yaml ~~~ 1. Get a shell into the pod and start the CockroachDB [built-in SQL client]({% link {{ page.version.version }}/cockroach-sql.md %}): diff --git a/src/current/_includes/v24.1/orchestration/kubernetes-stop-cluster.md b/src/current/_includes/v24.1/orchestration/kubernetes-stop-cluster.md index 734ef48885c..071acca486c 100644 --- a/src/current/_includes/v24.1/orchestration/kubernetes-stop-cluster.md +++ b/src/current/_includes/v24.1/orchestration/kubernetes-stop-cluster.md @@ -1,7 +1,7 @@ To shut down the CockroachDB cluster:
-{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. Delete the previously created custom resource: @@ -14,7 +14,7 @@ To shut down the CockroachDB cluster: {% include_cached copy-clipboard.html %} ~~~ shell - kubectl delete -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + kubectl delete -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ This will delete the CockroachDB cluster being run by the Operator. It intentionally does **not** delete: diff --git a/src/current/_includes/v24.1/orchestration/start-cockroachdb-operator-secure.md b/src/current/_includes/v24.1/orchestration/start-cockroachdb-operator-secure.md index fa5d08ca3a1..6aa936ae368 100644 --- a/src/current/_includes/v24.1/orchestration/start-cockroachdb-operator-secure.md +++ b/src/current/_includes/v24.1/orchestration/start-cockroachdb-operator-secure.md @@ -1,11 +1,11 @@ ### Install the Operator -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + {% capture apply_default_operator_manifest_command %} {% include_cached copy-clipboard.html %} ~~~ shell - kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ ~~~ clusterrole.rbac.authorization.k8s.io/cockroach-database-role created @@ -23,7 +23,7 @@ {% include_cached copy-clipboard.html %} ~~~ shell - curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ {% endcapture %} {% capture apply_local_operator_manifest_command %} @@ -38,7 +38,7 @@ {% include_cached copy-clipboard.html %} ~~~ shell - $ kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/crds.yaml + $ kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/crds.yaml ~~~ ~~~ @@ -76,7 +76,7 @@ After a cluster managed by the Kubernetes operator is initialized, its Kubernete {% include_cached copy-clipboard.html %} ~~~ shell - $ curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/examples/example.yaml + $ curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/examples/example.yaml ~~~ 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). diff --git a/src/current/_includes/v24.1/orchestration/test-cluster-secure.md b/src/current/_includes/v24.1/orchestration/test-cluster-secure.md index f255d8d62fc..8b9963a54eb 100644 --- a/src/current/_includes/v24.1/orchestration/test-cluster-secure.md +++ b/src/current/_includes/v24.1/orchestration/test-cluster-secure.md @@ -2,12 +2,12 @@ To use the CockroachDB SQL client, first launch a secure pod running the `cockro
-{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + {% include_cached copy-clipboard.html %} ~~~ shell $ kubectl create \ --f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/examples/client-secure-operator.yaml +-f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/examples/client-secure-operator.yaml ~~~ 1. Get a shell into the pod and start the CockroachDB [built-in SQL client]({% link {{ page.version.version }}/cockroach-sql.md %}): diff --git a/src/current/_includes/v24.2/orchestration/kubernetes-stop-cluster.md b/src/current/_includes/v24.2/orchestration/kubernetes-stop-cluster.md index 734ef48885c..071acca486c 100644 --- a/src/current/_includes/v24.2/orchestration/kubernetes-stop-cluster.md +++ b/src/current/_includes/v24.2/orchestration/kubernetes-stop-cluster.md @@ -1,7 +1,7 @@ To shut down the CockroachDB cluster:
-{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. Delete the previously created custom resource: @@ -14,7 +14,7 @@ To shut down the CockroachDB cluster: {% include_cached copy-clipboard.html %} ~~~ shell - kubectl delete -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + kubectl delete -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ This will delete the CockroachDB cluster being run by the Operator. It intentionally does **not** delete: diff --git a/src/current/_includes/v24.2/orchestration/start-cockroachdb-operator-secure.md b/src/current/_includes/v24.2/orchestration/start-cockroachdb-operator-secure.md index fa5d08ca3a1..6aa936ae368 100644 --- a/src/current/_includes/v24.2/orchestration/start-cockroachdb-operator-secure.md +++ b/src/current/_includes/v24.2/orchestration/start-cockroachdb-operator-secure.md @@ -1,11 +1,11 @@ ### Install the Operator -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + {% capture apply_default_operator_manifest_command %} {% include_cached copy-clipboard.html %} ~~~ shell - kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ ~~~ clusterrole.rbac.authorization.k8s.io/cockroach-database-role created @@ -23,7 +23,7 @@ {% include_cached copy-clipboard.html %} ~~~ shell - curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ {% endcapture %} {% capture apply_local_operator_manifest_command %} @@ -38,7 +38,7 @@ {% include_cached copy-clipboard.html %} ~~~ shell - $ kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/crds.yaml + $ kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/crds.yaml ~~~ ~~~ @@ -76,7 +76,7 @@ After a cluster managed by the Kubernetes operator is initialized, its Kubernete {% include_cached copy-clipboard.html %} ~~~ shell - $ curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/examples/example.yaml + $ curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/examples/example.yaml ~~~ 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). diff --git a/src/current/_includes/v24.2/orchestration/test-cluster-secure.md b/src/current/_includes/v24.2/orchestration/test-cluster-secure.md index f255d8d62fc..8b9963a54eb 100644 --- a/src/current/_includes/v24.2/orchestration/test-cluster-secure.md +++ b/src/current/_includes/v24.2/orchestration/test-cluster-secure.md @@ -2,12 +2,12 @@ To use the CockroachDB SQL client, first launch a secure pod running the `cockro
-{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + {% include_cached copy-clipboard.html %} ~~~ shell $ kubectl create \ --f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/examples/client-secure-operator.yaml +-f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/examples/client-secure-operator.yaml ~~~ 1. Get a shell into the pod and start the CockroachDB [built-in SQL client]({% link {{ page.version.version }}/cockroach-sql.md %}): diff --git a/src/current/_includes/v24.3/orchestration/kubernetes-stop-cluster.md b/src/current/_includes/v24.3/orchestration/kubernetes-stop-cluster.md index 734ef48885c..071acca486c 100644 --- a/src/current/_includes/v24.3/orchestration/kubernetes-stop-cluster.md +++ b/src/current/_includes/v24.3/orchestration/kubernetes-stop-cluster.md @@ -1,7 +1,7 @@ To shut down the CockroachDB cluster:
-{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. Delete the previously created custom resource: @@ -14,7 +14,7 @@ To shut down the CockroachDB cluster: {% include_cached copy-clipboard.html %} ~~~ shell - kubectl delete -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + kubectl delete -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ This will delete the CockroachDB cluster being run by the Operator. It intentionally does **not** delete: diff --git a/src/current/_includes/v24.3/orchestration/start-cockroachdb-operator-secure.md b/src/current/_includes/v24.3/orchestration/start-cockroachdb-operator-secure.md index fa5d08ca3a1..6aa936ae368 100644 --- a/src/current/_includes/v24.3/orchestration/start-cockroachdb-operator-secure.md +++ b/src/current/_includes/v24.3/orchestration/start-cockroachdb-operator-secure.md @@ -1,11 +1,11 @@ ### Install the Operator -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + {% capture apply_default_operator_manifest_command %} {% include_cached copy-clipboard.html %} ~~~ shell - kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ ~~~ clusterrole.rbac.authorization.k8s.io/cockroach-database-role created @@ -23,7 +23,7 @@ {% include_cached copy-clipboard.html %} ~~~ shell - curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ {% endcapture %} {% capture apply_local_operator_manifest_command %} @@ -38,7 +38,7 @@ {% include_cached copy-clipboard.html %} ~~~ shell - $ kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/crds.yaml + $ kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/crds.yaml ~~~ ~~~ @@ -76,7 +76,7 @@ After a cluster managed by the Kubernetes operator is initialized, its Kubernete {% include_cached copy-clipboard.html %} ~~~ shell - $ curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/examples/example.yaml + $ curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/examples/example.yaml ~~~ 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). diff --git a/src/current/_includes/v24.3/orchestration/test-cluster-secure.md b/src/current/_includes/v24.3/orchestration/test-cluster-secure.md index f255d8d62fc..8b9963a54eb 100644 --- a/src/current/_includes/v24.3/orchestration/test-cluster-secure.md +++ b/src/current/_includes/v24.3/orchestration/test-cluster-secure.md @@ -2,12 +2,12 @@ To use the CockroachDB SQL client, first launch a secure pod running the `cockro
-{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + {% include_cached copy-clipboard.html %} ~~~ shell $ kubectl create \ --f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/examples/client-secure-operator.yaml +-f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/examples/client-secure-operator.yaml ~~~ 1. Get a shell into the pod and start the CockroachDB [built-in SQL client]({% link {{ page.version.version }}/cockroach-sql.md %}): diff --git a/src/current/_includes/v25.1/orchestration/kubernetes-stop-cluster.md b/src/current/_includes/v25.1/orchestration/kubernetes-stop-cluster.md index 734ef48885c..071acca486c 100644 --- a/src/current/_includes/v25.1/orchestration/kubernetes-stop-cluster.md +++ b/src/current/_includes/v25.1/orchestration/kubernetes-stop-cluster.md @@ -1,7 +1,7 @@ To shut down the CockroachDB cluster:
-{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. Delete the previously created custom resource: @@ -14,7 +14,7 @@ To shut down the CockroachDB cluster: {% include_cached copy-clipboard.html %} ~~~ shell - kubectl delete -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + kubectl delete -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ This will delete the CockroachDB cluster being run by the Operator. It intentionally does **not** delete: diff --git a/src/current/_includes/v25.1/orchestration/start-cockroachdb-operator-secure.md b/src/current/_includes/v25.1/orchestration/start-cockroachdb-operator-secure.md index fa5d08ca3a1..6aa936ae368 100644 --- a/src/current/_includes/v25.1/orchestration/start-cockroachdb-operator-secure.md +++ b/src/current/_includes/v25.1/orchestration/start-cockroachdb-operator-secure.md @@ -1,11 +1,11 @@ ### Install the Operator -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + {% capture apply_default_operator_manifest_command %} {% include_cached copy-clipboard.html %} ~~~ shell - kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ ~~~ clusterrole.rbac.authorization.k8s.io/cockroach-database-role created @@ -23,7 +23,7 @@ {% include_cached copy-clipboard.html %} ~~~ shell - curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ {% endcapture %} {% capture apply_local_operator_manifest_command %} @@ -38,7 +38,7 @@ {% include_cached copy-clipboard.html %} ~~~ shell - $ kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/crds.yaml + $ kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/crds.yaml ~~~ ~~~ @@ -76,7 +76,7 @@ After a cluster managed by the Kubernetes operator is initialized, its Kubernete {% include_cached copy-clipboard.html %} ~~~ shell - $ curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/examples/example.yaml + $ curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/examples/example.yaml ~~~ 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). diff --git a/src/current/_includes/v25.1/orchestration/test-cluster-secure.md b/src/current/_includes/v25.1/orchestration/test-cluster-secure.md index f255d8d62fc..8b9963a54eb 100644 --- a/src/current/_includes/v25.1/orchestration/test-cluster-secure.md +++ b/src/current/_includes/v25.1/orchestration/test-cluster-secure.md @@ -2,12 +2,12 @@ To use the CockroachDB SQL client, first launch a secure pod running the `cockro
-{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + {% include_cached copy-clipboard.html %} ~~~ shell $ kubectl create \ --f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/examples/client-secure-operator.yaml +-f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/examples/client-secure-operator.yaml ~~~ 1. Get a shell into the pod and start the CockroachDB [built-in SQL client]({% link {{ page.version.version }}/cockroach-sql.md %}): diff --git a/src/current/_includes/v25.2/orchestration/kubernetes-stop-cluster.md b/src/current/_includes/v25.2/orchestration/kubernetes-stop-cluster.md index 56ad6451849..197e1fc174d 100644 --- a/src/current/_includes/v25.2/orchestration/kubernetes-stop-cluster.md +++ b/src/current/_includes/v25.2/orchestration/kubernetes-stop-cluster.md @@ -1,7 +1,7 @@ To shut down the CockroachDB cluster:
-{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. Delete the previously created custom resource: @@ -14,7 +14,7 @@ To shut down the CockroachDB cluster: {% include_cached copy-clipboard.html %} ~~~ shell - kubectl delete -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + kubectl delete -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ This will delete the CockroachDB cluster being run by the {{ site.data.products.public-operator }}. It intentionally does **not** delete: diff --git a/src/current/_includes/v25.2/orchestration/start-cockroachdb-operator-secure.md b/src/current/_includes/v25.2/orchestration/start-cockroachdb-operator-secure.md index 24371430ba5..059cd7b73b1 100644 --- a/src/current/_includes/v25.2/orchestration/start-cockroachdb-operator-secure.md +++ b/src/current/_includes/v25.2/orchestration/start-cockroachdb-operator-secure.md @@ -1,11 +1,11 @@ ### Install the Operator -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + {% capture apply_default_operator_manifest_command %} {% include_cached copy-clipboard.html %} ~~~ shell - kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ ~~~ clusterrole.rbac.authorization.k8s.io/cockroach-database-role created @@ -23,7 +23,7 @@ {% include_cached copy-clipboard.html %} ~~~ shell - curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ {% endcapture %} {% capture apply_local_operator_manifest_command %} @@ -38,7 +38,7 @@ {% include_cached copy-clipboard.html %} ~~~ shell - $ kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/crds.yaml + $ kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/crds.yaml ~~~ ~~~ @@ -76,7 +76,7 @@ After a cluster managed by the Kubernetes operator is initialized, its Kubernete {% include_cached copy-clipboard.html %} ~~~ shell - $ curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/examples/example.yaml + $ curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/examples/example.yaml ~~~ 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). diff --git a/src/current/_includes/v25.2/orchestration/test-cluster-secure.md b/src/current/_includes/v25.2/orchestration/test-cluster-secure.md index f255d8d62fc..8b9963a54eb 100644 --- a/src/current/_includes/v25.2/orchestration/test-cluster-secure.md +++ b/src/current/_includes/v25.2/orchestration/test-cluster-secure.md @@ -2,12 +2,12 @@ To use the CockroachDB SQL client, first launch a secure pod running the `cockro
-{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + {% include_cached copy-clipboard.html %} ~~~ shell $ kubectl create \ --f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/examples/client-secure-operator.yaml +-f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/examples/client-secure-operator.yaml ~~~ 1. Get a shell into the pod and start the CockroachDB [built-in SQL client]({% link {{ page.version.version }}/cockroach-sql.md %}): diff --git a/src/current/_includes/v25.3/orchestration/kubernetes-stop-cluster.md b/src/current/_includes/v25.3/orchestration/kubernetes-stop-cluster.md index 56ad6451849..197e1fc174d 100644 --- a/src/current/_includes/v25.3/orchestration/kubernetes-stop-cluster.md +++ b/src/current/_includes/v25.3/orchestration/kubernetes-stop-cluster.md @@ -1,7 +1,7 @@ To shut down the CockroachDB cluster:
-{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. Delete the previously created custom resource: @@ -14,7 +14,7 @@ To shut down the CockroachDB cluster: {% include_cached copy-clipboard.html %} ~~~ shell - kubectl delete -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + kubectl delete -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ This will delete the CockroachDB cluster being run by the {{ site.data.products.public-operator }}. It intentionally does **not** delete: diff --git a/src/current/_includes/v25.3/orchestration/start-cockroachdb-operator-secure.md b/src/current/_includes/v25.3/orchestration/start-cockroachdb-operator-secure.md index 24371430ba5..059cd7b73b1 100644 --- a/src/current/_includes/v25.3/orchestration/start-cockroachdb-operator-secure.md +++ b/src/current/_includes/v25.3/orchestration/start-cockroachdb-operator-secure.md @@ -1,11 +1,11 @@ ### Install the Operator -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + {% capture apply_default_operator_manifest_command %} {% include_cached copy-clipboard.html %} ~~~ shell - kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ ~~~ clusterrole.rbac.authorization.k8s.io/cockroach-database-role created @@ -23,7 +23,7 @@ {% include_cached copy-clipboard.html %} ~~~ shell - curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ {% endcapture %} {% capture apply_local_operator_manifest_command %} @@ -38,7 +38,7 @@ {% include_cached copy-clipboard.html %} ~~~ shell - $ kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/crds.yaml + $ kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/crds.yaml ~~~ ~~~ @@ -76,7 +76,7 @@ After a cluster managed by the Kubernetes operator is initialized, its Kubernete {% include_cached copy-clipboard.html %} ~~~ shell - $ curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/examples/example.yaml + $ curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/examples/example.yaml ~~~ 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). diff --git a/src/current/_includes/v25.3/orchestration/test-cluster-secure.md b/src/current/_includes/v25.3/orchestration/test-cluster-secure.md index f255d8d62fc..8b9963a54eb 100644 --- a/src/current/_includes/v25.3/orchestration/test-cluster-secure.md +++ b/src/current/_includes/v25.3/orchestration/test-cluster-secure.md @@ -2,12 +2,12 @@ To use the CockroachDB SQL client, first launch a secure pod running the `cockro
-{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + {% include_cached copy-clipboard.html %} ~~~ shell $ kubectl create \ --f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/examples/client-secure-operator.yaml +-f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/examples/client-secure-operator.yaml ~~~ 1. Get a shell into the pod and start the CockroachDB [built-in SQL client]({% link {{ page.version.version }}/cockroach-sql.md %}): diff --git a/src/current/_includes/v25.4/orchestration/kubernetes-stop-cluster.md b/src/current/_includes/v25.4/orchestration/kubernetes-stop-cluster.md index 56ad6451849..197e1fc174d 100644 --- a/src/current/_includes/v25.4/orchestration/kubernetes-stop-cluster.md +++ b/src/current/_includes/v25.4/orchestration/kubernetes-stop-cluster.md @@ -1,7 +1,7 @@ To shut down the CockroachDB cluster:
-{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. Delete the previously created custom resource: @@ -14,7 +14,7 @@ To shut down the CockroachDB cluster: {% include_cached copy-clipboard.html %} ~~~ shell - kubectl delete -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + kubectl delete -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ This will delete the CockroachDB cluster being run by the {{ site.data.products.public-operator }}. It intentionally does **not** delete: diff --git a/src/current/_includes/v25.4/orchestration/start-cockroachdb-operator-secure.md b/src/current/_includes/v25.4/orchestration/start-cockroachdb-operator-secure.md index 24371430ba5..059cd7b73b1 100644 --- a/src/current/_includes/v25.4/orchestration/start-cockroachdb-operator-secure.md +++ b/src/current/_includes/v25.4/orchestration/start-cockroachdb-operator-secure.md @@ -1,11 +1,11 @@ ### Install the Operator -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + {% capture apply_default_operator_manifest_command %} {% include_cached copy-clipboard.html %} ~~~ shell - kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ ~~~ clusterrole.rbac.authorization.k8s.io/cockroach-database-role created @@ -23,7 +23,7 @@ {% include_cached copy-clipboard.html %} ~~~ shell - curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ {% endcapture %} {% capture apply_local_operator_manifest_command %} @@ -38,7 +38,7 @@ {% include_cached copy-clipboard.html %} ~~~ shell - $ kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/crds.yaml + $ kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/crds.yaml ~~~ ~~~ @@ -76,7 +76,7 @@ After a cluster managed by the Kubernetes operator is initialized, its Kubernete {% include_cached copy-clipboard.html %} ~~~ shell - $ curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/examples/example.yaml + $ curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/examples/example.yaml ~~~ 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). diff --git a/src/current/_includes/v25.4/orchestration/test-cluster-secure.md b/src/current/_includes/v25.4/orchestration/test-cluster-secure.md index f255d8d62fc..8b9963a54eb 100644 --- a/src/current/_includes/v25.4/orchestration/test-cluster-secure.md +++ b/src/current/_includes/v25.4/orchestration/test-cluster-secure.md @@ -2,12 +2,12 @@ To use the CockroachDB SQL client, first launch a secure pod running the `cockro
-{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + {% include_cached copy-clipboard.html %} ~~~ shell $ kubectl create \ --f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/examples/client-secure-operator.yaml +-f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/examples/client-secure-operator.yaml ~~~ 1. Get a shell into the pod and start the CockroachDB [built-in SQL client]({% link {{ page.version.version }}/cockroach-sql.md %}): diff --git a/src/current/_includes/v26.1/orchestration/kubernetes-stop-cluster.md b/src/current/_includes/v26.1/orchestration/kubernetes-stop-cluster.md index 56ad6451849..197e1fc174d 100644 --- a/src/current/_includes/v26.1/orchestration/kubernetes-stop-cluster.md +++ b/src/current/_includes/v26.1/orchestration/kubernetes-stop-cluster.md @@ -1,7 +1,7 @@ To shut down the CockroachDB cluster:
-{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. Delete the previously created custom resource: @@ -14,7 +14,7 @@ To shut down the CockroachDB cluster: {% include_cached copy-clipboard.html %} ~~~ shell - kubectl delete -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + kubectl delete -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ This will delete the CockroachDB cluster being run by the {{ site.data.products.public-operator }}. It intentionally does **not** delete: diff --git a/src/current/_includes/v26.1/orchestration/start-cockroachdb-operator-secure.md b/src/current/_includes/v26.1/orchestration/start-cockroachdb-operator-secure.md index 24371430ba5..059cd7b73b1 100644 --- a/src/current/_includes/v26.1/orchestration/start-cockroachdb-operator-secure.md +++ b/src/current/_includes/v26.1/orchestration/start-cockroachdb-operator-secure.md @@ -1,11 +1,11 @@ ### Install the Operator -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + {% capture apply_default_operator_manifest_command %} {% include_cached copy-clipboard.html %} ~~~ shell - kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ ~~~ clusterrole.rbac.authorization.k8s.io/cockroach-database-role created @@ -23,7 +23,7 @@ {% include_cached copy-clipboard.html %} ~~~ shell - curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ {% endcapture %} {% capture apply_local_operator_manifest_command %} @@ -38,7 +38,7 @@ {% include_cached copy-clipboard.html %} ~~~ shell - $ kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/crds.yaml + $ kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/crds.yaml ~~~ ~~~ @@ -76,7 +76,7 @@ After a cluster managed by the Kubernetes operator is initialized, its Kubernete {% include_cached copy-clipboard.html %} ~~~ shell - $ curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/examples/example.yaml + $ curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/examples/example.yaml ~~~ 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). diff --git a/src/current/_includes/v26.1/orchestration/test-cluster-secure.md b/src/current/_includes/v26.1/orchestration/test-cluster-secure.md index f255d8d62fc..8b9963a54eb 100644 --- a/src/current/_includes/v26.1/orchestration/test-cluster-secure.md +++ b/src/current/_includes/v26.1/orchestration/test-cluster-secure.md @@ -2,12 +2,12 @@ To use the CockroachDB SQL client, first launch a secure pod running the `cockro
-{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + {% include_cached copy-clipboard.html %} ~~~ shell $ kubectl create \ --f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/examples/client-secure-operator.yaml +-f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/examples/client-secure-operator.yaml ~~~ 1. Get a shell into the pod and start the CockroachDB [built-in SQL client]({% link {{ page.version.version }}/cockroach-sql.md %}): diff --git a/src/current/_includes/v26.2/orchestration/kubernetes-stop-cluster.md b/src/current/_includes/v26.2/orchestration/kubernetes-stop-cluster.md index 56ad6451849..197e1fc174d 100644 --- a/src/current/_includes/v26.2/orchestration/kubernetes-stop-cluster.md +++ b/src/current/_includes/v26.2/orchestration/kubernetes-stop-cluster.md @@ -1,7 +1,7 @@ To shut down the CockroachDB cluster:
-{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. Delete the previously created custom resource: @@ -14,7 +14,7 @@ To shut down the CockroachDB cluster: {% include_cached copy-clipboard.html %} ~~~ shell - kubectl delete -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + kubectl delete -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ This will delete the CockroachDB cluster being run by the {{ site.data.products.public-operator }}. It intentionally does **not** delete: diff --git a/src/current/_includes/v26.2/orchestration/start-cockroachdb-operator-secure.md b/src/current/_includes/v26.2/orchestration/start-cockroachdb-operator-secure.md index 24371430ba5..059cd7b73b1 100644 --- a/src/current/_includes/v26.2/orchestration/start-cockroachdb-operator-secure.md +++ b/src/current/_includes/v26.2/orchestration/start-cockroachdb-operator-secure.md @@ -1,11 +1,11 @@ ### Install the Operator -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + {% capture apply_default_operator_manifest_command %} {% include_cached copy-clipboard.html %} ~~~ shell - kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ ~~~ clusterrole.rbac.authorization.k8s.io/cockroach-database-role created @@ -23,7 +23,7 @@ {% include_cached copy-clipboard.html %} ~~~ shell - curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ {% endcapture %} {% capture apply_local_operator_manifest_command %} @@ -38,7 +38,7 @@ {% include_cached copy-clipboard.html %} ~~~ shell - $ kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/crds.yaml + $ kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/crds.yaml ~~~ ~~~ @@ -76,7 +76,7 @@ After a cluster managed by the Kubernetes operator is initialized, its Kubernete {% include_cached copy-clipboard.html %} ~~~ shell - $ curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/examples/example.yaml + $ curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/examples/example.yaml ~~~ 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). diff --git a/src/current/_includes/v26.2/orchestration/test-cluster-secure.md b/src/current/_includes/v26.2/orchestration/test-cluster-secure.md index f255d8d62fc..8b9963a54eb 100644 --- a/src/current/_includes/v26.2/orchestration/test-cluster-secure.md +++ b/src/current/_includes/v26.2/orchestration/test-cluster-secure.md @@ -2,12 +2,12 @@ To use the CockroachDB SQL client, first launch a secure pod running the `cockro
-{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + {% include_cached copy-clipboard.html %} ~~~ shell $ kubectl create \ --f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/examples/client-secure-operator.yaml +-f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/examples/client-secure-operator.yaml ~~~ 1. Get a shell into the pod and start the CockroachDB [built-in SQL client]({% link {{ page.version.version }}/cockroach-sql.md %}): diff --git a/src/current/_includes/v26.3/orchestration/kubernetes-stop-cluster.md b/src/current/_includes/v26.3/orchestration/kubernetes-stop-cluster.md index 56ad6451849..197e1fc174d 100644 --- a/src/current/_includes/v26.3/orchestration/kubernetes-stop-cluster.md +++ b/src/current/_includes/v26.3/orchestration/kubernetes-stop-cluster.md @@ -1,7 +1,7 @@ To shut down the CockroachDB cluster:
-{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. Delete the previously created custom resource: @@ -14,7 +14,7 @@ To shut down the CockroachDB cluster: {% include_cached copy-clipboard.html %} ~~~ shell - kubectl delete -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + kubectl delete -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ This will delete the CockroachDB cluster being run by the {{ site.data.products.public-operator }}. It intentionally does **not** delete: diff --git a/src/current/_includes/v26.3/orchestration/start-cockroachdb-operator-secure.md b/src/current/_includes/v26.3/orchestration/start-cockroachdb-operator-secure.md index 24371430ba5..059cd7b73b1 100644 --- a/src/current/_includes/v26.3/orchestration/start-cockroachdb-operator-secure.md +++ b/src/current/_includes/v26.3/orchestration/start-cockroachdb-operator-secure.md @@ -1,11 +1,11 @@ ### Install the Operator -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + {% capture apply_default_operator_manifest_command %} {% include_cached copy-clipboard.html %} ~~~ shell - kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ ~~~ clusterrole.rbac.authorization.k8s.io/cockroach-database-role created @@ -23,7 +23,7 @@ {% include_cached copy-clipboard.html %} ~~~ shell - curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ {% endcapture %} {% capture apply_local_operator_manifest_command %} @@ -38,7 +38,7 @@ {% include_cached copy-clipboard.html %} ~~~ shell - $ kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/crds.yaml + $ kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/crds.yaml ~~~ ~~~ @@ -76,7 +76,7 @@ After a cluster managed by the Kubernetes operator is initialized, its Kubernete {% include_cached copy-clipboard.html %} ~~~ shell - $ curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/examples/example.yaml + $ curl -O https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/examples/example.yaml ~~~ 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). diff --git a/src/current/_includes/v26.3/orchestration/test-cluster-secure.md b/src/current/_includes/v26.3/orchestration/test-cluster-secure.md index f255d8d62fc..8b9963a54eb 100644 --- a/src/current/_includes/v26.3/orchestration/test-cluster-secure.md +++ b/src/current/_includes/v26.3/orchestration/test-cluster-secure.md @@ -2,12 +2,12 @@ To use the CockroachDB SQL client, first launch a secure pod running the `cockro
-{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + {% include_cached copy-clipboard.html %} ~~~ shell $ kubectl create \ --f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/examples/client-secure-operator.yaml +-f https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/examples/client-secure-operator.yaml ~~~ 1. Get a shell into the pod and start the CockroachDB [built-in SQL client]({% link {{ page.version.version }}/cockroach-sql.md %}): diff --git a/src/current/releases/kubernetes-operator.md b/src/current/releases/kubernetes-operator.md index b3c6a818d5a..175c34484ee 100644 --- a/src/current/releases/kubernetes-operator.md +++ b/src/current/releases/kubernetes-operator.md @@ -5,13 +5,11 @@ toc: true docs_area: releases --- -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} - The [Public Kubernetes operator](https://www.cockroachlabs.com/docs/stable/kubernetes-overview) allows you to configure, deploy, and manage CockroachDB {{ site.data.products.core }} clusters on Kubernetes. The {{ site.data.products.public-operator }} is released on a separate schedule and is versioned independently from CockroachDB. To learn more about different approaches to deploy CockroachDB using Kubernetes, refer to [Kubernetes Overview](https://www.cockroachlabs.com/docs/stable/kubernetes-overview). {% include /{{ site.versions.stable }}/cockroachdb-operator-recommendation.md %} -This page announces releases of the {{ site.data.products.public-operator }} and provides links to more information on GitHub. **Version {{ latest_operator_version }} is the latest release**. +This page announces releases of the {{ site.data.products.public-operator }} and provides links to more information on GitHub. **Version 2.18.3 is the latest release**. In addition to monitoring this page, you can subscribe to be notified about releases to the public. Visit the [{{ site.data.products.public-operator }} source code repository](https://github.com/cockroachdb/cockroach-operator) and click **Watch**. diff --git a/src/current/v23.1/configure-cockroachdb-kubernetes.md b/src/current/v23.1/configure-cockroachdb-kubernetes.md index ac07d9131f4..47315d4951c 100644 --- a/src/current/v23.1/configure-cockroachdb-kubernetes.md +++ b/src/current/v23.1/configure-cockroachdb-kubernetes.md @@ -7,7 +7,7 @@ secure: true docs_area: deploy --- -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + This page explains how to configure Kubernetes cluster resources such as memory, CPU, and storage. @@ -283,5 +283,5 @@ spec: Changing the SQL Ingress `host` on a running deployment will cause a rolling restart of the cluster, due to new node certificates being generated for the SQL host. {{site.data.alerts.end}} -The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/blob/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. +The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/blob/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator.
diff --git a/src/current/v23.1/deploy-cockroachdb-with-kubernetes-openshift.md b/src/current/v23.1/deploy-cockroachdb-with-kubernetes-openshift.md index 6d6cb7e01f3..e21427ff18a 100644 --- a/src/current/v23.1/deploy-cockroachdb-with-kubernetes-openshift.md +++ b/src/current/v23.1/deploy-cockroachdb-with-kubernetes-openshift.md @@ -85,7 +85,7 @@ This article assumes you have already installed the OpenShift Container Platform ## Step 3. Start CockroachDB -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. When the Operator is ready, click **View Operator** to navigate to the **Installed Operators** page. @@ -93,7 +93,7 @@ This article assumes you have already installed the OpenShift Container Platform OpenShift OperatorHub -1. Make sure **CockroachDB Version** is set to a valid CockroachDB version. For a list of compatible image names, see `spec.containers.env` in the [Operator manifest](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml) on GitHub. +1. Make sure **CockroachDB Version** is set to a valid CockroachDB version. For a list of compatible image names, see `spec.containers.env` in the [Operator manifest](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml) on GitHub. 1. This will open the **Create CrdbCluster** page. By default, this deploys a 3-node secure cluster. Leave the other fields unchanged and click **Create**. diff --git a/src/current/v23.1/scale-cockroachdb-kubernetes.md b/src/current/v23.1/scale-cockroachdb-kubernetes.md index 7e62cf5cdf7..5bdd61c949e 100644 --- a/src/current/v23.1/scale-cockroachdb-kubernetes.md +++ b/src/current/v23.1/scale-cockroachdb-kubernetes.md @@ -214,13 +214,13 @@ To enable the Operator to automatically remove persistent volumes when [scaling This workflow is unsupported and should be enabled at your own risk. {{site.data.alerts.end}} -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. Download the Operator manifest: {% include_cached copy-clipboard.html %} ~~~ shell - $ curl -0 https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + $ curl -0 https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ 1. Uncomment the following lines in the Operator manifest: diff --git a/src/current/v23.1/schedule-cockroachdb-kubernetes.md b/src/current/v23.1/schedule-cockroachdb-kubernetes.md index 973d234ffa9..44c850a6948 100644 --- a/src/current/v23.1/schedule-cockroachdb-kubernetes.md +++ b/src/current/v23.1/schedule-cockroachdb-kubernetes.md @@ -22,9 +22,9 @@ These settings control how CockroachDB pods can be identified or scheduled onto ## Enable feature gates -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} -To enable the [affinity](#affinities-and-anti-affinities), [toleration](#taints-and-tolerations), and [topology spread constraint](#topology-spread-constraints) rules, [download the Operator manifest](https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml) and add the following line to the `spec.containers.args` field: + +To enable the [affinity](#affinities-and-anti-affinities), [toleration](#taints-and-tolerations), and [topology spread constraint](#topology-spread-constraints) rules, [download the Operator manifest](https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml) and add the following line to the `spec.containers.args` field: {% include_cached copy-clipboard.html %} ~~~ yaml @@ -102,7 +102,7 @@ The `requiredDuringSchedulingIgnoredDuringExecution` node affinity rule, using t The `preferredDuringSchedulingIgnoredDuringExecution` node affinity rule, using the `NotIn` operator and specified `weight`, discourages (but does not disallow) CockroachDB pods from being scheduled onto nodes with the label `topology.kubernetes.io/zone=us-east4-b`. This achieves a similar effect as a `PreferNoSchedule` [taint](#taints-and-tolerations). -For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. +For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. ### Add a pod affinity or anti-affinity @@ -140,7 +140,7 @@ The `preferredDuringSchedulingIgnoredDuringExecution` pod affinity rule, using t The `requiredDuringSchedulingIgnoredDuringExecution` pod anti-affinity rule, using the `In` operator, requires CockroachDB pods not to be co-located on a worker node, as specified with `topologyKey`. -For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. +For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. ### Example: Scheduling CockroachDB onto labeled nodes @@ -282,7 +282,7 @@ spec: A `NoExecute` taint on a node prevents pods from being scheduled onto the node, and evicts pods from the node if they are already running on the node. The matching toleration allows a pod to be scheduled onto the node, and to continue running on the node if `tolerationSeconds` is not specified. If `tolerationSeconds` is specified, the pod is evicted after this number of seconds. -For more information on using taints and tolerations, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. +For more information on using taints and tolerations, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. ### Example: Evicting CockroachDB from a running worker node @@ -380,7 +380,7 @@ spec: The `DoNotSchedule` condition prevents labeled pods from being scheduled onto Kubernetes worker nodes when doing so would fail to meet the spread and topology constraints specified with `maxSkew` and `topologyKey`, respectively. -For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. +For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. ## Resource labels and annotations @@ -394,7 +394,7 @@ spec: additionalLabels: app.kubernetes.io/version: {{page.release_info.version}} additionalAnnotations: - operator: https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + operator: https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ To verify that the labels and annotations were applied to a pod, for example, run `kubectl describe pod {pod-name}`. diff --git a/src/current/v23.2/configure-cockroachdb-kubernetes.md b/src/current/v23.2/configure-cockroachdb-kubernetes.md index ac07d9131f4..47315d4951c 100644 --- a/src/current/v23.2/configure-cockroachdb-kubernetes.md +++ b/src/current/v23.2/configure-cockroachdb-kubernetes.md @@ -7,7 +7,7 @@ secure: true docs_area: deploy --- -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + This page explains how to configure Kubernetes cluster resources such as memory, CPU, and storage. @@ -283,5 +283,5 @@ spec: Changing the SQL Ingress `host` on a running deployment will cause a rolling restart of the cluster, due to new node certificates being generated for the SQL host. {{site.data.alerts.end}} -The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/blob/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. +The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/blob/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator.
diff --git a/src/current/v23.2/deploy-cockroachdb-with-kubernetes-openshift.md b/src/current/v23.2/deploy-cockroachdb-with-kubernetes-openshift.md index f7f7058fbe5..39439a77de7 100644 --- a/src/current/v23.2/deploy-cockroachdb-with-kubernetes-openshift.md +++ b/src/current/v23.2/deploy-cockroachdb-with-kubernetes-openshift.md @@ -85,7 +85,7 @@ This article assumes you have already installed the OpenShift Container Platform ## Step 3. Start CockroachDB -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. When the Operator is ready, click **View Operator** to navigate to the **Installed Operators** page. @@ -93,7 +93,7 @@ This article assumes you have already installed the OpenShift Container Platform OpenShift OperatorHub -1. Make sure **CockroachDB Version** is set to a valid CockroachDB version. For a list of compatible image names, see `spec.containers.env` in the [Operator manifest](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml) on GitHub. +1. Make sure **CockroachDB Version** is set to a valid CockroachDB version. For a list of compatible image names, see `spec.containers.env` in the [Operator manifest](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml) on GitHub. 1. This will open the **Create CrdbCluster** page. By default, this deploys a 3-node secure cluster. Leave the other fields unchanged and click **Create**. diff --git a/src/current/v23.2/scale-cockroachdb-kubernetes.md b/src/current/v23.2/scale-cockroachdb-kubernetes.md index 7e62cf5cdf7..5bdd61c949e 100644 --- a/src/current/v23.2/scale-cockroachdb-kubernetes.md +++ b/src/current/v23.2/scale-cockroachdb-kubernetes.md @@ -214,13 +214,13 @@ To enable the Operator to automatically remove persistent volumes when [scaling This workflow is unsupported and should be enabled at your own risk. {{site.data.alerts.end}} -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. Download the Operator manifest: {% include_cached copy-clipboard.html %} ~~~ shell - $ curl -0 https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + $ curl -0 https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ 1. Uncomment the following lines in the Operator manifest: diff --git a/src/current/v23.2/schedule-cockroachdb-kubernetes.md b/src/current/v23.2/schedule-cockroachdb-kubernetes.md index 973d234ffa9..44c850a6948 100644 --- a/src/current/v23.2/schedule-cockroachdb-kubernetes.md +++ b/src/current/v23.2/schedule-cockroachdb-kubernetes.md @@ -22,9 +22,9 @@ These settings control how CockroachDB pods can be identified or scheduled onto ## Enable feature gates -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} -To enable the [affinity](#affinities-and-anti-affinities), [toleration](#taints-and-tolerations), and [topology spread constraint](#topology-spread-constraints) rules, [download the Operator manifest](https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml) and add the following line to the `spec.containers.args` field: + +To enable the [affinity](#affinities-and-anti-affinities), [toleration](#taints-and-tolerations), and [topology spread constraint](#topology-spread-constraints) rules, [download the Operator manifest](https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml) and add the following line to the `spec.containers.args` field: {% include_cached copy-clipboard.html %} ~~~ yaml @@ -102,7 +102,7 @@ The `requiredDuringSchedulingIgnoredDuringExecution` node affinity rule, using t The `preferredDuringSchedulingIgnoredDuringExecution` node affinity rule, using the `NotIn` operator and specified `weight`, discourages (but does not disallow) CockroachDB pods from being scheduled onto nodes with the label `topology.kubernetes.io/zone=us-east4-b`. This achieves a similar effect as a `PreferNoSchedule` [taint](#taints-and-tolerations). -For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. +For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. ### Add a pod affinity or anti-affinity @@ -140,7 +140,7 @@ The `preferredDuringSchedulingIgnoredDuringExecution` pod affinity rule, using t The `requiredDuringSchedulingIgnoredDuringExecution` pod anti-affinity rule, using the `In` operator, requires CockroachDB pods not to be co-located on a worker node, as specified with `topologyKey`. -For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. +For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. ### Example: Scheduling CockroachDB onto labeled nodes @@ -282,7 +282,7 @@ spec: A `NoExecute` taint on a node prevents pods from being scheduled onto the node, and evicts pods from the node if they are already running on the node. The matching toleration allows a pod to be scheduled onto the node, and to continue running on the node if `tolerationSeconds` is not specified. If `tolerationSeconds` is specified, the pod is evicted after this number of seconds. -For more information on using taints and tolerations, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. +For more information on using taints and tolerations, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. ### Example: Evicting CockroachDB from a running worker node @@ -380,7 +380,7 @@ spec: The `DoNotSchedule` condition prevents labeled pods from being scheduled onto Kubernetes worker nodes when doing so would fail to meet the spread and topology constraints specified with `maxSkew` and `topologyKey`, respectively. -For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. +For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. ## Resource labels and annotations @@ -394,7 +394,7 @@ spec: additionalLabels: app.kubernetes.io/version: {{page.release_info.version}} additionalAnnotations: - operator: https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + operator: https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ To verify that the labels and annotations were applied to a pod, for example, run `kubectl describe pod {pod-name}`. diff --git a/src/current/v24.1/configure-cockroachdb-kubernetes.md b/src/current/v24.1/configure-cockroachdb-kubernetes.md index ac07d9131f4..47315d4951c 100644 --- a/src/current/v24.1/configure-cockroachdb-kubernetes.md +++ b/src/current/v24.1/configure-cockroachdb-kubernetes.md @@ -7,7 +7,7 @@ secure: true docs_area: deploy --- -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + This page explains how to configure Kubernetes cluster resources such as memory, CPU, and storage. @@ -283,5 +283,5 @@ spec: Changing the SQL Ingress `host` on a running deployment will cause a rolling restart of the cluster, due to new node certificates being generated for the SQL host. {{site.data.alerts.end}} -The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/blob/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. +The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/blob/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator.
diff --git a/src/current/v24.1/deploy-cockroachdb-with-kubernetes-openshift.md b/src/current/v24.1/deploy-cockroachdb-with-kubernetes-openshift.md index dbbac870b37..b91e42cb67d 100644 --- a/src/current/v24.1/deploy-cockroachdb-with-kubernetes-openshift.md +++ b/src/current/v24.1/deploy-cockroachdb-with-kubernetes-openshift.md @@ -85,7 +85,7 @@ This article assumes you have already installed the OpenShift Container Platform ## Step 3. Start CockroachDB -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. When the Operator is ready, click **View Operator** to navigate to the **Installed Operators** page. @@ -93,7 +93,7 @@ This article assumes you have already installed the OpenShift Container Platform OpenShift OperatorHub -1. Make sure **CockroachDB Version** is set to a valid CockroachDB version. For a list of compatible image names, see `spec.containers.env` in the [Operator manifest](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml) on GitHub. +1. Make sure **CockroachDB Version** is set to a valid CockroachDB version. For a list of compatible image names, see `spec.containers.env` in the [Operator manifest](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml) on GitHub. 1. This will open the **Create CrdbCluster** page. By default, this deploys a 3-node secure cluster. Leave the other fields unchanged and click **Create**. diff --git a/src/current/v24.1/scale-cockroachdb-kubernetes.md b/src/current/v24.1/scale-cockroachdb-kubernetes.md index 7e62cf5cdf7..5bdd61c949e 100644 --- a/src/current/v24.1/scale-cockroachdb-kubernetes.md +++ b/src/current/v24.1/scale-cockroachdb-kubernetes.md @@ -214,13 +214,13 @@ To enable the Operator to automatically remove persistent volumes when [scaling This workflow is unsupported and should be enabled at your own risk. {{site.data.alerts.end}} -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. Download the Operator manifest: {% include_cached copy-clipboard.html %} ~~~ shell - $ curl -0 https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + $ curl -0 https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ 1. Uncomment the following lines in the Operator manifest: diff --git a/src/current/v24.1/schedule-cockroachdb-kubernetes.md b/src/current/v24.1/schedule-cockroachdb-kubernetes.md index 973d234ffa9..44c850a6948 100644 --- a/src/current/v24.1/schedule-cockroachdb-kubernetes.md +++ b/src/current/v24.1/schedule-cockroachdb-kubernetes.md @@ -22,9 +22,9 @@ These settings control how CockroachDB pods can be identified or scheduled onto ## Enable feature gates -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} -To enable the [affinity](#affinities-and-anti-affinities), [toleration](#taints-and-tolerations), and [topology spread constraint](#topology-spread-constraints) rules, [download the Operator manifest](https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml) and add the following line to the `spec.containers.args` field: + +To enable the [affinity](#affinities-and-anti-affinities), [toleration](#taints-and-tolerations), and [topology spread constraint](#topology-spread-constraints) rules, [download the Operator manifest](https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml) and add the following line to the `spec.containers.args` field: {% include_cached copy-clipboard.html %} ~~~ yaml @@ -102,7 +102,7 @@ The `requiredDuringSchedulingIgnoredDuringExecution` node affinity rule, using t The `preferredDuringSchedulingIgnoredDuringExecution` node affinity rule, using the `NotIn` operator and specified `weight`, discourages (but does not disallow) CockroachDB pods from being scheduled onto nodes with the label `topology.kubernetes.io/zone=us-east4-b`. This achieves a similar effect as a `PreferNoSchedule` [taint](#taints-and-tolerations). -For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. +For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. ### Add a pod affinity or anti-affinity @@ -140,7 +140,7 @@ The `preferredDuringSchedulingIgnoredDuringExecution` pod affinity rule, using t The `requiredDuringSchedulingIgnoredDuringExecution` pod anti-affinity rule, using the `In` operator, requires CockroachDB pods not to be co-located on a worker node, as specified with `topologyKey`. -For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. +For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. ### Example: Scheduling CockroachDB onto labeled nodes @@ -282,7 +282,7 @@ spec: A `NoExecute` taint on a node prevents pods from being scheduled onto the node, and evicts pods from the node if they are already running on the node. The matching toleration allows a pod to be scheduled onto the node, and to continue running on the node if `tolerationSeconds` is not specified. If `tolerationSeconds` is specified, the pod is evicted after this number of seconds. -For more information on using taints and tolerations, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. +For more information on using taints and tolerations, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. ### Example: Evicting CockroachDB from a running worker node @@ -380,7 +380,7 @@ spec: The `DoNotSchedule` condition prevents labeled pods from being scheduled onto Kubernetes worker nodes when doing so would fail to meet the spread and topology constraints specified with `maxSkew` and `topologyKey`, respectively. -For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. +For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. ## Resource labels and annotations @@ -394,7 +394,7 @@ spec: additionalLabels: app.kubernetes.io/version: {{page.release_info.version}} additionalAnnotations: - operator: https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + operator: https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ To verify that the labels and annotations were applied to a pod, for example, run `kubectl describe pod {pod-name}`. diff --git a/src/current/v24.2/configure-cockroachdb-kubernetes.md b/src/current/v24.2/configure-cockroachdb-kubernetes.md index ac07d9131f4..47315d4951c 100644 --- a/src/current/v24.2/configure-cockroachdb-kubernetes.md +++ b/src/current/v24.2/configure-cockroachdb-kubernetes.md @@ -7,7 +7,7 @@ secure: true docs_area: deploy --- -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + This page explains how to configure Kubernetes cluster resources such as memory, CPU, and storage. @@ -283,5 +283,5 @@ spec: Changing the SQL Ingress `host` on a running deployment will cause a rolling restart of the cluster, due to new node certificates being generated for the SQL host. {{site.data.alerts.end}} -The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/blob/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. +The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/blob/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator.
diff --git a/src/current/v24.2/deploy-cockroachdb-with-kubernetes-openshift.md b/src/current/v24.2/deploy-cockroachdb-with-kubernetes-openshift.md index 73e7701b60a..547bde47117 100644 --- a/src/current/v24.2/deploy-cockroachdb-with-kubernetes-openshift.md +++ b/src/current/v24.2/deploy-cockroachdb-with-kubernetes-openshift.md @@ -85,7 +85,7 @@ This article assumes you have already installed the OpenShift Container Platform ## Step 3. Start CockroachDB -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. When the Operator is ready, click **View Operator** to navigate to the **Installed Operators** page. @@ -93,7 +93,7 @@ This article assumes you have already installed the OpenShift Container Platform OpenShift OperatorHub -1. Make sure **CockroachDB Version** is set to a valid CockroachDB version. For a list of compatible image names, see `spec.containers.env` in the [Operator manifest](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml) on GitHub. +1. Make sure **CockroachDB Version** is set to a valid CockroachDB version. For a list of compatible image names, see `spec.containers.env` in the [Operator manifest](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml) on GitHub. 1. This will open the **Create CrdbCluster** page. By default, this deploys a 3-node secure cluster. Leave the other fields unchanged and click **Create**. diff --git a/src/current/v24.2/scale-cockroachdb-kubernetes.md b/src/current/v24.2/scale-cockroachdb-kubernetes.md index 7e62cf5cdf7..5bdd61c949e 100644 --- a/src/current/v24.2/scale-cockroachdb-kubernetes.md +++ b/src/current/v24.2/scale-cockroachdb-kubernetes.md @@ -214,13 +214,13 @@ To enable the Operator to automatically remove persistent volumes when [scaling This workflow is unsupported and should be enabled at your own risk. {{site.data.alerts.end}} -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. Download the Operator manifest: {% include_cached copy-clipboard.html %} ~~~ shell - $ curl -0 https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + $ curl -0 https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ 1. Uncomment the following lines in the Operator manifest: diff --git a/src/current/v24.2/schedule-cockroachdb-kubernetes.md b/src/current/v24.2/schedule-cockroachdb-kubernetes.md index 973d234ffa9..44c850a6948 100644 --- a/src/current/v24.2/schedule-cockroachdb-kubernetes.md +++ b/src/current/v24.2/schedule-cockroachdb-kubernetes.md @@ -22,9 +22,9 @@ These settings control how CockroachDB pods can be identified or scheduled onto ## Enable feature gates -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} -To enable the [affinity](#affinities-and-anti-affinities), [toleration](#taints-and-tolerations), and [topology spread constraint](#topology-spread-constraints) rules, [download the Operator manifest](https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml) and add the following line to the `spec.containers.args` field: + +To enable the [affinity](#affinities-and-anti-affinities), [toleration](#taints-and-tolerations), and [topology spread constraint](#topology-spread-constraints) rules, [download the Operator manifest](https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml) and add the following line to the `spec.containers.args` field: {% include_cached copy-clipboard.html %} ~~~ yaml @@ -102,7 +102,7 @@ The `requiredDuringSchedulingIgnoredDuringExecution` node affinity rule, using t The `preferredDuringSchedulingIgnoredDuringExecution` node affinity rule, using the `NotIn` operator and specified `weight`, discourages (but does not disallow) CockroachDB pods from being scheduled onto nodes with the label `topology.kubernetes.io/zone=us-east4-b`. This achieves a similar effect as a `PreferNoSchedule` [taint](#taints-and-tolerations). -For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. +For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. ### Add a pod affinity or anti-affinity @@ -140,7 +140,7 @@ The `preferredDuringSchedulingIgnoredDuringExecution` pod affinity rule, using t The `requiredDuringSchedulingIgnoredDuringExecution` pod anti-affinity rule, using the `In` operator, requires CockroachDB pods not to be co-located on a worker node, as specified with `topologyKey`. -For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. +For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. ### Example: Scheduling CockroachDB onto labeled nodes @@ -282,7 +282,7 @@ spec: A `NoExecute` taint on a node prevents pods from being scheduled onto the node, and evicts pods from the node if they are already running on the node. The matching toleration allows a pod to be scheduled onto the node, and to continue running on the node if `tolerationSeconds` is not specified. If `tolerationSeconds` is specified, the pod is evicted after this number of seconds. -For more information on using taints and tolerations, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. +For more information on using taints and tolerations, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. ### Example: Evicting CockroachDB from a running worker node @@ -380,7 +380,7 @@ spec: The `DoNotSchedule` condition prevents labeled pods from being scheduled onto Kubernetes worker nodes when doing so would fail to meet the spread and topology constraints specified with `maxSkew` and `topologyKey`, respectively. -For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. +For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. ## Resource labels and annotations @@ -394,7 +394,7 @@ spec: additionalLabels: app.kubernetes.io/version: {{page.release_info.version}} additionalAnnotations: - operator: https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + operator: https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ To verify that the labels and annotations were applied to a pod, for example, run `kubectl describe pod {pod-name}`. diff --git a/src/current/v24.3/configure-cockroachdb-kubernetes.md b/src/current/v24.3/configure-cockroachdb-kubernetes.md index ac07d9131f4..47315d4951c 100644 --- a/src/current/v24.3/configure-cockroachdb-kubernetes.md +++ b/src/current/v24.3/configure-cockroachdb-kubernetes.md @@ -7,7 +7,7 @@ secure: true docs_area: deploy --- -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + This page explains how to configure Kubernetes cluster resources such as memory, CPU, and storage. @@ -283,5 +283,5 @@ spec: Changing the SQL Ingress `host` on a running deployment will cause a rolling restart of the cluster, due to new node certificates being generated for the SQL host. {{site.data.alerts.end}} -The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/blob/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. +The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/blob/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator.
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 434fabc8d04..9536398d01f 100644 --- a/src/current/v24.3/deploy-cockroachdb-with-kubernetes-openshift.md +++ b/src/current/v24.3/deploy-cockroachdb-with-kubernetes-openshift.md @@ -85,7 +85,7 @@ This article assumes you have already installed the OpenShift Container Platform ## Step 3. Start CockroachDB -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. When the Operator is ready, click **View Operator** to navigate to the **Installed Operators** page. @@ -93,7 +93,7 @@ This article assumes you have already installed the OpenShift Container Platform OpenShift OperatorHub -1. Make sure **CockroachDB Version** is set to a valid CockroachDB version. For a list of compatible image names, see `spec.containers.env` in the [Operator manifest](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml) on GitHub. +1. Make sure **CockroachDB Version** is set to a valid CockroachDB version. For a list of compatible image names, see `spec.containers.env` in the [Operator manifest](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml) on GitHub. 1. This will open the **Create CrdbCluster** page. By default, this deploys a 3-node secure cluster. Leave the other fields unchanged and click **Create**. diff --git a/src/current/v24.3/scale-cockroachdb-kubernetes.md b/src/current/v24.3/scale-cockroachdb-kubernetes.md index 7e62cf5cdf7..5bdd61c949e 100644 --- a/src/current/v24.3/scale-cockroachdb-kubernetes.md +++ b/src/current/v24.3/scale-cockroachdb-kubernetes.md @@ -214,13 +214,13 @@ To enable the Operator to automatically remove persistent volumes when [scaling This workflow is unsupported and should be enabled at your own risk. {{site.data.alerts.end}} -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. Download the Operator manifest: {% include_cached copy-clipboard.html %} ~~~ shell - $ curl -0 https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + $ curl -0 https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ 1. Uncomment the following lines in the Operator manifest: diff --git a/src/current/v24.3/schedule-cockroachdb-kubernetes.md b/src/current/v24.3/schedule-cockroachdb-kubernetes.md index 973d234ffa9..44c850a6948 100644 --- a/src/current/v24.3/schedule-cockroachdb-kubernetes.md +++ b/src/current/v24.3/schedule-cockroachdb-kubernetes.md @@ -22,9 +22,9 @@ These settings control how CockroachDB pods can be identified or scheduled onto ## Enable feature gates -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} -To enable the [affinity](#affinities-and-anti-affinities), [toleration](#taints-and-tolerations), and [topology spread constraint](#topology-spread-constraints) rules, [download the Operator manifest](https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml) and add the following line to the `spec.containers.args` field: + +To enable the [affinity](#affinities-and-anti-affinities), [toleration](#taints-and-tolerations), and [topology spread constraint](#topology-spread-constraints) rules, [download the Operator manifest](https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml) and add the following line to the `spec.containers.args` field: {% include_cached copy-clipboard.html %} ~~~ yaml @@ -102,7 +102,7 @@ The `requiredDuringSchedulingIgnoredDuringExecution` node affinity rule, using t The `preferredDuringSchedulingIgnoredDuringExecution` node affinity rule, using the `NotIn` operator and specified `weight`, discourages (but does not disallow) CockroachDB pods from being scheduled onto nodes with the label `topology.kubernetes.io/zone=us-east4-b`. This achieves a similar effect as a `PreferNoSchedule` [taint](#taints-and-tolerations). -For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. +For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. ### Add a pod affinity or anti-affinity @@ -140,7 +140,7 @@ The `preferredDuringSchedulingIgnoredDuringExecution` pod affinity rule, using t The `requiredDuringSchedulingIgnoredDuringExecution` pod anti-affinity rule, using the `In` operator, requires CockroachDB pods not to be co-located on a worker node, as specified with `topologyKey`. -For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. +For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. ### Example: Scheduling CockroachDB onto labeled nodes @@ -282,7 +282,7 @@ spec: A `NoExecute` taint on a node prevents pods from being scheduled onto the node, and evicts pods from the node if they are already running on the node. The matching toleration allows a pod to be scheduled onto the node, and to continue running on the node if `tolerationSeconds` is not specified. If `tolerationSeconds` is specified, the pod is evicted after this number of seconds. -For more information on using taints and tolerations, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. +For more information on using taints and tolerations, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. ### Example: Evicting CockroachDB from a running worker node @@ -380,7 +380,7 @@ spec: The `DoNotSchedule` condition prevents labeled pods from being scheduled onto Kubernetes worker nodes when doing so would fail to meet the spread and topology constraints specified with `maxSkew` and `topologyKey`, respectively. -For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. +For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. ## Resource labels and annotations @@ -394,7 +394,7 @@ spec: additionalLabels: app.kubernetes.io/version: {{page.release_info.version}} additionalAnnotations: - operator: https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + operator: https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ To verify that the labels and annotations were applied to a pod, for example, run `kubectl describe pod {pod-name}`. diff --git a/src/current/v25.1/configure-cockroachdb-kubernetes.md b/src/current/v25.1/configure-cockroachdb-kubernetes.md index ac07d9131f4..47315d4951c 100644 --- a/src/current/v25.1/configure-cockroachdb-kubernetes.md +++ b/src/current/v25.1/configure-cockroachdb-kubernetes.md @@ -7,7 +7,7 @@ secure: true docs_area: deploy --- -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + This page explains how to configure Kubernetes cluster resources such as memory, CPU, and storage. @@ -283,5 +283,5 @@ spec: Changing the SQL Ingress `host` on a running deployment will cause a rolling restart of the cluster, due to new node certificates being generated for the SQL host. {{site.data.alerts.end}} -The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/blob/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. +The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/blob/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator.
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 49e1fab6ca5..34e56d4b002 100644 --- a/src/current/v25.1/deploy-cockroachdb-with-kubernetes-openshift.md +++ b/src/current/v25.1/deploy-cockroachdb-with-kubernetes-openshift.md @@ -85,7 +85,7 @@ This article assumes you have already installed the OpenShift Container Platform ## Step 3. Start CockroachDB -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. When the Operator is ready, click **View Operator** to navigate to the **Installed Operators** page. @@ -93,7 +93,7 @@ This article assumes you have already installed the OpenShift Container Platform OpenShift OperatorHub -1. Make sure **CockroachDB Version** is set to a valid CockroachDB version. For a list of compatible image names, see `spec.containers.env` in the [Operator manifest](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml) on GitHub. +1. Make sure **CockroachDB Version** is set to a valid CockroachDB version. For a list of compatible image names, see `spec.containers.env` in the [Operator manifest](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml) on GitHub. 1. This will open the **Create CrdbCluster** page. By default, this deploys a 3-node secure cluster. Leave the other fields unchanged and click **Create**. diff --git a/src/current/v25.1/scale-cockroachdb-kubernetes.md b/src/current/v25.1/scale-cockroachdb-kubernetes.md index 7e62cf5cdf7..5bdd61c949e 100644 --- a/src/current/v25.1/scale-cockroachdb-kubernetes.md +++ b/src/current/v25.1/scale-cockroachdb-kubernetes.md @@ -214,13 +214,13 @@ To enable the Operator to automatically remove persistent volumes when [scaling This workflow is unsupported and should be enabled at your own risk. {{site.data.alerts.end}} -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. Download the Operator manifest: {% include_cached copy-clipboard.html %} ~~~ shell - $ curl -0 https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + $ curl -0 https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ 1. Uncomment the following lines in the Operator manifest: diff --git a/src/current/v25.1/schedule-cockroachdb-kubernetes.md b/src/current/v25.1/schedule-cockroachdb-kubernetes.md index 973d234ffa9..44c850a6948 100644 --- a/src/current/v25.1/schedule-cockroachdb-kubernetes.md +++ b/src/current/v25.1/schedule-cockroachdb-kubernetes.md @@ -22,9 +22,9 @@ These settings control how CockroachDB pods can be identified or scheduled onto ## Enable feature gates -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} -To enable the [affinity](#affinities-and-anti-affinities), [toleration](#taints-and-tolerations), and [topology spread constraint](#topology-spread-constraints) rules, [download the Operator manifest](https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml) and add the following line to the `spec.containers.args` field: + +To enable the [affinity](#affinities-and-anti-affinities), [toleration](#taints-and-tolerations), and [topology spread constraint](#topology-spread-constraints) rules, [download the Operator manifest](https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml) and add the following line to the `spec.containers.args` field: {% include_cached copy-clipboard.html %} ~~~ yaml @@ -102,7 +102,7 @@ The `requiredDuringSchedulingIgnoredDuringExecution` node affinity rule, using t The `preferredDuringSchedulingIgnoredDuringExecution` node affinity rule, using the `NotIn` operator and specified `weight`, discourages (but does not disallow) CockroachDB pods from being scheduled onto nodes with the label `topology.kubernetes.io/zone=us-east4-b`. This achieves a similar effect as a `PreferNoSchedule` [taint](#taints-and-tolerations). -For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. +For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. ### Add a pod affinity or anti-affinity @@ -140,7 +140,7 @@ The `preferredDuringSchedulingIgnoredDuringExecution` pod affinity rule, using t The `requiredDuringSchedulingIgnoredDuringExecution` pod anti-affinity rule, using the `In` operator, requires CockroachDB pods not to be co-located on a worker node, as specified with `topologyKey`. -For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. +For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. ### Example: Scheduling CockroachDB onto labeled nodes @@ -282,7 +282,7 @@ spec: A `NoExecute` taint on a node prevents pods from being scheduled onto the node, and evicts pods from the node if they are already running on the node. The matching toleration allows a pod to be scheduled onto the node, and to continue running on the node if `tolerationSeconds` is not specified. If `tolerationSeconds` is specified, the pod is evicted after this number of seconds. -For more information on using taints and tolerations, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. +For more information on using taints and tolerations, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. ### Example: Evicting CockroachDB from a running worker node @@ -380,7 +380,7 @@ spec: The `DoNotSchedule` condition prevents labeled pods from being scheduled onto Kubernetes worker nodes when doing so would fail to meet the spread and topology constraints specified with `maxSkew` and `topologyKey`, respectively. -For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. +For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the Operator. ## Resource labels and annotations @@ -394,7 +394,7 @@ spec: additionalLabels: app.kubernetes.io/version: {{page.release_info.version}} additionalAnnotations: - operator: https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + operator: https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ To verify that the labels and annotations were applied to a pod, for example, run `kubectl describe pod {pod-name}`. diff --git a/src/current/v25.2/configure-cockroachdb-kubernetes.md b/src/current/v25.2/configure-cockroachdb-kubernetes.md index 00cd0065fc1..ab37e67c44e 100644 --- a/src/current/v25.2/configure-cockroachdb-kubernetes.md +++ b/src/current/v25.2/configure-cockroachdb-kubernetes.md @@ -7,7 +7,7 @@ secure: true docs_area: deploy --- -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + This page explains how to configure Kubernetes cluster resources such as memory, CPU, and storage. @@ -287,5 +287,5 @@ spec: Changing the SQL Ingress `host` on a running deployment will cause a rolling restart of the cluster, due to new node certificates being generated for the SQL host. {{site.data.alerts.end}} -The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/blob/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the operator. +The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/blob/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the operator.
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 dc5120c6342..5ec1f238658 100644 --- a/src/current/v25.2/deploy-cockroachdb-with-kubernetes-openshift.md +++ b/src/current/v25.2/deploy-cockroachdb-with-kubernetes-openshift.md @@ -87,7 +87,7 @@ This article assumes you have already installed the OpenShift Container Platform ## Step 3. Start CockroachDB -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. When the operator is ready, click **View Operator** to navigate to the **Installed Operators** page. @@ -95,7 +95,7 @@ This article assumes you have already installed the OpenShift Container Platform OpenShift OperatorHub -1. Make sure **CockroachDB Version** is set to a valid CockroachDB version. For a list of compatible image names, see `spec.containers.env` in the [pulic operator manifest](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml) on GitHub. +1. Make sure **CockroachDB Version** is set to a valid CockroachDB version. For a list of compatible image names, see `spec.containers.env` in the [pulic operator manifest](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml) on GitHub. 1. This will open the **Create CrdbCluster** page. By default, this deploys a 3-node secure cluster. Leave the other fields unchanged and click **Create**. diff --git a/src/current/v25.2/scale-cockroachdb-kubernetes.md b/src/current/v25.2/scale-cockroachdb-kubernetes.md index 4c03460161e..daab277a4b1 100644 --- a/src/current/v25.2/scale-cockroachdb-kubernetes.md +++ b/src/current/v25.2/scale-cockroachdb-kubernetes.md @@ -218,13 +218,13 @@ To enable the {{ site.data.products.public-operator }} to automatically remove p This workflow is unsupported and should be enabled at your own risk. {{site.data.alerts.end}} -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. Download the {{ site.data.products.public-operator }} manifest: {% include_cached copy-clipboard.html %} ~~~ shell - $ curl -0 https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + $ curl -0 https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ 1. Uncomment the following lines in the {{ site.data.products.public-operator }} manifest: diff --git a/src/current/v25.2/schedule-cockroachdb-kubernetes.md b/src/current/v25.2/schedule-cockroachdb-kubernetes.md index dd67d369c5e..2df8e198ff3 100644 --- a/src/current/v25.2/schedule-cockroachdb-kubernetes.md +++ b/src/current/v25.2/schedule-cockroachdb-kubernetes.md @@ -32,9 +32,9 @@ These settings control how CockroachDB pods can be identified or scheduled onto ## Enable feature gates -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} -To enable the [affinity](#affinities-and-anti-affinities), [toleration](#taints-and-tolerations), and [topology spread constraint](#topology-spread-constraints) rules, [download the {{ site.data.products.public-operator }} manifest](https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml) and add the following line to the `spec.containers.args` field: + +To enable the [affinity](#affinities-and-anti-affinities), [toleration](#taints-and-tolerations), and [topology spread constraint](#topology-spread-constraints) rules, [download the {{ site.data.products.public-operator }} manifest](https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml) and add the following line to the `spec.containers.args` field: {% include_cached copy-clipboard.html %} ~~~ yaml @@ -112,7 +112,7 @@ The `requiredDuringSchedulingIgnoredDuringExecution` node affinity rule, using t The `preferredDuringSchedulingIgnoredDuringExecution` node affinity rule, using the `NotIn` operator and specified `weight`, discourages (but does not disallow) CockroachDB pods from being scheduled onto nodes with the label `topology.kubernetes.io/zone=us-east4-b`. This achieves a similar effect as a `PreferNoSchedule` [taint](#taints-and-tolerations). -For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. +For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. ### Add a pod affinity or anti-affinity @@ -150,7 +150,7 @@ The `preferredDuringSchedulingIgnoredDuringExecution` pod affinity rule, using t The `requiredDuringSchedulingIgnoredDuringExecution` pod anti-affinity rule, using the `In` operator, requires CockroachDB pods not to be co-located on a worker node, as specified with `topologyKey`. -For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. +For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. ### Example: Scheduling CockroachDB onto labeled nodes @@ -292,7 +292,7 @@ spec: A `NoExecute` taint on a node prevents pods from being scheduled onto the node, and evicts pods from the node if they are already running on the node. The matching toleration allows a pod to be scheduled onto the node, and to continue running on the node if `tolerationSeconds` is not specified. If `tolerationSeconds` is specified, the pod is evicted after this number of seconds. -For more information on using taints and tolerations, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. +For more information on using taints and tolerations, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. ### Example: Evicting CockroachDB from a running worker node @@ -390,7 +390,7 @@ spec: The `DoNotSchedule` condition prevents labeled pods from being scheduled onto Kubernetes worker nodes when doing so would fail to meet the spread and topology constraints specified with `maxSkew` and `topologyKey`, respectively. -For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. +For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. ## Resource labels and annotations @@ -404,7 +404,7 @@ spec: additionalLabels: app.kubernetes.io/version: {{page.release_info.version}} additionalAnnotations: - operator: https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + operator: https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ To verify that the labels and annotations were applied to a pod, for example, run `kubectl describe pod {pod-name}`. diff --git a/src/current/v25.3/configure-cockroachdb-kubernetes.md b/src/current/v25.3/configure-cockroachdb-kubernetes.md index 00cd0065fc1..ab37e67c44e 100644 --- a/src/current/v25.3/configure-cockroachdb-kubernetes.md +++ b/src/current/v25.3/configure-cockroachdb-kubernetes.md @@ -7,7 +7,7 @@ secure: true docs_area: deploy --- -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + This page explains how to configure Kubernetes cluster resources such as memory, CPU, and storage. @@ -287,5 +287,5 @@ spec: Changing the SQL Ingress `host` on a running deployment will cause a rolling restart of the cluster, due to new node certificates being generated for the SQL host. {{site.data.alerts.end}} -The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/blob/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the operator. +The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/blob/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the operator.
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 0ea67eb1c8d..ce49d17b5f2 100644 --- a/src/current/v25.3/deploy-cockroachdb-with-kubernetes-openshift.md +++ b/src/current/v25.3/deploy-cockroachdb-with-kubernetes-openshift.md @@ -87,7 +87,7 @@ This article assumes you have already installed the OpenShift Container Platform ## Step 3. Start CockroachDB -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. When the operator is ready, click **View Operator** to navigate to the **Installed Operators** page. @@ -95,7 +95,7 @@ This article assumes you have already installed the OpenShift Container Platform OpenShift OperatorHub -1. Make sure **CockroachDB Version** is set to a valid CockroachDB version. For a list of compatible image names, see `spec.containers.env` in the [pulic operator manifest](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml) on GitHub. +1. Make sure **CockroachDB Version** is set to a valid CockroachDB version. For a list of compatible image names, see `spec.containers.env` in the [pulic operator manifest](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml) on GitHub. 1. This will open the **Create CrdbCluster** page. By default, this deploys a 3-node secure cluster. Leave the other fields unchanged and click **Create**. diff --git a/src/current/v25.3/scale-cockroachdb-kubernetes.md b/src/current/v25.3/scale-cockroachdb-kubernetes.md index 4c03460161e..daab277a4b1 100644 --- a/src/current/v25.3/scale-cockroachdb-kubernetes.md +++ b/src/current/v25.3/scale-cockroachdb-kubernetes.md @@ -218,13 +218,13 @@ To enable the {{ site.data.products.public-operator }} to automatically remove p This workflow is unsupported and should be enabled at your own risk. {{site.data.alerts.end}} -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. Download the {{ site.data.products.public-operator }} manifest: {% include_cached copy-clipboard.html %} ~~~ shell - $ curl -0 https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + $ curl -0 https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ 1. Uncomment the following lines in the {{ site.data.products.public-operator }} manifest: diff --git a/src/current/v25.3/schedule-cockroachdb-kubernetes.md b/src/current/v25.3/schedule-cockroachdb-kubernetes.md index dd67d369c5e..2df8e198ff3 100644 --- a/src/current/v25.3/schedule-cockroachdb-kubernetes.md +++ b/src/current/v25.3/schedule-cockroachdb-kubernetes.md @@ -32,9 +32,9 @@ These settings control how CockroachDB pods can be identified or scheduled onto ## Enable feature gates -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} -To enable the [affinity](#affinities-and-anti-affinities), [toleration](#taints-and-tolerations), and [topology spread constraint](#topology-spread-constraints) rules, [download the {{ site.data.products.public-operator }} manifest](https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml) and add the following line to the `spec.containers.args` field: + +To enable the [affinity](#affinities-and-anti-affinities), [toleration](#taints-and-tolerations), and [topology spread constraint](#topology-spread-constraints) rules, [download the {{ site.data.products.public-operator }} manifest](https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml) and add the following line to the `spec.containers.args` field: {% include_cached copy-clipboard.html %} ~~~ yaml @@ -112,7 +112,7 @@ The `requiredDuringSchedulingIgnoredDuringExecution` node affinity rule, using t The `preferredDuringSchedulingIgnoredDuringExecution` node affinity rule, using the `NotIn` operator and specified `weight`, discourages (but does not disallow) CockroachDB pods from being scheduled onto nodes with the label `topology.kubernetes.io/zone=us-east4-b`. This achieves a similar effect as a `PreferNoSchedule` [taint](#taints-and-tolerations). -For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. +For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. ### Add a pod affinity or anti-affinity @@ -150,7 +150,7 @@ The `preferredDuringSchedulingIgnoredDuringExecution` pod affinity rule, using t The `requiredDuringSchedulingIgnoredDuringExecution` pod anti-affinity rule, using the `In` operator, requires CockroachDB pods not to be co-located on a worker node, as specified with `topologyKey`. -For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. +For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. ### Example: Scheduling CockroachDB onto labeled nodes @@ -292,7 +292,7 @@ spec: A `NoExecute` taint on a node prevents pods from being scheduled onto the node, and evicts pods from the node if they are already running on the node. The matching toleration allows a pod to be scheduled onto the node, and to continue running on the node if `tolerationSeconds` is not specified. If `tolerationSeconds` is specified, the pod is evicted after this number of seconds. -For more information on using taints and tolerations, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. +For more information on using taints and tolerations, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. ### Example: Evicting CockroachDB from a running worker node @@ -390,7 +390,7 @@ spec: The `DoNotSchedule` condition prevents labeled pods from being scheduled onto Kubernetes worker nodes when doing so would fail to meet the spread and topology constraints specified with `maxSkew` and `topologyKey`, respectively. -For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. +For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. ## Resource labels and annotations @@ -404,7 +404,7 @@ spec: additionalLabels: app.kubernetes.io/version: {{page.release_info.version}} additionalAnnotations: - operator: https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + operator: https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ To verify that the labels and annotations were applied to a pod, for example, run `kubectl describe pod {pod-name}`. diff --git a/src/current/v25.4/configure-cockroachdb-kubernetes.md b/src/current/v25.4/configure-cockroachdb-kubernetes.md index 00cd0065fc1..ab37e67c44e 100644 --- a/src/current/v25.4/configure-cockroachdb-kubernetes.md +++ b/src/current/v25.4/configure-cockroachdb-kubernetes.md @@ -7,7 +7,7 @@ secure: true docs_area: deploy --- -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + This page explains how to configure Kubernetes cluster resources such as memory, CPU, and storage. @@ -287,5 +287,5 @@ spec: Changing the SQL Ingress `host` on a running deployment will cause a rolling restart of the cluster, due to new node certificates being generated for the SQL host. {{site.data.alerts.end}} -The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/blob/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the operator. +The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/blob/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the operator.
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 2f88e50b23d..74e817d684f 100644 --- a/src/current/v25.4/deploy-cockroachdb-with-kubernetes-openshift.md +++ b/src/current/v25.4/deploy-cockroachdb-with-kubernetes-openshift.md @@ -87,7 +87,7 @@ This article assumes you have already installed the OpenShift Container Platform ## Step 3. Start CockroachDB -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. When the operator is ready, click **View Operator** to navigate to the **Installed Operators** page. @@ -95,7 +95,7 @@ This article assumes you have already installed the OpenShift Container Platform OpenShift OperatorHub -1. Make sure **CockroachDB Version** is set to a valid CockroachDB version. For a list of compatible image names, see `spec.containers.env` in the [pulic operator manifest](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml) on GitHub. +1. Make sure **CockroachDB Version** is set to a valid CockroachDB version. For a list of compatible image names, see `spec.containers.env` in the [pulic operator manifest](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml) on GitHub. 1. This will open the **Create CrdbCluster** page. By default, this deploys a 3-node secure cluster. Leave the other fields unchanged and click **Create**. diff --git a/src/current/v25.4/scale-cockroachdb-kubernetes.md b/src/current/v25.4/scale-cockroachdb-kubernetes.md index 4c03460161e..daab277a4b1 100644 --- a/src/current/v25.4/scale-cockroachdb-kubernetes.md +++ b/src/current/v25.4/scale-cockroachdb-kubernetes.md @@ -218,13 +218,13 @@ To enable the {{ site.data.products.public-operator }} to automatically remove p This workflow is unsupported and should be enabled at your own risk. {{site.data.alerts.end}} -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. Download the {{ site.data.products.public-operator }} manifest: {% include_cached copy-clipboard.html %} ~~~ shell - $ curl -0 https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + $ curl -0 https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ 1. Uncomment the following lines in the {{ site.data.products.public-operator }} manifest: diff --git a/src/current/v25.4/schedule-cockroachdb-kubernetes.md b/src/current/v25.4/schedule-cockroachdb-kubernetes.md index dd67d369c5e..2df8e198ff3 100644 --- a/src/current/v25.4/schedule-cockroachdb-kubernetes.md +++ b/src/current/v25.4/schedule-cockroachdb-kubernetes.md @@ -32,9 +32,9 @@ These settings control how CockroachDB pods can be identified or scheduled onto ## Enable feature gates -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} -To enable the [affinity](#affinities-and-anti-affinities), [toleration](#taints-and-tolerations), and [topology spread constraint](#topology-spread-constraints) rules, [download the {{ site.data.products.public-operator }} manifest](https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml) and add the following line to the `spec.containers.args` field: + +To enable the [affinity](#affinities-and-anti-affinities), [toleration](#taints-and-tolerations), and [topology spread constraint](#topology-spread-constraints) rules, [download the {{ site.data.products.public-operator }} manifest](https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml) and add the following line to the `spec.containers.args` field: {% include_cached copy-clipboard.html %} ~~~ yaml @@ -112,7 +112,7 @@ The `requiredDuringSchedulingIgnoredDuringExecution` node affinity rule, using t The `preferredDuringSchedulingIgnoredDuringExecution` node affinity rule, using the `NotIn` operator and specified `weight`, discourages (but does not disallow) CockroachDB pods from being scheduled onto nodes with the label `topology.kubernetes.io/zone=us-east4-b`. This achieves a similar effect as a `PreferNoSchedule` [taint](#taints-and-tolerations). -For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. +For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. ### Add a pod affinity or anti-affinity @@ -150,7 +150,7 @@ The `preferredDuringSchedulingIgnoredDuringExecution` pod affinity rule, using t The `requiredDuringSchedulingIgnoredDuringExecution` pod anti-affinity rule, using the `In` operator, requires CockroachDB pods not to be co-located on a worker node, as specified with `topologyKey`. -For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. +For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. ### Example: Scheduling CockroachDB onto labeled nodes @@ -292,7 +292,7 @@ spec: A `NoExecute` taint on a node prevents pods from being scheduled onto the node, and evicts pods from the node if they are already running on the node. The matching toleration allows a pod to be scheduled onto the node, and to continue running on the node if `tolerationSeconds` is not specified. If `tolerationSeconds` is specified, the pod is evicted after this number of seconds. -For more information on using taints and tolerations, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. +For more information on using taints and tolerations, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. ### Example: Evicting CockroachDB from a running worker node @@ -390,7 +390,7 @@ spec: The `DoNotSchedule` condition prevents labeled pods from being scheduled onto Kubernetes worker nodes when doing so would fail to meet the spread and topology constraints specified with `maxSkew` and `topologyKey`, respectively. -For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. +For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. ## Resource labels and annotations @@ -404,7 +404,7 @@ spec: additionalLabels: app.kubernetes.io/version: {{page.release_info.version}} additionalAnnotations: - operator: https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + operator: https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ To verify that the labels and annotations were applied to a pod, for example, run `kubectl describe pod {pod-name}`. diff --git a/src/current/v26.1/configure-cockroachdb-kubernetes.md b/src/current/v26.1/configure-cockroachdb-kubernetes.md index 00cd0065fc1..ab37e67c44e 100644 --- a/src/current/v26.1/configure-cockroachdb-kubernetes.md +++ b/src/current/v26.1/configure-cockroachdb-kubernetes.md @@ -7,7 +7,7 @@ secure: true docs_area: deploy --- -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + This page explains how to configure Kubernetes cluster resources such as memory, CPU, and storage. @@ -287,5 +287,5 @@ spec: Changing the SQL Ingress `host` on a running deployment will cause a rolling restart of the cluster, due to new node certificates being generated for the SQL host. {{site.data.alerts.end}} -The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/blob/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the operator. +The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/blob/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the operator.
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 163b9c15d3e..a9f79a33275 100644 --- a/src/current/v26.1/deploy-cockroachdb-with-kubernetes-openshift.md +++ b/src/current/v26.1/deploy-cockroachdb-with-kubernetes-openshift.md @@ -87,7 +87,7 @@ This article assumes you have already installed the OpenShift Container Platform ## Step 3. Start CockroachDB -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. When the operator is ready, click **View Operator** to navigate to the **Installed Operators** page. @@ -95,7 +95,7 @@ This article assumes you have already installed the OpenShift Container Platform OpenShift OperatorHub -1. Make sure **CockroachDB Version** is set to a valid CockroachDB version. For a list of compatible image names, see `spec.containers.env` in the [pulic operator manifest](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml) on GitHub. +1. Make sure **CockroachDB Version** is set to a valid CockroachDB version. For a list of compatible image names, see `spec.containers.env` in the [pulic operator manifest](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml) on GitHub. 1. This will open the **Create CrdbCluster** page. By default, this deploys a 3-node secure cluster. Leave the other fields unchanged and click **Create**. diff --git a/src/current/v26.1/scale-cockroachdb-kubernetes.md b/src/current/v26.1/scale-cockroachdb-kubernetes.md index 4c03460161e..daab277a4b1 100644 --- a/src/current/v26.1/scale-cockroachdb-kubernetes.md +++ b/src/current/v26.1/scale-cockroachdb-kubernetes.md @@ -218,13 +218,13 @@ To enable the {{ site.data.products.public-operator }} to automatically remove p This workflow is unsupported and should be enabled at your own risk. {{site.data.alerts.end}} -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. Download the {{ site.data.products.public-operator }} manifest: {% include_cached copy-clipboard.html %} ~~~ shell - $ curl -0 https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + $ curl -0 https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ 1. Uncomment the following lines in the {{ site.data.products.public-operator }} manifest: diff --git a/src/current/v26.1/schedule-cockroachdb-kubernetes.md b/src/current/v26.1/schedule-cockroachdb-kubernetes.md index dd67d369c5e..2df8e198ff3 100644 --- a/src/current/v26.1/schedule-cockroachdb-kubernetes.md +++ b/src/current/v26.1/schedule-cockroachdb-kubernetes.md @@ -32,9 +32,9 @@ These settings control how CockroachDB pods can be identified or scheduled onto ## Enable feature gates -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} -To enable the [affinity](#affinities-and-anti-affinities), [toleration](#taints-and-tolerations), and [topology spread constraint](#topology-spread-constraints) rules, [download the {{ site.data.products.public-operator }} manifest](https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml) and add the following line to the `spec.containers.args` field: + +To enable the [affinity](#affinities-and-anti-affinities), [toleration](#taints-and-tolerations), and [topology spread constraint](#topology-spread-constraints) rules, [download the {{ site.data.products.public-operator }} manifest](https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml) and add the following line to the `spec.containers.args` field: {% include_cached copy-clipboard.html %} ~~~ yaml @@ -112,7 +112,7 @@ The `requiredDuringSchedulingIgnoredDuringExecution` node affinity rule, using t The `preferredDuringSchedulingIgnoredDuringExecution` node affinity rule, using the `NotIn` operator and specified `weight`, discourages (but does not disallow) CockroachDB pods from being scheduled onto nodes with the label `topology.kubernetes.io/zone=us-east4-b`. This achieves a similar effect as a `PreferNoSchedule` [taint](#taints-and-tolerations). -For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. +For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. ### Add a pod affinity or anti-affinity @@ -150,7 +150,7 @@ The `preferredDuringSchedulingIgnoredDuringExecution` pod affinity rule, using t The `requiredDuringSchedulingIgnoredDuringExecution` pod anti-affinity rule, using the `In` operator, requires CockroachDB pods not to be co-located on a worker node, as specified with `topologyKey`. -For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. +For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. ### Example: Scheduling CockroachDB onto labeled nodes @@ -292,7 +292,7 @@ spec: A `NoExecute` taint on a node prevents pods from being scheduled onto the node, and evicts pods from the node if they are already running on the node. The matching toleration allows a pod to be scheduled onto the node, and to continue running on the node if `tolerationSeconds` is not specified. If `tolerationSeconds` is specified, the pod is evicted after this number of seconds. -For more information on using taints and tolerations, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. +For more information on using taints and tolerations, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. ### Example: Evicting CockroachDB from a running worker node @@ -390,7 +390,7 @@ spec: The `DoNotSchedule` condition prevents labeled pods from being scheduled onto Kubernetes worker nodes when doing so would fail to meet the spread and topology constraints specified with `maxSkew` and `topologyKey`, respectively. -For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. +For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. ## Resource labels and annotations @@ -404,7 +404,7 @@ spec: additionalLabels: app.kubernetes.io/version: {{page.release_info.version}} additionalAnnotations: - operator: https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + operator: https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ To verify that the labels and annotations were applied to a pod, for example, run `kubectl describe pod {pod-name}`. diff --git a/src/current/v26.2/configure-cockroachdb-kubernetes.md b/src/current/v26.2/configure-cockroachdb-kubernetes.md index 00cd0065fc1..ab37e67c44e 100644 --- a/src/current/v26.2/configure-cockroachdb-kubernetes.md +++ b/src/current/v26.2/configure-cockroachdb-kubernetes.md @@ -7,7 +7,7 @@ secure: true docs_area: deploy --- -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + This page explains how to configure Kubernetes cluster resources such as memory, CPU, and storage. @@ -287,5 +287,5 @@ spec: Changing the SQL Ingress `host` on a running deployment will cause a rolling restart of the cluster, due to new node certificates being generated for the SQL host. {{site.data.alerts.end}} -The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/blob/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the operator. +The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/blob/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the operator.
diff --git a/src/current/v26.2/deploy-cockroachdb-with-kubernetes-openshift.md b/src/current/v26.2/deploy-cockroachdb-with-kubernetes-openshift.md index 6a06dae04ee..f7392710f3b 100644 --- a/src/current/v26.2/deploy-cockroachdb-with-kubernetes-openshift.md +++ b/src/current/v26.2/deploy-cockroachdb-with-kubernetes-openshift.md @@ -87,7 +87,7 @@ This article assumes you have already installed the OpenShift Container Platform ## Step 3. Start CockroachDB -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. When the operator is ready, click **View Operator** to navigate to the **Installed Operators** page. @@ -95,7 +95,7 @@ This article assumes you have already installed the OpenShift Container Platform OpenShift OperatorHub -1. Make sure **CockroachDB Version** is set to a valid CockroachDB version. For a list of compatible image names, see `spec.containers.env` in the [pulic operator manifest](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml) on GitHub. +1. Make sure **CockroachDB Version** is set to a valid CockroachDB version. For a list of compatible image names, see `spec.containers.env` in the [pulic operator manifest](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml) on GitHub. 1. This will open the **Create CrdbCluster** page. By default, this deploys a 3-node secure cluster. Leave the other fields unchanged and click **Create**. diff --git a/src/current/v26.2/scale-cockroachdb-kubernetes.md b/src/current/v26.2/scale-cockroachdb-kubernetes.md index 4c03460161e..daab277a4b1 100644 --- a/src/current/v26.2/scale-cockroachdb-kubernetes.md +++ b/src/current/v26.2/scale-cockroachdb-kubernetes.md @@ -218,13 +218,13 @@ To enable the {{ site.data.products.public-operator }} to automatically remove p This workflow is unsupported and should be enabled at your own risk. {{site.data.alerts.end}} -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. Download the {{ site.data.products.public-operator }} manifest: {% include_cached copy-clipboard.html %} ~~~ shell - $ curl -0 https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + $ curl -0 https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ 1. Uncomment the following lines in the {{ site.data.products.public-operator }} manifest: diff --git a/src/current/v26.2/schedule-cockroachdb-kubernetes.md b/src/current/v26.2/schedule-cockroachdb-kubernetes.md index dd67d369c5e..2df8e198ff3 100644 --- a/src/current/v26.2/schedule-cockroachdb-kubernetes.md +++ b/src/current/v26.2/schedule-cockroachdb-kubernetes.md @@ -32,9 +32,9 @@ These settings control how CockroachDB pods can be identified or scheduled onto ## Enable feature gates -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} -To enable the [affinity](#affinities-and-anti-affinities), [toleration](#taints-and-tolerations), and [topology spread constraint](#topology-spread-constraints) rules, [download the {{ site.data.products.public-operator }} manifest](https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml) and add the following line to the `spec.containers.args` field: + +To enable the [affinity](#affinities-and-anti-affinities), [toleration](#taints-and-tolerations), and [topology spread constraint](#topology-spread-constraints) rules, [download the {{ site.data.products.public-operator }} manifest](https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml) and add the following line to the `spec.containers.args` field: {% include_cached copy-clipboard.html %} ~~~ yaml @@ -112,7 +112,7 @@ The `requiredDuringSchedulingIgnoredDuringExecution` node affinity rule, using t The `preferredDuringSchedulingIgnoredDuringExecution` node affinity rule, using the `NotIn` operator and specified `weight`, discourages (but does not disallow) CockroachDB pods from being scheduled onto nodes with the label `topology.kubernetes.io/zone=us-east4-b`. This achieves a similar effect as a `PreferNoSchedule` [taint](#taints-and-tolerations). -For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. +For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. ### Add a pod affinity or anti-affinity @@ -150,7 +150,7 @@ The `preferredDuringSchedulingIgnoredDuringExecution` pod affinity rule, using t The `requiredDuringSchedulingIgnoredDuringExecution` pod anti-affinity rule, using the `In` operator, requires CockroachDB pods not to be co-located on a worker node, as specified with `topologyKey`. -For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. +For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. ### Example: Scheduling CockroachDB onto labeled nodes @@ -292,7 +292,7 @@ spec: A `NoExecute` taint on a node prevents pods from being scheduled onto the node, and evicts pods from the node if they are already running on the node. The matching toleration allows a pod to be scheduled onto the node, and to continue running on the node if `tolerationSeconds` is not specified. If `tolerationSeconds` is specified, the pod is evicted after this number of seconds. -For more information on using taints and tolerations, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. +For more information on using taints and tolerations, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. ### Example: Evicting CockroachDB from a running worker node @@ -390,7 +390,7 @@ spec: The `DoNotSchedule` condition prevents labeled pods from being scheduled onto Kubernetes worker nodes when doing so would fail to meet the spread and topology constraints specified with `maxSkew` and `topologyKey`, respectively. -For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. +For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. ## Resource labels and annotations @@ -404,7 +404,7 @@ spec: additionalLabels: app.kubernetes.io/version: {{page.release_info.version}} additionalAnnotations: - operator: https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + operator: https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ To verify that the labels and annotations were applied to a pod, for example, run `kubectl describe pod {pod-name}`. diff --git a/src/current/v26.3/configure-cockroachdb-kubernetes.md b/src/current/v26.3/configure-cockroachdb-kubernetes.md index 00cd0065fc1..ab37e67c44e 100644 --- a/src/current/v26.3/configure-cockroachdb-kubernetes.md +++ b/src/current/v26.3/configure-cockroachdb-kubernetes.md @@ -7,7 +7,7 @@ secure: true docs_area: deploy --- -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + This page explains how to configure Kubernetes cluster resources such as memory, CPU, and storage. @@ -287,5 +287,5 @@ spec: Changing the SQL Ingress `host` on a running deployment will cause a rolling restart of the cluster, due to new node certificates being generated for the SQL host. {{site.data.alerts.end}} -The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/blob/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the operator. +The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/blob/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the operator.
diff --git a/src/current/v26.3/deploy-cockroachdb-with-kubernetes-openshift.md b/src/current/v26.3/deploy-cockroachdb-with-kubernetes-openshift.md index 91772f6296f..28b3911665c 100644 --- a/src/current/v26.3/deploy-cockroachdb-with-kubernetes-openshift.md +++ b/src/current/v26.3/deploy-cockroachdb-with-kubernetes-openshift.md @@ -87,7 +87,7 @@ This article assumes you have already installed the OpenShift Container Platform ## Step 3. Start CockroachDB -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. When the operator is ready, click **View Operator** to navigate to the **Installed Operators** page. @@ -95,7 +95,7 @@ This article assumes you have already installed the OpenShift Container Platform OpenShift OperatorHub -1. Make sure **CockroachDB Version** is set to a valid CockroachDB version. For a list of compatible image names, see `spec.containers.env` in the [pulic operator manifest](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml) on GitHub. +1. Make sure **CockroachDB Version** is set to a valid CockroachDB version. For a list of compatible image names, see `spec.containers.env` in the [pulic operator manifest](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml) on GitHub. 1. This will open the **Create CrdbCluster** page. By default, this deploys a 3-node secure cluster. Leave the other fields unchanged and click **Create**. diff --git a/src/current/v26.3/scale-cockroachdb-kubernetes.md b/src/current/v26.3/scale-cockroachdb-kubernetes.md index 4c03460161e..daab277a4b1 100644 --- a/src/current/v26.3/scale-cockroachdb-kubernetes.md +++ b/src/current/v26.3/scale-cockroachdb-kubernetes.md @@ -218,13 +218,13 @@ To enable the {{ site.data.products.public-operator }} to automatically remove p This workflow is unsupported and should be enabled at your own risk. {{site.data.alerts.end}} -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} + 1. Download the {{ site.data.products.public-operator }} manifest: {% include_cached copy-clipboard.html %} ~~~ shell - $ curl -0 https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + $ curl -0 https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ 1. Uncomment the following lines in the {{ site.data.products.public-operator }} manifest: diff --git a/src/current/v26.3/schedule-cockroachdb-kubernetes.md b/src/current/v26.3/schedule-cockroachdb-kubernetes.md index dd67d369c5e..2df8e198ff3 100644 --- a/src/current/v26.3/schedule-cockroachdb-kubernetes.md +++ b/src/current/v26.3/schedule-cockroachdb-kubernetes.md @@ -32,9 +32,9 @@ These settings control how CockroachDB pods can be identified or scheduled onto ## Enable feature gates -{% capture latest_operator_version %}{% include_cached latest_operator_version.md %}{% endcapture %} -To enable the [affinity](#affinities-and-anti-affinities), [toleration](#taints-and-tolerations), and [topology spread constraint](#topology-spread-constraints) rules, [download the {{ site.data.products.public-operator }} manifest](https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml) and add the following line to the `spec.containers.args` field: + +To enable the [affinity](#affinities-and-anti-affinities), [toleration](#taints-and-tolerations), and [topology spread constraint](#topology-spread-constraints) rules, [download the {{ site.data.products.public-operator }} manifest](https://raw.githubusercontent.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml) and add the following line to the `spec.containers.args` field: {% include_cached copy-clipboard.html %} ~~~ yaml @@ -112,7 +112,7 @@ The `requiredDuringSchedulingIgnoredDuringExecution` node affinity rule, using t The `preferredDuringSchedulingIgnoredDuringExecution` node affinity rule, using the `NotIn` operator and specified `weight`, discourages (but does not disallow) CockroachDB pods from being scheduled onto nodes with the label `topology.kubernetes.io/zone=us-east4-b`. This achieves a similar effect as a `PreferNoSchedule` [taint](#taints-and-tolerations). -For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. +For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. ### Add a pod affinity or anti-affinity @@ -150,7 +150,7 @@ The `preferredDuringSchedulingIgnoredDuringExecution` pod affinity rule, using t The `requiredDuringSchedulingIgnoredDuringExecution` pod anti-affinity rule, using the `In` operator, requires CockroachDB pods not to be co-located on a worker node, as specified with `topologyKey`. -For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. +For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. ### Example: Scheduling CockroachDB onto labeled nodes @@ -292,7 +292,7 @@ spec: A `NoExecute` taint on a node prevents pods from being scheduled onto the node, and evicts pods from the node if they are already running on the node. The matching toleration allows a pod to be scheduled onto the node, and to continue running on the node if `tolerationSeconds` is not specified. If `tolerationSeconds` is specified, the pod is evicted after this number of seconds. -For more information on using taints and tolerations, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. +For more information on using taints and tolerations, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. ### Example: Evicting CockroachDB from a running worker node @@ -390,7 +390,7 @@ spec: The `DoNotSchedule` condition prevents labeled pods from being scheduled onto Kubernetes worker nodes when doing so would fail to meet the spread and topology constraints specified with `maxSkew` and `topologyKey`, respectively. -For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. +For more context on how these rules work, see the [Kubernetes documentation](https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/). The [custom resource definition](https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml) details the fields supported by the {{ site.data.products.public-operator }}. ## Resource labels and annotations @@ -404,7 +404,7 @@ spec: additionalLabels: app.kubernetes.io/version: {{page.release_info.version}} additionalAnnotations: - operator: https://raw.github.com/cockroachdb/cockroach-operator/v{{ latest_operator_version }}/install/operator.yaml + operator: https://raw.github.com/cockroachdb/cockroach-operator/v2.18.3/install/operator.yaml ~~~ To verify that the labels and annotations were applied to a pod, for example, run `kubectl describe pod {pod-name}`.