kubernetes
/
kops
mirror of https://github.com/kubernetes/kops.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs updates to clarify and fix typos 

Helps with https://github.com/kubernetes/kops/issues/3441.
This commit is contained in:
John Laswell 2017-09-25 13:13:23 -04:00
parent 8562242c68
commit a6dbc73502
No known key found for this signature in database
GPG Key ID: 68F81DA166A13B9B
3 changed files with 61 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
cmd/kops/rollingupdatecluster.go
View File

@ -43,42 +43,41 @@ import (
var ( var (
rollingupdate_long = pretty.LongDesc(i18n.T(` rollingupdate_long = pretty.LongDesc(i18n.T(`
This command updates a kubernetes cluster to match the cloud, and kops specifications. This command updates a kubernetes cluster to match the cloud and kops specifications.
To perform rolling update, you need to update the cloud resources first with the command To perform a rolling update, you need to update the cloud resources first with the command
` + pretty.Bash("kops update cluster") + `. ` + pretty.Bash("kops update cluster") + `.
If rolling-update does not report that the cluster needs to be rolled you can force the cluster to be If rolling-update does not report that the cluster needs to be rolled, you can force the cluster to be
rolled with the force flag. Rolling update drains and validates the cluster by default. A cluster is rolled with the force flag. Rolling update drains and validates the cluster by default. A cluster is
deemed validated when all required nodes are running, and all pods in the kube-system namespace are operational. deemed validated when all required nodes are running and all pods in the kube-system namespace are operational.
When a node is deleted rolling-update sleeps the interval for the node type, and the tries for the same period When a node is deleted, rolling-update sleeps the interval for the node type, and then tries for the same period
of time for the cluster to be validated. For instance setting --master-interval=3m causes rolling-update of time for the cluster to be validated. For instance, setting --master-interval=3m causes rolling-update
to wait for 3m after a master is rolled, and another 3m for the cluster to stabilize and pass to wait for 3 minutes after a master is rolled, and another 3 minutes for the cluster to stabilize and pass
validation. validation.
Note: terraform users will need run the following commands all from the same directory Note: terraform users will need to run all of the following commands from the same directory
` + pretty.Bash("kops update cluster --target=terraform") + `then ` + pretty.Bash("kops update cluster --target=terraform") + ` then ` + pretty.Bash("terraform plan") + ` then
` + pretty.Bash("terraform plan") + ` then ` + pretty.Bash("terraform apply") + ` + pretty.Bash("terraform apply") + ` prior to running ` + pretty.Bash("kops rolling-update cluster") + `.`))
`prior to running` + pretty.Bash("kops rolling-update cluster") + `.`))
rollingupdate_example = templates.Examples(i18n.T(` rollingupdate_example = templates.Examples(i18n.T(`
# Preview a rolling-update # Preview a rolling-update.
kops rolling-update cluster kops rolling-update cluster
# Roll the currently selected kops cluster with defaults. # Roll the currently selected kops cluster with defaults.
# Nodes will be drained and the cluster will be validated between node replacement # Nodes will be drained and the cluster will be validated between node replacement.
kops rolling-update cluster --yes kops rolling-update cluster --yes
# Roll the k8s-cluster.example.com kops cluster # Roll the k8s-cluster.example.com kops cluster,
# do not fail if the cluster does not validate # do not fail if the cluster does not validate,
# wait 8 min to create new node, and at least 8 min # wait 8 min to create new node, and wait at least
# to validate the cluster. # 8 min to validate the cluster.
kops rolling-update cluster k8s-cluster.example.com --yes \ kops rolling-update cluster k8s-cluster.example.com --yes \
--fail-on-validate-error="false" \ --fail-on-validate-error="false" \
--master-interval=8m \ --master-interval=8m \
--node-interval=8m --node-interval=8m
# Roll the k8s-cluster.example.com kops cluster # Roll the k8s-cluster.example.com kops cluster,
# do not validate the cluster because of the cloudonly flag. # do not validate the cluster because of the cloudonly flag.
# Force the entire cluster to roll, even if rolling update # Force the entire cluster to roll, even if rolling update
# reports that the cluster does not need to be rolled. # reports that the cluster does not need to be rolled.
@ -86,9 +85,9 @@ var (
--cloudonly \ --cloudonly \
--force --force
# Roll the k8s-cluster.example.com kops cluster # Roll the k8s-cluster.example.com kops cluster,
# only roll the node instancegroup # only roll the node instancegroup,
# use the new drain an validate functionality # use the new drain an validate functionality.
kops rolling-update cluster k8s-cluster.example.com --yes \ kops rolling-update cluster k8s-cluster.example.com --yes \
--fail-on-validate-error="false" \ --fail-on-validate-error="false" \
--node-interval 8m \ --node-interval 8m \
@ -123,7 +122,7 @@ type RollingUpdateOptions struct {
ClusterName string ClusterName string
// InstanceGroups is the list of instance groups to rolling-update; // InstanceGroups is the list of instance groups to rolling-update;
// if not specified all instance groups will be updated // if not specified, all instance groups will be updated
InstanceGroups []string InstanceGroups []string
} }

40
docs/cli/kops_rolling-update.md
View File

@ -8,43 +8,43 @@ Rolling update a cluster.
### Synopsis ### Synopsis
This command updates a kubernetes cluster to match the cloud, and kops specifications. This command updates a kubernetes cluster to match the cloud and kops specifications.
To perform rolling update, you need to update the cloud resources first with the command To perform a rolling update, you need to update the cloud resources first with the command
`kops update cluster`. `kops update cluster`.
If rolling-update does not report that the cluster needs to be rolled you can force the cluster to be If rolling-update does not report that the cluster needs to be rolled, you can force the cluster to be
rolled with the force flag. Rolling update drains and validates the cluster by default. A cluster is rolled with the force flag. Rolling update drains and validates the cluster by default. A cluster is
deemed validated when all required nodes are running, and all pods in the kube-system namespace are operational. deemed validated when all required nodes are running and all pods in the kube-system namespace are operational.
When a node is deleted rolling-update sleeps the interval for the node type, and the tries for the same period When a node is deleted, rolling-update sleeps the interval for the node type, and then tries for the same period
of time for the cluster to be validated. For instance setting --master-interval=3m causes rolling-update of time for the cluster to be validated. For instance, setting --master-interval=3m causes rolling-update
to wait for 3m after a master is rolled, and another 3m for the cluster to stabilize and pass to wait for 3 minutes after a master is rolled, and another 3 minutes for the cluster to stabilize and pass
validation. validation.
Note: terraform users will need run the following commands all from the same directory Note: terraform users will need to run all of the following commands from the same directory
`kops update cluster --target=terraform`then `kops update cluster --target=terraform` then `terraform plan` then
`terraform plan` then `terraform apply`prior to running`kops rolling-update cluster`. `terraform apply` prior to running `kops rolling-update cluster`.
### Examples ### Examples
``` ```
# Preview a rolling-update # Preview a rolling-update.
kops rolling-update cluster kops rolling-update cluster
# Roll the currently selected kops cluster with defaults. # Roll the currently selected kops cluster with defaults.
# Nodes will be drained and the cluster will be validated between node replacement # Nodes will be drained and the cluster will be validated between node replacement.
kops rolling-update cluster --yes kops rolling-update cluster --yes
# Roll the k8s-cluster.example.com kops cluster # Roll the k8s-cluster.example.com kops cluster,
# do not fail if the cluster does not validate # do not fail if the cluster does not validate,
# wait 8 min to create new node, and at least 8 min # wait 8 min to create new node, and wait at least
# to validate the cluster. # 8 min to validate the cluster.
kops rolling-update cluster k8s-cluster.example.com --yes \ kops rolling-update cluster k8s-cluster.example.com --yes \
--fail-on-validate-error="false" \ --fail-on-validate-error="false" \
--master-interval=8m \ --master-interval=8m \
--node-interval=8m --node-interval=8m
# Roll the k8s-cluster.example.com kops cluster # Roll the k8s-cluster.example.com kops cluster,
# do not validate the cluster because of the cloudonly flag. # do not validate the cluster because of the cloudonly flag.
# Force the entire cluster to roll, even if rolling update # Force the entire cluster to roll, even if rolling update
# reports that the cluster does not need to be rolled. # reports that the cluster does not need to be rolled.
@ -52,9 +52,9 @@ Note: terraform users will need run the following commands all from the same dir
--cloudonly \ --cloudonly \
--force --force
# Roll the k8s-cluster.example.com kops cluster # Roll the k8s-cluster.example.com kops cluster,
# only roll the node instancegroup # only roll the node instancegroup,
# use the new drain an validate functionality # use the new drain an validate functionality.
kops rolling-update cluster k8s-cluster.example.com --yes \ kops rolling-update cluster k8s-cluster.example.com --yes \
--fail-on-validate-error="false" \ --fail-on-validate-error="false" \
--node-interval 8m \ --node-interval 8m \

40
docs/cli/kops_rolling-update_cluster.md
View File

@ -8,22 +8,22 @@ Rolling update a cluster.
### Synopsis ### Synopsis
This command updates a kubernetes cluster to match the cloud, and kops specifications. This command updates a kubernetes cluster to match the cloud and kops specifications.
To perform rolling update, you need to update the cloud resources first with the command To perform a rolling update, you need to update the cloud resources first with the command
`kops update cluster`. `kops update cluster`.
If rolling-update does not report that the cluster needs to be rolled you can force the cluster to be If rolling-update does not report that the cluster needs to be rolled, you can force the cluster to be
rolled with the force flag. Rolling update drains and validates the cluster by default. A cluster is rolled with the force flag. Rolling update drains and validates the cluster by default. A cluster is
deemed validated when all required nodes are running, and all pods in the kube-system namespace are operational. deemed validated when all required nodes are running and all pods in the kube-system namespace are operational.
When a node is deleted rolling-update sleeps the interval for the node type, and the tries for the same period When a node is deleted, rolling-update sleeps the interval for the node type, and then tries for the same period
of time for the cluster to be validated. For instance setting --master-interval=3m causes rolling-update of time for the cluster to be validated. For instance, setting --master-interval=3m causes rolling-update
to wait for 3m after a master is rolled, and another 3m for the cluster to stabilize and pass to wait for 3 minutes after a master is rolled, and another 3 minutes for the cluster to stabilize and pass
validation. validation.
Note: terraform users will need run the following commands all from the same directory Note: terraform users will need to run all of the following commands from the same directory
`kops update cluster --target=terraform`then `kops update cluster --target=terraform` then `terraform plan` then
`terraform plan` then `terraform apply`prior to running`kops rolling-update cluster`. `terraform apply` prior to running `kops rolling-update cluster`.
``` ```
kops rolling-update cluster kops rolling-update cluster
@ -32,23 +32,23 @@ kops rolling-update cluster
### Examples ### Examples
``` ```
# Preview a rolling-update # Preview a rolling-update.
kops rolling-update cluster kops rolling-update cluster
# Roll the currently selected kops cluster with defaults. # Roll the currently selected kops cluster with defaults.
# Nodes will be drained and the cluster will be validated between node replacement # Nodes will be drained and the cluster will be validated between node replacement.
kops rolling-update cluster --yes kops rolling-update cluster --yes
# Roll the k8s-cluster.example.com kops cluster # Roll the k8s-cluster.example.com kops cluster,
# do not fail if the cluster does not validate # do not fail if the cluster does not validate,
# wait 8 min to create new node, and at least 8 min # wait 8 min to create new node, and wait at least
# to validate the cluster. # 8 min to validate the cluster.
kops rolling-update cluster k8s-cluster.example.com --yes \ kops rolling-update cluster k8s-cluster.example.com --yes \
--fail-on-validate-error="false" \ --fail-on-validate-error="false" \
--master-interval=8m \ --master-interval=8m \
--node-interval=8m --node-interval=8m
# Roll the k8s-cluster.example.com kops cluster # Roll the k8s-cluster.example.com kops cluster,
# do not validate the cluster because of the cloudonly flag. # do not validate the cluster because of the cloudonly flag.
# Force the entire cluster to roll, even if rolling update # Force the entire cluster to roll, even if rolling update
# reports that the cluster does not need to be rolled. # reports that the cluster does not need to be rolled.
@ -56,9 +56,9 @@ kops rolling-update cluster
--cloudonly \ --cloudonly \
--force --force
# Roll the k8s-cluster.example.com kops cluster # Roll the k8s-cluster.example.com kops cluster,
# only roll the node instancegroup # only roll the node instancegroup,
# use the new drain an validate functionality # use the new drain an validate functionality.
kops rolling-update cluster k8s-cluster.example.com --yes \ kops rolling-update cluster k8s-cluster.example.com --yes \
--fail-on-validate-error="false" \ --fail-on-validate-error="false" \
--node-interval 8m \ --node-interval 8m \