Skip to content

Update k8s tutorials #4805

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 15, 2019
Merged

Update k8s tutorials #4805

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
246 changes: 246 additions & 0 deletions _includes/metric-names.md
View file
Open in desktop

Large diffs are not rendered by default.

15 changes: 10 additions & 5 deletions _includes/v19.1/orchestration/kubernetes-prometheus-alertmanager.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@ If you're on Hosted GKE, before starting, make sure the email address associated

{% include copy-clipboard.html %}
~~~ shell
$ kubectl apply -f https://raw.githubusercontent.com/coreos/prometheus-operator/release-0.20/bundle.yaml
$ kubectl apply \
-f https://raw.githubusercontent.com/coreos/prometheus-operator/release-0.20/bundle.yaml
~~~

~~~
Expand All @@ -68,7 +69,8 @@ If you're on Hosted GKE, before starting, make sure the email address associated

{% include copy-clipboard.html %}
~~~ shell
$ kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach/master/cloud/kubernetes/prometheus/prometheus.yaml
$ kubectl apply \
-f https://raw.githubusercontent.com/cockroachdb/cockroach/master/cloud/kubernetes/prometheus/prometheus.yaml
~~~

~~~
Expand Down Expand Up @@ -115,7 +117,8 @@ Active monitoring helps you spot problems early, but it is also essential to sen

{% include copy-clipboard.html %}
~~~ shell
$ kubectl create secret generic alertmanager-cockroachdb --from-file=alertmanager.yaml=alertmanager-config.yaml
$ kubectl create secret generic alertmanager-cockroachdb \
--from-file=alertmanager.yaml=alertmanager-config.yaml
~~~

~~~
Expand All @@ -139,7 +142,8 @@ Active monitoring helps you spot problems early, but it is also essential to sen

{% include copy-clipboard.html %}
~~~ shell
$ kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach/master/cloud/kubernetes/prometheus/alertmanager.yaml
$ kubectl apply \
-f https://raw.githubusercontent.com/cockroachdb/cockroach/master/cloud/kubernetes/prometheus/alertmanager.yaml
~~~

~~~
Expand Down Expand Up @@ -168,7 +172,8 @@ Active monitoring helps you spot problems early, but it is also essential to sen

{% include copy-clipboard.html %}
~~~ shell
$ kubectl apply -f https://raw.githubusercontent.com/cockroachdb/cockroach/master/cloud/kubernetes/prometheus/alert-rules.yaml
$ kubectl apply \
-f https://raw.githubusercontent.com/cockroachdb/cockroach/master/cloud/kubernetes/prometheus/alert-rules.yaml
~~~

~~~
Expand Down
66 changes: 43 additions & 23 deletions _includes/v19.1/orchestration/kubernetes-remove-nodes-insecure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
To safely remove a node from your cluster, you must first decommission the node and only then adjust the `--replicas` value of your StatefulSet configuration to permanently remove it. This sequence is important because the decommissioning process lets a node finish in-flight requests, rejects any new requests, and transfers all range replicas and range leases off the node.
To safely remove a node from your cluster, you must first decommission the node and only then adjust the `Replicas` value of your StatefulSet configuration to permanently remove it. This sequence is important because the decommissioning process lets a node finish in-flight requests, rejects any new requests, and transfers all range replicas and range leases off the node.

{{site.data.alerts.callout_danger}}
If you remove nodes without first telling CockroachDB to decommission them, you may cause data or even cluster unavailability. For more details about how this works and what to consider before removing nodes, see [Decommission Nodes](remove-nodes.html).
Expand All @@ -9,17 +9,22 @@ If you remove nodes without first telling CockroachDB to decommission them, you
<section class="filter-content" markdown="1" data-scope="manual">
{% include copy-clipboard.html %}
~~~ shell
$ kubectl run cockroachdb -it --image=cockroachdb/cockroach --rm --restart=Never \
-- node status --insecure --host=cockroachdb-public
$ kubectl run cockroachdb -it \
--image=cockroachdb/cockroach:{{page.release_info.version}} \
--rm \
--restart=Never \
-- node status \
--insecure \
--host=cockroachdb-public
~~~

