Merge pull request #2402 from chrislovecnm/docs-updates

docs are out of date
This commit is contained in:
Eric Hole 2017-04-22 15:27:29 -04:00 committed by GitHub
commit 372718b354
44 changed files with 74 additions and 67 deletions

View File

@ -100,7 +100,7 @@ This command updates a kubernetes cluster to match the cloud, and kops specifica
To perform rolling update, you need to update the cloud resources first with "kops update cluster"
Use KOPS_FEATURE_FLAGS="+DrainAndValidateRollingUpdate" to use beta code that drains the nodes
and validates the cluser. New flags for Drain and Validation operations will be shown when
and validates the cluster. New flags for Drain and Validation operations will be shown when
the environment variable is set.`,
}

View File

@ -24,20 +24,20 @@ It allows you to create, destroy, upgrade and maintain clusters.
```
### SEE ALSO
* [kops completion](kops_completion.md) - Output shell completion code for the given shell (bash)
* [kops create](kops_create.md) - Create a resource by filename or stdin
* [kops delete](kops_delete.md) - delete clusters
* [kops describe](kops_describe.md) - describe objects
* [kops edit](kops_edit.md) - Edit resource
* [kops export](kops_export.md) - export clusters/kubecfg
* [kops get](kops_get.md) - list or get objects
* [kops import](kops_import.md) - import clusters
* [kops replace](kops_replace.md) - Replace a resource by filename or stdin
* [kops rolling-update](kops_rolling-update.md) - rolling update clusters
* [kops secrets](kops_secrets.md) - Manage secrets & keys
* [kops toolbox](kops_toolbox.md) - Misc infrequently used commands
* [kops update](kops_update.md) - update clusters
* [kops upgrade](kops_upgrade.md) - upgrade clusters
* [kops validate](kops_validate.md) - Validate Cluster
* [kops version](kops_version.md) - Print the client version information
* [kops completion](kops_completion.md) - Output shell completion code for the given shell (bash or zsh).
* [kops create](kops_create.md) - Create a resource by filename or stdin.
* [kops delete](kops_delete.md) - Delete clusters and instancegroups
* [kops describe](kops_describe.md) - Get additional information about cloud resources.
* [kops edit](kops_edit.md) - Edit clusters and other resrouces.
* [kops export](kops_export.md) - Exports a kubecfg for target cluster.
* [kops get](kops_get.md) - List all instances of a resource.
* [kops import](kops_import.md) - Import existing resources into the state store.
* [kops replace](kops_replace.md) - Replace a resource by filename or stdin.
* [kops rolling-update](kops_rolling-update.md) - Initiate rolling updates on clusters.
* [kops secrets](kops_secrets.md) - Manage secrets & keys.
* [kops toolbox](kops_toolbox.md) - Misc infrequently used commands.
* [kops update](kops_update.md) - Creates or updates cloud resources to match cluster spec.
* [kops upgrade](kops_upgrade.md) - Automates checking for and applying Kubernetes updates.
* [kops validate](kops_validate.md) - Run validation check on Kubernetes cluster.
* [kops version](kops_version.md) - Print the client version information.

View File

@ -1,11 +1,11 @@
## kops create
Create a resource by filename or stdin
Create a resource by filename or stdin.
### Synopsis
Create a resource by filename or stdin
Create a resource by filename or stdin.
```
kops create -f FILENAME

View File

@ -16,17 +16,20 @@ kops create cluster
```
--admin-access stringSlice Restrict access to admin endpoints (SSH, HTTPS) to this CIDR. If not set, access will not be restricted by IP. (default [0.0.0.0/0])
--associate-public-ip Specify --associate-public-ip=[true|false] to enable/disable association of public IP for master ASG and nodes. Default is 'true'.
--authorization string Authorization mode to use: AlwaysAllow or RBAC (default "AlwaysAllow")
--bastion Pass the --bastion flag to enable a bastion instance group. Only applies to private topology.
--channel string Channel for default versions and configuration to use (default "stable")
--cloud string Cloud provider to use - gce, aws
--cloud-labels string A list of KV pairs used to tag all instance groups in AWS (eg "Owner=John Doe,Team=Some Team").
--dns string DNS hosted zone to use: public|private. Default is 'public'. (default "Public")
--dns-zone string DNS hosted zone to use (defaults to longest matching zone)
--encrypt-etcd-storage Generate key in aws kms and use it for encrypt etcd volumes
--image string Image to use
--kubernetes-version string Version of kubernetes to run (defaults to version in channel)
--master-count int32 Set the number of masters. Defaults to one master per master-zone
--master-security-groups stringSlice Add precreated additional security groups to masters.
--master-size string Set instance size for masters
--master-tenancy string The tenancy of the master group on AWS. Can either be default or dedicated.
--master-zones stringSlice Zones in which to run masters (must be an odd number)
--model string Models to apply (separate multiple models with commas) (default "config,proto,cloudup")
--network-cidr string Set to override the default network CIDR
@ -34,6 +37,7 @@ kops create cluster
--node-count int32 Set the number of nodes
--node-security-groups stringSlice Add precreated additional security groups to nodes.
--node-size string Set instance size for nodes
--node-tenancy string The tenancy of the node group on AWS. Can be either default or dedicated.
--out string Path to write any local output
--project string Project to use (must be set on GCE)
--ssh-public-key string SSH public key to use (default "~/.ssh/id_rsa.pub")
@ -60,5 +64,5 @@ kops create cluster
```
### SEE ALSO
* [kops create](kops_create.md) - Create a resource by filename or stdin
* [kops create](kops_create.md) - Create a resource by filename or stdin.

View File

@ -14,7 +14,8 @@ kops create instancegroup
### Options
```
--role string Type of instance group to create (Node,Master,Bastion) (default "Node")
--role string Type of instance group to create (Node,Master,Bastion) (default "Node")
--subnet stringSlice Subnets in which to create instance group
```
### Options inherited from parent commands
@ -33,5 +34,5 @@ kops create instancegroup
```
### SEE ALSO
* [kops create](kops_create.md) - Create a resource by filename or stdin
* [kops create](kops_create.md) - Create a resource by filename or stdin.

