From 8e979ca4345810880631fd16bbaad7005e38d1e0 Mon Sep 17 00:00:00 2001 From: Billy Shambrook Date: Sat, 5 Nov 2016 00:07:54 +0000 Subject: [PATCH 1/5] add genhelpdocs cmd to generate cli markdown docs --- Makefile | 3 ++ cmd/kops/gen_help_docs.go | 55 +++++++++++++++++++ docs/cli/kops.md | 42 +++++++++++++++ docs/cli/kops_create.md | 41 +++++++++++++++ docs/cli/kops_create_cluster.md | 58 +++++++++++++++++++++ docs/cli/kops_create_instancegroup.md | 32 ++++++++++++ docs/cli/kops_create_secret.md | 29 +++++++++++ docs/cli/kops_create_secret_sshpublickey.md | 38 ++++++++++++++ docs/cli/kops_delete.md | 31 +++++++++++ docs/cli/kops_delete_cluster.md | 41 +++++++++++++++ docs/cli/kops_delete_instancegroup.md | 32 ++++++++++++ docs/cli/kops_delete_secret.md | 32 ++++++++++++ docs/cli/kops_describe.md | 29 +++++++++++ docs/cli/kops_describe_secrets.md | 38 ++++++++++++++ docs/cli/kops_edit.md | 31 +++++++++++ docs/cli/kops_edit_cluster.md | 32 ++++++++++++ docs/cli/kops_edit_federation.md | 32 ++++++++++++ docs/cli/kops_edit_instancegroup.md | 32 ++++++++++++ docs/cli/kops_export.md | 29 +++++++++++ docs/cli/kops_export_kubecfg.md | 32 ++++++++++++ docs/cli/kops_genhelpdocs.md | 38 ++++++++++++++ docs/cli/kops_get.md | 38 ++++++++++++++ docs/cli/kops_get_clusters.md | 39 ++++++++++++++ docs/cli/kops_get_federations.md | 33 ++++++++++++ docs/cli/kops_get_instancegroups.md | 33 ++++++++++++ docs/cli/kops_get_secrets.md | 39 ++++++++++++++ docs/cli/kops_import.md | 29 +++++++++++ docs/cli/kops_import_cluster.md | 38 ++++++++++++++ docs/cli/kops_rolling-update.md | 29 +++++++++++ docs/cli/kops_rolling-update_cluster.md | 42 +++++++++++++++ docs/cli/kops_secrets.md | 32 ++++++++++++ docs/cli/kops_secrets_create.md | 32 ++++++++++++ docs/cli/kops_secrets_describe.md | 32 ++++++++++++ docs/cli/kops_secrets_expose.md | 32 ++++++++++++ docs/cli/kops_secrets_get.md | 32 ++++++++++++ docs/cli/kops_toolbox.md | 29 +++++++++++ docs/cli/kops_toolbox_convert-imported.md | 39 ++++++++++++++ docs/cli/kops_update.md | 30 +++++++++++ docs/cli/kops_update_cluster.md | 42 +++++++++++++++ docs/cli/kops_update_federation.md | 32 ++++++++++++ docs/cli/kops_upgrade.md | 29 +++++++++++ docs/cli/kops_upgrade_cluster.md | 39 ++++++++++++++ docs/cli/kops_version.md | 32 ++++++++++++ 43 files changed, 1479 insertions(+) create mode 100644 cmd/kops/gen_help_docs.go create mode 100644 docs/cli/kops.md create mode 100644 docs/cli/kops_create.md create mode 100644 docs/cli/kops_create_cluster.md create mode 100644 docs/cli/kops_create_instancegroup.md create mode 100644 docs/cli/kops_create_secret.md create mode 100644 docs/cli/kops_create_secret_sshpublickey.md create mode 100644 docs/cli/kops_delete.md create mode 100644 docs/cli/kops_delete_cluster.md create mode 100644 docs/cli/kops_delete_instancegroup.md create mode 100644 docs/cli/kops_delete_secret.md create mode 100644 docs/cli/kops_describe.md create mode 100644 docs/cli/kops_describe_secrets.md create mode 100644 docs/cli/kops_edit.md create mode 100644 docs/cli/kops_edit_cluster.md create mode 100644 docs/cli/kops_edit_federation.md create mode 100644 docs/cli/kops_edit_instancegroup.md create mode 100644 docs/cli/kops_export.md create mode 100644 docs/cli/kops_export_kubecfg.md create mode 100644 docs/cli/kops_genhelpdocs.md create mode 100644 docs/cli/kops_get.md create mode 100644 docs/cli/kops_get_clusters.md create mode 100644 docs/cli/kops_get_federations.md create mode 100644 docs/cli/kops_get_instancegroups.md create mode 100644 docs/cli/kops_get_secrets.md create mode 100644 docs/cli/kops_import.md create mode 100644 docs/cli/kops_import_cluster.md create mode 100644 docs/cli/kops_rolling-update.md create mode 100644 docs/cli/kops_rolling-update_cluster.md create mode 100644 docs/cli/kops_secrets.md create mode 100644 docs/cli/kops_secrets_create.md create mode 100644 docs/cli/kops_secrets_describe.md create mode 100644 docs/cli/kops_secrets_expose.md create mode 100644 docs/cli/kops_secrets_get.md create mode 100644 docs/cli/kops_toolbox.md create mode 100644 docs/cli/kops_toolbox_convert-imported.md create mode 100644 docs/cli/kops_update.md create mode 100644 docs/cli/kops_update_cluster.md create mode 100644 docs/cli/kops_update_federation.md create mode 100644 docs/cli/kops_upgrade.md create mode 100644 docs/cli/kops_upgrade_cluster.md create mode 100644 docs/cli/kops_version.md diff --git a/Makefile b/Makefile index b07ed8e49f..5a3c8cdee2 100644 --- a/Makefile +++ b/Makefile @@ -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/ diff --git a/cmd/kops/gen_help_docs.go b/cmd/kops/gen_help_docs.go new file mode 100644 index 0000000000..4285eb8418 --- /dev/null +++ b/cmd/kops/gen_help_docs.go @@ -0,0 +1,55 @@ +/* +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 { + err := doc.GenMarkdownTree(rootCommand.cobraCommand, c.OutDir) + + return err +} diff --git a/docs/cli/kops.md b/docs/cli/kops.md new file mode 100644 index 0000000000..363cde9e73 --- /dev/null +++ b/docs/cli/kops.md @@ -0,0 +1,42 @@ +## 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 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 genhelpdocs](kops_genhelpdocs.md) - Generate CLI help docs +* [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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_create.md b/docs/cli/kops_create.md new file mode 100644 index 0000000000..744377b3a1 --- /dev/null +++ b/docs/cli/kops_create.md @@ -0,0 +1,41 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_create_cluster.md b/docs/cli/kops_create_cluster.md new file mode 100644 index 0000000000..5dad56217d --- /dev/null +++ b/docs/cli/kops_create_cluster.md @@ -0,0 +1,58 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_create_instancegroup.md b/docs/cli/kops_create_instancegroup.md new file mode 100644 index 0000000000..6246f5968b --- /dev/null +++ b/docs/cli/kops_create_instancegroup.md @@ -0,0 +1,32 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_create_secret.md b/docs/cli/kops_create_secret.md new file mode 100644 index 0000000000..2257b37b92 --- /dev/null +++ b/docs/cli/kops_create_secret.md @@ -0,0 +1,29 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_create_secret_sshpublickey.md b/docs/cli/kops_create_secret_sshpublickey.md new file mode 100644 index 0000000000..afa1c9df72 --- /dev/null +++ b/docs/cli/kops_create_secret_sshpublickey.md @@ -0,0 +1,38 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_delete.md b/docs/cli/kops_delete.md new file mode 100644 index 0000000000..391a908d26 --- /dev/null +++ b/docs/cli/kops_delete.md @@ -0,0 +1,31 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_delete_cluster.md b/docs/cli/kops_delete_cluster.md new file mode 100644 index 0000000000..943f61cdb6 --- /dev/null +++ b/docs/cli/kops_delete_cluster.md @@ -0,0 +1,41 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_delete_instancegroup.md b/docs/cli/kops_delete_instancegroup.md new file mode 100644 index 0000000000..105b9b959d --- /dev/null +++ b/docs/cli/kops_delete_instancegroup.md @@ -0,0 +1,32 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_delete_secret.md b/docs/cli/kops_delete_secret.md new file mode 100644 index 0000000000..47869a6e32 --- /dev/null +++ b/docs/cli/kops_delete_secret.md @@ -0,0 +1,32 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_describe.md b/docs/cli/kops_describe.md new file mode 100644 index 0000000000..8654f881c5 --- /dev/null +++ b/docs/cli/kops_describe.md @@ -0,0 +1,29 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_describe_secrets.md b/docs/cli/kops_describe_secrets.md new file mode 100644 index 0000000000..7fb44db69e --- /dev/null +++ b/docs/cli/kops_describe_secrets.md @@ -0,0 +1,38 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_edit.md b/docs/cli/kops_edit.md new file mode 100644 index 0000000000..bb6d0e8249 --- /dev/null +++ b/docs/cli/kops_edit.md @@ -0,0 +1,31 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_edit_cluster.md b/docs/cli/kops_edit_cluster.md new file mode 100644 index 0000000000..73e51dcd45 --- /dev/null +++ b/docs/cli/kops_edit_cluster.md @@ -0,0 +1,32 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_edit_federation.md b/docs/cli/kops_edit_federation.md new file mode 100644 index 0000000000..194c92f428 --- /dev/null +++ b/docs/cli/kops_edit_federation.md @@ -0,0 +1,32 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_edit_instancegroup.md b/docs/cli/kops_edit_instancegroup.md new file mode 100644 index 0000000000..ab35535c73 --- /dev/null +++ b/docs/cli/kops_edit_instancegroup.md @@ -0,0 +1,32 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_export.md b/docs/cli/kops_export.md new file mode 100644 index 0000000000..312df04539 --- /dev/null +++ b/docs/cli/kops_export.md @@ -0,0 +1,29 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_export_kubecfg.md b/docs/cli/kops_export_kubecfg.md new file mode 100644 index 0000000000..d0fd3e944d --- /dev/null +++ b/docs/cli/kops_export_kubecfg.md @@ -0,0 +1,32 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_genhelpdocs.md b/docs/cli/kops_genhelpdocs.md new file mode 100644 index 0000000000..376a60656f --- /dev/null +++ b/docs/cli/kops_genhelpdocs.md @@ -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 diff --git a/docs/cli/kops_get.md b/docs/cli/kops_get.md new file mode 100644 index 0000000000..bbdddeadea --- /dev/null +++ b/docs/cli/kops_get.md @@ -0,0 +1,38 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_get_clusters.md b/docs/cli/kops_get_clusters.md new file mode 100644 index 0000000000..f37df84312 --- /dev/null +++ b/docs/cli/kops_get_clusters.md @@ -0,0 +1,39 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_get_federations.md b/docs/cli/kops_get_federations.md new file mode 100644 index 0000000000..5a2358f72c --- /dev/null +++ b/docs/cli/kops_get_federations.md @@ -0,0 +1,33 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_get_instancegroups.md b/docs/cli/kops_get_instancegroups.md new file mode 100644 index 0000000000..4cbc1c96c2 --- /dev/null +++ b/docs/cli/kops_get_instancegroups.md @@ -0,0 +1,33 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_get_secrets.md b/docs/cli/kops_get_secrets.md new file mode 100644 index 0000000000..44cb34ec8b --- /dev/null +++ b/docs/cli/kops_get_secrets.md @@ -0,0 +1,39 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_import.md b/docs/cli/kops_import.md new file mode 100644 index 0000000000..ebb560dbed --- /dev/null +++ b/docs/cli/kops_import.md @@ -0,0 +1,29 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_import_cluster.md b/docs/cli/kops_import_cluster.md new file mode 100644 index 0000000000..23a02e5bf8 --- /dev/null +++ b/docs/cli/kops_import_cluster.md @@ -0,0 +1,38 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_rolling-update.md b/docs/cli/kops_rolling-update.md new file mode 100644 index 0000000000..bf225bdfc8 --- /dev/null +++ b/docs/cli/kops_rolling-update.md @@ -0,0 +1,29 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_rolling-update_cluster.md b/docs/cli/kops_rolling-update_cluster.md new file mode 100644 index 0000000000..a4ba65dcdf --- /dev/null +++ b/docs/cli/kops_rolling-update_cluster.md @@ -0,0 +1,42 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_secrets.md b/docs/cli/kops_secrets.md new file mode 100644 index 0000000000..5f2f3c2a83 --- /dev/null +++ b/docs/cli/kops_secrets.md @@ -0,0 +1,32 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_secrets_create.md b/docs/cli/kops_secrets_create.md new file mode 100644 index 0000000000..78e4e09d11 --- /dev/null +++ b/docs/cli/kops_secrets_create.md @@ -0,0 +1,32 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_secrets_describe.md b/docs/cli/kops_secrets_describe.md new file mode 100644 index 0000000000..8aadeb243d --- /dev/null +++ b/docs/cli/kops_secrets_describe.md @@ -0,0 +1,32 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_secrets_expose.md b/docs/cli/kops_secrets_expose.md new file mode 100644 index 0000000000..49cd8b9d0d --- /dev/null +++ b/docs/cli/kops_secrets_expose.md @@ -0,0 +1,32 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_secrets_get.md b/docs/cli/kops_secrets_get.md new file mode 100644 index 0000000000..aff43de18a --- /dev/null +++ b/docs/cli/kops_secrets_get.md @@ -0,0 +1,32 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_toolbox.md b/docs/cli/kops_toolbox.md new file mode 100644 index 0000000000..7b322bc89a --- /dev/null +++ b/docs/cli/kops_toolbox.md @@ -0,0 +1,29 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_toolbox_convert-imported.md b/docs/cli/kops_toolbox_convert-imported.md new file mode 100644 index 0000000000..8306e7f69c --- /dev/null +++ b/docs/cli/kops_toolbox_convert-imported.md @@ -0,0 +1,39 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_update.md b/docs/cli/kops_update.md new file mode 100644 index 0000000000..76aa4b0a01 --- /dev/null +++ b/docs/cli/kops_update.md @@ -0,0 +1,30 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_update_cluster.md b/docs/cli/kops_update_cluster.md new file mode 100644 index 0000000000..551f4c0afd --- /dev/null +++ b/docs/cli/kops_update_cluster.md @@ -0,0 +1,42 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_update_federation.md b/docs/cli/kops_update_federation.md new file mode 100644 index 0000000000..734d37191f --- /dev/null +++ b/docs/cli/kops_update_federation.md @@ -0,0 +1,32 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_upgrade.md b/docs/cli/kops_upgrade.md new file mode 100644 index 0000000000..42a080b586 --- /dev/null +++ b/docs/cli/kops_upgrade.md @@ -0,0 +1,29 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_upgrade_cluster.md b/docs/cli/kops_upgrade_cluster.md new file mode 100644 index 0000000000..85f503a2c7 --- /dev/null +++ b/docs/cli/kops_upgrade_cluster.md @@ -0,0 +1,39 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_version.md b/docs/cli/kops_version.md new file mode 100644 index 0000000000..5f01788961 --- /dev/null +++ b/docs/cli/kops_version.md @@ -0,0 +1,32 @@ +## 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 From ea689f8ca9cb1efa5fa21d6e193ed52554b9ccf9 Mon Sep 17 00:00:00 2001 From: Billy Shambrook Date: Sat, 5 Nov 2016 00:27:06 +0000 Subject: [PATCH 2/5] add completion cli command. --- cmd/kops/completion.go | 89 +++++++++++++++++++++++++++++++++++++ docs/cli/kops.md | 2 +- docs/cli/kops_completion.md | 38 ++++++++++++++++ 3 files changed, 128 insertions(+), 1 deletion(-) create mode 100644 cmd/kops/completion.go create mode 100644 docs/cli/kops_completion.md diff --git a/cmd/kops/completion.go b/cmd/kops/completion.go new file mode 100644 index 0000000000..ecd331fb64 --- /dev/null +++ b/cmd/kops/completion.go @@ -0,0 +1,89 @@ +/* +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 completionCmd = CompletionCmd{ + cobraCommand: &cobra.Command{ + Use: "completion", + Short: "Outputs kops shell completion for the given shell (bash)", + }, +} + +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 +} diff --git a/docs/cli/kops.md b/docs/cli/kops.md index 363cde9e73..971e5150a9 100644 --- a/docs/cli/kops.md +++ b/docs/cli/kops.md @@ -24,12 +24,12 @@ It allows you to create, destroy, upgrade and maintain clusters. ``` ### SEE ALSO +* [kops completion](kops_completion.md) - Outputs kops shell completion 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 genhelpdocs](kops_genhelpdocs.md) - Generate CLI help docs * [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 diff --git a/docs/cli/kops_completion.md b/docs/cli/kops_completion.md new file mode 100644 index 0000000000..42d84941c1 --- /dev/null +++ b/docs/cli/kops_completion.md @@ -0,0 +1,38 @@ +## kops completion + +Outputs kops shell completion for the given shell (bash) + +### Synopsis + + +Outputs kops shell completion for the given shell (bash) + +``` +kops completion +``` + +### 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 + +###### Auto generated by spf13/cobra on 5-Nov-2016 From 13919b066a9a0434aefd86ab6c5d31d3c3dfb554 Mon Sep 17 00:00:00 2001 From: Billy Shambrook Date: Tue, 8 Nov 2016 11:52:03 +0000 Subject: [PATCH 3/5] add example to cli help for completion command. --- cmd/kops/completion.go | 17 +++++++++++++++-- docs/cli/kops.md | 2 +- docs/cli/kops_completion.md | 14 ++++++++++++-- 3 files changed, 28 insertions(+), 5 deletions(-) diff --git a/cmd/kops/completion.go b/cmd/kops/completion.go index ecd331fb64..1dbb5a2ce6 100644 --- a/cmd/kops/completion.go +++ b/cmd/kops/completion.go @@ -45,10 +45,23 @@ type CompletionCmd struct { 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: "Outputs kops shell completion for the given shell (bash)", + Use: "completion", + Short: "Output shell completion code for the given shell (bash)", + Long: longDescription, + Example: example, }, } diff --git a/docs/cli/kops.md b/docs/cli/kops.md index 971e5150a9..5a7d31665d 100644 --- a/docs/cli/kops.md +++ b/docs/cli/kops.md @@ -24,7 +24,7 @@ It allows you to create, destroy, upgrade and maintain clusters. ``` ### SEE ALSO -* [kops completion](kops_completion.md) - Outputs kops shell completion for the given shell (bash) +* [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 diff --git a/docs/cli/kops_completion.md b/docs/cli/kops_completion.md index 42d84941c1..5741e0221d 100644 --- a/docs/cli/kops_completion.md +++ b/docs/cli/kops_completion.md @@ -1,16 +1,26 @@ ## kops completion -Outputs kops shell completion for the given shell (bash) +Output shell completion code for the given shell (bash) ### Synopsis -Outputs kops shell completion for the given shell (bash) +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 ``` From 7472349b8647ece9edebee8cf11261f3fb86686b Mon Sep 17 00:00:00 2001 From: Billy Shambrook Date: Tue, 8 Nov 2016 11:56:50 +0000 Subject: [PATCH 4/5] Stop cobra adding a autogenerated comment when creating docs. This is to avoid spamming pull requests. --- cmd/kops/completion.go | 4 ++-- cmd/kops/gen_help_docs.go | 1 + docs/cli/kops.md | 1 - docs/cli/kops_completion.md | 6 +++--- docs/cli/kops_create.md | 1 - docs/cli/kops_create_cluster.md | 1 - docs/cli/kops_create_instancegroup.md | 1 - docs/cli/kops_create_secret.md | 1 - docs/cli/kops_create_secret_sshpublickey.md | 1 - docs/cli/kops_delete.md | 1 - docs/cli/kops_delete_cluster.md | 1 - docs/cli/kops_delete_instancegroup.md | 1 - docs/cli/kops_delete_secret.md | 1 - docs/cli/kops_describe.md | 1 - docs/cli/kops_describe_secrets.md | 1 - docs/cli/kops_edit.md | 1 - docs/cli/kops_edit_cluster.md | 1 - docs/cli/kops_edit_federation.md | 1 - docs/cli/kops_edit_instancegroup.md | 1 - docs/cli/kops_export.md | 1 - docs/cli/kops_export_kubecfg.md | 1 - docs/cli/kops_get.md | 1 - docs/cli/kops_get_clusters.md | 1 - docs/cli/kops_get_federations.md | 1 - docs/cli/kops_get_instancegroups.md | 1 - docs/cli/kops_get_secrets.md | 1 - docs/cli/kops_import.md | 1 - docs/cli/kops_import_cluster.md | 1 - docs/cli/kops_rolling-update.md | 1 - docs/cli/kops_rolling-update_cluster.md | 1 - docs/cli/kops_secrets.md | 1 - docs/cli/kops_secrets_create.md | 1 - docs/cli/kops_secrets_describe.md | 1 - docs/cli/kops_secrets_expose.md | 1 - docs/cli/kops_secrets_get.md | 1 - docs/cli/kops_toolbox.md | 1 - docs/cli/kops_toolbox_convert-imported.md | 1 - docs/cli/kops_update.md | 1 - docs/cli/kops_update_cluster.md | 1 - docs/cli/kops_update_federation.md | 1 - docs/cli/kops_upgrade.md | 1 - docs/cli/kops_upgrade_cluster.md | 1 - docs/cli/kops_version.md | 1 - 43 files changed, 6 insertions(+), 45 deletions(-) diff --git a/cmd/kops/completion.go b/cmd/kops/completion.go index 1dbb5a2ce6..682755223d 100644 --- a/cmd/kops/completion.go +++ b/cmd/kops/completion.go @@ -52,8 +52,8 @@ 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)` +# load in the kops completion code for bash (depends on the bash-completion framework). +source <(kops completion bash)` ) var completionCmd = CompletionCmd{ diff --git a/cmd/kops/gen_help_docs.go b/cmd/kops/gen_help_docs.go index 4285eb8418..1873181e12 100644 --- a/cmd/kops/gen_help_docs.go +++ b/cmd/kops/gen_help_docs.go @@ -49,6 +49,7 @@ func init() { } func (c *GenHelpDocsCmd) Run() error { + rootCommand.cobraCommand.DisableAutoGenTag = true err := doc.GenMarkdownTree(rootCommand.cobraCommand, c.OutDir) return err diff --git a/docs/cli/kops.md b/docs/cli/kops.md index 5a7d31665d..88d60b1655 100644 --- a/docs/cli/kops.md +++ b/docs/cli/kops.md @@ -39,4 +39,3 @@ It allows you to create, destroy, upgrade and maintain clusters. * [kops upgrade](kops_upgrade.md) - upgrade clusters * [kops version](kops_version.md) - Print the client version information -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_completion.md b/docs/cli/kops_completion.md index 5741e0221d..79aae96069 100644 --- a/docs/cli/kops_completion.md +++ b/docs/cli/kops_completion.md @@ -17,8 +17,9 @@ kops completion ### Examples ``` -# load in the kops completion code for bash (depends on the bash-completion framework). -source <(kops completion bash) + + # load in the kops completion code for bash (depends on the bash-completion framework). + source <(kops completion bash) ``` ### Options @@ -45,4 +46,3 @@ source <(kops completion bash) ### SEE ALSO * [kops](kops.md) - kops is kubernetes ops -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_create.md b/docs/cli/kops_create.md index 744377b3a1..c899e8ae3c 100644 --- a/docs/cli/kops_create.md +++ b/docs/cli/kops_create.md @@ -38,4 +38,3 @@ kops create -f FILENAME * [kops create instancegroup](kops_create_instancegroup.md) - Create instancegroup * [kops create secret](kops_create_secret.md) - Create secrets -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_create_cluster.md b/docs/cli/kops_create_cluster.md index 5dad56217d..dc62b5dadd 100644 --- a/docs/cli/kops_create_cluster.md +++ b/docs/cli/kops_create_cluster.md @@ -55,4 +55,3 @@ kops create cluster ### SEE ALSO * [kops create](kops_create.md) - Create a resource by filename or stdin -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_create_instancegroup.md b/docs/cli/kops_create_instancegroup.md index 6246f5968b..0acf0a8c3e 100644 --- a/docs/cli/kops_create_instancegroup.md +++ b/docs/cli/kops_create_instancegroup.md @@ -29,4 +29,3 @@ kops create instancegroup ### SEE ALSO * [kops create](kops_create.md) - Create a resource by filename or stdin -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_create_secret.md b/docs/cli/kops_create_secret.md index 2257b37b92..b3b637da58 100644 --- a/docs/cli/kops_create_secret.md +++ b/docs/cli/kops_create_secret.md @@ -26,4 +26,3 @@ Create secrets. * [kops create](kops_create.md) - Create a resource by filename or stdin * [kops create secret sshpublickey](kops_create_secret_sshpublickey.md) - Create SSH publickey -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_create_secret_sshpublickey.md b/docs/cli/kops_create_secret_sshpublickey.md index afa1c9df72..0e9ca714ba 100644 --- a/docs/cli/kops_create_secret_sshpublickey.md +++ b/docs/cli/kops_create_secret_sshpublickey.md @@ -35,4 +35,3 @@ kops create secret sshpublickey ### SEE ALSO * [kops create secret](kops_create_secret.md) - Create secrets -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_delete.md b/docs/cli/kops_delete.md index 391a908d26..0b4d210feb 100644 --- a/docs/cli/kops_delete.md +++ b/docs/cli/kops_delete.md @@ -28,4 +28,3 @@ Delete clusters * [kops delete instancegroup](kops_delete_instancegroup.md) - Delete instancegroup * [kops delete secret](kops_delete_secret.md) - Delete secret -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_delete_cluster.md b/docs/cli/kops_delete_cluster.md index 943f61cdb6..48507c9ca7 100644 --- a/docs/cli/kops_delete_cluster.md +++ b/docs/cli/kops_delete_cluster.md @@ -38,4 +38,3 @@ kops delete cluster CLUSTERNAME [--yes] ### SEE ALSO * [kops delete](kops_delete.md) - delete clusters -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_delete_instancegroup.md b/docs/cli/kops_delete_instancegroup.md index 105b9b959d..afc82e44c9 100644 --- a/docs/cli/kops_delete_instancegroup.md +++ b/docs/cli/kops_delete_instancegroup.md @@ -29,4 +29,3 @@ kops delete instancegroup ### SEE ALSO * [kops delete](kops_delete.md) - delete clusters -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_delete_secret.md b/docs/cli/kops_delete_secret.md index 47869a6e32..34437da787 100644 --- a/docs/cli/kops_delete_secret.md +++ b/docs/cli/kops_delete_secret.md @@ -29,4 +29,3 @@ kops delete secret ### SEE ALSO * [kops delete](kops_delete.md) - delete clusters -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_describe.md b/docs/cli/kops_describe.md index 8654f881c5..cc293fd7b7 100644 --- a/docs/cli/kops_describe.md +++ b/docs/cli/kops_describe.md @@ -26,4 +26,3 @@ describe objects * [kops](kops.md) - kops is kubernetes ops * [kops describe secrets](kops_describe_secrets.md) - Describe secrets -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_describe_secrets.md b/docs/cli/kops_describe_secrets.md index 7fb44db69e..457382e2a3 100644 --- a/docs/cli/kops_describe_secrets.md +++ b/docs/cli/kops_describe_secrets.md @@ -35,4 +35,3 @@ kops describe secrets ### SEE ALSO * [kops describe](kops_describe.md) - describe objects -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_edit.md b/docs/cli/kops_edit.md index bb6d0e8249..7573bde82d 100644 --- a/docs/cli/kops_edit.md +++ b/docs/cli/kops_edit.md @@ -28,4 +28,3 @@ edit items * [kops edit federation](kops_edit_federation.md) - Edit federation * [kops edit instancegroup](kops_edit_instancegroup.md) - Edit instancegroup -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_edit_cluster.md b/docs/cli/kops_edit_cluster.md index 73e51dcd45..f4509c197f 100644 --- a/docs/cli/kops_edit_cluster.md +++ b/docs/cli/kops_edit_cluster.md @@ -29,4 +29,3 @@ kops edit cluster ### SEE ALSO * [kops edit](kops_edit.md) - edit items -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_edit_federation.md b/docs/cli/kops_edit_federation.md index 194c92f428..4a309de8e5 100644 --- a/docs/cli/kops_edit_federation.md +++ b/docs/cli/kops_edit_federation.md @@ -29,4 +29,3 @@ kops edit federation ### SEE ALSO * [kops edit](kops_edit.md) - edit items -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_edit_instancegroup.md b/docs/cli/kops_edit_instancegroup.md index ab35535c73..a2ee539484 100644 --- a/docs/cli/kops_edit_instancegroup.md +++ b/docs/cli/kops_edit_instancegroup.md @@ -29,4 +29,3 @@ kops edit instancegroup ### SEE ALSO * [kops edit](kops_edit.md) - edit items -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_export.md b/docs/cli/kops_export.md index 312df04539..8e6aabd3f6 100644 --- a/docs/cli/kops_export.md +++ b/docs/cli/kops_export.md @@ -26,4 +26,3 @@ export clusters/kubecfg * [kops](kops.md) - kops is kubernetes ops * [kops export kubecfg](kops_export_kubecfg.md) - Generate a kubecfg file for a cluster -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_export_kubecfg.md b/docs/cli/kops_export_kubecfg.md index d0fd3e944d..07df08ace9 100644 --- a/docs/cli/kops_export_kubecfg.md +++ b/docs/cli/kops_export_kubecfg.md @@ -29,4 +29,3 @@ kops export kubecfg CLUSTERNAME ### SEE ALSO * [kops export](kops_export.md) - export clusters/kubecfg -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_get.md b/docs/cli/kops_get.md index bbdddeadea..8c34ebc11d 100644 --- a/docs/cli/kops_get.md +++ b/docs/cli/kops_get.md @@ -35,4 +35,3 @@ list or get objects * [kops get instancegroups](kops_get_instancegroups.md) - get instancegroups * [kops get secrets](kops_get_secrets.md) - get secrets -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_get_clusters.md b/docs/cli/kops_get_clusters.md index f37df84312..e0d3f974cc 100644 --- a/docs/cli/kops_get_clusters.md +++ b/docs/cli/kops_get_clusters.md @@ -36,4 +36,3 @@ kops get clusters ### SEE ALSO * [kops get](kops_get.md) - list or get objects -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_get_federations.md b/docs/cli/kops_get_federations.md index 5a2358f72c..1164701ec1 100644 --- a/docs/cli/kops_get_federations.md +++ b/docs/cli/kops_get_federations.md @@ -30,4 +30,3 @@ kops get federations ### SEE ALSO * [kops get](kops_get.md) - list or get objects -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_get_instancegroups.md b/docs/cli/kops_get_instancegroups.md index 4cbc1c96c2..5d4cb35ab9 100644 --- a/docs/cli/kops_get_instancegroups.md +++ b/docs/cli/kops_get_instancegroups.md @@ -30,4 +30,3 @@ kops get instancegroups ### SEE ALSO * [kops get](kops_get.md) - list or get objects -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_get_secrets.md b/docs/cli/kops_get_secrets.md index 44cb34ec8b..3eaf72f827 100644 --- a/docs/cli/kops_get_secrets.md +++ b/docs/cli/kops_get_secrets.md @@ -36,4 +36,3 @@ kops get secrets ### SEE ALSO * [kops get](kops_get.md) - list or get objects -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_import.md b/docs/cli/kops_import.md index ebb560dbed..463993c9dd 100644 --- a/docs/cli/kops_import.md +++ b/docs/cli/kops_import.md @@ -26,4 +26,3 @@ import clusters * [kops](kops.md) - kops is kubernetes ops * [kops import cluster](kops_import_cluster.md) - Import existing cluster into the state store -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_import_cluster.md b/docs/cli/kops_import_cluster.md index 23a02e5bf8..83ea4693ec 100644 --- a/docs/cli/kops_import_cluster.md +++ b/docs/cli/kops_import_cluster.md @@ -35,4 +35,3 @@ kops import cluster ### SEE ALSO * [kops import](kops_import.md) - import clusters -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_rolling-update.md b/docs/cli/kops_rolling-update.md index bf225bdfc8..773707dd87 100644 --- a/docs/cli/kops_rolling-update.md +++ b/docs/cli/kops_rolling-update.md @@ -26,4 +26,3 @@ rolling update clusters * [kops](kops.md) - kops is kubernetes ops * [kops rolling-update cluster](kops_rolling-update_cluster.md) - rolling-update cluster -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_rolling-update_cluster.md b/docs/cli/kops_rolling-update_cluster.md index a4ba65dcdf..8439dd7132 100644 --- a/docs/cli/kops_rolling-update_cluster.md +++ b/docs/cli/kops_rolling-update_cluster.md @@ -39,4 +39,3 @@ kops rolling-update cluster ### SEE ALSO * [kops rolling-update](kops_rolling-update.md) - rolling update clusters -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_secrets.md b/docs/cli/kops_secrets.md index 5f2f3c2a83..5dfdcfdf20 100644 --- a/docs/cli/kops_secrets.md +++ b/docs/cli/kops_secrets.md @@ -29,4 +29,3 @@ Manage secrets & keys * [kops secrets expose](kops_secrets_expose.md) - Expose secrets * [kops secrets get](kops_secrets_get.md) - Get secrets -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_secrets_create.md b/docs/cli/kops_secrets_create.md index 78e4e09d11..8161bc17cf 100644 --- a/docs/cli/kops_secrets_create.md +++ b/docs/cli/kops_secrets_create.md @@ -29,4 +29,3 @@ kops secrets create ### SEE ALSO * [kops secrets](kops_secrets.md) - Manage secrets & keys -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_secrets_describe.md b/docs/cli/kops_secrets_describe.md index 8aadeb243d..45bda3903a 100644 --- a/docs/cli/kops_secrets_describe.md +++ b/docs/cli/kops_secrets_describe.md @@ -29,4 +29,3 @@ kops secrets describe ### SEE ALSO * [kops secrets](kops_secrets.md) - Manage secrets & keys -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_secrets_expose.md b/docs/cli/kops_secrets_expose.md index 49cd8b9d0d..cad005daf3 100644 --- a/docs/cli/kops_secrets_expose.md +++ b/docs/cli/kops_secrets_expose.md @@ -29,4 +29,3 @@ kops secrets expose ### SEE ALSO * [kops secrets](kops_secrets.md) - Manage secrets & keys -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_secrets_get.md b/docs/cli/kops_secrets_get.md index aff43de18a..4943bf30a3 100644 --- a/docs/cli/kops_secrets_get.md +++ b/docs/cli/kops_secrets_get.md @@ -29,4 +29,3 @@ kops secrets get ### SEE ALSO * [kops secrets](kops_secrets.md) - Manage secrets & keys -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_toolbox.md b/docs/cli/kops_toolbox.md index 7b322bc89a..dd0a76868c 100644 --- a/docs/cli/kops_toolbox.md +++ b/docs/cli/kops_toolbox.md @@ -26,4 +26,3 @@ Misc infrequently used commands * [kops](kops.md) - kops is kubernetes ops * [kops toolbox convert-imported](kops_toolbox_convert-imported.md) - Convert an imported cluster into a kops cluster -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_toolbox_convert-imported.md b/docs/cli/kops_toolbox_convert-imported.md index 8306e7f69c..190fc34da0 100644 --- a/docs/cli/kops_toolbox_convert-imported.md +++ b/docs/cli/kops_toolbox_convert-imported.md @@ -36,4 +36,3 @@ kops toolbox convert-imported ### SEE ALSO * [kops toolbox](kops_toolbox.md) - Misc infrequently used commands -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_update.md b/docs/cli/kops_update.md index 76aa4b0a01..779e725e8c 100644 --- a/docs/cli/kops_update.md +++ b/docs/cli/kops_update.md @@ -27,4 +27,3 @@ Update clusters * [kops update cluster](kops_update_cluster.md) - Update cluster * [kops update federation](kops_update_federation.md) - Update federation -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_update_cluster.md b/docs/cli/kops_update_cluster.md index 551f4c0afd..8f2e802578 100644 --- a/docs/cli/kops_update_cluster.md +++ b/docs/cli/kops_update_cluster.md @@ -39,4 +39,3 @@ kops update cluster ### SEE ALSO * [kops update](kops_update.md) - update clusters -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_update_federation.md b/docs/cli/kops_update_federation.md index 734d37191f..ba608bde2f 100644 --- a/docs/cli/kops_update_federation.md +++ b/docs/cli/kops_update_federation.md @@ -29,4 +29,3 @@ kops update federation ### SEE ALSO * [kops update](kops_update.md) - update clusters -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_upgrade.md b/docs/cli/kops_upgrade.md index 42a080b586..d3b4dcefdf 100644 --- a/docs/cli/kops_upgrade.md +++ b/docs/cli/kops_upgrade.md @@ -26,4 +26,3 @@ upgrade clusters * [kops](kops.md) - kops is kubernetes ops * [kops upgrade cluster](kops_upgrade_cluster.md) - Upgrade cluster -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_upgrade_cluster.md b/docs/cli/kops_upgrade_cluster.md index 85f503a2c7..282126f185 100644 --- a/docs/cli/kops_upgrade_cluster.md +++ b/docs/cli/kops_upgrade_cluster.md @@ -36,4 +36,3 @@ kops upgrade cluster ### SEE ALSO * [kops upgrade](kops_upgrade.md) - upgrade clusters -###### Auto generated by spf13/cobra on 5-Nov-2016 diff --git a/docs/cli/kops_version.md b/docs/cli/kops_version.md index 5f01788961..9146654a8d 100644 --- a/docs/cli/kops_version.md +++ b/docs/cli/kops_version.md @@ -29,4 +29,3 @@ kops version ### SEE ALSO * [kops](kops.md) - kops is kubernetes ops -###### Auto generated by spf13/cobra on 5-Nov-2016 From cca9d62265797a7a0f9a119ef930c6766dd2ec0d Mon Sep 17 00:00:00 2001 From: Billy Shambrook Date: Tue, 8 Nov 2016 12:02:48 +0000 Subject: [PATCH 5/5] Add a development doc about general documentation guidelines --- docs/development/documentation.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 docs/development/documentation.md diff --git a/docs/development/documentation.md b/docs/development/documentation.md new file mode 100644 index 0000000000..1804331486 --- /dev/null +++ b/docs/development/documentation.md @@ -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`).