Follow style guide for code snippets (#7382)

The prompt character shouldn't be included and command output should be
separated from the command itself.

See https://kubernetes.io/docs/home/contribute/style-guide/#code-snippet-formatting
This commit is contained in:
Matt Kelly
2018-02-16 22:59:38 -05:00
committed by k8s-ci-robot
parent 87bf22b6f0
commit eea2ddcc91
2 changed files with 51 additions and 31 deletions
@@ -36,10 +36,10 @@ You have to carry out the following steps by executing these commands on your ma
1. Install the most recent version of `kubeadm` using `curl` like so: 1. Install the most recent version of `kubeadm` using `curl` like so:
```shell ```shell
$ export VERSION=$(curl -sSL https://dl.k8s.io/release/stable.txt) # or manually specify a released Kubernetes version export VERSION=$(curl -sSL https://dl.k8s.io/release/stable.txt) # or manually specify a released Kubernetes version
$ export ARCH=amd64 # or: arm, arm64, ppc64le, s390x export ARCH=amd64 # or: arm, arm64, ppc64le, s390x
$ curl -sSL https://dl.k8s.io/release/${VERSION}/bin/linux/${ARCH}/kubeadm > /usr/bin/kubeadm curl -sSL https://dl.k8s.io/release/${VERSION}/bin/linux/${ARCH}/kubeadm > /usr/bin/kubeadm
$ chmod a+rx /usr/bin/kubeadm chmod a+rx /usr/bin/kubeadm
``` ```
**Caution:** Upgrading the `kubeadm` package on your system prior to **Caution:** Upgrading the `kubeadm` package on your system prior to
upgrading the control plane causes a failed upgrade. Even though upgrading the control plane causes a failed upgrade. Even though
@@ -51,7 +51,7 @@ this limitation.
Verify that this download of kubeadm works, and has the expected version: Verify that this download of kubeadm works, and has the expected version:
```shell ```shell
$ kubeadm version kubeadm version
``` ```
2. If this the first time you use `kubeadm upgrade`, in order to preserve the configuration for future upgrades, do: 2. If this the first time you use `kubeadm upgrade`, in order to preserve the configuration for future upgrades, do:
@@ -61,7 +61,7 @@ Note that for below you will need to recall what CLI args you passed to `kubeadm
If you used flags, do: If you used flags, do:
```shell ```shell
$ kubeadm config upload from-flags [flags] kubeadm config upload from-flags [flags]
``` ```
Where `flags` can be empty. Where `flags` can be empty.
@@ -69,7 +69,7 @@ Where `flags` can be empty.
If you used a config file, do: If you used a config file, do:
```shell ```shell
$ kubeadm config upload from-file --config [config] kubeadm config upload from-file --config [config]
``` ```
Where the `config` is mandatory. Where the `config` is mandatory.
@@ -77,7 +77,12 @@ Where the `config` is mandatory.
3. On the master node, run the following: 3. On the master node, run the following:
```shell ```shell
$ kubeadm upgrade plan kubeadm upgrade plan
```
You should see output similar to this:
```shell
[preflight] Running pre-flight checks [preflight] Running pre-flight checks
[upgrade] Making sure the cluster is healthy: [upgrade] Making sure the cluster is healthy:
[upgrade/health] Checking API Server health: Healthy [upgrade/health] Checking API Server health: Healthy
@@ -138,7 +143,12 @@ The `kubeadm upgrade plan` checks that your cluster is in an upgradeable state a
4. Pick a version to upgrade to and run, for example, `kubeadm upgrade apply` as follows: 4. Pick a version to upgrade to and run, for example, `kubeadm upgrade apply` as follows:
```shell ```shell
$ kubeadm upgrade apply v1.8.0 kubeadm upgrade apply v1.8.0
```
You should see output similar to this:
```shell
[preflight] Running pre-flight checks [preflight] Running pre-flight checks
[upgrade] Making sure the cluster is healthy: [upgrade] Making sure the cluster is healthy:
[upgrade/health] Checking API Server health: Healthy [upgrade/health] Checking API Server health: Healthy
@@ -211,7 +221,7 @@ $ kubeadm upgrade apply v1.8.0
6. Add RBAC permissions for automated certificate rotation. In the future, kubeadm will perform this step automatically: 6. Add RBAC permissions for automated certificate rotation. In the future, kubeadm will perform this step automatically:
```shell ```shell
$ kubectl create clusterrolebinding kubeadm:node-autoapprove-certificate-rotation --clusterrole=system:certificates.k8s.io:certificatesigningrequests:selfnodeclient --group=system:nodes kubectl create clusterrolebinding kubeadm:node-autoapprove-certificate-rotation --clusterrole=system:certificates.k8s.io:certificatesigningrequests:selfnodeclient --group=system:nodes
``` ```
## Upgrading your master and node packages ## Upgrading your master and node packages
@@ -221,7 +231,7 @@ For each host (referred to as `$HOST` below) in your cluster, upgrade `kubelet`
1. Prepare the host for maintenance, marking it unschedulable and evicting the workload: 1. Prepare the host for maintenance, marking it unschedulable and evicting the workload:
```shell ```shell
$ kubectl drain $HOST --ignore-daemonsets kubectl drain $HOST --ignore-daemonsets
``` ```
When running this command against the master host, this error is expected and can be safely ignored (since there are static pods running on the master): When running this command against the master host, this error is expected and can be safely ignored (since there are static pods running on the master):
@@ -236,32 +246,32 @@ error: pods not managed by ReplicationController, ReplicaSet, Job, DaemonSet or
If the host is running a Debian-based distro such as Ubuntu, run: If the host is running a Debian-based distro such as Ubuntu, run:
```shell ```shell
$ apt-get update apt-get update
$ apt-get upgrade apt-get upgrade
``` ```
If the host is running CentOS or the like, run: If the host is running CentOS or the like, run:
```shell ```shell
$ yum update yum update
``` ```
Now the new version of the `kubelet` should be running on the host. Verify this using the following command on `$HOST`: Now the new version of the `kubelet` should be running on the host. Verify this using the following command on `$HOST`:
```shell ```shell
$ systemctl status kubelet systemctl status kubelet
``` ```
3. Bring the host back online by marking it schedulable: 3. Bring the host back online by marking it schedulable:
```shell ```shell
$ kubectl uncordon $HOST kubectl uncordon $HOST
``` ```
4. After upgrading `kubelet` on each host in your cluster, verify that all nodes are available again by executing the following (from anywhere, for example, from outside the cluster): 4. After upgrading `kubelet` on each host in your cluster, verify that all nodes are available again by executing the following (from anywhere, for example, from outside the cluster):
```shell ```shell
$ kubectl get nodes kubectl get nodes
``` ```
If the `STATUS` column of the above command shows `Ready` for all of your hosts, you are done. If the `STATUS` column of the above command shows `Ready` for all of your hosts, you are done.
@@ -39,10 +39,10 @@ Execute these commands on your master node:
1. Install the most recent version of `kubeadm` using `curl` like so: 1. Install the most recent version of `kubeadm` using `curl` like so:
```shell ```shell
$ export VERSION=$(curl -sSL https://dl.k8s.io/release/stable.txt) # or manually specify a released Kubernetes version export VERSION=$(curl -sSL https://dl.k8s.io/release/stable.txt) # or manually specify a released Kubernetes version
$ export ARCH=amd64 # or: arm, arm64, ppc64le, s390x export ARCH=amd64 # or: arm, arm64, ppc64le, s390x
$ curl -sSL https://dl.k8s.io/release/${VERSION}/bin/linux/${ARCH}/kubeadm > /usr/bin/kubeadm curl -sSL https://dl.k8s.io/release/${VERSION}/bin/linux/${ARCH}/kubeadm > /usr/bin/kubeadm
$ chmod a+rx /usr/bin/kubeadm chmod a+rx /usr/bin/kubeadm
``` ```
**Caution:** Upgrading the `kubeadm` package on your system prior to upgrading the control plane causes a failed upgrade. **Caution:** Upgrading the `kubeadm` package on your system prior to upgrading the control plane causes a failed upgrade.
@@ -53,13 +53,18 @@ team is working on fixing this limitation.
Verify that this download of kubeadm works and has the expected version: Verify that this download of kubeadm works and has the expected version:
```shell ```shell
$ kubeadm version kubeadm version
``` ```
2. On the master node, run the following: 2. On the master node, run the following:
```shell ```shell
$ kubeadm upgrade plan kubeadm upgrade plan
```
You should see output similar to this:
```shell
[preflight] Running pre-flight checks [preflight] Running pre-flight checks
[upgrade] Making sure the cluster is healthy: [upgrade] Making sure the cluster is healthy:
[upgrade/health] Checking API Server health: Healthy [upgrade/health] Checking API Server health: Healthy
@@ -122,7 +127,12 @@ To check CoreDNS version, include the `--feature-gates=CoreDNS=true` flag to ver
3. Pick a version to upgrade to and run. For example: 3. Pick a version to upgrade to and run. For example:
```shell ```shell
$ kubeadm upgrade apply v1.9.0 kubeadm upgrade apply v1.9.0
```
You should see output similar to this:
```shell
[preflight] Running pre-flight checks. [preflight] Running pre-flight checks.
[upgrade] Making sure the cluster is healthy: [upgrade] Making sure the cluster is healthy:
[upgrade/config] Making sure the configuration is correct: [upgrade/config] Making sure the configuration is correct:
@@ -194,7 +204,7 @@ For each host (referred to as `$HOST` below) in your cluster, upgrade `kubelet`
1. Prepare the host for maintenance, marking it unschedulable and evicting the workload: 1. Prepare the host for maintenance, marking it unschedulable and evicting the workload:
```shell ```shell
$ kubectl drain $HOST --ignore-daemonsets kubectl drain $HOST --ignore-daemonsets
``` ```
When running this command against the master host, this error is expected and can be safely ignored (since there are static pods running on the master): When running this command against the master host, this error is expected and can be safely ignored (since there are static pods running on the master):
@@ -209,32 +219,32 @@ error: pods not managed by ReplicationController, ReplicaSet, Job, DaemonSet or
If the host is running a Debian-based distro such as Ubuntu, run: If the host is running a Debian-based distro such as Ubuntu, run:
```shell ```shell
$ apt-get update apt-get update
$ apt-get upgrade apt-get upgrade
``` ```
If the host is running CentOS or the like, run: If the host is running CentOS or the like, run:
```shell ```shell
$ yum update yum update
``` ```
Now the new version of the `kubelet` should be running on the host. Verify this using the following command on `$HOST`: Now the new version of the `kubelet` should be running on the host. Verify this using the following command on `$HOST`:
```shell ```shell
$ systemctl status kubelet systemctl status kubelet
``` ```
3. Bring the host back online by marking it schedulable: 3. Bring the host back online by marking it schedulable:
```shell ```shell
$ kubectl uncordon $HOST kubectl uncordon $HOST
``` ```
4. After upgrading `kubelet` on each host in your cluster, verify that all nodes are available again by executing the following (from anywhere, for example, from outside the cluster): 4. After upgrading `kubelet` on each host in your cluster, verify that all nodes are available again by executing the following (from anywhere, for example, from outside the cluster):
```shell ```shell
$ kubectl get nodes kubectl get nodes
``` ```
If the `STATUS` column of the above command shows `Ready` for all of your hosts, you are done. If the `STATUS` column of the above command shows `Ready` for all of your hosts, you are done.