View File

@ -23,6 +23,6 @@ Create secrets.
```
### SEE ALSO
* [kops create](kops_create.md) - Create a resource by filename or stdin
* [kops create](kops_create.md) - Create a resource by filename or stdin.
* [kops create secret sshpublickey](kops_create_secret_sshpublickey.md) - Create SSH publickey

View File

@ -1,10 +1,11 @@
## kops delete
Deletes a resource by filename or stdin
Delete clusters and instancegroups
### Synopsis
Delete clusters or instancegroups by filename or stdin
Delete clusters and instancegroups
```
kops delete -f FILENAME [--yes]
@ -37,3 +38,4 @@ kops delete -f FILENAME [--yes]
* [kops delete cluster](kops_delete_cluster.md) - Delete cluster
* [kops delete instancegroup](kops_delete_instancegroup.md) - Delete instancegroup
* [kops delete secret](kops_delete_secret.md) - Delete secret

View File

@ -36,5 +36,5 @@ kops delete cluster CLUSTERNAME [--yes]
```
### SEE ALSO
* [kops delete](kops_delete.md) - delete clusters
* [kops delete](kops_delete.md) - Delete clusters and instancegroups

View File

@ -33,5 +33,5 @@ kops delete instancegroup
```
### SEE ALSO
* [kops delete](kops_delete.md) - delete clusters
* [kops delete](kops_delete.md) - Delete clusters and instancegroups

View File

@ -27,5 +27,5 @@ kops delete secret
```
### SEE ALSO
* [kops delete](kops_delete.md) - delete clusters
* [kops delete](kops_delete.md) - Delete clusters and instancegroups

View File

@ -1,11 +1,11 @@
## kops describe
describe objects
Get additional information about cloud resources.
### Synopsis
describe objects
Get additional information about cloud resources.
### Options inherited from parent commands

View File

@ -33,5 +33,5 @@ kops describe secrets
```
### SEE ALSO
* [kops describe](kops_describe.md) - describe objects
* [kops describe](kops_describe.md) - Get additional information about cloud resources.

View File

@ -1,12 +1,12 @@
## kops edit
Edit resource
Edit clusters and other resrouces.
### Synopsis
Edit a resource configuration.
This command changes the cloud specification in the registry.
It does not update the cloud resources, to apply the changes use "kops update cluster".

View File

@ -31,5 +31,5 @@ kops edit cluster
```
### SEE ALSO
* [kops edit](kops_edit.md) - Edit resource
* [kops edit](kops_edit.md) - Edit clusters and other resrouces.

View File

@ -27,5 +27,5 @@ kops edit federation
```
### SEE ALSO
* [kops edit](kops_edit.md) - Edit resource
* [kops edit](kops_edit.md) - Edit clusters and other resrouces.

View File

@ -31,5 +31,5 @@ kops edit instancegroup
```
### SEE ALSO
* [kops edit](kops_edit.md) - Edit resource
* [kops edit](kops_edit.md) - Edit clusters and other resrouces.

View File

@ -1,6 +1,6 @@
## kops export
export clusters/kubecfg
Exports a kubecfg for target cluster.
### Synopsis

View File

@ -27,5 +27,5 @@ kops export kubecfg CLUSTERNAME
```
### SEE ALSO
* [kops export](kops_export.md) - export clusters/kubecfg
* [kops export](kops_export.md) - Exports a kubecfg for target cluster.

View File

@ -1,6 +1,6 @@
## kops get
list or get objects
List all instances of a resource.
### Synopsis

View File

@ -34,5 +34,5 @@ kops get clusters
```
### SEE ALSO
* [kops get](kops_get.md) - list or get objects
* [kops get](kops_get.md) - List all instances of a resource.

View File

@ -28,5 +28,5 @@ kops get federations
```
### SEE ALSO
* [kops get](kops_get.md) - list or get objects
* [kops get](kops_get.md) - List all instances of a resource.

