Merge pull request #818 from Frameio/cobra-docs

Cobra improvements
This commit is contained in:
Chris Love 2016-11-08 10:02:25 -08:00 committed by GitHub
commit 789dd5777c
46 changed files with 1600 additions and 0 deletions

View File

@ -118,6 +118,9 @@ gcs-publish-ci: gcs-upload
echo "${GCS_URL}/${VERSION}" > .build/upload/${LATEST_FILE}
gsutil -h "Cache-Control:private, max-age=0, no-transform" cp .build/upload/${LATEST_FILE} ${GCS_LOCATION}
gen-cli-docs:
@kops genhelpdocs --out docs/cli
# Assumes running on linux for speed (todo: crossbuild on OSX?)
push: nodeup-gocode
scp -C ${GOPATH_1ST}/bin/nodeup ${TARGET}:/tmp/

102
cmd/kops/completion.go Normal file
View File

@ -0,0 +1,102 @@
/*
Copyright 2016 The Kubernetes Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package main
import (
"fmt"
"io"
"os"
"github.com/spf13/cobra"
)
const boilerPlate = `
# Copyright 2016 The Kubernetes Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
`
type CompletionCmd struct {
cobraCommand *cobra.Command
Shell string
}
var (
longDescription = `Output shell completion code for the given shell (bash).
This command prints shell code which must be evaluation to provide interactive
completion of kops commands.`
example = `
# load in the kops completion code for bash (depends on the bash-completion framework).
source <(kops completion bash)`
)
var completionCmd = CompletionCmd{
cobraCommand: &cobra.Command{
Use: "completion",
Short: "Output shell completion code for the given shell (bash)",
Long: longDescription,
Example: example,
},
}
func init() {
cmd := completionCmd.cobraCommand
rootCommand.cobraCommand.AddCommand(cmd)
cmd.Run = func(cmd *cobra.Command, args []string) {
err := completionCmd.Run(os.Stdout)
if err != nil {
exitWithError(err)
}
}
cmd.Flags().StringVar(&completionCmd.Shell, "shell", "", "target shell (bash).")
}
func (c *CompletionCmd) Run(w io.Writer) error {
if c.Shell == "" {
return fmt.Errorf("--shell is required")
}
if c.Shell != "bash" {
return fmt.Errorf("only bash shell is supported for kops completion")
}
_, err := w.Write([]byte(boilerPlate))
if err != nil {
return err
}
err = rootCommand.cobraCommand.GenBashCompletion(w)
if err != nil {
return err
}
return nil
}

56
cmd/kops/gen_help_docs.go Normal file
View File

@ -0,0 +1,56 @@
/*
Copyright 2016 The Kubernetes Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package main
import (
"github.com/spf13/cobra"
"github.com/spf13/cobra/doc"
)
type GenHelpDocsCmd struct {
cobraCommand *cobra.Command
OutDir string
}
var genHelpDocsCmd = GenHelpDocsCmd{
cobraCommand: &cobra.Command{
Use: "genhelpdocs",
Short: "Generate CLI help docs",
Hidden: true,
},
}
func init() {
cmd := genHelpDocsCmd.cobraCommand
rootCommand.cobraCommand.AddCommand(cmd)
cmd.Run = func(cmd *cobra.Command, args []string) {
err := genHelpDocsCmd.Run()
if err != nil {
exitWithError(err)
}
}
cmd.Flags().StringVar(&genHelpDocsCmd.OutDir, "out", "", "path to write out to.")
}
func (c *GenHelpDocsCmd) Run() error {
rootCommand.cobraCommand.DisableAutoGenTag = true
err := doc.GenMarkdownTree(rootCommand.cobraCommand, c.OutDir)
return err
}

41
docs/cli/kops.md Normal file
View File

@ -0,0 +1,41 @@
## kops
kops is kubernetes ops
### Synopsis
kops is kubernetes ops.
It allows you to create, destroy, upgrade and maintain clusters.
### Options
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### 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 items
* [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 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 version](kops_version.md) - Print the client version information

View File

@ -0,0 +1,48 @@
## kops completion
Output shell completion code for the given shell (bash)
### Synopsis
Output shell completion code for the given shell (bash).
This command prints shell code which must be evaluation to provide interactive
completion of kops commands.
```
kops completion
```
### Examples
```
# load in the kops completion code for bash (depends on the bash-completion framework).
source <(kops completion bash)
```
### Options
```
--shell string target shell (bash).
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops](kops.md) - kops is kubernetes ops

40
docs/cli/kops_create.md Normal file
View File

@ -0,0 +1,40 @@
## kops create
Create a resource by filename or stdin
### Synopsis
Create a resource by filename or stdin
```
kops create -f FILENAME
```
### Options
```
-f, --filename stringSlice Filename to use to create the resource
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops](kops.md) - kops is kubernetes ops
* [kops create cluster](kops_create_cluster.md) - Create cluster
* [kops create instancegroup](kops_create_instancegroup.md) - Create instancegroup
* [kops create secret](kops_create_secret.md) - Create secrets

View File

@ -0,0 +1,57 @@
## kops create cluster
Create cluster
### Synopsis
Creates a k8s cluster.
```
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)
--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-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. (default "kubenet")
--node-count int 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")
--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
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops create](kops_create.md) - Create a resource by filename or stdin

View File

@ -0,0 +1,31 @@
## kops create instancegroup
Create instancegroup
### Synopsis
Create an instancegroup configuration.
```
kops create instancegroup
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops create](kops_create.md) - Create a resource by filename or stdin

View File

@ -0,0 +1,28 @@
## kops create secret
Create secrets
### Synopsis
Create secrets.
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [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

@ -0,0 +1,37 @@
## kops create secret sshpublickey
Create SSH publickey
### Synopsis
Create SSH publickey.
```
kops create secret sshpublickey
```
### Options
```
-i, --pubkey string Path to SSH public key
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops create secret](kops_create_secret.md) - Create secrets

30
docs/cli/kops_delete.md Normal file
View File

@ -0,0 +1,30 @@
## kops delete
delete clusters
### Synopsis
Delete clusters
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops](kops.md) - kops is kubernetes ops
* [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

@ -0,0 +1,40 @@
## kops delete cluster
Delete cluster
### Synopsis
Deletes a k8s cluster.
```
kops delete cluster CLUSTERNAME [--yes]
```
### Options
```
--external Delete an external cluster
--region string region
--unregister Don't delete cloud resources, just unregister the cluster
--yes Delete without confirmation
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops delete](kops_delete.md) - delete clusters

View File

@ -0,0 +1,31 @@
## kops delete instancegroup
Delete instancegroup
### Synopsis
Delete an instancegroup configuration.
```
kops delete instancegroup
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops delete](kops_delete.md) - delete clusters

View File

@ -0,0 +1,31 @@
## kops delete secret
Delete secret
### Synopsis
Delete a secret.
```
kops delete secret
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops delete](kops_delete.md) - delete clusters

28
docs/cli/kops_describe.md Normal file
View File

@ -0,0 +1,28 @@
## kops describe
describe objects
### Synopsis
describe objects
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops](kops.md) - kops is kubernetes ops
* [kops describe secrets](kops_describe_secrets.md) - Describe secrets

View File

@ -0,0 +1,37 @@
## kops describe secrets
Describe secrets
### Synopsis
Describe secrets.
```
kops describe secrets
```
### Options
```
--type string Filter by secret type
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops describe](kops_describe.md) - describe objects

30
docs/cli/kops_edit.md Normal file
View File

@ -0,0 +1,30 @@
## kops edit
edit items
### Synopsis
edit items
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops](kops.md) - kops is kubernetes ops
* [kops edit cluster](kops_edit_cluster.md) - Edit cluster
* [kops edit federation](kops_edit_federation.md) - Edit federation
* [kops edit instancegroup](kops_edit_instancegroup.md) - Edit instancegroup

View File

@ -0,0 +1,31 @@
## kops edit cluster
Edit cluster
### Synopsis
Edit a cluster configuration.
```
kops edit cluster
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops edit](kops_edit.md) - edit items

View File

@ -0,0 +1,31 @@
## kops edit federation
Edit federation
### Synopsis
Edit a federation configuration.
```
kops edit federation
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops edit](kops_edit.md) - edit items

View File

@ -0,0 +1,31 @@
## kops edit instancegroup
Edit instancegroup
### Synopsis
Edit an instancegroup configuration.
```
kops edit instancegroup
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops edit](kops_edit.md) - edit items

28
docs/cli/kops_export.md Normal file
View File

@ -0,0 +1,28 @@
## kops export
export clusters/kubecfg
### Synopsis
export clusters/kubecfg
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops](kops.md) - kops is kubernetes ops
* [kops export kubecfg](kops_export_kubecfg.md) - Generate a kubecfg file for a cluster

View File

@ -0,0 +1,31 @@
## kops export kubecfg
Generate a kubecfg file for a cluster
### Synopsis
Creates a kubecfg file for a cluster, based on the state
```
kops export kubecfg CLUSTERNAME
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops export](kops_export.md) - export clusters/kubecfg

View File

@ -0,0 +1,38 @@
## kops genhelpdocs
Generate CLI help docs
### Synopsis
Generate CLI help docs
```
kops genhelpdocs
```
### Options
```
--out string path to write out to.
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops](kops.md) - kops is kubernetes ops
###### Auto generated by spf13/cobra on 5-Nov-2016

37
docs/cli/kops_get.md Normal file
View File

@ -0,0 +1,37 @@
## kops get
list or get objects
### Synopsis
list or get objects
### Options
```
-o, --output string output format. One of: table, yaml (default "table")
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops](kops.md) - kops is kubernetes ops
* [kops get clusters](kops_get_clusters.md) - get clusters
* [kops get federations](kops_get_federations.md) - get federations
* [kops get instancegroups](kops_get_instancegroups.md) - get instancegroups
* [kops get secrets](kops_get_secrets.md) - get secrets

View File

@ -0,0 +1,38 @@
## kops get clusters
get clusters
### Synopsis
List or get clusters.
```
kops get clusters
```
### Options
```
--full Show fully populated configuration
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
-o, --output string output format. One of: table, yaml (default "table")
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops get](kops_get.md) - list or get objects

View File

@ -0,0 +1,32 @@
## kops get federations
get federations
### Synopsis
List or get federations.
```
kops get federations
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
-o, --output string output format. One of: table, yaml (default "table")
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops get](kops_get.md) - list or get objects

View File

@ -0,0 +1,32 @@
## kops get instancegroups
get instancegroups
### Synopsis
List or get InstanceGroups.
```
kops get instancegroups
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
-o, --output string output format. One of: table, yaml (default "table")
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops get](kops_get.md) - list or get objects

View File

@ -0,0 +1,38 @@
## kops get secrets
get secrets
### Synopsis
List or get secrets.
```
kops get secrets
```
### Options
```
--type string Filter by secret type
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
-o, --output string output format. One of: table, yaml (default "table")
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops get](kops_get.md) - list or get objects

28
docs/cli/kops_import.md Normal file
View File

@ -0,0 +1,28 @@
## kops import
import clusters
### Synopsis
import clusters
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops](kops.md) - kops is kubernetes ops
* [kops import cluster](kops_import_cluster.md) - Import existing cluster into the state store

View File

@ -0,0 +1,37 @@
## kops import cluster
Import existing cluster into the state store
### Synopsis
Imports the settings of an existing k8s cluster.
```
kops import cluster
```
### Options
```
--region string region
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops import](kops_import.md) - import clusters

View File

@ -0,0 +1,28 @@
## kops rolling-update
rolling update clusters
### Synopsis
rolling update clusters
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops](kops.md) - kops is kubernetes ops
* [kops rolling-update cluster](kops_rolling-update_cluster.md) - rolling-update cluster

View File

@ -0,0 +1,41 @@
## kops rolling-update cluster
rolling-update cluster
### Synopsis
rolling-updates a k8s cluster.
```
kops rolling-update cluster
```
### Options
```
--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
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops rolling-update](kops_rolling-update.md) - rolling update clusters

31
docs/cli/kops_secrets.md Normal file
View File

@ -0,0 +1,31 @@
## kops secrets
Manage secrets & keys
### Synopsis
Manage secrets & keys
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops](kops.md) - kops is kubernetes ops
* [kops secrets create](kops_secrets_create.md) - Create secrets
* [kops secrets describe](kops_secrets_describe.md) - Describe secrets
* [kops secrets expose](kops_secrets_expose.md) - Expose secrets
* [kops secrets get](kops_secrets_get.md) - Get secrets

View File

@ -0,0 +1,31 @@
## kops secrets create
Create secrets
### Synopsis
Create secrets.
```
kops secrets create
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops secrets](kops_secrets.md) - Manage secrets & keys

View File

@ -0,0 +1,31 @@
## kops secrets describe
Describe secrets
### Synopsis
Describe secrets.
```
kops secrets describe
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops secrets](kops_secrets.md) - Manage secrets & keys

View File

@ -0,0 +1,31 @@
## kops secrets expose
Expose secrets
### Synopsis
Expose secrets.
```
kops secrets expose
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops secrets](kops_secrets.md) - Manage secrets & keys

View File

@ -0,0 +1,31 @@
## kops secrets get
Get secrets
### Synopsis
Get secrets.
```
kops secrets get
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops secrets](kops_secrets.md) - Manage secrets & keys

28
docs/cli/kops_toolbox.md Normal file
View File

@ -0,0 +1,28 @@
## kops toolbox
Misc infrequently used commands
### Synopsis
Misc infrequently used commands
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### 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

View File

@ -0,0 +1,38 @@
## kops toolbox convert-imported
Convert an imported cluster into a kops cluster
### Synopsis
Convert an imported cluster into a kops cluster
```
kops toolbox convert-imported
```
### Options
```
--channel string Channel to use for upgrade (default "stable")
--newname string new cluster name
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops toolbox](kops_toolbox.md) - Misc infrequently used commands

29
docs/cli/kops_update.md Normal file
View File

@ -0,0 +1,29 @@
## kops update
update clusters
### Synopsis
Update clusters
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops](kops.md) - kops is kubernetes ops
* [kops update cluster](kops_update_cluster.md) - Update cluster
* [kops update federation](kops_update_federation.md) - Update federation

View File

@ -0,0 +1,41 @@
## kops update cluster
Update cluster
### Synopsis
Updates a k8s cluster.
```
kops update cluster
```
### Options
```
--model string Models to apply (separate multiple models with commas) (default "config,proto,cloudup")
--out string Path to write any local output
--ssh-public-key string SSH public key to use (deprecated: use kops create secret instead)
--target string Target - direct, terraform (default "direct")
--yes Actually create cloud resources
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops update](kops_update.md) - update clusters

View File

@ -0,0 +1,31 @@
## kops update federation
Update federation
### Synopsis
Updates a k8s federation.
```
kops update federation
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops update](kops_update.md) - update clusters

28
docs/cli/kops_upgrade.md Normal file
View File

@ -0,0 +1,28 @@
## kops upgrade
upgrade clusters
### Synopsis
upgrade clusters
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops](kops.md) - kops is kubernetes ops
* [kops upgrade cluster](kops_upgrade_cluster.md) - Upgrade cluster

View File

@ -0,0 +1,38 @@
## kops upgrade cluster
Upgrade cluster
### Synopsis
Upgrades a k8s cluster.
```
kops upgrade cluster
```
### Options
```
--channel string Channel to use for upgrade
--yes Apply update
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops upgrade](kops_upgrade.md) - upgrade clusters

31
docs/cli/kops_version.md Normal file
View File

@ -0,0 +1,31 @@
## kops version
Print the client version information
### Synopsis
Print the client version information
```
kops version
```
### Options inherited from parent commands
```
--alsologtostderr log to standard error as well as files
--config string config file (default is $HOME/.kops.yaml)
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--logtostderr log to standard error instead of files (default false)
--name string Name of cluster
--state string Location of state storage
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level log level for V logs
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kops](kops.md) - kops is kubernetes ops

View File

@ -0,0 +1,10 @@
# Documentation guidelines
## CLI commands
`kops` uses cobra for it's CLI implementation. Each command should have the following help fields defined where possible:
* `Short`: single sentence description of command.
* `Long`: expanded description and usage of the command. The text from the `Short` field should be the first sentence in the `Long` field.
* `Example`: example(s) of how to use the command. This field is formatted as a code snippet in the docs, so make sure if you have comments
that these are written as a bash comment (e.g. `# this is a comment`).