~~~
id | address | build | started_at | updated_at | is_available | is_live
+----+---------------------------------------------------------------------------------+--------+----------------------------------+----------------------------------+--------------+---------+
1 | cockroachdb-0.cockroachdb.default.svc.cluster.local:26257 | v2.1.1 | 2018-11-29 16:04:36.486082+00:00 | 2018-11-29 18:24:24.587454+00:00 | true | true
2 | cockroachdb-2.cockroachdb.default.svc.cluster.local:26257 | v2.1.1 | 2018-11-29 16:55:03.880406+00:00 | 2018-11-29 18:24:23.469302+00:00 | true | true
3 | cockroachdb-1.cockroachdb.default.svc.cluster.local:26257 | v2.1.1 | 2018-11-29 16:04:41.383588+00:00 | 2018-11-29 18:24:25.030175+00:00 | true | true
4 | cockroachdb-3.cockroachdb.default.svc.cluster.local:26257 | v2.1.1 | 2018-11-29 17:31:19.990784+00:00 | 2018-11-29 18:24:26.041686+00:00 | true | true
1 | cockroachdb-0.cockroachdb.default.svc.cluster.local:26257 | {{page.release_info.version}} | 2018-11-29 16:04:36.486082+00:00 | 2018-11-29 18:24:24.587454+00:00 | true | true
2 | cockroachdb-2.cockroachdb.default.svc.cluster.local:26257 | {{page.release_info.version}} | 2018-11-29 16:55:03.880406+00:00 | 2018-11-29 18:24:23.469302+00:00 | true | true
3 | cockroachdb-1.cockroachdb.default.svc.cluster.local:26257 | {{page.release_info.version}} | 2018-11-29 16:04:41.383588+00:00 | 2018-11-29 18:24:25.030175+00:00 | true | true
4 | cockroachdb-3.cockroachdb.default.svc.cluster.local:26257 | {{page.release_info.version}} | 2018-11-29 17:31:19.990784+00:00 | 2018-11-29 18:24:26.041686+00:00 | true | true
(4 rows)
~~~

Expand All @@ -28,17 +33,22 @@ If you remove nodes without first telling CockroachDB to decommission them, you
<section class="filter-content" markdown="1" data-scope="helm">
{% include copy-clipboard.html %}
~~~ shell
$ kubectl run cockroachdb -it --image=cockroachdb/cockroach --rm --restart=Never \
-- node status --insecure --host=my-release-cockroachdb-public
$ kubectl run cockroachdb -it \
--image=cockroachdb/cockroach:{{page.release_info.version}} \
--rm \
--restart=Never \
-- node status \
--insecure \
--host=my-release-cockroachdb-public
~~~

~~~
id | address | build | started_at | updated_at | is_available | is_live
+----+---------------------------------------------------------------------------------+--------+----------------------------------+----------------------------------+--------------+---------+
1 | my-release-cockroachdb-0.my-release-cockroachdb.default.svc.cluster.local:26257 | v2.1.1 | 2018-11-29 16:04:36.486082+00:00 | 2018-11-29 18:24:24.587454+00:00 | true | true
2 | my-release-cockroachdb-2.my-release-cockroachdb.default.svc.cluster.local:26257 | v2.1.1 | 2018-11-29 16:55:03.880406+00:00 | 2018-11-29 18:24:23.469302+00:00 | true | true
3 | my-release-cockroachdb-1.my-release-cockroachdb.default.svc.cluster.local:26257 | v2.1.1 | 2018-11-29 16:04:41.383588+00:00 | 2018-11-29 18:24:25.030175+00:00 | true | true
4 | my-release-cockroachdb-3.my-release-cockroachdb.default.svc.cluster.local:26257 | v2.1.1 | 2018-11-29 17:31:19.990784+00:00 | 2018-11-29 18:24:26.041686+00:00 | true | true
1 | my-release-cockroachdb-0.my-release-cockroachdb.default.svc.cluster.local:26257 | {{page.release_info.version}} | 2018-11-29 16:04:36.486082+00:00 | 2018-11-29 18:24:24.587454+00:00 | true | true
2 | my-release-cockroachdb-2.my-release-cockroachdb.default.svc.cluster.local:26257 | {{page.release_info.version}} | 2018-11-29 16:55:03.880406+00:00 | 2018-11-29 18:24:23.469302+00:00 | true | true
3 | my-release-cockroachdb-1.my-release-cockroachdb.default.svc.cluster.local:26257 | {{page.release_info.version}} | 2018-11-29 16:04:41.383588+00:00 | 2018-11-29 18:24:25.030175+00:00 | true | true
4 | my-release-cockroachdb-3.my-release-cockroachdb.default.svc.cluster.local:26257 | {{page.release_info.version}} | 2018-11-29 17:31:19.990784+00:00 | 2018-11-29 18:24:26.041686+00:00 | true | true
(4 rows)
~~~
</section>
Expand All @@ -52,16 +62,26 @@ If you remove nodes without first telling CockroachDB to decommission them, you
<section class="filter-content" markdown="1" data-scope="manual">
{% include copy-clipboard.html %}
~~~ shell
$ kubectl run cockroachdb -it --image=cockroachdb/cockroach --rm --restart=Never \
-- node decommission <node ID> --insecure --host=cockroachdb-public
$ kubectl run cockroachdb -it \
--image=cockroachdb/cockroach:{{page.release_info.version}} \
--rm \
--restart=Never \
-- node decommission <node ID> \
--insecure \
--host=cockroachdb-public
~~~
</section>

