From bf7646bd9eeda1f841b17b1f128d0c8eab719a98 Mon Sep 17 00:00:00 2001 From: Eric Paris Date: Thu, 3 Sep 2015 17:07:24 -0400 Subject: [PATCH] Update docs based on new spf13/cobra --- contrib/completions/bash/kubectl | 77 ++++--------------- docs/man/man1/kubectl-annotate.1 | 4 - docs/man/man1/kubectl-api-versions.1 | 6 -- docs/man/man1/kubectl-attach.1 | 4 - docs/man/man1/kubectl-cluster-info.1 | 6 -- docs/man/man1/kubectl-config-set-cluster.1 | 4 - docs/man/man1/kubectl-config-set-context.1 | 4 - .../man/man1/kubectl-config-set-credentials.1 | 4 - docs/man/man1/kubectl-config-set.1 | 6 -- docs/man/man1/kubectl-config-unset.1 | 6 -- docs/man/man1/kubectl-config-use-context.1 | 6 -- docs/man/man1/kubectl-config-view.1 | 4 - docs/man/man1/kubectl-config.1 | 4 - docs/man/man1/kubectl-create.1 | 4 - docs/man/man1/kubectl-delete.1 | 4 - docs/man/man1/kubectl-describe.1 | 4 - docs/man/man1/kubectl-exec.1 | 4 - docs/man/man1/kubectl-expose.1 | 4 - docs/man/man1/kubectl-get.1 | 4 - docs/man/man1/kubectl-label.1 | 4 - docs/man/man1/kubectl-logs.1 | 4 - docs/man/man1/kubectl-namespace.1 | 6 -- docs/man/man1/kubectl-patch.1 | 4 - docs/man/man1/kubectl-port-forward.1 | 4 - docs/man/man1/kubectl-proxy.1 | 4 - docs/man/man1/kubectl-replace.1 | 4 - docs/man/man1/kubectl-rolling-update.1 | 4 - docs/man/man1/kubectl-run.1 | 4 - docs/man/man1/kubectl-scale.1 | 4 - docs/man/man1/kubectl-stop.1 | 4 - docs/man/man1/kubectl-version.1 | 4 - docs/man/man1/kubectl.1 | 4 - docs/user-guide/kubectl/kubectl.md | 3 +- docs/user-guide/kubectl/kubectl_annotate.md | 3 +- .../kubectl/kubectl_api-versions.md | 8 +- docs/user-guide/kubectl/kubectl_attach.md | 3 +- .../kubectl/kubectl_cluster-info.md | 8 +- docs/user-guide/kubectl/kubectl_config.md | 3 +- .../kubectl/kubectl_config_set-cluster.md | 3 +- .../kubectl/kubectl_config_set-context.md | 3 +- .../kubectl/kubectl_config_set-credentials.md | 3 +- docs/user-guide/kubectl/kubectl_config_set.md | 8 +- .../kubectl/kubectl_config_unset.md | 8 +- .../kubectl/kubectl_config_use-context.md | 8 +- .../user-guide/kubectl/kubectl_config_view.md | 3 +- docs/user-guide/kubectl/kubectl_create.md | 3 +- docs/user-guide/kubectl/kubectl_delete.md | 3 +- docs/user-guide/kubectl/kubectl_describe.md | 3 +- docs/user-guide/kubectl/kubectl_exec.md | 3 +- docs/user-guide/kubectl/kubectl_expose.md | 3 +- docs/user-guide/kubectl/kubectl_get.md | 3 +- docs/user-guide/kubectl/kubectl_label.md | 3 +- docs/user-guide/kubectl/kubectl_logs.md | 3 +- docs/user-guide/kubectl/kubectl_namespace.md | 8 +- docs/user-guide/kubectl/kubectl_patch.md | 3 +- .../kubectl/kubectl_port-forward.md | 3 +- docs/user-guide/kubectl/kubectl_proxy.md | 3 +- docs/user-guide/kubectl/kubectl_replace.md | 3 +- .../kubectl/kubectl_rolling-update.md | 3 +- docs/user-guide/kubectl/kubectl_run.md | 3 +- docs/user-guide/kubectl/kubectl_scale.md | 3 +- docs/user-guide/kubectl/kubectl_stop.md | 3 +- docs/user-guide/kubectl/kubectl_version.md | 3 +- 63 files changed, 44 insertions(+), 292 deletions(-) diff --git a/contrib/completions/bash/kubectl b/contrib/completions/bash/kubectl index 84ce513a09e3e..34bd8d3c7a0c6 100644 --- a/contrib/completions/bash/kubectl +++ b/contrib/completions/bash/kubectl @@ -1,6 +1,5 @@ #!/bin/bash - __debug() { if [[ -n ${BASH_COMP_DEBUG_FILE} ]]; then @@ -8,6 +7,14 @@ __debug() fi } +# Homebrew on Macs have version 1.3 of bash-completion which doesn't include +# _init_completion. This is a very minimal version of that function. +__my_init_completion() +{ + COMPREPLY=() + _get_comp_words_by_ref cur prev words cword +} + __index_of_word() { local w word=$1 @@ -260,8 +267,6 @@ _kubectl_get() two_word_flags+=("-f") flags_with_completion+=("-f") flags_completion+=("__handle_filename_extension_flag json|stdin|yaml|yml") - flags+=("--help") - flags+=("-h") flags+=("--label-columns=") two_word_flags+=("-L") flags+=("--no-headers") @@ -317,8 +322,6 @@ _kubectl_describe() two_word_flags+=("-f") flags_with_completion+=("-f") flags_completion+=("__handle_filename_extension_flag json|stdin|yaml|yml") - flags+=("--help") - flags+=("-h") flags+=("--selector=") two_word_flags+=("-l") @@ -354,8 +357,6 @@ _kubectl_create() two_word_flags+=("-f") flags_with_completion+=("-f") flags_completion+=("__handle_filename_extension_flag json|stdin|yaml|yml") - flags+=("--help") - flags+=("-h") flags+=("--output=") two_word_flags+=("-o") flags+=("--validate") @@ -385,8 +386,6 @@ _kubectl_replace() flags_completion+=("__handle_filename_extension_flag json|stdin|yaml|yml") flags+=("--force") flags+=("--grace-period=") - flags+=("--help") - flags+=("-h") flags+=("--output=") two_word_flags+=("-o") flags+=("--timeout=") @@ -414,8 +413,6 @@ _kubectl_patch() two_word_flags+=("-f") flags_with_completion+=("-f") flags_completion+=("__handle_filename_extension_flag json|stdin|yaml|yml") - flags+=("--help") - flags+=("-h") flags+=("--output=") two_word_flags+=("-o") flags+=("--patch=") @@ -446,8 +443,6 @@ _kubectl_delete() flags_with_completion+=("-f") flags_completion+=("__handle_filename_extension_flag json|stdin|yaml|yml") flags+=("--grace-period=") - flags+=("--help") - flags+=("-h") flags+=("--ignore-not-found") flags+=("--output=") two_word_flags+=("-o") @@ -487,8 +482,6 @@ _kubectl_namespace() flags_with_completion=() flags_completion=() - flags+=("--help") - flags+=("-h") must_have_one_flag=() must_have_one_noun=() @@ -508,8 +501,6 @@ _kubectl_logs() two_word_flags+=("-c") flags+=("--follow") flags+=("-f") - flags+=("--help") - flags+=("-h") flags+=("--interactive") flags+=("--previous") flags+=("-p") @@ -536,8 +527,6 @@ _kubectl_rolling-update() two_word_flags+=("-f") flags_with_completion+=("-f") flags_completion+=("__handle_filename_extension_flag json|stdin|yaml|yml") - flags+=("--help") - flags+=("-h") flags+=("--image=") flags+=("--no-headers") flags+=("--output=") @@ -578,8 +567,6 @@ _kubectl_scale() two_word_flags+=("-f") flags_with_completion+=("-f") flags_completion+=("__handle_filename_extension_flag json|stdin|yaml|yml") - flags+=("--help") - flags+=("-h") flags+=("--output=") two_word_flags+=("-o") flags+=("--replicas=") @@ -603,8 +590,6 @@ _kubectl_attach() flags+=("--container=") two_word_flags+=("-c") - flags+=("--help") - flags+=("-h") flags+=("--stdin") flags+=("-i") flags+=("--tty") @@ -626,8 +611,6 @@ _kubectl_exec() flags+=("--container=") two_word_flags+=("-c") - flags+=("--help") - flags+=("-h") flags+=("--pod=") two_word_flags+=("-p") flags+=("--stdin") @@ -649,8 +632,6 @@ _kubectl_port-forward() flags_with_completion=() flags_completion=() - flags+=("--help") - flags+=("-h") flags+=("--pod=") two_word_flags+=("-p") @@ -672,8 +653,6 @@ _kubectl_proxy() flags+=("--accept-paths=") flags+=("--api-prefix=") flags+=("--disable-filter") - flags+=("--help") - flags+=("-h") flags+=("--port=") two_word_flags+=("-p") flags+=("--reject-methods=") @@ -703,8 +682,6 @@ _kubectl_run() flags+=("--command") flags+=("--dry-run") flags+=("--generator=") - flags+=("--help") - flags+=("-h") flags+=("--hostport=") flags+=("--image=") flags+=("--labels=") @@ -750,8 +727,6 @@ _kubectl_stop() flags_with_completion+=("-f") flags_completion+=("__handle_filename_extension_flag json|stdin|yaml|yml") flags+=("--grace-period=") - flags+=("--help") - flags+=("-h") flags+=("--ignore-not-found") flags+=("--output=") two_word_flags+=("-o") @@ -784,8 +759,6 @@ _kubectl_expose() flags_with_completion+=("-f") flags_completion+=("__handle_filename_extension_flag json|stdin|yaml|yml") flags+=("--generator=") - flags+=("--help") - flags+=("-h") flags+=("--labels=") two_word_flags+=("-l") flags+=("--name=") @@ -829,8 +802,6 @@ _kubectl_label() two_word_flags+=("-f") flags_with_completion+=("-f") flags_completion+=("__handle_filename_extension_flag json|stdin|yaml|yml") - flags+=("--help") - flags+=("-h") flags+=("--no-headers") flags+=("--output=") two_word_flags+=("-o") @@ -884,8 +855,6 @@ _kubectl_annotate() two_word_flags+=("-f") flags_with_completion+=("-f") flags_completion+=("__handle_filename_extension_flag json|stdin|yaml|yml") - flags+=("--help") - flags+=("-h") flags+=("--overwrite") flags+=("--resource-version=") @@ -904,8 +873,6 @@ _kubectl_config_view() flags_completion=() flags+=("--flatten") - flags+=("--help") - flags+=("-h") flags+=("--merge") flags+=("--minify") flags+=("--no-headers") @@ -936,8 +903,6 @@ _kubectl_config_set-cluster() flags+=("--api-version=") flags+=("--certificate-authority=") flags+=("--embed-certs") - flags+=("--help") - flags+=("-h") flags+=("--insecure-skip-tls-verify") flags+=("--server=") @@ -958,8 +923,6 @@ _kubectl_config_set-credentials() flags+=("--client-certificate=") flags+=("--client-key=") flags+=("--embed-certs") - flags+=("--help") - flags+=("-h") flags+=("--password=") flags+=("--token=") flags+=("--username=") @@ -979,8 +942,6 @@ _kubectl_config_set-context() flags_completion=() flags+=("--cluster=") - flags+=("--help") - flags+=("-h") flags+=("--namespace=") flags+=("--user=") @@ -998,8 +959,6 @@ _kubectl_config_set() flags_with_completion=() flags_completion=() - flags+=("--help") - flags+=("-h") must_have_one_flag=() must_have_one_noun=() @@ -1015,8 +974,6 @@ _kubectl_config_unset() flags_with_completion=() flags_completion=() - flags+=("--help") - flags+=("-h") must_have_one_flag=() must_have_one_noun=() @@ -1032,8 +989,6 @@ _kubectl_config_use-context() flags_with_completion=() flags_completion=() - flags+=("--help") - flags+=("-h") must_have_one_flag=() must_have_one_noun=() @@ -1056,8 +1011,6 @@ _kubectl_config() flags_with_completion=() flags_completion=() - flags+=("--help") - flags+=("-h") flags+=("--kubeconfig=") must_have_one_flag=() @@ -1074,8 +1027,6 @@ _kubectl_cluster-info() flags_with_completion=() flags_completion=() - flags+=("--help") - flags+=("-h") must_have_one_flag=() must_have_one_noun=() @@ -1091,8 +1042,6 @@ _kubectl_api-versions() flags_with_completion=() flags_completion=() - flags+=("--help") - flags+=("-h") must_have_one_flag=() must_have_one_noun=() @@ -1110,8 +1059,6 @@ _kubectl_version() flags+=("--client") flags+=("-c") - flags+=("--help") - flags+=("-h") must_have_one_flag=() must_have_one_noun=() @@ -1157,8 +1104,6 @@ _kubectl() flags+=("--client-key=") flags+=("--cluster=") flags+=("--context=") - flags+=("--help") - flags+=("-h") flags+=("--insecure-skip-tls-verify") flags+=("--kubeconfig=") flags+=("--log-backtrace-at=") @@ -1184,7 +1129,11 @@ _kubectl() __start_kubectl() { local cur prev words cword - _init_completion -s || return + if declare -F _init_completions >/dev/null 2>&1; then + _init_completion -s || return + else + __my_init_completion || return + fi local c=0 local flags=() diff --git a/docs/man/man1/kubectl-annotate.1 b/docs/man/man1/kubectl-annotate.1 index 6b2666c87bc1d..15396b5ae7727 100644 --- a/docs/man/man1/kubectl-annotate.1 +++ b/docs/man/man1/kubectl-annotate.1 @@ -37,10 +37,6 @@ resourcequotas (quota) or secrets. \fB\-f\fP, \fB\-\-filename\fP=[] Filename, directory, or URL to a file identifying the resource to update the annotation -.PP -\fB\-h\fP, \fB\-\-help\fP=false - help for annotate - .PP \fB\-\-overwrite\fP=false If true, allow annotations to be overwritten, otherwise reject annotation updates that overwrite existing annotations. diff --git a/docs/man/man1/kubectl-api-versions.1 b/docs/man/man1/kubectl-api-versions.1 index 7ee68b2c2bd5a..a0c08afe9d146 100644 --- a/docs/man/man1/kubectl-api-versions.1 +++ b/docs/man/man1/kubectl-api-versions.1 @@ -16,12 +16,6 @@ kubectl api\-versions \- Print available API versions. Print available API versions. -.SH OPTIONS -.PP -\fB\-h\fP, \fB\-\-help\fP=false - help for api\-versions - - .SH OPTIONS INHERITED FROM PARENT COMMANDS .PP \fB\-\-alsologtostderr\fP=false diff --git a/docs/man/man1/kubectl-attach.1 b/docs/man/man1/kubectl-attach.1 index 55de8f34243a9..a5d499d20d286 100644 --- a/docs/man/man1/kubectl-attach.1 +++ b/docs/man/man1/kubectl-attach.1 @@ -21,10 +21,6 @@ Attach to a a process that is already running inside an existing container. \fB\-c\fP, \fB\-\-container\fP="" Container name -.PP -\fB\-h\fP, \fB\-\-help\fP=false - help for attach - .PP \fB\-i\fP, \fB\-\-stdin\fP=false Pass stdin to the container diff --git a/docs/man/man1/kubectl-cluster-info.1 b/docs/man/man1/kubectl-cluster-info.1 index 8d2c19a9a5f27..5be571dc06f33 100644 --- a/docs/man/man1/kubectl-cluster-info.1 +++ b/docs/man/man1/kubectl-cluster-info.1 @@ -16,12 +16,6 @@ kubectl cluster\-info \- Display cluster info Display addresses of the master and services with label kubernetes.io/cluster\-service=true -.SH OPTIONS -.PP -\fB\-h\fP, \fB\-\-help\fP=false - help for cluster\-info - - .SH OPTIONS INHERITED FROM PARENT COMMANDS .PP \fB\-\-alsologtostderr\fP=false diff --git a/docs/man/man1/kubectl-config-set-cluster.1 b/docs/man/man1/kubectl-config-set-cluster.1 index f89e66e497141..39dedd8d014cb 100644 --- a/docs/man/man1/kubectl-config-set-cluster.1 +++ b/docs/man/man1/kubectl-config-set-cluster.1 @@ -30,10 +30,6 @@ Specifying a name that already exists will merge new fields on top of existing v \fB\-\-embed\-certs\fP=false embed\-certs for the cluster entry in kubeconfig -.PP -\fB\-h\fP, \fB\-\-help\fP=false - help for set\-cluster - .PP \fB\-\-insecure\-skip\-tls\-verify\fP=false insecure\-skip\-tls\-verify for the cluster entry in kubeconfig diff --git a/docs/man/man1/kubectl-config-set-context.1 b/docs/man/man1/kubectl-config-set-context.1 index 389c0f0e31186..9cfc976ba844d 100644 --- a/docs/man/man1/kubectl-config-set-context.1 +++ b/docs/man/man1/kubectl-config-set-context.1 @@ -22,10 +22,6 @@ Specifying a name that already exists will merge new fields on top of existing v \fB\-\-cluster\fP="" cluster for the context entry in kubeconfig -.PP -\fB\-h\fP, \fB\-\-help\fP=false - help for set\-context - .PP \fB\-\-namespace\fP="" namespace for the context entry in kubeconfig diff --git a/docs/man/man1/kubectl-config-set-credentials.1 b/docs/man/man1/kubectl-config-set-credentials.1 index 9e752ce55cc4d..749eabc107b99 100644 --- a/docs/man/man1/kubectl-config-set-credentials.1 +++ b/docs/man/man1/kubectl-config-set-credentials.1 @@ -45,10 +45,6 @@ Bearer token and basic auth are mutually exclusive. \fB\-\-embed\-certs\fP=false embed client cert/key for the user entry in kubeconfig -.PP -\fB\-h\fP, \fB\-\-help\fP=false - help for set\-credentials - .PP \fB\-\-password\fP="" password for the user entry in kubeconfig diff --git a/docs/man/man1/kubectl-config-set.1 b/docs/man/man1/kubectl-config-set.1 index ccbd2645f554d..18f1c9ebdbbc2 100644 --- a/docs/man/man1/kubectl-config-set.1 +++ b/docs/man/man1/kubectl-config-set.1 @@ -18,12 +18,6 @@ PROPERTY\_NAME is a dot delimited name where each token represents either a attr PROPERTY\_VALUE is the new value you wish to set. -.SH OPTIONS -.PP -\fB\-h\fP, \fB\-\-help\fP=false - help for set - - .SH OPTIONS INHERITED FROM PARENT COMMANDS .PP \fB\-\-alsologtostderr\fP=false diff --git a/docs/man/man1/kubectl-config-unset.1 b/docs/man/man1/kubectl-config-unset.1 index 2e676d52901b3..99a5a53f28258 100644 --- a/docs/man/man1/kubectl-config-unset.1 +++ b/docs/man/man1/kubectl-config-unset.1 @@ -17,12 +17,6 @@ Unsets an individual value in a kubeconfig file PROPERTY\_NAME is a dot delimited name where each token represents either a attribute name or a map key. Map keys may not contain dots. -.SH OPTIONS -.PP -\fB\-h\fP, \fB\-\-help\fP=false - help for unset - - .SH OPTIONS INHERITED FROM PARENT COMMANDS .PP \fB\-\-alsologtostderr\fP=false diff --git a/docs/man/man1/kubectl-config-use-context.1 b/docs/man/man1/kubectl-config-use-context.1 index 35d7cc4a10bcb..e0758fc894406 100644 --- a/docs/man/man1/kubectl-config-use-context.1 +++ b/docs/man/man1/kubectl-config-use-context.1 @@ -16,12 +16,6 @@ kubectl config use\-context \- Sets the current\-context in a kubeconfig file Sets the current\-context in a kubeconfig file -.SH OPTIONS -.PP -\fB\-h\fP, \fB\-\-help\fP=false - help for use\-context - - .SH OPTIONS INHERITED FROM PARENT COMMANDS .PP \fB\-\-alsologtostderr\fP=false diff --git a/docs/man/man1/kubectl-config-view.1 b/docs/man/man1/kubectl-config-view.1 index e679fc132c28a..25ab0462cac48 100644 --- a/docs/man/man1/kubectl-config-view.1 +++ b/docs/man/man1/kubectl-config-view.1 @@ -24,10 +24,6 @@ You can use \-\-output=template \-\-template=TEMPLATE to extract specific values \fB\-\-flatten\fP=false flatten the resulting kubeconfig file into self contained output (useful for creating portable kubeconfig files) -.PP -\fB\-h\fP, \fB\-\-help\fP=false - help for view - .PP \fB\-\-merge\fP=true merge together the full hierarchy of kubeconfig files diff --git a/docs/man/man1/kubectl-config.1 b/docs/man/man1/kubectl-config.1 index 885683681566e..6568d96bb67ca 100644 --- a/docs/man/man1/kubectl-config.1 +++ b/docs/man/man1/kubectl-config.1 @@ -23,10 +23,6 @@ The loading order follows these rules: .SH OPTIONS -.PP -\fB\-h\fP, \fB\-\-help\fP=false - help for config - .PP \fB\-\-kubeconfig\fP="" use a particular kubeconfig file diff --git a/docs/man/man1/kubectl-create.1 b/docs/man/man1/kubectl-create.1 index 7d991f9088e20..d41c10737035a 100644 --- a/docs/man/man1/kubectl-create.1 +++ b/docs/man/man1/kubectl-create.1 @@ -24,10 +24,6 @@ JSON and YAML formats are accepted. \fB\-f\fP, \fB\-\-filename\fP=[] Filename, directory, or URL to file to use to create the resource -.PP -\fB\-h\fP, \fB\-\-help\fP=false - help for create - .PP \fB\-o\fP, \fB\-\-output\fP="" Output mode. Use "\-o name" for shorter output (resource/name). diff --git a/docs/man/man1/kubectl-delete.1 b/docs/man/man1/kubectl-delete.1 index f4d2fbe7568d8..feefc5ba68a52 100644 --- a/docs/man/man1/kubectl-delete.1 +++ b/docs/man/man1/kubectl-delete.1 @@ -44,10 +44,6 @@ will be lost along with the rest of the resource. \fB\-\-grace\-period\fP=\-1 Period of time in seconds given to the resource to terminate gracefully. Ignored if negative. -.PP -\fB\-h\fP, \fB\-\-help\fP=false - help for delete - .PP \fB\-\-ignore\-not\-found\fP=false Treat "resource not found" as a successful delete. Defaults to "true" when \-\-all is specified. diff --git a/docs/man/man1/kubectl-describe.1 b/docs/man/man1/kubectl-describe.1 index bc4f4a1bbbf02..9633eb1da5f7b 100644 --- a/docs/man/man1/kubectl-describe.1 +++ b/docs/man/man1/kubectl-describe.1 @@ -38,10 +38,6 @@ namespaces (ns) or secrets. \fB\-f\fP, \fB\-\-filename\fP=[] Filename, directory, or URL to a file containing the resource to describe -.PP -\fB\-h\fP, \fB\-\-help\fP=false - help for describe - .PP \fB\-l\fP, \fB\-\-selector\fP="" Selector (label query) to filter on diff --git a/docs/man/man1/kubectl-exec.1 b/docs/man/man1/kubectl-exec.1 index 942f9a21bf4a1..65c5bf8f9c7f6 100644 --- a/docs/man/man1/kubectl-exec.1 +++ b/docs/man/man1/kubectl-exec.1 @@ -21,10 +21,6 @@ Execute a command in a container. \fB\-c\fP, \fB\-\-container\fP="" Container name. If omitted, the first container in the pod will be chosen -.PP -\fB\-h\fP, \fB\-\-help\fP=false - help for exec - .PP \fB\-p\fP, \fB\-\-pod\fP="" Pod name diff --git a/docs/man/man1/kubectl-expose.1 b/docs/man/man1/kubectl-expose.1 index cb48a3ad21f9b..d148ffcaf0db4 100644 --- a/docs/man/man1/kubectl-expose.1 +++ b/docs/man/man1/kubectl-expose.1 @@ -46,10 +46,6 @@ re\-use the labels from the resource it exposes. \fB\-\-generator\fP="service/v2" The name of the API generator to use. There are 2 generators: 'service/v1' and 'service/v2'. The only difference between them is that service port in v1 is named 'default', while it is left unnamed in v2. Default is 'service/v2'. -.PP -\fB\-h\fP, \fB\-\-help\fP=false - help for expose - .PP \fB\-l\fP, \fB\-\-labels\fP="" Labels to apply to the service created by this call. diff --git a/docs/man/man1/kubectl-get.1 b/docs/man/man1/kubectl-get.1 index 85f302ba21bff..3c94adeb246f3 100644 --- a/docs/man/man1/kubectl-get.1 +++ b/docs/man/man1/kubectl-get.1 @@ -35,10 +35,6 @@ of the \-\-template flag, you can filter the attributes of the fetched resource( \fB\-f\fP, \fB\-\-filename\fP=[] Filename, directory, or URL to a file identifying the resource to get from a server. -.PP -\fB\-h\fP, \fB\-\-help\fP=false - help for get - .PP \fB\-L\fP, \fB\-\-label\-columns\fP=[] Accepts a comma separated list of labels that are going to be presented as columns. Names are case\-sensitive. You can also use multiple flag statements like \-L label1 \-L label2... diff --git a/docs/man/man1/kubectl-label.1 b/docs/man/man1/kubectl-label.1 index 22eb98fce493d..98cf53ae94895 100644 --- a/docs/man/man1/kubectl-label.1 +++ b/docs/man/man1/kubectl-label.1 @@ -34,10 +34,6 @@ If \-\-resource\-version is specified, then updates will use this resource versi \fB\-f\fP, \fB\-\-filename\fP=[] Filename, directory, or URL to a file identifying the resource to update the labels -.PP -\fB\-h\fP, \fB\-\-help\fP=false - help for label - .PP \fB\-\-no\-headers\fP=false When using the default output, don't print headers. diff --git a/docs/man/man1/kubectl-logs.1 b/docs/man/man1/kubectl-logs.1 index 83b2f7b0a265f..ca4c778353813 100644 --- a/docs/man/man1/kubectl-logs.1 +++ b/docs/man/man1/kubectl-logs.1 @@ -25,10 +25,6 @@ Print the logs for a container in a pod. If the pod has only one container, the \fB\-f\fP, \fB\-\-follow\fP=false Specify if the logs should be streamed. -.PP -\fB\-h\fP, \fB\-\-help\fP=false - help for logs - .PP \fB\-\-interactive\fP=true If true, prompt the user for input when required. Default true. diff --git a/docs/man/man1/kubectl-namespace.1 b/docs/man/man1/kubectl-namespace.1 index c2d0ab18efc17..98af4283c49fe 100644 --- a/docs/man/man1/kubectl-namespace.1 +++ b/docs/man/man1/kubectl-namespace.1 @@ -19,12 +19,6 @@ SUPERSEDED: Set and view the current Kubernetes namespace scope for command lin namespace has been superseded by the context.namespace field of .kubeconfig files. See 'kubectl config set\-context \-\-help' for more details. -.SH OPTIONS -.PP -\fB\-h\fP, \fB\-\-help\fP=false - help for namespace - - .SH OPTIONS INHERITED FROM PARENT COMMANDS .PP \fB\-\-alsologtostderr\fP=false diff --git a/docs/man/man1/kubectl-patch.1 b/docs/man/man1/kubectl-patch.1 index ff692ad024d05..db3c8a520f787 100644 --- a/docs/man/man1/kubectl-patch.1 +++ b/docs/man/man1/kubectl-patch.1 @@ -28,10 +28,6 @@ Please refer to the models in \fB\-f\fP, \fB\-\-filename\fP=[] Filename, directory, or URL to a file identifying the resource to update -.PP -\fB\-h\fP, \fB\-\-help\fP=false - help for patch - .PP \fB\-o\fP, \fB\-\-output\fP="" Output mode. Use "\-o name" for shorter output (resource/name). diff --git a/docs/man/man1/kubectl-port-forward.1 b/docs/man/man1/kubectl-port-forward.1 index 4f158b237c02b..883c9c04388b1 100644 --- a/docs/man/man1/kubectl-port-forward.1 +++ b/docs/man/man1/kubectl-port-forward.1 @@ -17,10 +17,6 @@ Forward one or more local ports to a pod. .SH OPTIONS -.PP -\fB\-h\fP, \fB\-\-help\fP=false - help for port\-forward - .PP \fB\-p\fP, \fB\-\-pod\fP="" Pod name diff --git a/docs/man/man1/kubectl-proxy.1 b/docs/man/man1/kubectl-proxy.1 index 8144e15e5df8b..b2e232da80003 100644 --- a/docs/man/man1/kubectl-proxy.1 +++ b/docs/man/man1/kubectl-proxy.1 @@ -54,10 +54,6 @@ The above lets you 'curl localhost:8001/custom/api/v1/pods' \fB\-\-disable\-filter\fP=false If true, disable request filtering in the proxy. This is dangerous, and can leave you vulnerable to XSRF attacks, when used with an accessible port. -.PP -\fB\-h\fP, \fB\-\-help\fP=false - help for proxy - .PP \fB\-p\fP, \fB\-\-port\fP=8001 The port on which to run the proxy. Set to 0 to pick a random port. diff --git a/docs/man/man1/kubectl-replace.1 b/docs/man/man1/kubectl-replace.1 index a60ddcd2e1e8c..b76175b1aa297 100644 --- a/docs/man/man1/kubectl-replace.1 +++ b/docs/man/man1/kubectl-replace.1 @@ -42,10 +42,6 @@ Please refer to the models in \fB\-\-grace\-period\fP=\-1 Only relevant during a force replace. Period of time in seconds given to the old resource to terminate gracefully. Ignored if negative. -.PP -\fB\-h\fP, \fB\-\-help\fP=false - help for replace - .PP \fB\-o\fP, \fB\-\-output\fP="" Output mode. Use "\-o name" for shorter output (resource/name). diff --git a/docs/man/man1/kubectl-rolling-update.1 b/docs/man/man1/kubectl-rolling-update.1 index ad28bb51d5dc7..32ae729db9384 100644 --- a/docs/man/man1/kubectl-rolling-update.1 +++ b/docs/man/man1/kubectl-rolling-update.1 @@ -34,10 +34,6 @@ existing replication controller and overwrite at least one (common) label in its \fB\-f\fP, \fB\-\-filename\fP=[] Filename or URL to file to use to create the new replication controller. -.PP -\fB\-h\fP, \fB\-\-help\fP=false - help for rolling\-update - .PP \fB\-\-image\fP="" Image to use for upgrading the replication controller. Can not be used with \-\-filename/\-f diff --git a/docs/man/man1/kubectl-run.1 b/docs/man/man1/kubectl-run.1 index 88dc6300517ad..5df0bb6c1892d 100644 --- a/docs/man/man1/kubectl-run.1 +++ b/docs/man/man1/kubectl-run.1 @@ -34,10 +34,6 @@ Creates a replication controller to manage the created container(s). \fB\-\-generator\fP="" The name of the API generator to use. Default is 'run/v1' if \-\-restart=Always, otherwise the default is 'run\-pod/v1'. -.PP -\fB\-h\fP, \fB\-\-help\fP=false - help for run - .PP \fB\-\-hostport\fP=\-1 The host port mapping for the container port. To demonstrate a single\-machine container. diff --git a/docs/man/man1/kubectl-scale.1 b/docs/man/man1/kubectl-scale.1 index c0dea101f9b63..800c53c9468ce 100644 --- a/docs/man/man1/kubectl-scale.1 +++ b/docs/man/man1/kubectl-scale.1 @@ -31,10 +31,6 @@ scale is sent to the server. \fB\-f\fP, \fB\-\-filename\fP=[] Filename, directory, or URL to a file identifying the replication controller to set a new size -.PP -\fB\-h\fP, \fB\-\-help\fP=false - help for scale - .PP \fB\-o\fP, \fB\-\-output\fP="" Output mode. Use "\-o name" for shorter output (resource/name). diff --git a/docs/man/man1/kubectl-stop.1 b/docs/man/man1/kubectl-stop.1 index efb409c5ee73f..0bd2ea8cb1fac 100644 --- a/docs/man/man1/kubectl-stop.1 +++ b/docs/man/man1/kubectl-stop.1 @@ -37,10 +37,6 @@ If the resource is scalable it will be scaled to 0 before deletion. \fB\-\-grace\-period\fP=\-1 Period of time in seconds given to the resource to terminate gracefully. Ignored if negative. -.PP -\fB\-h\fP, \fB\-\-help\fP=false - help for stop - .PP \fB\-\-ignore\-not\-found\fP=false Treat "resource not found" as a successful stop. diff --git a/docs/man/man1/kubectl-version.1 b/docs/man/man1/kubectl-version.1 index 557f7687f9fe9..916c43f38587e 100644 --- a/docs/man/man1/kubectl-version.1 +++ b/docs/man/man1/kubectl-version.1 @@ -21,10 +21,6 @@ Print the client and server version information. \fB\-c\fP, \fB\-\-client\fP=false Client version only (no server required). -.PP -\fB\-h\fP, \fB\-\-help\fP=false - help for version - .SH OPTIONS INHERITED FROM PARENT COMMANDS .PP diff --git a/docs/man/man1/kubectl.1 b/docs/man/man1/kubectl.1 index 26db3cab4a7af..a95623c3aca5d 100644 --- a/docs/man/man1/kubectl.1 +++ b/docs/man/man1/kubectl.1 @@ -49,10 +49,6 @@ Find more information at \fB\-\-context\fP="" The name of the kubeconfig context to use -.PP -\fB\-h\fP, \fB\-\-help\fP=false - help for kubectl - .PP \fB\-\-insecure\-skip\-tls\-verify\fP=false If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. diff --git a/docs/user-guide/kubectl/kubectl.md b/docs/user-guide/kubectl/kubectl.md index 7b5e9f04f5af5..cf8c2085cfb24 100644 --- a/docs/user-guide/kubectl/kubectl.md +++ b/docs/user-guide/kubectl/kubectl.md @@ -56,7 +56,6 @@ kubectl --client-key="": Path to a client key file for TLS. --cluster="": The name of the kubeconfig cluster to use --context="": The name of the kubeconfig context to use - -h, --help[=false]: help for kubectl --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. --kubeconfig="": Path to the kubeconfig file to use for CLI requests. --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace @@ -101,7 +100,7 @@ kubectl * [kubectl stop](kubectl_stop.md) - Deprecated: Gracefully shut down a resource by name or filename. * [kubectl version](kubectl_version.md) - Print the client and server version information. -###### Auto generated by spf13/cobra at 2015-08-21 17:18:05.169032754 +0000 UTC +###### Auto generated by spf13/cobra at 2015-09-03 21:06:22.476725335 +0000 UTC [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_annotate.md b/docs/user-guide/kubectl/kubectl_annotate.md index 2b89739012a0e..b185ff2c5e5e6 100644 --- a/docs/user-guide/kubectl/kubectl_annotate.md +++ b/docs/user-guide/kubectl/kubectl_annotate.md @@ -83,7 +83,6 @@ $ kubectl annotate pods foo description- ``` --all[=false]: select all resources in the namespace of the specified resource types -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to update the annotation - -h, --help[=false]: help for annotate --overwrite[=false]: If true, allow annotations to be overwritten, otherwise reject annotation updates that overwrite existing annotations. --resource-version="": If non-empty, the annotation update will only succeed if this is the current resource-version for the object. Only valid when specifying a single resource. ``` @@ -120,7 +119,7 @@ $ kubectl annotate pods foo description- * [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra at 2015-08-27 02:40:25.687121316 +0000 UTC +###### Auto generated by spf13/cobra at 2015-09-03 21:06:22.474197531 +0000 UTC [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_annotate.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_api-versions.md b/docs/user-guide/kubectl/kubectl_api-versions.md index a2f22363446ed..eaeef7866f507 100644 --- a/docs/user-guide/kubectl/kubectl_api-versions.md +++ b/docs/user-guide/kubectl/kubectl_api-versions.md @@ -44,12 +44,6 @@ Print available API versions. kubectl api-versions ``` -### Options - -``` - -h, --help[=false]: help for api-versions -``` - ### Options inherited from parent commands ``` @@ -82,7 +76,7 @@ kubectl api-versions * [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra at 2015-08-21 17:18:05.168773226 +0000 UTC +###### Auto generated by spf13/cobra at 2015-09-03 21:06:22.476265479 +0000 UTC [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_api-versions.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_attach.md b/docs/user-guide/kubectl/kubectl_attach.md index e6d0126dfcf79..6155446b7d0ff 100644 --- a/docs/user-guide/kubectl/kubectl_attach.md +++ b/docs/user-guide/kubectl/kubectl_attach.md @@ -62,7 +62,6 @@ $ kubectl attach 123456-7890 -c ruby-container -i -t ``` -c, --container="": Container name - -h, --help[=false]: help for attach -i, --stdin[=false]: Pass stdin to the container -t, --tty[=false]: Stdin is a TTY ``` @@ -99,7 +98,7 @@ $ kubectl attach 123456-7890 -c ruby-container -i -t * [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra at 2015-09-02 09:55:50.948089316 +0000 UTC +###### Auto generated by spf13/cobra at 2015-09-03 21:06:22.471309711 +0000 UTC [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_attach.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_cluster-info.md b/docs/user-guide/kubectl/kubectl_cluster-info.md index 9a4b821eb2082..f7728387eaba8 100644 --- a/docs/user-guide/kubectl/kubectl_cluster-info.md +++ b/docs/user-guide/kubectl/kubectl_cluster-info.md @@ -44,12 +44,6 @@ Display addresses of the master and services with label kubernetes.io/cluster-se kubectl cluster-info ``` -### Options - -``` - -h, --help[=false]: help for cluster-info -``` - ### Options inherited from parent commands ``` @@ -82,7 +76,7 @@ kubectl cluster-info * [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra at 2015-08-21 17:18:05.168659453 +0000 UTC +###### Auto generated by spf13/cobra at 2015-09-03 21:06:22.476078738 +0000 UTC [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_cluster-info.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_config.md b/docs/user-guide/kubectl/kubectl_config.md index c44a1656e01b9..a16a4603b21f6 100644 --- a/docs/user-guide/kubectl/kubectl_config.md +++ b/docs/user-guide/kubectl/kubectl_config.md @@ -53,7 +53,6 @@ kubectl config SUBCOMMAND ### Options ``` - -h, --help[=false]: help for config --kubeconfig="": use a particular kubeconfig file ``` @@ -95,7 +94,7 @@ kubectl config SUBCOMMAND * [kubectl config use-context](kubectl_config_use-context.md) - Sets the current-context in a kubeconfig file * [kubectl config view](kubectl_config_view.md) - displays Merged kubeconfig settings or a specified kubeconfig file. -###### Auto generated by spf13/cobra at 2015-08-21 17:18:05.16853102 +0000 UTC +###### Auto generated by spf13/cobra at 2015-09-03 21:06:22.475888484 +0000 UTC [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_config_set-cluster.md b/docs/user-guide/kubectl/kubectl_config_set-cluster.md index 03d96efde53b9..a24a48be32e8c 100644 --- a/docs/user-guide/kubectl/kubectl_config_set-cluster.md +++ b/docs/user-guide/kubectl/kubectl_config_set-cluster.md @@ -64,7 +64,6 @@ $ kubectl config set-cluster e2e --insecure-skip-tls-verify=true --api-version="": api-version for the cluster entry in kubeconfig --certificate-authority="": path to certificate-authority for the cluster entry in kubeconfig --embed-certs=false: embed-certs for the cluster entry in kubeconfig - -h, --help[=false]: help for set-cluster --insecure-skip-tls-verify=false: insecure-skip-tls-verify for the cluster entry in kubeconfig --server="": server for the cluster entry in kubeconfig ``` @@ -97,7 +96,7 @@ $ kubectl config set-cluster e2e --insecure-skip-tls-verify=true * [kubectl config](kubectl_config.md) - config modifies kubeconfig files -###### Auto generated by spf13/cobra at 2015-08-21 17:18:05.167359915 +0000 UTC +###### Auto generated by spf13/cobra at 2015-09-03 21:06:22.474677631 +0000 UTC [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config_set-cluster.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_config_set-context.md b/docs/user-guide/kubectl/kubectl_config_set-context.md index fb5f519a2aafc..116d28025112a 100644 --- a/docs/user-guide/kubectl/kubectl_config_set-context.md +++ b/docs/user-guide/kubectl/kubectl_config_set-context.md @@ -56,7 +56,6 @@ $ kubectl config set-context gce --user=cluster-admin ``` --cluster="": cluster for the context entry in kubeconfig - -h, --help[=false]: help for set-context --namespace="": namespace for the context entry in kubeconfig --user="": user for the context entry in kubeconfig ``` @@ -90,7 +89,7 @@ $ kubectl config set-context gce --user=cluster-admin * [kubectl config](kubectl_config.md) - config modifies kubeconfig files -###### Auto generated by spf13/cobra at 2015-08-21 17:18:05.168034038 +0000 UTC +###### Auto generated by spf13/cobra at 2015-09-03 21:06:22.475093212 +0000 UTC [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config_set-context.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_config_set-credentials.md b/docs/user-guide/kubectl/kubectl_config_set-credentials.md index dc6d3da6bef70..dc84b808ce650 100644 --- a/docs/user-guide/kubectl/kubectl_config_set-credentials.md +++ b/docs/user-guide/kubectl/kubectl_config_set-credentials.md @@ -77,7 +77,6 @@ $ kubectl config set-credentials cluster-admin --client-certificate=~/.kube/admi --client-certificate="": path to client-certificate for the user entry in kubeconfig --client-key="": path to client-key for the user entry in kubeconfig --embed-certs=false: embed client cert/key for the user entry in kubeconfig - -h, --help[=false]: help for set-credentials --password="": password for the user entry in kubeconfig --token="": token for the user entry in kubeconfig --username="": username for the user entry in kubeconfig @@ -110,7 +109,7 @@ $ kubectl config set-credentials cluster-admin --client-certificate=~/.kube/admi * [kubectl config](kubectl_config.md) - config modifies kubeconfig files -###### Auto generated by spf13/cobra at 2015-08-21 17:18:05.167500874 +0000 UTC +###### Auto generated by spf13/cobra at 2015-09-03 21:06:22.474882527 +0000 UTC [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config_set-credentials.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_config_set.md b/docs/user-guide/kubectl/kubectl_config_set.md index 6c15b3a31f73b..ab0229e3a8114 100644 --- a/docs/user-guide/kubectl/kubectl_config_set.md +++ b/docs/user-guide/kubectl/kubectl_config_set.md @@ -46,12 +46,6 @@ PROPERTY_VALUE is the new value you wish to set. kubectl config set PROPERTY_NAME PROPERTY_VALUE ``` -### Options - -``` - -h, --help[=false]: help for set -``` - ### Options inherited from parent commands ``` @@ -84,7 +78,7 @@ kubectl config set PROPERTY_NAME PROPERTY_VALUE * [kubectl config](kubectl_config.md) - config modifies kubeconfig files -###### Auto generated by spf13/cobra at 2015-08-21 17:18:05.16816699 +0000 UTC +###### Auto generated by spf13/cobra at 2015-09-03 21:06:22.475281504 +0000 UTC [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config_set.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_config_unset.md b/docs/user-guide/kubectl/kubectl_config_unset.md index a78b673632a38..5f86a0f58d9de 100644 --- a/docs/user-guide/kubectl/kubectl_config_unset.md +++ b/docs/user-guide/kubectl/kubectl_config_unset.md @@ -45,12 +45,6 @@ PROPERTY_NAME is a dot delimited name where each token represents either a attri kubectl config unset PROPERTY_NAME ``` -### Options - -``` - -h, --help[=false]: help for unset -``` - ### Options inherited from parent commands ``` @@ -83,7 +77,7 @@ kubectl config unset PROPERTY_NAME * [kubectl config](kubectl_config.md) - config modifies kubeconfig files -###### Auto generated by spf13/cobra at 2015-08-21 17:18:05.168279315 +0000 UTC +###### Auto generated by spf13/cobra at 2015-09-03 21:06:22.475473658 +0000 UTC [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config_unset.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_config_use-context.md b/docs/user-guide/kubectl/kubectl_config_use-context.md index 5247161b5f8b2..6a62618aa4c99 100644 --- a/docs/user-guide/kubectl/kubectl_config_use-context.md +++ b/docs/user-guide/kubectl/kubectl_config_use-context.md @@ -44,12 +44,6 @@ Sets the current-context in a kubeconfig file kubectl config use-context CONTEXT_NAME ``` -### Options - -``` - -h, --help[=false]: help for use-context -``` - ### Options inherited from parent commands ``` @@ -82,7 +76,7 @@ kubectl config use-context CONTEXT_NAME * [kubectl config](kubectl_config.md) - config modifies kubeconfig files -###### Auto generated by spf13/cobra at 2015-08-21 17:18:05.168411074 +0000 UTC +###### Auto generated by spf13/cobra at 2015-09-03 21:06:22.475674294 +0000 UTC [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config_use-context.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_config_view.md b/docs/user-guide/kubectl/kubectl_config_view.md index a47132d69855e..d92a26f1646bd 100644 --- a/docs/user-guide/kubectl/kubectl_config_view.md +++ b/docs/user-guide/kubectl/kubectl_config_view.md @@ -60,7 +60,6 @@ $ kubectl config view -o template --template='{{range .users}}{{ if eq .name "e2 ``` --flatten[=false]: flatten the resulting kubeconfig file into self contained output (useful for creating portable kubeconfig files) - -h, --help[=false]: help for view --merge=true: merge together the full hierarchy of kubeconfig files --minify[=false]: remove all information not used by current-context from the output --no-headers[=false]: When using the default output, don't print headers. @@ -104,7 +103,7 @@ $ kubectl config view -o template --template='{{range .users}}{{ if eq .name "e2 * [kubectl config](kubectl_config.md) - config modifies kubeconfig files -###### Auto generated by spf13/cobra at 2015-08-26 09:03:39.977436672 +0000 UTC +###### Auto generated by spf13/cobra at 2015-09-03 21:06:22.474467216 +0000 UTC [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config_view.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_create.md b/docs/user-guide/kubectl/kubectl_create.md index 2ac1b734ea769..f718dc10fee71 100644 --- a/docs/user-guide/kubectl/kubectl_create.md +++ b/docs/user-guide/kubectl/kubectl_create.md @@ -60,7 +60,6 @@ $ cat pod.json | kubectl create -f - ``` -f, --filename=[]: Filename, directory, or URL to file to use to create the resource - -h, --help[=false]: help for create -o, --output="": Output mode. Use "-o name" for shorter output (resource/name). --validate[=true]: If true, use a schema to validate the input before sending it ``` @@ -97,7 +96,7 @@ $ cat pod.json | kubectl create -f - * [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra at 2015-08-27 08:49:26.55743532 +0000 UTC +###### Auto generated by spf13/cobra at 2015-09-03 21:06:22.469492371 +0000 UTC [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_create.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_delete.md b/docs/user-guide/kubectl/kubectl_delete.md index 9a9b596ec26d2..18fc8061ca998 100644 --- a/docs/user-guide/kubectl/kubectl_delete.md +++ b/docs/user-guide/kubectl/kubectl_delete.md @@ -81,7 +81,6 @@ $ kubectl delete pods --all --cascade[=true]: If true, cascade the deletion of the resources managed by this resource (e.g. Pods created by a ReplicationController). Default true. -f, --filename=[]: Filename, directory, or URL to a file containing the resource to delete. --grace-period=-1: Period of time in seconds given to the resource to terminate gracefully. Ignored if negative. - -h, --help[=false]: help for delete --ignore-not-found[=false]: Treat "resource not found" as a successful delete. Defaults to "true" when --all is specified. -o, --output="": Output mode. Use "-o name" for shorter output (resource/name). -l, --selector="": Selector (label query) to filter on. @@ -120,7 +119,7 @@ $ kubectl delete pods --all * [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra at 2015-08-25 10:17:24.591839542 +0000 UTC +###### Auto generated by spf13/cobra at 2015-09-03 21:06:22.470182255 +0000 UTC [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_delete.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_describe.md b/docs/user-guide/kubectl/kubectl_describe.md index 015860bc4b0f5..5fa18144d3282 100644 --- a/docs/user-guide/kubectl/kubectl_describe.md +++ b/docs/user-guide/kubectl/kubectl_describe.md @@ -84,7 +84,6 @@ $ kubectl describe pods frontend ``` -f, --filename=[]: Filename, directory, or URL to a file containing the resource to describe - -h, --help[=false]: help for describe -l, --selector="": Selector (label query) to filter on ``` @@ -120,7 +119,7 @@ $ kubectl describe pods frontend * [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra at 2015-08-21 07:07:55.972896481 +0000 UTC +###### Auto generated by spf13/cobra at 2015-09-03 21:06:22.469291072 +0000 UTC [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_describe.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_exec.md b/docs/user-guide/kubectl/kubectl_exec.md index bec8202b442e6..a1471e6f34747 100644 --- a/docs/user-guide/kubectl/kubectl_exec.md +++ b/docs/user-guide/kubectl/kubectl_exec.md @@ -62,7 +62,6 @@ $ kubectl exec 123456-7890 -c ruby-container -i -t -- bash -il ``` -c, --container="": Container name. If omitted, the first container in the pod will be chosen - -h, --help[=false]: help for exec -p, --pod="": Pod name -i, --stdin[=false]: Pass stdin to the container -t, --tty[=false]: Stdin is a TTY @@ -100,7 +99,7 @@ $ kubectl exec 123456-7890 -c ruby-container -i -t -- bash -il * [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra at 2015-09-02 09:55:50.948300118 +0000 UTC +###### Auto generated by spf13/cobra at 2015-09-03 21:06:22.471517301 +0000 UTC [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_exec.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_expose.md b/docs/user-guide/kubectl/kubectl_expose.md index a98ed70224f7f..2d0531dada029 100644 --- a/docs/user-guide/kubectl/kubectl_expose.md +++ b/docs/user-guide/kubectl/kubectl_expose.md @@ -72,7 +72,6 @@ $ kubectl expose rc streamer --port=4100 --protocol=udp --name=video-stream --external-ip="": External IP address to set for the service. The service can be accessed by this IP in addition to its generated service IP. -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to expose a service --generator="service/v2": The name of the API generator to use. There are 2 generators: 'service/v1' and 'service/v2'. The only difference between them is that service port in v1 is named 'default', while it is left unnamed in v2. Default is 'service/v2'. - -h, --help[=false]: help for expose -l, --labels="": Labels to apply to the service created by this call. --name="": The name for the newly created object. --no-headers[=false]: When using the default output, don't print headers. @@ -122,7 +121,7 @@ $ kubectl expose rc streamer --port=4100 --protocol=udp --name=video-stream * [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra at 2015-09-03 03:58:51.196935872 +0000 UTC +###### Auto generated by spf13/cobra at 2015-09-03 21:06:22.473647619 +0000 UTC [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_expose.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_get.md b/docs/user-guide/kubectl/kubectl_get.md index 79499a8717cd4..c9eed59085853 100644 --- a/docs/user-guide/kubectl/kubectl_get.md +++ b/docs/user-guide/kubectl/kubectl_get.md @@ -88,7 +88,6 @@ $ kubectl get rc/web service/frontend pods/web-pod-13je7 ``` --all-namespaces[=false]: If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace. -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to get from a server. - -h, --help[=false]: help for get -L, --label-columns=[]: Accepts a comma separated list of labels that are going to be presented as columns. Names are case-sensitive. You can also use multiple flag statements like -L label1 -L label2... --no-headers[=false]: When using the default output, don't print headers. -o, --output="": Output format. One of: json|yaml|template|templatefile|wide|jsonpath|name. @@ -133,7 +132,7 @@ $ kubectl get rc/web service/frontend pods/web-pod-13je7 * [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra at 2015-08-26 09:03:39.972870101 +0000 UTC +###### Auto generated by spf13/cobra at 2015-09-03 21:06:22.469014739 +0000 UTC [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_get.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_label.md b/docs/user-guide/kubectl/kubectl_label.md index 3e90c6833585e..d521ae3e3b469 100644 --- a/docs/user-guide/kubectl/kubectl_label.md +++ b/docs/user-guide/kubectl/kubectl_label.md @@ -77,7 +77,6 @@ $ kubectl label pods foo bar- --all[=false]: select all resources in the namespace of the specified resource types --dry-run[=false]: If true, only print the object that would be sent, without sending it. -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to update the labels - -h, --help[=false]: help for label --no-headers[=false]: When using the default output, don't print headers. -o, --output="": Output format. One of: json|yaml|template|templatefile|wide|jsonpath|name. --output-version="": Output the formatted object with the given version (default api-version). @@ -121,7 +120,7 @@ $ kubectl label pods foo bar- * [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra at 2015-08-31 12:51:55.222410248 +0000 UTC +###### Auto generated by spf13/cobra at 2015-09-04 23:19:55.649428669 +0000 UTC [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_label.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_logs.md b/docs/user-guide/kubectl/kubectl_logs.md index 45c36b7ed4b9e..79ac2d3b0b60b 100644 --- a/docs/user-guide/kubectl/kubectl_logs.md +++ b/docs/user-guide/kubectl/kubectl_logs.md @@ -62,7 +62,6 @@ $ kubectl logs -f 123456-7890 ruby-container ``` -c, --container="": Container name -f, --follow[=false]: Specify if the logs should be streamed. - -h, --help[=false]: help for logs --interactive[=true]: If true, prompt the user for input when required. Default true. -p, --previous[=false]: If true, print the logs for the previous instance of the container in a pod if it exists. ``` @@ -99,7 +98,7 @@ $ kubectl logs -f 123456-7890 ruby-container * [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra at 2015-09-02 09:55:50.94749958 +0000 UTC +###### Auto generated by spf13/cobra at 2015-09-03 21:06:22.470591683 +0000 UTC [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_logs.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_namespace.md b/docs/user-guide/kubectl/kubectl_namespace.md index da011d2bd9317..3e686d46f005c 100644 --- a/docs/user-guide/kubectl/kubectl_namespace.md +++ b/docs/user-guide/kubectl/kubectl_namespace.md @@ -47,12 +47,6 @@ namespace has been superseded by the context.namespace field of .kubeconfig file kubectl namespace [namespace] ``` -### Options - -``` - -h, --help[=false]: help for namespace -``` - ### Options inherited from parent commands ``` @@ -85,7 +79,7 @@ kubectl namespace [namespace] * [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra at 2015-08-21 17:18:05.164903046 +0000 UTC +###### Auto generated by spf13/cobra at 2015-09-03 21:06:22.470380367 +0000 UTC [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_namespace.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_patch.md b/docs/user-guide/kubectl/kubectl_patch.md index 04b4a2c6ed329..aee0b3a18bef1 100644 --- a/docs/user-guide/kubectl/kubectl_patch.md +++ b/docs/user-guide/kubectl/kubectl_patch.md @@ -66,7 +66,6 @@ kubectl patch pod valid-pod -p '{"spec":{"containers":[{"name":"kubernetes-serve ``` -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to update - -h, --help[=false]: help for patch -o, --output="": Output mode. Use "-o name" for shorter output (resource/name). -p, --patch="": The patch to be applied to the resource JSON file. ``` @@ -103,7 +102,7 @@ kubectl patch pod valid-pod -p '{"spec":{"containers":[{"name":"kubernetes-serve * [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra at 2015-08-21 17:18:05.164613432 +0000 UTC +###### Auto generated by spf13/cobra at 2015-09-03 21:06:22.469927571 +0000 UTC [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_patch.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_port-forward.md b/docs/user-guide/kubectl/kubectl_port-forward.md index 84a6780bff661..ee8771f2a6af0 100644 --- a/docs/user-guide/kubectl/kubectl_port-forward.md +++ b/docs/user-guide/kubectl/kubectl_port-forward.md @@ -64,7 +64,6 @@ $ kubectl port-forward mypod 0:5000 ### Options ``` - -h, --help[=false]: help for port-forward -p, --pod="": Pod name ``` @@ -100,7 +99,7 @@ $ kubectl port-forward mypod 0:5000 * [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra at 2015-09-02 09:55:50.948456523 +0000 UTC +###### Auto generated by spf13/cobra at 2015-09-03 21:06:22.471732563 +0000 UTC [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_port-forward.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_proxy.md b/docs/user-guide/kubectl/kubectl_proxy.md index 4aa613ced4510..131d1c3060a8f 100644 --- a/docs/user-guide/kubectl/kubectl_proxy.md +++ b/docs/user-guide/kubectl/kubectl_proxy.md @@ -81,7 +81,6 @@ $ kubectl proxy --api-prefix=/k8s-api --accept-paths="^/.*": Regular expression for paths that the proxy should accept. --api-prefix="/api/": Prefix to serve the proxied API under. --disable-filter[=false]: If true, disable request filtering in the proxy. This is dangerous, and can leave you vulnerable to XSRF attacks, when used with an accessible port. - -h, --help[=false]: help for proxy -p, --port=8001: The port on which to run the proxy. Set to 0 to pick a random port. --reject-methods="POST,PUT,PATCH": Regular expression for HTTP methods that the proxy should reject. --reject-paths="^/api/.*/exec,^/api/.*/run": Regular expression for paths that the proxy should reject. @@ -122,7 +121,7 @@ $ kubectl proxy --api-prefix=/k8s-api * [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra at 2015-08-21 17:18:05.166284754 +0000 UTC +###### Auto generated by spf13/cobra at 2015-09-03 21:06:22.472010935 +0000 UTC [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_proxy.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_replace.md b/docs/user-guide/kubectl/kubectl_replace.md index c4e58c165eae3..ad65549704ddc 100644 --- a/docs/user-guide/kubectl/kubectl_replace.md +++ b/docs/user-guide/kubectl/kubectl_replace.md @@ -73,7 +73,6 @@ kubectl replace --force -f ./pod.json -f, --filename=[]: Filename, directory, or URL to file to use to replace the resource. --force[=false]: Delete and re-create the specified resource --grace-period=-1: Only relevant during a force replace. Period of time in seconds given to the old resource to terminate gracefully. Ignored if negative. - -h, --help[=false]: help for replace -o, --output="": Output mode. Use "-o name" for shorter output (resource/name). --timeout=0: Only relevant during a force replace. The length of time to wait before giving up on a delete of the old resource, zero means determine a timeout from the size of the object --validate[=true]: If true, use a schema to validate the input before sending it @@ -111,7 +110,7 @@ kubectl replace --force -f ./pod.json * [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra at 2015-08-21 17:18:05.164469074 +0000 UTC +###### Auto generated by spf13/cobra at 2015-09-03 21:06:22.469727962 +0000 UTC [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_replace.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_rolling-update.md b/docs/user-guide/kubectl/kubectl_rolling-update.md index 63b142cb8c2b4..4d8e38bd48d21 100644 --- a/docs/user-guide/kubectl/kubectl_rolling-update.md +++ b/docs/user-guide/kubectl/kubectl_rolling-update.md @@ -72,7 +72,6 @@ $ kubectl rolling-update frontend --image=image:v2 --deployment-label-key="deployment": The key to use to differentiate between two different controllers, default 'deployment'. Only relevant when --image is specified, ignored otherwise --dry-run[=false]: If true, print out the changes that would be made, but don't actually make them. -f, --filename=[]: Filename or URL to file to use to create the new replication controller. - -h, --help[=false]: help for rolling-update --image="": Image to use for upgrading the replication controller. Can not be used with --filename/-f --no-headers[=false]: When using the default output, don't print headers. -o, --output="": Output format. One of: json|yaml|template|templatefile|wide|jsonpath|name. @@ -119,7 +118,7 @@ $ kubectl rolling-update frontend --image=image:v2 * [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra at 2015-08-26 09:03:39.974410445 +0000 UTC +###### Auto generated by spf13/cobra at 2015-09-03 21:06:22.470878033 +0000 UTC [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_rolling-update.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_run.md b/docs/user-guide/kubectl/kubectl_run.md index 1e96ae8a74b26..ecfdcea2812b7 100644 --- a/docs/user-guide/kubectl/kubectl_run.md +++ b/docs/user-guide/kubectl/kubectl_run.md @@ -77,7 +77,6 @@ $ kubectl run nginx --image=nginx --command -- ... --command[=false]: If true and extra arguments are present, use them as the 'command' field in the container, rather than the 'args' field which is the default. --dry-run[=false]: If true, only print the object that would be sent, without sending it. --generator="": The name of the API generator to use. Default is 'run/v1' if --restart=Always, otherwise the default is 'run-pod/v1'. - -h, --help[=false]: help for run --hostport=-1: The host port mapping for the container port. To demonstrate a single-machine container. --image="": The image for the container to run. -l, --labels="": Labels to apply to the pod(s). @@ -127,7 +126,7 @@ $ kubectl run nginx --image=nginx --command -- ... * [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra at 2015-09-02 09:55:50.948932668 +0000 UTC +###### Auto generated by spf13/cobra at 2015-09-03 21:06:22.472292491 +0000 UTC [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_run.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_scale.md b/docs/user-guide/kubectl/kubectl_scale.md index fcb061bdd824e..068cbed9df0fa 100644 --- a/docs/user-guide/kubectl/kubectl_scale.md +++ b/docs/user-guide/kubectl/kubectl_scale.md @@ -70,7 +70,6 @@ $ kubectl scale --replicas=5 rc/foo rc/bar ``` --current-replicas=-1: Precondition for current size. Requires that the current size of the replication controller match this value in order to scale. -f, --filename=[]: Filename, directory, or URL to a file identifying the replication controller to set a new size - -h, --help[=false]: help for scale -o, --output="": Output mode. Use "-o name" for shorter output (resource/name). --replicas=-1: The new desired number of replicas. Required. --resource-version="": Precondition for resource version. Requires that the current resource version match this value in order to scale. @@ -109,7 +108,7 @@ $ kubectl scale --replicas=5 rc/foo rc/bar * [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra at 2015-08-21 17:18:05.165785015 +0000 UTC +###### Auto generated by spf13/cobra at 2015-09-03 21:06:22.471116954 +0000 UTC [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_scale.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_stop.md b/docs/user-guide/kubectl/kubectl_stop.md index 90144527f8354..33c5fe100c9d7 100644 --- a/docs/user-guide/kubectl/kubectl_stop.md +++ b/docs/user-guide/kubectl/kubectl_stop.md @@ -72,7 +72,6 @@ $ kubectl stop -f path/to/resources --all[=false]: [-all] to select all the specified resources. -f, --filename=[]: Filename, directory, or URL to file of resource(s) to be stopped. --grace-period=-1: Period of time in seconds given to the resource to terminate gracefully. Ignored if negative. - -h, --help[=false]: help for stop --ignore-not-found[=false]: Treat "resource not found" as a successful stop. -o, --output="": Output mode. Use "-o name" for shorter output (resource/name). -l, --selector="": Selector (label query) to filter on. @@ -111,7 +110,7 @@ $ kubectl stop -f path/to/resources * [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra at 2015-08-21 17:18:05.166601667 +0000 UTC +###### Auto generated by spf13/cobra at 2015-09-03 21:06:22.47250815 +0000 UTC [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_stop.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_version.md b/docs/user-guide/kubectl/kubectl_version.md index 5bc9266e2d278..b5743a53c9af3 100644 --- a/docs/user-guide/kubectl/kubectl_version.md +++ b/docs/user-guide/kubectl/kubectl_version.md @@ -48,7 +48,6 @@ kubectl version ``` -c, --client[=false]: Client version only (no server required). - -h, --help[=false]: help for version ``` ### Options inherited from parent commands @@ -83,7 +82,7 @@ kubectl version * [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra at 2015-08-21 17:18:05.1688832 +0000 UTC +###### Auto generated by spf13/cobra at 2015-09-03 21:06:22.476464324 +0000 UTC [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_version.md?pixel)]()