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

Typo and wording fix to getting_started/commands doc

This commit is contained in:
MoShitrit 2020-06-21 11:13:16 -04:00
parent 77663acec2
commit 86a23d8090
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/getting_started/commands.md
View File

@ -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` registers a cluster. There are two ways of registering a cluster: using a cluster spec file or using cli arguments.
### `kops create -f <cluser spec>` ### `kops create -f <cluster spec>`
`kops create -f <cluster spec>` 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 -f <cluster spec>` 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`
`kops create cluster <clustername>` 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 <clustername>` 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`
`kops update cluster <clustername>` creates or updates the cloud resources to match the cluster spec. `kops update cluster <clustername>` 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 <name>`, and then As a precaution, it is safer run in 'preview' mode first using `kops update cluster --name <name>`, and once confirmed
when you are happy that it is making the right changes you run`kops update cluster --name <name> --yes`. the output matches your expectations, you can apply the changes by adding `--yes` to the command - `kops update cluster --name <name> --yes`.
## `kops rolling-update cluster` ## `kops rolling-update cluster`
`kops update cluster <clustername>` updates a kubernetes cluster to match the cloud and kops specifications. `kops update cluster <clustername>` 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 <name>`, and then As a precaution, it is safer run in 'preview' mode first using `kops rolling-update cluster --name <name>`, and once confirmed
when you are happy that it is making the right changes you run`kops rolling-update cluster --name <name> --yes`. the output matches your expectations, you can apply the changes by adding `--yes` to the command - `kops rolling-update cluster --name <name> --yes`.
## `kops get clusters` ## `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 `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. 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 <name>`, and then As a precaution, it is safer run in 'preview' mode first using `kops delete cluster --name <name>`, and once confirmed
when you are happy that it is deleting the right things you run `kops delete cluster --name <name> --yes`. the output matches your expectations, you can perform the actual deletion by adding `--yes` to the command - `kops delete cluster --name <name> --yes`.
## `kops toolbox template` ## `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` ## `kops version`