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

Clarify docs: rename spec to desired conf 

In the S3 bucket, the file cluster.spec is not actually the spec, but the
actual configuration. The file config is the spec. To avoid confusion,
this commit changes spec/specification into 'desired configuration' in
the documentation, to avoid associating cluster.spec with a cluster
'specification' that the users should use.
This commit is contained in:
Quentin Nerden 2017-06-11 16:11:28 +02:00
parent 3d2bcdf547
commit 5491f179d1
20 changed files with 64 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
cmd/kops/create.go
View File

@ -44,14 +44,14 @@ var (
create_long = templates.LongDesc(i18n.T(`
Create a resource:` + validResources +
`
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 configuration specification files.
(Note: secrets cannot be created from YAML config files yet).
`))
create_example = templates.Examples(i18n.T(`
# Create a cluster using a cluser spec file
# Create a cluster from the configuration specification in a YAML file
kops create -f my-cluster.yaml
# Create a cluster in AWS

2
cmd/kops/edit.go
View File

@ -27,7 +27,7 @@ import (
var (
edit_long = templates.LongDesc(i18n.T(`Edit a resource configuration.
This command changes the cloud specification in the registry.
This command changes the desired 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.

2
cmd/kops/edit_cluster.go
View File

@ -45,7 +45,7 @@ type EditClusterOptions struct {
var (
edit_cluster_long = templates.LongDesc(i18n.T(`Edit a cluster configuration.
This command changes the cluster cloud specification in the registry.
This command changes the desired cluster 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.

6
cmd/kops/edit_federation.go
View File

@ -37,10 +37,10 @@ var (
edit_federation_long = pretty.LongDesc(`
Edit a cluster configuration.
This command changes the federation cloud specification in the registry.
This command changes the federation cloud desired 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.
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.
kops edit does not update the cloud resources, to apply the changes use ` + pretty.Bash("kops update cluster") + `.`)

4
cmd/kops/edit_instancegroup.go
View File

@ -38,7 +38,7 @@ import (
var (
edit_instancegroup_long = templates.LongDesc(i18n.T(`Edit a cluster configuration.
This command changes the instancegroup cloud specification in the registry.
This command changes the instancegroup desired 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.
@ -46,7 +46,7 @@ var (
kops edit does not update the cloud resources, to apply the changes use "kops update cluster".`))
edit_instancegroup_example = templates.Examples(i18n.T(`
# Edit a instancegroup configuration.
# Edit an instancegroup desired configuration.
kops edit ig --name k8s-cluster.example.com node --state=s3://kops-state-1234
`))

15
cmd/kops/get.go
View File

@ -37,20 +37,17 @@ var (
Display one or many resources.` + validResources))
get_example = templates.Examples(i18n.T(`
# Get all resource in a single cluster as yaml
kops get --name k8s-cluster.example.com -o yaml
# Get all clusters in a state store
kops get clusters
# Get a cluster
kops get cluster k8s-cluster.example.com
# Get a cluster and its instancegroups
kops get k8s-cluster.example.com
# Get a cluster YAML cluster spec
kops get cluster k8s-cluster.example.com -o yaml
# Get a cluster and its instancegroups' YAML desired configuration
kops get k8s-cluster.example.com -o yaml
# Get an instancegroup
kops get ig --name k8s-cluster.example.com nodes
# Save a cluster and its instancegroups' desired configuration to YAML file
kops get k8s-cluster.example.com -o yaml > cluster-desired-config.yaml
# Get a secret
kops get secrets kube -oplaintext

9
cmd/kops/get_cluster.go
View File

@ -43,7 +43,14 @@ var (
kops get clusters
# Get a cluster
kops get cluster k8s-cluster.example.com`))
kops get cluster k8s-cluster.example.com
# Get a cluster YAML desired configuration
kops get cluster k8s-cluster.example.com -o yaml
# Save a cluster desired configuration to YAML file
kops get cluster k8s-cluster.example.com -o yaml > cluster-desired-config.yaml
`))
get_cluster_short = i18n.T(`Get one or many clusters.`)

11
cmd/kops/get_instancegroups.go
View File

@ -22,8 +22,9 @@ import (
"strconv"
"strings"
"github.com/spf13/cobra"
"io"
"github.com/spf13/cobra"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/kops/cmd/kops/util"
api "k8s.io/kops/pkg/apis/kops"
@ -40,8 +41,12 @@ var (
# Get all instancegroups in a state store
kops get ig
# Get a cluster
kops get ig --name k8s-cluster.example.com nodes`))
# Get a cluster's instancegroup
kops get ig --name k8s-cluster.example.com nodes
# Save a cluster's instancegroups desired configuration to YAML file
kops get ig --name k8s-cluster.example.com -o yaml > instancegroups-desired-config.yaml
`))
get_instancegroups_short = i18n.T(`Get one or many instancegroups`)
)

4
cmd/kops/replace.go
View File

@ -36,10 +36,10 @@ import (
var (
replaceLong = templates.LongDesc(i18n.T(`
Replace a resource specification by filename or stdin.`))
Replace a resource desired configuration by filename or stdin.`))
replaceExample = templates.Examples(i18n.T(`
# Replace a cluster specification using a file
# Replace a cluster desired configuration using a YAML file
kops replace -f my-cluster.yaml
# Note, if the resource does not exist the command will error, use --force to provision resource

2
cmd/kops/update.go
View File

@ -27,7 +27,7 @@ import (
var (
update_long = templates.LongDesc(i18n.T(`
Creates or updates cloud resources to match cluster spec.
Creates or updates cloud resources to match cluster desired configuration.
`))
update_example = templates.Examples(i18n.T(`

4
docs/cli/kops_create.md
View File

@ -15,7 +15,7 @@ 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 configuration specification files. (Note: secrets cannot be created from YAML config files yet).
```
kops create -f FILENAME
@ -24,7 +24,7 @@ kops create -f FILENAME
### Examples
```
# Create a cluster using a cluser spec file
# Create a cluster from the configuration specification in a YAML file
kops create -f my-cluster.yaml
# Create a cluster in AWS

2
docs/cli/kops_edit.md
View File

@ -8,7 +8,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 desired 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.

2
docs/cli/kops_edit_cluster.md
View File

@ -10,7 +10,7 @@ Edit cluster.
Edit a cluster configuration.
This command changes the cluster cloud specification in the registry.
This command changes the desired cluster 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.

6
docs/cli/kops_edit_federation.md
View File

@ -10,10 +10,10 @@ Edit federation.
Edit a cluster configuration.
This command changes the federation cloud specification in the registry.
This command changes the federation cloud desired 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.
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.
kops edit does not update the cloud resources, to apply the changes use `kops update cluster`.

4
docs/cli/kops_edit_instancegroup.md
View File

@ -10,7 +10,7 @@ Edit instancegroup.
Edit a cluster configuration.
This command changes the instancegroup cloud specification in the registry.
This command changes the instancegroup desired 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.
@ -24,7 +24,7 @@ kops edit instancegroup
### Examples
```
# Edit a instancegroup configuration.
# Edit an instancegroup desired configuration.
kops edit ig --name k8s-cluster.example.com node --state=s3://kops-state-1234
```

15
docs/cli/kops_get.md
View File

@ -22,20 +22,17 @@ kops get
### Examples
```
# Get all resource in a single cluster as yaml
kops get --name k8s-cluster.example.com -o yaml
# Get all clusters in a state store
kops get clusters
# Get a cluster
kops get cluster k8s-cluster.example.com
# Get a cluster and its instancegroups
kops get k8s-cluster.example.com
# Get a cluster YAML cluster spec
kops get cluster k8s-cluster.example.com -o yaml
# Get a cluster and its instancegroups' YAML desired configuration
kops get k8s-cluster.example.com -o yaml
# Get an instancegroup
kops get ig --name k8s-cluster.example.com nodes
# Save a cluster and its instancegroups' desired configuration to YAML file
kops get k8s-cluster.example.com -o yaml > cluster-desired-config.yaml
# Get a secret
kops get secrets kube -oplaintext

6
docs/cli/kops_get_clusters.md
View File

@ -22,6 +22,12 @@ kops get clusters
# Get a cluster
kops get cluster k8s-cluster.example.com
# Get a cluster YAML desired configuration
kops get cluster k8s-cluster.example.com -o yaml
# Save a cluster desired configuration to YAML file
kops get cluster k8s-cluster.example.com -o yaml > cluster-desired-config.yaml
```
### Options

5
docs/cli/kops_get_instancegroups.md
View File

@ -20,8 +20,11 @@ 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 desired configuration to YAML file
kops get ig --name k8s-cluster.example.com -o yaml > instancegroups-desired-config.yaml
```
### Options inherited from parent commands

4
docs/cli/kops_replace.md
View File

@ -8,7 +8,7 @@ Replace cluster resources.
### Synopsis
Replace a resource specification by filename or stdin.
Replace a resource desired configuration by filename or stdin.
```
kops replace -f FILENAME
@ -17,7 +17,7 @@ kops replace -f FILENAME
### Examples
```
# Replace a cluster specification using a file
# Replace a cluster desired configuration using a YAML file
kops replace -f my-cluster.yaml
# Note, if the resource does not exist the command will error, use --force to provision resource

2
docs/cli/kops_update.md
View File

@ -8,7 +8,7 @@ Update a cluster.
### Synopsis
Creates or updates cloud resources to match cluster spec.
Creates or updates cloud resources to match cluster desired configuration.
### Examples