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

Updating documentation

This commit is contained in:
chrislovecnm 2017-02-01 22:08:19 -07:00
parent d4ae576c35
commit d228592af5
10 changed files with 68 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/cli/kops.md
View File

@ -28,7 +28,7 @@ It allows you to create, destroy, upgrade and maintain clusters.
* [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 items
* [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

49
docs/cli/kops_create_cluster.md
View File

@ -14,31 +14,30 @@ kops create cluster
### Options
```
--admin-access string Restrict access to admin endpoints (SSH, HTTPS) to this CIDR. If not set, access will not be restricted by IP.
--associate-public-ip Specify --associate-public-ip=[true|false] to enable/disable association of public IP for master ASG and nodes. Default is 'true'. (default true)
--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
--dns-zone string DNS hosted zone to use (defaults to longest matching zone)
--image string Image to use
--kubernetes-version string Version of kubernetes to run (defaults to version in channel)
--master-security-groups string Add precreated additional security groups to masters.
--master-size string Set instance size for masters
--master-zones string 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
--networking string Networking mode to use. kubenet (default), classic, external, cni, kopeio-vxlan, weave, calico. (default "kubenet")
--node-count int Set the number of nodes
--node-security-groups string Add precreated additional security groups to nodes.
--node-size string Set instance size for nodes
--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")
--target string Target - direct, terraform (default "direct")
-t, --topology string Controls network topology for the cluster. public|private. Default is 'public'. (default "public")
--vpc string Set to use a shared VPC
--yes Specify --yes to immediately create the cluster
--zones string Zones in which to run the 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'.
--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
--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)
--image string Image to use
--kubernetes-version string Version of kubernetes to run (defaults to version in channel)
--master-size string Set instance size for masters
--master-zones string 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
--networking string Networking mode to use. kubenet (default), classic, external, cni, kopeio-vxlan, weave, calico. (default "kubenet")
--node-count int32 Set the number of nodes
--node-size string Set instance size for nodes
--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")
--target string Target - direct, terraform (default "direct")
-t, --topology string Controls network topology for the cluster. public|private. Default is 'public'. (default "public")
--vpc string Set to use a shared VPC
--yes Specify --yes to immediately create the cluster
--zones string Zones in which to run the cluster
```
### Options inherited from parent commands

2
docs/cli/kops_delete_cluster.md
View File

@ -17,7 +17,7 @@ kops delete cluster CLUSTERNAME [--yes]
--external Delete an external cluster
--region string region
--unregister Don't delete cloud resources, just unregister the cluster
--yes Delete without confirmation
-y, --yes Specify --yes to delete the cluster
```
### Options inherited from parent commands

6
docs/cli/kops_delete_instancegroup.md
View File

@ -11,6 +11,12 @@ Delete an instancegroup configuration.
kops delete instancegroup
```
### Options
```
-y, --yes Specify --yes to immediately delete the instance group
```
### Options inherited from parent commands
```

8
docs/cli/kops_edit.md
View File

@ -1,11 +1,15 @@
## kops edit
edit items
Edit resource
### Synopsis
edit items
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".
### Options inherited from parent commands

6
docs/cli/kops_edit_cluster.md
View File

@ -7,6 +7,10 @@ Edit cluster
Edit a cluster 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".
```
kops edit cluster
```
@ -27,5 +31,5 @@ kops edit cluster
```
### SEE ALSO
* [kops edit](kops_edit.md) - edit items
* [kops edit](kops_edit.md) - Edit resource

2
docs/cli/kops_edit_federation.md
View File

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

6
docs/cli/kops_edit_instancegroup.md
View File

@ -7,6 +7,10 @@ Edit instancegroup
Edit an instancegroup 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".
```
kops edit instancegroup
```
@ -27,5 +31,5 @@ kops edit instancegroup
```
### SEE ALSO
* [kops edit](kops_edit.md) - edit items
* [kops edit](kops_edit.md) - Edit resource

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

@ -24,5 +24,5 @@ rolling update clusters
### SEE ALSO
* [kops](kops.md) - kops is kubernetes ops
* [kops rolling-update cluster](kops_rolling-update_cluster.md) - rolling-update cluster
* [kops rolling-update cluster](kops_rolling-update_cluster.md) - Rolling update a cluster

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

@ -1,11 +1,18 @@
## kops rolling-update cluster
rolling-update cluster
Rolling update a cluster
### Synopsis
rolling-updates a k8s cluster.
Rolling update a cluster instance groups.
This command updates the running instances to match the cloud specifications.
Use KOPS_FEATURE_FLAGS="+ValidiateAndDrainRollingUpdate" to use beta code that drains the nodes
and validates the cluser.
To perform rolling update, you need to update the cloud resources first with "kops update cluster"
```
kops rolling-update cluster
@ -14,12 +21,15 @@ kops rolling-update cluster
### Options
```
--bastion-interval duration Time to wait between restarting bastions (default 5m0s)
--cloudonly Perform rolling update without confirming progress with k8s
--force Force rolling update, even if no changes
--master-interval duration Time to wait between restarting masters (default 5m0s)
--node-interval duration Time to wait between restarting nodes (default 2m0s)
--yes perform rolling update without confirmation
--bastion-interval duration Time to wait between restarting bastions (default 5m0s)
--cloudonly Perform rolling update without confirming progress with k8s
--force Force rolling update, even if no changes
--force-drain The node will be upgraded if the drain fails, if set to false the rolling update will fail if a drain fails. Enable with KOPS_FEATURE_FLAGS='+ValidiateAndDrainRollingUpdate' (default true)
--instance-group stringSlice List of instance groups to update (defaults to all if not specified)
--master-interval duration Time to wait between restarting masters (default 5m0s)
--node-interval duration Time to wait between restarting nodes (default 2m0s)
--validate Validate the cluster, and if the validation fails stop the rolling-update. Enable with KOPS_FEATURE_FLAGS='+ValidiateAndDrainRollingUpdate' (default true)
--yes perform rolling update without confirmation
```
### Options inherited from parent commands