View File

@ -28,5 +28,5 @@ kops get instancegroups
```
### SEE ALSO
* [kops get](kops_get.md) - list or get objects
* [kops get](kops_get.md) - List all instances of a resource.

View File

@ -34,5 +34,5 @@ kops get secrets
```
### SEE ALSO
* [kops get](kops_get.md) - list or get objects
* [kops get](kops_get.md) - List all instances of a resource.

View File

@ -1,6 +1,6 @@
## kops import
import clusters
Import existing resources into the state store.
### Synopsis

View File

@ -33,5 +33,5 @@ kops import cluster
```
### SEE ALSO
* [kops import](kops_import.md) - import clusters
* [kops import](kops_import.md) - Import existing resources into the state store.

View File

@ -1,11 +1,11 @@
## kops replace
Replace a resource by filename or stdin
Replace a resource by filename or stdin.
### Synopsis
Replace a resource by filename or stdin
Replace a resource by filename or stdin.
```
kops replace -f FILENAME

View File

@ -1,6 +1,6 @@
## kops rolling-update
rolling update clusters
Initiate rolling updates on clusters.
### Synopsis

View File

@ -47,5 +47,5 @@ kops rolling-update cluster
```
### SEE ALSO
* [kops rolling-update](kops_rolling-update.md) - rolling update clusters
* [kops rolling-update](kops_rolling-update.md) - Initiate rolling updates on clusters.

View File

@ -1,6 +1,6 @@
## kops secrets
Manage secrets & keys
Manage secrets & keys.
### Synopsis

View File

@ -27,5 +27,5 @@ kops secrets create
```
### SEE ALSO
* [kops secrets](kops_secrets.md) - Manage secrets & keys
* [kops secrets](kops_secrets.md) - Manage secrets & keys.

View File

@ -27,5 +27,5 @@ kops secrets describe
```
### SEE ALSO
* [kops secrets](kops_secrets.md) - Manage secrets & keys
* [kops secrets](kops_secrets.md) - Manage secrets & keys.

View File

@ -27,5 +27,5 @@ kops secrets expose
```
### SEE ALSO
* [kops secrets](kops_secrets.md) - Manage secrets & keys
* [kops secrets](kops_secrets.md) - Manage secrets & keys.

View File

@ -27,5 +27,5 @@ kops secrets get
```
### SEE ALSO
* [kops secrets](kops_secrets.md) - Manage secrets & keys
* [kops secrets](kops_secrets.md) - Manage secrets & keys.

View File

@ -1,11 +1,11 @@
## kops toolbox
Misc infrequently used commands
Misc infrequently used commands.
### Synopsis
Misc infrequently used commands
Misc infrequently used commands.
### Options inherited from parent commands

View File

@ -34,5 +34,5 @@ kops toolbox convert-imported
```
### SEE ALSO
* [kops toolbox](kops_toolbox.md) - Misc infrequently used commands
* [kops toolbox](kops_toolbox.md) - Misc infrequently used commands.

View File

@ -33,5 +33,5 @@ kops toolbox dump
```
### SEE ALSO
* [kops toolbox](kops_toolbox.md) - Misc infrequently used commands
* [kops toolbox](kops_toolbox.md) - Misc infrequently used commands.

View File

@ -1,6 +1,6 @@
## kops update
update clusters
Creates or updates cloud resources to match cluster spec.
### Synopsis

View File

@ -38,5 +38,5 @@ kops update cluster
```
### SEE ALSO
* [kops update](kops_update.md) - update clusters
* [kops update](kops_update.md) - Creates or updates cloud resources to match cluster spec.

View File

@ -27,5 +27,5 @@ kops update federation
```
### SEE ALSO
* [kops update](kops_update.md) - update clusters
* [kops update](kops_update.md) - Creates or updates cloud resources to match cluster spec.

View File

@ -1,6 +1,6 @@
## kops upgrade
upgrade clusters
Automates checking for and applying Kubernetes updates.
### Synopsis

View File

@ -34,5 +34,5 @@ kops upgrade cluster
```
### SEE ALSO
* [kops upgrade](kops_upgrade.md) - upgrade clusters
* [kops upgrade](kops_upgrade.md) - Automates checking for and applying Kubernetes updates.

View File

@ -1,6 +1,6 @@
## kops validate
Validate Cluster
Run validation check on Kubernetes cluster.
### Synopsis

View File

@ -27,5 +27,5 @@ kops validate cluster
```
### SEE ALSO
* [kops validate](kops_validate.md) - Validate Cluster
* [kops validate](kops_validate.md) - Run validation check on Kubernetes cluster.

View File

@ -1,11 +1,11 @@
## kops version
Print the client version information
Print the client version information.
### Synopsis
Print the client version information
Print the client version information.
```
kops version