From 86a23d8090a1d561556868c2bbab8c1b60a00b2e Mon Sep 17 00:00:00 2001 From: MoShitrit Date: Sun, 21 Jun 2020 11:13:16 -0400 Subject: [PATCH] Typo and wording fix to getting_started/commands doc --- docs/getting_started/commands.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/getting_started/commands.md b/docs/getting_started/commands.md index 74dc13266c..befdb8064a 100644 --- a/docs/getting_started/commands.md +++ b/docs/getting_started/commands.md @@ -6,27 +6,28 @@ Please refer to the kops [cli reference](../cli/kops.md) for full documentation. `kops create` registers a cluster. There are two ways of registering a cluster: using a cluster spec file or using cli arguments. -### `kops create -f ` +### `kops create -f ` `kops create -f ` will register a cluster using a kops spec yaml file. After the cluster has been registered you need to run `kops update cluster --yes` to create the cloud resources. ### `kops create cluster` -`kops create cluster ` creates a cloud specification in the registry using cli arguments. In most cases, you will need to edit the cluster spec using `kops edit` before actually creating the cloud resources. If you are sure you do not need to do any moditication, you can add the `--yes` flag to immediately create the cluster including cloud resource. +`kops create cluster ` creates a cloud specification in the registry using cli arguments. In most cases, you will need to edit the cluster spec using `kops edit` before actually creating the cloud resources. +Once confirmed you don't need any modifications, you can add the `--yes` flag to immediately create the cluster including cloud resource. ## `kops update cluster` `kops update cluster ` creates or updates the cloud resources to match the cluster spec. -It is recommended that you run it first in 'preview' mode with `kops update cluster --name `, and then -when you are happy that it is making the right changes you run`kops update cluster --name --yes`. +As a precaution, it is safer run in 'preview' mode first using `kops update cluster --name `, and once confirmed +the output matches your expectations, you can apply the changes by adding `--yes` to the command - `kops update cluster --name --yes`. ## `kops rolling-update cluster` `kops update cluster ` updates a kubernetes cluster to match the cloud and kops specifications. -It is recommended that you run it first in 'preview' mode with `kops rolling-update cluster --name `, and then -when you are happy that it is making the right changes you run`kops rolling-update cluster --name --yes`. +As a precaution, it is safer run in 'preview' mode first using `kops rolling-update cluster --name `, and once confirmed +the output matches your expectations, you can apply the changes by adding `--yes` to the command - `kops rolling-update cluster --name --yes`. ## `kops get clusters` @@ -37,12 +38,12 @@ when you are happy that it is making the right changes you run`kops rolling-upda `kops delete cluster` deletes the cloud resources (instances, DNS entries, volumes, ELBs, VPCs etc) for a particular cluster. It also removes the cluster from the registry. -It is recommended that you run it first in 'preview' mode with `kops delete cluster --name `, and then -when you are happy that it is deleting the right things you run `kops delete cluster --name --yes`. +As a precaution, it is safer run in 'preview' mode first using `kops delete cluster --name `, and once confirmed +the output matches your expectations, you can perform the actual deletion by adding `--yes` to the command - `kops delete cluster --name --yes`. ## `kops toolbox template` -`kops toolbox template` lets you generate a kops spec using go templates. This is very handy if you want to consistently manage multiple clusters. +`kops toolbox template` lets you generate a kops spec using `go` templates. This is very handy if you want to consistently manage multiple clusters. ## `kops version`