<section class="filter-content" markdown="1" data-scope="helm">
{% include copy-clipboard.html %}
~~~ shell
$ kubectl run cockroachdb -it --image=cockroachdb/cockroach --rm --restart=Never \
-- node decommission <node ID> --insecure --host=my-release-cockroachdb-public
$ kubectl run cockroachdb -it \
--image=cockroachdb/cockroach:{{page.release_info.version}} \
--rm \
--restart=Never \
-- node decommission <node ID> \
--insecure \
--host=my-release-cockroachdb-public
~~~
</section>

Expand All @@ -85,7 +105,7 @@ If you remove nodes without first telling CockroachDB to decommission them, you
No more data reported on target nodes. Please verify cluster health before removing the nodes.
~~~

3. Once the node has been decommissioned, use the `kubectl scale` command to remove a pod from your StatefulSet:
3. Once the node has been decommissioned, remove a pod from your StatefulSet:

<section class="filter-content" markdown="1" data-scope="manual">
{% include copy-clipboard.html %}
Expand All @@ -101,10 +121,10 @@ If you remove nodes without first telling CockroachDB to decommission them, you
<section class="filter-content" markdown="1" data-scope="helm">
{% include copy-clipboard.html %}
~~~ shell
$ kubectl scale statefulset my-release-cockroachdb --replicas=3
~~~

~~~
statefulset "my-release-cockroachdb" scaled
$ helm upgrade \
my-release \
stable/cockroachdb \
--set Replicas=3 \
--reuse-values
~~~
</section>
48 changes: 30 additions & 18 deletions _includes/v19.1/orchestration/kubernetes-remove-nodes-secure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
To safely remove a node from your cluster, you must first decommission the node and only then adjust the `--replicas` value of your StatefulSet configuration to permanently remove it. This sequence is important because the decommissioning process lets a node finish in-flight requests, rejects any new requests, and transfers all range replicas and range leases off the node.
To safely remove a node from your cluster, you must first decommission the node and only then adjust the `Replicas` value of your StatefulSet configuration to permanently remove it. This sequence is important because the decommissioning process lets a node finish in-flight requests, rejects any new requests, and transfers all range replicas and range leases off the node.

{{site.data.alerts.callout_danger}}
If you remove nodes without first telling CockroachDB to decommission them, you may cause data or even cluster unavailability. For more details about how this works and what to consider before removing nodes, see [Decommission Nodes](remove-nodes.html).
Expand All @@ -9,33 +9,39 @@ If you remove nodes without first telling CockroachDB to decommission them, you
<section class="filter-content" markdown="1" data-scope="manual">
{% include copy-clipboard.html %}
~~~ shell
$ kubectl exec -it cockroachdb-client-secure -- ./cockroach node status --certs-dir=/cockroach-certs --host=cockroachdb-public
$ kubectl exec -it cockroachdb-client-secure \
-- ./cockroach node status \
--certs-dir=/cockroach-certs \
--host=cockroachdb-public
~~~

~~~
id | address | build | started_at | updated_at | is_available | is_live
+----+---------------------------------------------------------------------------------+--------+----------------------------------+----------------------------------+--------------+---------+
1 | cockroachdb-0.cockroachdb.default.svc.cluster.local:26257 | v2.1.1 | 2018-11-29 16:04:36.486082+00:00 | 2018-11-29 18:24:24.587454+00:00 | true | true
2 | cockroachdb-2.cockroachdb.default.svc.cluster.local:26257 | v2.1.1 | 2018-11-29 16:55:03.880406+00:00 | 2018-11-29 18:24:23.469302+00:00 | true | true
3 | cockroachdb-1.cockroachdb.default.svc.cluster.local:26257 | v2.1.1 | 2018-11-29 16:04:41.383588+00:00 | 2018-11-29 18:24:25.030175+00:00 | true | true
4 | cockroachdb-3.cockroachdb.default.svc.cluster.local:26257 | v2.1.1 | 2018-11-29 17:31:19.990784+00:00 | 2018-11-29 18:24:26.041686+00:00 | true | true
1 | cockroachdb-0.cockroachdb.default.svc.cluster.local:26257 | {{page.release_info.version}} | 2018-11-29 16:04:36.486082+00:00 | 2018-11-29 18:24:24.587454+00:00 | true | true
2 | cockroachdb-2.cockroachdb.default.svc.cluster.local:26257 | {{page.release_info.version}} | 2018-11-29 16:55:03.880406+00:00 | 2018-11-29 18:24:23.469302+00:00 | true | true
3 | cockroachdb-1.cockroachdb.default.svc.cluster.local:26257 | {{page.release_info.version}} | 2018-11-29 16:04:41.383588+00:00 | 2018-11-29 18:24:25.030175+00:00 | true | true
4 | cockroachdb-3.cockroachdb.default.svc.cluster.local:26257 | {{page.release_info.version}} | 2018-11-29 17:31:19.990784+00:00 | 2018-11-29 18:24:26.041686+00:00 | true | true
(4 rows)
~~~
</section>

