K8s docs updates and initial reorganization #10578
Conversation
|
This change is |
|
✔️ Netlify Preview 🔨 Explore the source changes: 579acc7 🔍 Inspect the deploy log: https://app.netlify.com/sites/cockroachdb-docs/deploys/60c285635003970008427a59 😎 Browse the preview: https://deploy-preview-10578--cockroachdb-docs.netlify.app |
|
Files changed: _includes/sidebar-data-v21.1.json |
|
Files changed: _includes/sidebar-data-v21.1.json |
1 similar comment
|
Files changed: _includes/sidebar-data-v21.1.json |
|
Files changed: _includes/sidebar-data-v21.1.json |
|
@keith-mcclellan @udnay You can check a preview of the updated docs here: https://deploy-preview-10578--cockroachdb-docs.netlify.app/docs/v21.1/operate-cockroachdb-kubernetes.html |
|
@keith-mcclellan @udnay Friendly ping on this docs review. It's definitely a lot of widespread changes, but the main docs that need review are:
I'd like to ensure these are in good shape for the Operator GA release. Also, there are a number of custom resource fields not yet documented here. If you think any are must-haves to document for GA, please let me know here. |
| {{site.data.alerts.callout_success}}The documentation offers the choice of using Google's Cloud Shell product or using a local shell on your machine. Choose to use a local shell if you want to be able to view the CockroachDB Admin UI using the steps in this guide.{{site.data.alerts.end}} | ||
|
|
||
| 2. From your local workstation, start the Kubernetes cluster: | ||
|
|
||
| {% include copy-clipboard.html %} | ||
| ~~~ shell | ||
| $ gcloud container clusters create cockroachdb --machine-type n1-standard-4 | ||
| $ gcloud container clusters create cockroachdb --machine-type n2-standard-4 |
There was a problem hiding this comment.
This creates a zonal cluster and not a regional one, we should maybe note that regional is recommended for production use.
| ... | ||
| ~~~ | ||
|
|
||
| 1. This will continue until all of the pods have restarted and are running the new image. To check the image of each pod to determine whether they've all be upgraded, run: |
There was a problem hiding this comment.
Should we mention that the process takes time because the operator ensures that CRDB does not lose quorum due to the upgrade process?
| ~~~ | ||
|
|
||
| ~~~ | ||
| persistentvolumeclaim "datadir-cockroachdb-3" deleted |
There was a problem hiding this comment.
Doesn't the operator do this now? It will during the operators next action /cc @keith-mcclellan
There was a problem hiding this comment.
We should make a specific section here for the operator. This is correct for the other install patterns
| @@ -57,13 +50,12 @@ You can expand certain [types of persistent volumes](https://kubernetes.io/docs/ | |||
| storageclass.storage.k8s.io/standard patched | |||
| ~~~ | |||
|
|
|||
| 3. Edit one of the persistent volume claims to request more space: | |||
| 1. Edit one of the persistent volume claims to request more space: | |||
| 1. The CockroachDB cluster needs to be expanded one node at a time. Repeat steps 3 - 6 to increase the capacities of the remaining volumes by the same amount. |
There was a problem hiding this comment.
I'm guessing these are auto-generated now
There was a problem hiding this comment.
Only if the customer is using a storage class. If they statically provisioned the PVs this is still correct.
| {% include copy-clipboard.html %} | ||
| ~~~ shell | ||
| $ kubectl exec -it cockroachdb-client-secure \ | ||
| -- ./cockroach node decommission 4 \ |
There was a problem hiding this comment.
@keith-mcclellan this didn't work for the operator, does this need to be updated?
There was a problem hiding this comment.
the helm chart is still co-presenting GRPC and SQL on 26257, so this command will still work there.
| @@ -17,86 +13,58 @@ The Operator is currently supported for GKE only. | |||
|
|
|||
| 1. Apply the Operator manifest: | |||
|
|
|||
| {{site.data.alerts.callout_info}} | |||
| By default, the Operator is configured to install in the `default` namespace. To use the Operator in a custom namespace, download the [Operator manifest](https://github.com/cockroachdb/cockroach-operator/blob/master/manifests/operator.yaml) and edit all instances of `namespace: default` to specify your custom namespace. Then apply this version of the manifest to the cluster with `kubectl apply -f {local-file-path}` instead of using the command below. | |||
There was a problem hiding this comment.
Maybe a callout that the operator can only install CRDB into the same namespace that it is installed in?
|
|
||
| - [Hosted GKE](#hosted-gke) | ||
| - [Hosted EKS](#hosted-eks) | ||
| - [Manual GCE](#manual-gce) | ||
| - [Manual AWS](#manual-aws) | ||
|
|
||
| {{site.data.alerts.callout_info}} | ||
| The CockroachDB Kubernetes Operator is currently supported for GKE only. |
There was a problem hiding this comment.
Should we add openshift here? @keith-mcclellan
There was a problem hiding this comment.
yes, and we should link to the openshift specific docs. good catch!
There was a problem hiding this comment.
Reviewable status:
complete! 0 of 0 LGTMs obtained (waiting on @johnrk, @keith-mcclellan, and @udnay)
_includes/v20.1/orchestration/start-kubernetes.md, line 24 at r5 (raw file):
Previously, udnay (Yandu Oppacher) wrote…
This creates a zonal cluster and not a regional one, we should maybe note that
regionalis recommended for production use.
@udnay Since this doc is aimed at production deployments, I'd like to just use the regional instructions here. But is it currently possible to use a regional cluster with CRDB on any of our install patterns? My understanding was that we would need each node to define a separate AZ in its --locality flag, which doesn't seem to be how the Operator, manual configs, and Helm chart work.
Also, what should be the correct regional settings? From the doc https://cloud.google.com/kubernetes-engine/docs/how-to/creating-a-regional-cluster, I gather gcloud container clusters create cockroachdb --machine-type n2-standard-4 --num-nodes 1 --region us-west1 creates a regional cluster with 3 zones and 1 node in each zone. Would this also affect how we later add and removes nodes in the cluster?
_includes/v20.2/orchestration/kubernetes-operator-upgrade-cluster.md, line 77 at r5 (raw file):
Previously, keith-mcclellan (Keith) wrote…
yes
Done.
_includes/v20.2/orchestration/kubernetes-remove-nodes-secure.md, line 139 at r5 (raw file):
Previously, keith-mcclellan (Keith) wrote…
We should make a specific section here for the operator. This is correct for the other install patterns
Sorry this was confusing. This is the old v20.2 doc that no longer appears in v21.1 (which correctly states that the Operator deletes the PVC for the node). I've now corrected the v20.2 doc.
_includes/v21.1/orchestration/start-cockroachdb-operator-secure.md, line 17 at r5 (raw file):
Previously, keith-mcclellan (Keith) wrote…
👍
Done.
_includes/v21.1/orchestration/start-kubernetes.md, line 9 at r5 (raw file):
Previously, keith-mcclellan (Keith) wrote…
yes, and we should link to the openshift specific docs. good catch!
Done.
_includes/v21.1/orchestration/kubernetes-expand-disk-helm.md, line 53 at r5 (raw file):
Previously, udnay (Yandu Oppacher) wrote…
Numbering?
Our docs convention is to use 1. throughout ordered lists - they are automatically numbered correctly on the rendered page.
66065: cloud: uncomment and fix default CPU resources in K8s configs r=chrisseto a=taroface Relates to cockroachdb/docs#10578. The default CPU resource limit/request was too large in the StatefulSet configs (I think I introduced this error previously). The updated value makes sense for the `n2-standard-4` machines we use in our deployment tutorials, and the CPU/memory ratio is consistent with our recommendation in the [Production Checklist](https://www.cockroachlabs.com/docs/stable/recommended-production-settings.html). Also uncommented the `resources` object, since we recommend always defining resource requests/limits explicitly. The updated docs in cockroachdb/docs#10578 make it clear that these values should be tailored to a production deployment. cc @udnay Co-authored-by: taroface <[email protected]>
For the sake of expediency, I'm going to save regional vs. zonal instructions for #10479 and move ahead with the updates here. |
|
|
||
| 1. Start the CockroachDB [built-in SQL client](cockroach-sql.html): | ||
|
|
||
| {% include copy-clipboard.html %} |
There was a problem hiding this comment.
| {% include copy-clipboard.html %} | |
| {% include_cached copy-clipboard.html %} |
|
|
||
| 1. Set the `cluster.preserve_downgrade_option` [cluster setting](cluster-settings.html) to the version you are upgrading from: | ||
|
|
||
| {% include copy-clipboard.html %} |
There was a problem hiding this comment.
| {% include copy-clipboard.html %} | |
| {% include_cached copy-clipboard.html %} |
|
|
||
| 1. Exit the SQL shell and pod: | ||
|
|
||
| {% include copy-clipboard.html %} |
There was a problem hiding this comment.
| {% include copy-clipboard.html %} | |
| {% include_cached copy-clipboard.html %} |
|
|
||
| Open and edit `example.yaml`: | ||
|
|
||
| {% include copy-clipboard.html %} |
There was a problem hiding this comment.
| {% include copy-clipboard.html %} | |
| {% include_cached copy-clipboard.html %} |
| $ vi example.yaml | ||
| ~~~ | ||
|
|
||
| ~~~ |
There was a problem hiding this comment.
| ~~~ | |
| {% include_cached copy-clipboard.html %} | |
| ~~~ |
| - Under **Node Status**, make sure all nodes that should be live are listed as such. If any nodes are unexpectedly listed as suspect or dead, identify why the nodes are offline and either restart them or [decommission](#remove-nodes) them before beginning your upgrade. If there are dead and non-decommissioned nodes in your cluster, it will not be possible to finalize the upgrade (either automatically or manually). | ||
| - Under **Replication Status**, make sure there are 0 under-replicated and unavailable ranges. Otherwise, performing a rolling upgrade increases the risk that ranges will lose a majority of their replicas and cause cluster unavailability. Therefore, it's important to identify and resolve the cause of range under-replication and/or unavailability before beginning your upgrade. | ||
| - In the **Node List**: | ||
| - Make sure all nodes are on the same version. If any nodes are behind, upgrade them to the cluster's current version first, and then start this process over. |
There was a problem hiding this comment.
| - Make sure all nodes are on the same version. If any nodes are behind, upgrade them to the cluster's current version first, and then start this process over. | |
| - Make sure all nodes are on the same version. If not all nodes are on the same version, upgrade them to the cluster's highest current version first, and then start this process over. |
|
|
||
| 1. Verify that all pods have been upgraded by running: | ||
|
|
||
| {% include copy-clipboard.html %} |
There was a problem hiding this comment.
| {% include copy-clipboard.html %} | |
| {% include_cached copy-clipboard.html %} |
|
|
||
| 1. Start the CockroachDB [built-in SQL client](cockroach-sql.html). For example, if you followed the steps in [Deploy CockroachDB with Kubernetes](deploy-cockroachdb-with-kubernetes.html#step-3-use-the-built-in-sql-client) to launch a secure client pod, get a shell into the `cockroachdb-client-secure` pod: | ||
|
|
||
| {% include copy-clipboard.html %} |
There was a problem hiding this comment.
| {% include copy-clipboard.html %} | |
| {% include_cached copy-clipboard.html %} |
|
|
||
| 1. Re-enable auto-finalization: | ||
|
|
||
| {% include copy-clipboard.html %} |
There was a problem hiding this comment.
| {% include copy-clipboard.html %} | |
| {% include_cached copy-clipboard.html %} |
|
|
||
| 1. Exit the SQL shell and pod: | ||
|
|
||
| {% include copy-clipboard.html %} |
There was a problem hiding this comment.
| {% include copy-clipboard.html %} | |
| {% include_cached copy-clipboard.html %} |
There was a problem hiding this comment.
TFTR Ian! Only thing I didn't do was format StatefulSet, which I believe is used pretty colloquially in K8s land and IMO doesn't require the special code formatting.
Reviewable status:
_includes/v20.2/orchestration/kubernetes-operator-upgrade-cluster.md, line 17 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v20.2/orchestration/kubernetes-operator-upgrade-cluster.md, line 26 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v20.2/orchestration/kubernetes-operator-upgrade-cluster.md, line 33 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v20.2/orchestration/kubernetes-operator-upgrade-cluster.md, line 42 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v20.2/orchestration/kubernetes-operator-upgrade-cluster.md, line 47 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %} ~~~
Done.
_includes/v20.2/orchestration/kubernetes-operator-upgrade-cluster.md, line 54 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v20.2/orchestration/kubernetes-operator-upgrade-cluster.md, line 63 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v20.2/orchestration/kubernetes-operator-upgrade-cluster.md, line 79 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v20.2/orchestration/kubernetes-operator-upgrade-cluster.md, line 107 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v20.2/orchestration/kubernetes-operator-upgrade-cluster.md, line 116 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v20.2/orchestration/kubernetes-operator-upgrade-cluster.md, line 123 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v20.2/orchestration/kubernetes-remove-nodes-secure.md, line 275 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v20.2/orchestration/kubernetes-remove-nodes-secure.md, line 290 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v20.2/orchestration/kubernetes-remove-nodes-secure.md, line 303 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-cockroach-cert.md, line 7 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-cockroach-cert.md, line 19 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-cockroach-cert.md, line 28 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-cockroach-cert.md, line 38 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-cockroach-cert.md, line 51 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-cockroach-cert.md, line 67 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-cockroach-cert.md, line 80 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-expand-disk-manual.md, line 10 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-expand-disk-manual.md, line 24 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-expand-disk-manual.md, line 44 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-expand-disk-manual.md, line 59 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-expand-disk-manual.md, line 70 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-expand-disk-manual.md, line 88 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-expand-disk-manual.md, line 99 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-expand-disk-manual.md, line 108 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-remove-nodes-helm.md, line 9 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-remove-nodes-helm.md, line 29 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
1. Use the [`cockroach node decommission`](cockroach-node.html) command to decommission the node with the highest number in its address, specifying its ID (in this example, node ID `4` because its address is `my-release-cockroachdb-3`):
Done.
_includes/v21.1/orchestration/kubernetes-remove-nodes-helm.md, line 32 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
You must decommission the node with the highest number in its address. Kubernetes will remove the pod for the node with the highest number in its address when you reduce the replica count.
Done.
_includes/v21.1/orchestration/kubernetes-remove-nodes-helm.md, line 35 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-remove-nodes-helm.md, line 63 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
1. Once the node has been decommissioned, scale down your `StatefulSet`:
Going to leave this unformatted, as it is used pretty informally.
_includes/v21.1/orchestration/kubernetes-remove-nodes-helm.md, line 65 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-remove-nodes-helm.md, line 76 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-remove-nodes-helm.md, line 92 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-remove-nodes-helm.md, line 107 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-remove-nodes-helm.md, line 120 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-remove-nodes-manual.md, line 9 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-remove-nodes-manual.md, line 29 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
1. Use the [`cockroach node decommission`](cockroach-node.html) command to decommission the node with the highest number in its address, specifying its ID (in this example, node ID `4` because its address is `my-release-cockroachdb-3`):
Done.
_includes/v21.1/orchestration/kubernetes-remove-nodes-manual.md, line 32 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
You must decommission the node with the highest number in its address. Kubernetes will remove the pod for the node with the highest number in its address when you reduce the replica count.
Done.
_includes/v21.1/orchestration/kubernetes-remove-nodes-manual.md, line 35 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-remove-nodes-manual.md, line 63 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
1. Once the node has been decommissioned, scale down your `StatefulSet`:
Same comment as above.
_includes/v21.1/orchestration/kubernetes-remove-nodes-manual.md, line 65 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-remove-nodes-manual.md, line 76 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-remove-nodes-manual.md, line 92 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-remove-nodes-manual.md, line 107 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-remove-nodes-manual.md, line 120 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-scale-cluster-helm.md, line 7 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-scale-cluster-helm.md, line 41 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-scale-cluster-helm.md, line 63 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-scale-cluster-helm.md, line 92 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-scale-cluster-helm.md, line 103 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-scale-cluster-manual.md, line 13 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-scale-cluster-manual.md, line 24 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-helm.md, line 15 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
Do we have any docs on how to identify the causes of under-replication or unavailable ranges?
Yes. Good call!
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-helm.md, line 17 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
- Make sure all nodes are on the same version. If not all nodes are on the same version, upgrade them to the cluster's highest current version first, and then start this process over.
Done.
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-helm.md, line 34 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-helm.md, line 46 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-helm.md, line 61 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-helm.md, line 68 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-helm.md, line 73 at r6 (raw file):
- Add a partition to the update strategy defined in the
StatefulSet. Only the pods numbered greater than or equal to the partition value will be updated. For a cluster with 3 pods (e.g.,cockroachdb-0,cockroachdb-1,cockroachdb-2) the partition value should be 2:
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-helm.md, line 75 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-helm.md, line 89 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-helm.md, line 94 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-helm.md, line 105 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-helm.md, line 127 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-helm.md, line 137 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-helm.md, line 151 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-helm.md, line 167 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-helm.md, line 174 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-helm.md, line 186 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-helm.md, line 216 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-helm.md, line 228 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-helm.md, line 243 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-helm.md, line 250 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-manual.md, line 15 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
Same comment as with the Helm version. Ideally we should direct users to some docs about solving this.
Done.
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-manual.md, line 17 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
- Make sure all nodes are on the same version. If not all nodes are on the same version, upgrade them to the cluster's highest current version first, and then start this process over.
Done.
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-manual.md, line 34 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-manual.md, line 45 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-manual.md, line 60 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-manual.md, line 67 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-manual.md, line 74 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-manual.md, line 86 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-manual.md, line 99 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-manual.md, line 115 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-manual.md, line 124 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-manual.md, line 139 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-manual.md, line 155 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-manual.md, line 162 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-manual.md, line 176 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-manual.md, line 205 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-manual.md, line 217 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-manual.md, line 232 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-upgrade-cluster-manual.md, line 239 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/monitor-cluster.md, line 10 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/start-cockroachdb-operator-secure.md, line 43 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/start-cockroachdb-operator-secure.md, line 57 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/start-cockroachdb-operator-secure.md, line 68 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/start-cockroachdb-operator-secure.md, line 81 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/start-cockroachdb-secure.md, line 5 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/start-cockroachdb-secure.md, line 14 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %} ~~~ yaml
Done.
_includes/v21.1/orchestration/start-cockroachdb-secure.md, line 35 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/start-cockroachdb-secure.md, line 68 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/start-cockroachdb-secure.md, line 82 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/start-cockroachdb-secure.md, line 95 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/start-kubernetes.md, line 28 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/test-cluster-secure.md, line 4 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/test-cluster-secure.md, line 12 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/test-cluster-secure.md, line 25 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
Should this be a v21.1 version?
Nice catch, fixed.
_includes/v21.1/orchestration/test-cluster-secure.md, line 37 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
v21.1/kubernetes-performance.md, line 441 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
Should this link to the 20.2 version of that doc?
Yes, because this step is no longer documented in v21.1 due to a K8s change. This doc is also due for an overhaul, but I had to fix the link in the meantime.
v21.1/kubernetes-performance.md, line 443 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
Should this link to the 20.2 version of that doc?
Ditto.
v21.1/monitor-cockroachdb-kubernetes.md, line 27 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
v21.1/monitor-cockroachdb-kubernetes.md, line 40 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
v21.1/monitor-cockroachdb-kubernetes.md, line 53 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
v21.1/monitor-cockroachdb-kubernetes.md, line 68 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
We recommend checking for the latest Prometheus Operator [release version](https://github.com/prometheus-operator/prometheus-operator/blob/master/RELEASE.md) and specifying this version in the following command.
Done.
v21.1/monitor-cockroachdb-kubernetes.md, line 71 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
v21.1/monitor-cockroachdb-kubernetes.md, line 95 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
v21.1/monitor-cockroachdb-kubernetes.md, line 107 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
v21.1/monitor-cockroachdb-kubernetes.md, line 116 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
v21.1/monitor-cockroachdb-kubernetes.md, line 133 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
v21.1/monitor-cockroachdb-kubernetes.md, line 160 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
v21.1/monitor-cockroachdb-kubernetes.md, line 162 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
Why so many Os?
Such a good question... Fixed.
v21.1/monitor-cockroachdb-kubernetes.md, line 170 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
v21.1/monitor-cockroachdb-kubernetes.md, line 180 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
v21.1/monitor-cockroachdb-kubernetes.md, line 195 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
v21.1/monitor-cockroachdb-kubernetes.md, line 210 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
v21.1/monitor-cockroachdb-kubernetes.md, line 225 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
v21.1/monitor-cockroachdb-kubernetes.md, line 247 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
v21.1/operate-cockroachdb-kubernetes.md, line 81 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
v21.1/operate-cockroachdb-kubernetes.md, line 442 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
v21.1/operate-cockroachdb-kubernetes.md, line 523 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
Same comment as before on user guidance.
Done.
v21.1/operate-cockroachdb-kubernetes.md, line 525 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
- Make sure all nodes are on the same version. If not all nodes are on the same version, upgrade them to the cluster's highest current version first, and then start this process over.
Done.
v21.1/operate-cockroachdb-kubernetes.md, line 551 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
v21.1/operate-cockroachdb-kubernetes.md, line 571 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
v21.1/operate-cockroachdb-kubernetes.md, line 580 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
v21.1/operate-cockroachdb-kubernetes.md, line 587 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-expand-disk-helm.md, line 24 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-expand-disk-helm.md, line 70 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-expand-disk-helm.md, line 88 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-expand-disk-helm.md, line 99 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
_includes/v21.1/orchestration/kubernetes-expand-disk-helm.md, line 108 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
v21.1/deploy-cockroachdb-with-kubernetes-insecure.md, line 130 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
v21.1/deploy-cockroachdb-with-kubernetes-insecure.md, line 136 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
v21.1/deploy-cockroachdb-with-kubernetes-insecure.md, line 142 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
v21.1/deploy-cockroachdb-with-kubernetes-insecure.md, line 148 at r6 (raw file):
Previously, ianjevans (Ian Evans) wrote…
{% include_cached copy-clipboard.html %}
Done.
Separate the "Orchestrate" single-cluster tutorial into 3 articles:
The second article was needed in order to more effectively document the custom resources in the Operator. For manual configs and Helm, the article reuses the content from the "Orchestrate" tutorial.
Also fixed various issues that were reported during the bug bash and previously.
Still pending:
Rotating certificatesWill address in a separate PRFixes cockroachdb/cockroach-operator#472
Fixes cockroachdb/cockroach-operator#471
Fixes #10429
Fixes #9828
Fixes #8889
Fixes cockroachdb/cockroach-operator#461
Fixes #9778
Fixes #9777
Fixes cockroachdb/cockroach-operator#506
Fixes cockroachdb/cockroach-operator#469
Fixes #9787
Fixes #10011
Fixes #8888
Fixes #10323
Fixes cockroachdb/cockroach-operator#468