Edit doc for kops get, create, replace, edit

This is to avoid confusion between files 'cluster.spec and config. It was confusing what was actually updated by those commands (not the cluster.spec file). Also added: - examples to save cluster config to file - example to save instancegroups to config file
kubernetes · May 20, 2017 · dec350c · dec350c
1 parent 0dd346f
commit dec350c
Show file tree

Hide file tree

Showing 10 changed files with 27 additions and 12 deletions.
diff --git a/docs/cli/kops_create.md b/docs/cli/kops_create.md
@@ -12,7 +12,8 @@ Create a resource:
   * secret  
   * federation  
 
-Create a cluster, instancegroup or secret using command line flags or YAML cluster spec. Clusters and instancegroups can be created using the YAML cluster spec.
+Create a cluster, instancegroup or secret using command line parameters or YAML config files.
+(Note: secrets cannot be created from YAML config files yet).
 
 ```
 kops create -f FILENAME
@@ -21,7 +22,7 @@ kops create -f FILENAME
 ### Examples
 
 ```
-  # Create a cluster using a cluser spec file
+  # Create a cluster from the configuration in a YAML file
   kops create -f my-cluster.yaml
   
   # Create a cluster in AWS
@@ -65,4 +66,4 @@ kops create -f FILENAME
 * [kops create cluster](kops_create_cluster.md)	 - Create a Kubernetes cluster.
 * [kops create instancegroup](kops_create_instancegroup.md)	 - Create an instancegroup.
 * [kops create secret](kops_create_secret.md)	 - Create a secret.
-
+* [kops get](kops_get.md) - Get a cluster or instancegroup YAML config files
diff --git a/docs/cli/kops_edit.md b/docs/cli/kops_edit.md
@@ -5,7 +5,7 @@ Edit clusters and other resources.
 ### Synopsis
 
 
-Edit a resource configuration. This command changes the cloud specification in the registry. 
+Edit a resource configuration. This command changes the cloud configuration in the registry. 
 
   To set your preferred editor, you can define the EDITOR environment variable.
   When you have done this, kops will use the editor that you have set.

diff --git a/docs/cli/kops_edit_cluster.md b/docs/cli/kops_edit_cluster.md
@@ -7,7 +7,7 @@ Edit cluster.
 
 Edit a cluster configuration. 
 
-This command changes the cluster cloud specification in the registry. 
+This command changes the cluster cloud configuration in the registry. 
 
   To set your preferred editor, you can define the EDITOR environment variable.
   When you have done this, kops will use the editor that you have set.

diff --git a/docs/cli/kops_edit_federation.md b/docs/cli/kops_edit_federation.md
@@ -7,7 +7,7 @@ Edit federation.
 
 Edit a cluster configuration. 
 
-This command changes the federation cloud specification in the registry. 
+This command changes the federation cloud configuration in the registry. 
 
   To set your preferred editor, you can define the EDITOR environment variable.
   When you have done this, kops will use the editor that you have set.

diff --git a/docs/cli/kops_edit_instancegroup.md b/docs/cli/kops_edit_instancegroup.md
@@ -7,7 +7,7 @@ Edit instancegroup.
 
 Edit a cluster configuration. 
 
-This command changes the instancegroup cloud specification in the registry. 
+This command changes the instancegroup cloud configuration in the registry. 
 
   To set your preferred editor, you can define the EDITOR environment variable.
   When you have done this, kops will use the editor that you have set.

diff --git a/docs/cli/kops_get.md b/docs/cli/kops_get.md
@@ -21,9 +21,12 @@ Display one or many resources.
   # Get a cluster
   kops get cluster k8s-cluster.example.com
   
-  # Get a cluster YAML cluster spec
+  # Get a cluster YAML configuration
   kops get cluster k8s-cluster.example.com -o yaml
   
+  # Save a cluster configuration to YAML file
+  kops get cluster k8s-cluster.example.com -o yaml > cluster-config.yaml
+
   # Get an instancegroup
   kops get ig --name k8s-cluster.example.com nodes
   

diff --git a/docs/cli/kops_get_clusters.md b/docs/cli/kops_get_clusters.md
@@ -19,6 +19,13 @@ kops get clusters
   
   # Get a cluster
   kops get cluster k8s-cluster.example.com
+  
+  # Get a cluster YAML configuration
+  kops get cluster k8s-cluster.example.com -o yaml
+
+  # Save a cluster configuration to YAML file
+  kops get cluster k8s-cluster.example.com -o yaml > cluster-config.yaml
+
 ```
 
 ### Options

diff --git a/docs/cli/kops_get_instancegroups.md b/docs/cli/kops_get_instancegroups.md
@@ -17,8 +17,12 @@ kops get instancegroups
   # Get all instancegroups in a state store
   kops get ig
   
-  # Get a cluster
+  # Get a cluster's instancegroup 
   kops get ig --name k8s-cluster.example.com nodes
+
+  # Save a cluster's instancegroups configuration to YAML file
+  kops get ig --name k8s-cluster.example.com -o yaml > instancegroups-config.yaml
+
 ```
 
 ### Options inherited from parent commands

diff --git a/docs/cli/kops_replace.md b/docs/cli/kops_replace.md
@@ -5,7 +5,7 @@ Replace cluster resources.
 ### Synopsis
 
 
-Replace a resource specification by filename or stdin.
+Replace a resource configuration by filename or stdin.
 
 ```
 kops replace -f FILENAME
@@ -14,7 +14,7 @@ kops replace -f FILENAME
 ### Examples
 
 ```
-  # Replace a cluster specification using a file
+  # Replace a cluster configuration using a file
   kops replace -f my-cluster.yaml
 ```
 

diff --git a/docs/cli/kops_update.md b/docs/cli/kops_update.md
@@ -5,7 +5,7 @@ Update a cluster.
 ### Synopsis
 
 
-Creates or updates cloud resources to match cluster spec.
+Creates or updates cloud resources to match cluster config.
 
 ### Examples