<section class="filter-content" markdown="1" data-scope="helm">
{% include copy-clipboard.html %}
~~~ shell
$ kubectl exec -it cockroachdb-client-secure -- ./cockroach node status --certs-dir=/cockroach-certs --host=my-release-cockroachdb-public
$ kubectl exec -it cockroachdb-client-secure \
-- ./cockroach node status \
--certs-dir=/cockroach-certs \
--host=my-release-cockroachdb-public
~~~

~~~
id | address | build | started_at | updated_at | is_available | is_live
+----+---------------------------------------------------------------------------------+--------+----------------------------------+----------------------------------+--------------+---------+
1 | my-release-cockroachdb-0.my-release-cockroachdb.default.svc.cluster.local:26257 | v2.1.1 | 2018-11-29 16:04:36.486082+00:00 | 2018-11-29 18:24:24.587454+00:00 | true | true
2 | my-release-cockroachdb-2.my-release-cockroachdb.default.svc.cluster.local:26257 | v2.1.1 | 2018-11-29 16:55:03.880406+00:00 | 2018-11-29 18:24:23.469302+00:00 | true | true
3 | my-release-cockroachdb-1.my-release-cockroachdb.default.svc.cluster.local:26257 | v2.1.1 | 2018-11-29 16:04:41.383588+00:00 | 2018-11-29 18:24:25.030175+00:00 | true | true
4 | my-release-cockroachdb-3.my-release-cockroachdb.default.svc.cluster.local:26257 | v2.1.1 | 2018-11-29 17:31:19.990784+00:00 | 2018-11-29 18:24:26.041686+00:00 | true | true
1 | my-release-cockroachdb-0.my-release-cockroachdb.default.svc.cluster.local:26257 | {{page.release_info.version}} | 2018-11-29 16:04:36.486082+00:00 | 2018-11-29 18:24:24.587454+00:00 | true | true
2 | my-release-cockroachdb-2.my-release-cockroachdb.default.svc.cluster.local:26257 | {{page.release_info.version}} | 2018-11-29 16:55:03.880406+00:00 | 2018-11-29 18:24:23.469302+00:00 | true | true
3 | my-release-cockroachdb-1.my-release-cockroachdb.default.svc.cluster.local:26257 | {{page.release_info.version}} | 2018-11-29 16:04:41.383588+00:00 | 2018-11-29 18:24:25.030175+00:00 | true | true
4 | my-release-cockroachdb-3.my-release-cockroachdb.default.svc.cluster.local:26257 | {{page.release_info.version}} | 2018-11-29 17:31:19.990784+00:00 | 2018-11-29 18:24:26.041686+00:00 | true | true
(4 rows)
~~~
</section>
Expand All @@ -51,14 +57,20 @@ If you remove nodes without first telling CockroachDB to decommission them, you
<section class="filter-content" markdown="1" data-scope="manual">
{% include copy-clipboard.html %}
~~~ shell
$ kubectl exec -it cockroachdb-client-secure -- ./cockroach node decommission <node ID> --insecure --host=cockroachdb-public
$ kubectl exec -it cockroachdb-client-secure \
-- ./cockroach node decommission <node ID> \
--insecure \
--host=cockroachdb-public
~~~
</section>

<section class="filter-content" markdown="1" data-scope="helm">
{% include copy-clipboard.html %}
~~~ shell
$ kubectl exec -it cockroachdb-client-secure -- ./cockroach node decommission <node ID> --insecure --host=my-release-cockroachdb-public
$ kubectl exec -it cockroachdb-client-secure \
-- ./cockroach node decommission <node ID> \
--insecure \
--host=my-release-cockroachdb-public
~~~
</section>

Expand Down Expand Up @@ -98,10 +110,10 @@ If you remove nodes without first telling CockroachDB to decommission them, you
<section class="filter-content" markdown="1" data-scope="helm">
{% include copy-clipboard.html %}
~~~ shell
$ kubectl scale statefulset my-release-cockroachdb --replicas=3
~~~

~~~
statefulset "my-release-cockroachdb" scaled
$ helm upgrade \
my-release \
stable/cockroachdb \
--set Replicas=3 \
--reuse-values
~~~
</section>
Loading