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

make gen-cli-docs

This commit is contained in:
Ciprian Hacman 2020-11-14 16:02:59 +02:00
parent ab05d1873b
commit 3ca128d5ef
31 changed files with 57 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
cmd/kops/root.go
View File

@ -52,7 +52,7 @@ const (
var (
rootLong = templates.LongDesc(i18n.T(`
kOps is Kubernetes ops.
kOps is Kubernetes Operations.
kOps is the easiest way to get a production grade Kubernetes cluster up and running.
We like to think of it as kubectl for clusters.

12
docs/cli/kops.md
View File

@ -3,15 +3,15 @@
## kops
kops is Kubernetes ops.
kOps is Kubernetes Operations.
### Synopsis
kops is Kubernetes ops.
kOps is Kubernetes Operations.
kops is the easiest way to get a production grade Kubernetes cluster up and running. We like to think of it as kubectl for clusters.
kOps is the easiest way to get a production grade Kubernetes cluster up and running. We like to think of it as kubectl for clusters.
kops helps you create, destroy, upgrade and maintain production-grade, highly available, Kubernetes clusters from the command line. AWS (Amazon Web Services) is currently officially supported, with GCE and OpenStack in beta support.
kOps helps you create, destroy, upgrade and maintain production-grade, highly available, Kubernetes clusters from the command line. AWS (Amazon Web Services) is currently officially supported, with GCE and OpenStack in beta support.
### Options
@ -50,6 +50,6 @@ kops is Kubernetes ops.
* [kops toolbox](kops_toolbox.md) - Misc infrequently used commands.
* [kops update](kops_update.md) - Update a cluster.
* [kops upgrade](kops_upgrade.md) - Upgrade a kubernetes cluster.
* [kops validate](kops_validate.md) - Validate a kops cluster.
* [kops version](kops_version.md) - Print the kops version information.
* [kops validate](kops_validate.md) - Validate a kOps cluster.
* [kops version](kops_version.md) - Print the kOps version information.

6
docs/cli/kops_completion.md
View File

@ -7,9 +7,9 @@ Output shell completion code for the given shell (bash or zsh).
### Synopsis
Output shell completion code for the specified shell (bash or zsh). The shell code must be evaluated to provide interactive completion of kOps commands. This can be done by sourcing it from the .bash_profile.
Output shell completion code for the specified shell (bash or zsh). The shell code must be evaluated to provide interactive completion of kops commands. This can be done by sourcing it from the .bash_profile.
Note: this requires the bash-completion framework, which is not installed by default on Mac. Once installed, bash_completion must be evaluated. This can be done by adding the following line to the .bash_profile
Note: this requires the bash-completion framework, which is not installed by default on Mac. Once installed, bash_completion must be evaluated. This can be done by adding the following line to the .bash_profile
Note for zsh users: zsh completions are only supported in versions of zsh >= 5.2
@ -68,5 +68,5 @@ kops completion [flags]
### SEE ALSO
* [kops](kops.md) - kops is Kubernetes ops.
* [kops](kops.md) - kOps is Kubernetes Operations.

2
docs/cli/kops_create.md
View File

@ -75,7 +75,7 @@ kops create -f FILENAME [flags]
### SEE ALSO
* [kops](kops.md) - kops is Kubernetes ops.
* [kops](kops.md) - kOps is Kubernetes Operations.
* [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.

4
docs/cli/kops_create_cluster.md
View File

@ -113,10 +113,10 @@ kops create cluster [flags]
--out string Path to write any local output
-o, --output string Output format. One of json|yaml. Used with the --dry-run flag.
--project string Project to use (must be set on GCE)
--ssh-access strings Restrict SSH access to this CIDR. If not set, access will not be restricted by IP. (default [0.0.0.0/0])
--ssh-access strings Restrict SSH access to this CIDR. If not set, access will not be restricted by IP. (default [0.0.0.0/0])
--ssh-public-key string SSH public key to use (defaults to ~/.ssh/id_rsa.pub on AWS)
--subnets strings Set to use shared subnets
--target string Valid targets: direct, terraform, cloudformation. Set this flag to terraform if you want kops to generate terraform (default "direct")
--target string Valid targets: direct, terraform, cloudformation. Set this flag to terraform if you want kOps to generate terraform (default "direct")
-t, --topology string Controls network topology for the cluster: public|private. (default "public")
--utility-subnets strings Set to use shared utility subnets
--vpc string Set to use a shared VPC

2
docs/cli/kops_create_secret_ciliumpassword.md
View File

@ -32,7 +32,7 @@ kops create secret ciliumpassword [flags]
```
-f, -- string Path to the cilium encryption config file
--force Force replace the kops secret if it already exists
--force Force replace the kOps secret if it already exists
-h, --help help for ciliumpassword
```

2
docs/cli/kops_create_secret_dockerconfig.md
View File

@ -31,7 +31,7 @@ kops create secret dockerconfig [flags]
```
-f, -- string Path to docker config JSON file
--force Force replace the kops secret if it already exists
--force Force replace the kOps secret if it already exists
-h, --help help for dockerconfig
```

2
docs/cli/kops_create_secret_encryptionconfig.md
View File

@ -31,7 +31,7 @@ kops create secret encryptionconfig [flags]
```
-f, -- string Path to encryption config yaml file
--force Force replace the kops secret if it already exists
--force Force replace the kOps secret if it already exists
-h, --help help for encryptionconfig
```

4
docs/cli/kops_create_secret_weavepassword.md
View File

@ -9,7 +9,7 @@ Create a weave encryption config.
Create a new weave encryption secret, and store it in the state store. Used to weave networking to use encrypted communication between nodes.
If no password is provided, kops will generate one at random.
If no password is provided, kOps will generate one at random.
WARNING: cannot be enabled on a running cluster without downtime.
@ -38,7 +38,7 @@ kops create secret weavepassword [flags]
```
-f, -- string Path to the weave password file (optional)
--force Force replace the kops secret if it already exists
--force Force replace the kOps secret if it already exists
-h, --help help for weavepassword
```

2
docs/cli/kops_delete.md
View File

@ -63,7 +63,7 @@ kops delete -f FILENAME [--yes] [flags]
### SEE ALSO
* [kops](kops.md) - kops is Kubernetes ops.
* [kops](kops.md) - kOps is Kubernetes Operations.
* [kops delete cluster](kops_delete_cluster.md) - Delete a cluster.
* [kops delete instance](kops_delete_instance.md) - Delete an instance
* [kops delete instancegroup](kops_delete_instancegroup.md) - Delete instancegroup

2
docs/cli/kops_delete_instancegroup.md
View File

@ -7,7 +7,7 @@ Delete instancegroup
### Synopsis
Delete an instancegroup configuration. kops has the concept of "instance groups", which are a group of similar virtual machines. On AWS, they map to an AutoScalingGroup. An ig work either as a Kubernetes master or a node.
Delete an instancegroup configuration. kOps has the concept of "instance groups", which are a group of similar virtual machines. On AWS, they map to an AutoScalingGroup. An ig work either as a Kubernetes master or a node.
```
kops delete instancegroup [flags]

2
docs/cli/kops_describe.md
View File

@ -43,6 +43,6 @@ Get additional information about cloud and cluster resources.
### SEE ALSO
* [kops](kops.md) - kops is Kubernetes ops.
* [kops](kops.md) - kOps is Kubernetes Operations.
* [kops describe secrets](kops_describe_secrets.md) - Describe a cluster secret

4
docs/cli/kops_edit.md
View File

@ -10,7 +10,7 @@ Edit clusters and other resources.
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.
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".
@ -53,7 +53,7 @@ Edit a resource configuration. This command changes the desired configuration in
### SEE ALSO
* [kops](kops.md) - kops is Kubernetes ops.
* [kops](kops.md) - kOps is Kubernetes Operations.
* [kops edit cluster](kops_edit_cluster.md) - Edit cluster.
* [kops edit instancegroup](kops_edit_instancegroup.md) - Edit instancegroup.

2
docs/cli/kops_edit_cluster.md
View File

@ -12,7 +12,7 @@ Edit a cluster configuration.
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.
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".

2
docs/cli/kops_edit_instancegroup.md
View File

@ -12,7 +12,7 @@ Edit a cluster configuration.
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.
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".

2
docs/cli/kops_export.md
View File

@ -44,6 +44,6 @@ Export configurations from a cluster.
### SEE ALSO
* [kops](kops.md) - kops is Kubernetes ops.
* [kops](kops.md) - kOps is Kubernetes Operations.
* [kops export kubecfg](kops_export_kubecfg.md) - Export kubecfg.

4
docs/cli/kops_export_kubecfg.md
View File

@ -30,8 +30,8 @@ kops export kubecfg CLUSTERNAME [flags]
```
--admin duration[=18h0m0s] export a cluster admin user credential with the given lifetime and add it to the cluster context
--all export all clusters from the kops state store
--auth-plugin use the kops authentication plugin
--all export all clusters from the kOps state store
--auth-plugin use the kOps authentication plugin
-h, --help help for kubecfg
--internal use the cluster's internal DNS name
--kubeconfig string the location of the kubeconfig file to create.

2
docs/cli/kops_get.md
View File

@ -68,7 +68,7 @@ kops get [flags]
### SEE ALSO
* [kops](kops.md) - kops is Kubernetes ops.
* [kops](kops.md) - kOps is Kubernetes Operations.
* [kops get clusters](kops_get_clusters.md) - Get one or many clusters.
* [kops get instancegroups](kops_get_instancegroups.md) - Get one or many instancegroups
* [kops get instances](kops_get_instances.md) - Display cluster instances.

2
docs/cli/kops_import.md
View File

@ -45,6 +45,6 @@ Imports a kubernetes cluster created by kube-up.sh into a state store. This com
### SEE ALSO
* [kops](kops.md) - kops is Kubernetes ops.
* [kops](kops.md) - kOps is Kubernetes Operations.
* [kops import cluster](kops_import_cluster.md) - Import a cluster.

2
docs/cli/kops_replace.md
View File

@ -56,5 +56,5 @@ kops replace -f FILENAME [flags]
### SEE ALSO
* [kops](kops.md) - kops is Kubernetes ops.
* [kops](kops.md) - kOps is Kubernetes Operations.

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

@ -31,11 +31,11 @@ Note: terraform users will need to run all of the following commands from the sa
# Preview a rolling-update.
kops rolling-update cluster
# Roll the currently selected kops cluster with defaults.
# Roll the currently selected kOps cluster with defaults.
# Nodes will be drained and the cluster will be validated between node replacement.
kops rolling-update cluster --yes
# Roll the k8s-cluster.example.com kops cluster,
# Roll the k8s-cluster.example.com kOps cluster,
# do not fail if the cluster does not validate,
# wait 8 min to create new node, and wait at least
# 8 min to validate the cluster.
@ -44,7 +44,7 @@ Note: terraform users will need to run all of the following commands from the sa
--master-interval=8m \
--node-interval=8m
# Roll the k8s-cluster.example.com kops cluster,
# Roll the k8s-cluster.example.com kOps cluster,
# do not validate the cluster because of the cloudonly flag.
# Force the entire cluster to roll, even if rolling update
# reports that the cluster does not need to be rolled.
@ -52,7 +52,7 @@ Note: terraform users will need to run all of the following commands from the sa
--cloudonly \
--force
# Roll the k8s-cluster.example.com kops cluster,
# Roll the k8s-cluster.example.com kOps cluster,
# only roll the node instancegroup,
# use the new drain and validate functionality.
kops rolling-update cluster k8s-cluster.example.com --yes \
@ -89,6 +89,6 @@ Note: terraform users will need to run all of the following commands from the sa
### SEE ALSO
* [kops](kops.md) - kops is Kubernetes ops.
* [kops](kops.md) - kOps is Kubernetes Operations.
* [kops rolling-update cluster](kops_rolling-update_cluster.md) - Rolling update a cluster.

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

@ -35,11 +35,11 @@ kops rolling-update cluster [flags]
# Preview a rolling-update.
kops rolling-update cluster
# Roll the currently selected kops cluster with defaults.
# Roll the currently selected kOps cluster with defaults.
# Nodes will be drained and the cluster will be validated between node replacement.
kops rolling-update cluster --yes
# Roll the k8s-cluster.example.com kops cluster,
# Roll the k8s-cluster.example.com kOps cluster,
# do not fail if the cluster does not validate,
# wait 8 min to create new node, and wait at least
# 8 min to validate the cluster.
@ -48,7 +48,7 @@ kops rolling-update cluster [flags]
--master-interval=8m \
--node-interval=8m
# Roll the k8s-cluster.example.com kops cluster,
# Roll the k8s-cluster.example.com kOps cluster,
# do not validate the cluster because of the cloudonly flag.
# Force the entire cluster to roll, even if rolling update
# reports that the cluster does not need to be rolled.
@ -56,7 +56,7 @@ kops rolling-update cluster [flags]
--cloudonly \
--force
# Roll the k8s-cluster.example.com kops cluster,
# Roll the k8s-cluster.example.com kOps cluster,
# only roll the node instancegroup,
# use the new drain and validate functionality.
kops rolling-update cluster k8s-cluster.example.com --yes \

2
docs/cli/kops_set.md
View File

@ -46,6 +46,6 @@ Set a configuration field.
### SEE ALSO
* [kops](kops.md) - kops is Kubernetes ops.
* [kops](kops.md) - kOps is Kubernetes Operations.
* [kops set cluster](kops_set_cluster.md) - Set cluster fields.

4
docs/cli/kops_toolbox.md
View File

@ -44,8 +44,8 @@ Misc infrequently used commands.
### SEE ALSO
* [kops](kops.md) - kops is Kubernetes ops.
* [kops toolbox convert-imported](kops_toolbox_convert-imported.md) - Convert an imported cluster into a kops cluster.
* [kops](kops.md) - kOps is Kubernetes Operations.
* [kops toolbox convert-imported](kops_toolbox_convert-imported.md) - Convert an imported cluster into a kOps cluster.
* [kops toolbox dump](kops_toolbox_dump.md) - Dump cluster information
* [kops toolbox instance-selector](kops_toolbox_instance-selector.md) - Generate on-demand or spot instance-group specs by providing resource specs like vcpus and memory.
* [kops toolbox template](kops_toolbox_template.md) - Generate cluster.yaml from template

4
docs/cli/kops_toolbox_convert-imported.md
View File

@ -3,11 +3,11 @@
## kops toolbox convert-imported
Convert an imported cluster into a kops cluster.
Convert an imported cluster into a kOps cluster.
### Synopsis
Convert an imported cluster into a kops cluster.
Convert an imported cluster into a kOps cluster.
```
kops toolbox convert-imported [flags]

2
docs/cli/kops_update.md
View File

@ -44,6 +44,6 @@ Creates or updates cloud resources to match cluster desired configuration.
### SEE ALSO
* [kops](kops.md) - kops is Kubernetes ops.
* [kops](kops.md) - kOps is Kubernetes Operations.
* [kops update cluster](kops_update_cluster.md) - Update a cluster.

2
docs/cli/kops_update_cluster.md
View File

@ -26,7 +26,7 @@ kops update cluster [flags]
```
--admin duration[=18h0m0s] Also export a cluster admin user credential with the specified lifetime and add it to the cluster context
--allow-kops-downgrade Allow an older version of kops to update the cluster than last used
--allow-kops-downgrade Allow an older version of kOps to update the cluster than last used
--create-kube-config Will control automatically creating the kube config file on your local filesystem (default true)
-h, --help help for cluster
--internal Use the cluster's internal DNS name. Implies --create-kube-config

2
docs/cli/kops_upgrade.md
View File

@ -44,6 +44,6 @@ Automates checking for and applying Kubernetes updates. This upgrades a cluster
### SEE ALSO
* [kops](kops.md) - kops is Kubernetes ops.
* [kops](kops.md) - kOps is Kubernetes Operations.
* [kops upgrade cluster](kops_upgrade_cluster.md) - Upgrade a kubernetes cluster.

6
docs/cli/kops_validate.md
View File

@ -3,7 +3,7 @@
## kops validate
Validate a kops cluster.
Validate a kOps cluster.
### Synopsis
@ -45,6 +45,6 @@ This command validates a cluster. See: kops validate cluster -h
### SEE ALSO
* [kops](kops.md) - kops is Kubernetes ops.
* [kops validate cluster](kops_validate_cluster.md) - Validate a kops cluster.
* [kops](kops.md) - kOps is Kubernetes Operations.
* [kops validate cluster](kops_validate_cluster.md) - Validate a kOps cluster.

4
docs/cli/kops_validate_cluster.md
View File

@ -3,7 +3,7 @@
## kops validate cluster
Validate a kops cluster.
Validate a kOps cluster.
### Synopsis
@ -58,5 +58,5 @@ kops validate cluster [flags]
### SEE ALSO
* [kops validate](kops_validate.md) - Validate a kops cluster.
* [kops validate](kops_validate.md) - Validate a kOps cluster.

8
docs/cli/kops_version.md
View File

@ -3,11 +3,11 @@
## kops version
Print the kops version information.
Print the kOps version information.
### Synopsis
Print the kops version and git SHA.
Print the kOps version and git SHA.
```
kops version [flags]
@ -23,7 +23,7 @@ kops version [flags]
```
-h, --help help for version
--short only print the main kops version, useful for scripting
--short only print the main kOps version, useful for scripting
```
### Options inherited from parent commands
@ -48,5 +48,5 @@ kops version [flags]
### SEE ALSO
* [kops](kops.md) - kops is Kubernetes ops.
* [kops](kops.md) - kOps is Kubernetes Operations.