Update generated docs, given upstream cobra/pflag changes.

duda · Mar 13, 2015 · cf213ab · cf213ab
1 parent f98cd70
commit cf213ab
Show file tree

Hide file tree

Showing 52 changed files with 249 additions and 200 deletions.
diff --git a/docs/kubectl-clusterinfo.md b/docs/kubectl-clusterinfo.md
@@ -11,6 +11,12 @@ Display addresses of the master and services with label kubernetes.io/cluster-se
 kubectl clusterinfo
 ```
 
+### Options
+
+```
+  -h, --help=false: help for clusterinfo
+```
+
 ### Options inherrited from parent commands
 
 ```
@@ -22,7 +28,6 @@ kubectl clusterinfo
       --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

diff --git a/docs/kubectl-config-set-cluster.md b/docs/kubectl-config-set-cluster.md
@@ -28,24 +28,25 @@ $ kubectl config set-cluster e2e --insecure-skip-tls-verify=true
 ### Options
 
 ```
+      --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
 ```
 
 ### Options inherrited from parent commands
 
 ```
       --alsologtostderr=false: log to standard error as well as files
-      --api-version="": The API version to use when talking to the server
   -a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
-      --certificate-authority="": Path to a cert. file for the certificate authority.
       --client-certificate="": Path to a client key file for TLS.
       --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
       --envvar=false: use the .kubeconfig from $KUBECONFIG
       --global=false: use the .kubeconfig from /home/username
-  -h, --help=false: help for config
-      --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="": use a particular .kubeconfig file
       --local=false: use the .kubeconfig in the current directory
       --log_backtrace_at=:0: when logging hits line file:N, emit a stack trace
@@ -55,7 +56,6 @@ $ kubectl config set-cluster e2e --insecure-skip-tls-verify=true
       --match-server-version=false: Require server version to match client version
       --namespace="": If present, the namespace scope for this CLI request.
       --password="": Password for basic authentication to the API server.
-  -s, --server="": The address and port of the Kubernetes API server
       --stderrthreshold=2: logs at or above this threshold go to stderr
       --token="": Bearer token for authentication to the API server.
       --user="": The name of the kubeconfig user to use

diff --git a/docs/kubectl-config-set-context.md b/docs/kubectl-config-set-context.md
@@ -19,6 +19,15 @@ kubectl config set-context NAME [--cluster=cluster_nickname] [--user=user_nickna
 $ kubectl config set-context gce --user=cluster-admin
 ```
 
+### Options
+
+```
+      --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
+```
+
 ### Options inherrited from parent commands
 
 ```
@@ -28,11 +37,9 @@ $ kubectl config set-context gce --user=cluster-admin
       --certificate-authority="": Path to a cert. file for the certificate authority.
       --client-certificate="": Path to a client key file for TLS.
       --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
       --envvar=false: use the .kubeconfig from $KUBECONFIG
       --global=false: use the .kubeconfig from /home/username
-  -h, --help=false: help for config
       --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="": use a particular .kubeconfig file
       --local=false: use the .kubeconfig in the current directory
@@ -41,12 +48,10 @@ $ kubectl config set-context gce --user=cluster-admin
       --log_flush_frequency=5s: Maximum number of seconds between log flushes
       --logtostderr=true: log to standard error instead of files
       --match-server-version=false: Require server version to match client version
-      --namespace="": If present, the namespace scope for this CLI request.
       --password="": Password for basic authentication to the API server.
   -s, --server="": The address and port of the Kubernetes API server
       --stderrthreshold=2: logs at or above this threshold go to stderr
       --token="": Bearer token for authentication to the API server.
-      --user="": The name of the kubeconfig user to use
       --username="": Username for basic authentication to the API server.
       --v=0: log level for V logs
       --validate=false: If true, use a schema to validate the input before sending it

diff --git a/docs/kubectl-config-set-credentials.md b/docs/kubectl-config-set-credentials.md
@@ -41,23 +41,26 @@ $ kubectl set-credentials cluster-admin --client-certificate=~/.kube/admin.crt -
 ### Options
 
 ```
+      --auth-path=: auth-path for the user entry in .kubeconfig
+      --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
 ```
 
 ### Options inherrited from parent commands
 
 ```
       --alsologtostderr=false: log to standard error as well as files
       --api-version="": The API version to use when talking to the server
-  -a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
       --certificate-authority="": Path to a cert. file for the certificate authority.
-      --client-certificate="": Path to a client key file for TLS.
-      --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
       --envvar=false: use the .kubeconfig from $KUBECONFIG
       --global=false: use the .kubeconfig from /home/username
-  -h, --help=false: help for config
       --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="": use a particular .kubeconfig file
       --local=false: use the .kubeconfig in the current directory
@@ -67,12 +70,9 @@ $ kubectl set-credentials cluster-admin --client-certificate=~/.kube/admin.crt -
       --logtostderr=true: log to standard error instead of files
       --match-server-version=false: Require server version to match client version
       --namespace="": If present, the namespace scope for this CLI request.
-      --password="": Password for basic authentication to the API server.
   -s, --server="": The address and port of the Kubernetes API server
       --stderrthreshold=2: logs at or above this threshold go to stderr
-      --token="": Bearer token for authentication to the API server.
       --user="": The name of the kubeconfig user to use
-      --username="": Username for basic authentication to the API server.
       --v=0: log level for V logs
       --validate=false: If true, use a schema to validate the input before sending it
       --vmodule=: comma-separated list of pattern=N settings for file-filtered logging

diff --git a/docs/kubectl-config-set.md b/docs/kubectl-config-set.md
@@ -13,6 +13,12 @@ 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 inherrited from parent commands
 
 ```
@@ -26,7 +32,6 @@ kubectl config set PROPERTY_NAME PROPERTY_VALUE
       --context="": The name of the kubeconfig context to use
       --envvar=false: use the .kubeconfig from $KUBECONFIG
       --global=false: use the .kubeconfig from /home/username
-  -h, --help=false: help for config
       --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="": use a particular .kubeconfig file
       --local=false: use the .kubeconfig in the current directory

diff --git a/docs/kubectl-config-unset.md b/docs/kubectl-config-unset.md
@@ -12,6 +12,12 @@ 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 inherrited from parent commands
 
 ```
@@ -25,7 +31,6 @@ kubectl config unset PROPERTY_NAME
       --context="": The name of the kubeconfig context to use
       --envvar=false: use the .kubeconfig from $KUBECONFIG
       --global=false: use the .kubeconfig from /home/username
-  -h, --help=false: help for config
       --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="": use a particular .kubeconfig file
       --local=false: use the .kubeconfig in the current directory

diff --git a/docs/kubectl-config-use-context.md b/docs/kubectl-config-use-context.md
@@ -11,6 +11,12 @@ Sets the current-context in a .kubeconfig file
 kubectl config use-context CONTEXT_NAME
 ```
 
+### Options
+
+```
+  -h, --help=false: help for use-context
+```
+
 ### Options inherrited from parent commands
 
 ```
@@ -24,7 +30,6 @@ kubectl config use-context CONTEXT_NAME
       --context="": The name of the kubeconfig context to use
       --envvar=false: use the .kubeconfig from $KUBECONFIG
       --global=false: use the .kubeconfig from /home/username
-  -h, --help=false: help for config
       --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="": use a particular .kubeconfig file
       --local=false: use the .kubeconfig in the current directory

diff --git a/docs/kubectl-config-view.md b/docs/kubectl-config-view.md
@@ -29,6 +29,7 @@ $ kubectl config view -o template --template='{{ index . "users" "e2e" "password
 ### Options
 
 ```
+  -h, --help=false: help for view
       --merge=true: merge together the full hierarchy of .kubeconfig files
       --no-headers=false: When using the default output, don't print headers.
   -o, --output="": Output format. One of: json|yaml|template|templatefile.
@@ -49,7 +50,6 @@ $ kubectl config view -o template --template='{{ index . "users" "e2e" "password
       --context="": The name of the kubeconfig context to use
       --envvar=false: use the .kubeconfig from $KUBECONFIG
       --global=false: use the .kubeconfig from /home/username
-  -h, --help=false: help for config
       --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="": use a particular .kubeconfig file
       --local=false: use the .kubeconfig in the current directory

diff --git a/docs/kubectl-config.md b/docs/kubectl-config.md
@@ -16,6 +16,8 @@ kubectl config SUBCOMMAND
 ```
       --envvar=false: use the .kubeconfig from $KUBECONFIG
       --global=false: use the .kubeconfig from /home/username
+  -h, --help=false: help for config
+      --kubeconfig="": use a particular .kubeconfig file
       --local=false: use the .kubeconfig in the current directory
 ```
 
@@ -30,9 +32,7 @@ kubectl config SUBCOMMAND
       --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
       --log_dir=: If non-empty, write log files in this directory
       --log_flush_frequency=5s: Maximum number of seconds between log flushes

diff --git a/docs/kubectl-create.md b/docs/kubectl-create.md
@@ -27,6 +27,7 @@ $ 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
 ```
 
 ### Options inherrited from parent commands
@@ -40,7 +41,6 @@ $ cat pod.json | kubectl create -f -
       --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

diff --git a/docs/kubectl-delete.md b/docs/kubectl-delete.md
@@ -44,6 +44,7 @@ $ kubectl delete pods --all
 ```
       --all=false: [-all] to select all the specified resources
   -f, --filename=[]: Filename, directory, or URL to a file containing the resource to delete
+  -h, --help=false: help for delete
   -l, --selector="": Selector (label query) to filter on
 ```
 
@@ -58,7 +59,6 @@ $ kubectl delete pods --all
       --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

diff --git a/docs/kubectl-describe.md b/docs/kubectl-describe.md
@@ -14,6 +14,12 @@ given resource.
 kubectl describe RESOURCE ID
 ```
 
+### Options
+
+```
+  -h, --help=false: help for describe
+```
+
 ### Options inherrited from parent commands
 
 ```
@@ -25,7 +31,6 @@ kubectl describe RESOURCE ID
       --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

diff --git a/docs/kubectl-exec.md b/docs/kubectl-exec.md
@@ -25,6 +25,7 @@ $ kubectl exec -p 123456-7890 -c ruby-container -i -t -- bash -il
 
 ```
   -c, --container="": Container name
+  -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
@@ -41,7 +42,6 @@ $ kubectl exec -p 123456-7890 -c ruby-container -i -t -- bash -il
       --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

diff --git a/docs/kubectl-expose.md b/docs/kubectl-expose.md
@@ -31,6 +31,7 @@ $ kubectl expose streamer --port=4100 --protocol=udp --service-name=video-stream
       --create-external-load-balancer=false: If true, create an external load balancer for this service. Implementation is cloud provider dependent. Default is 'false'.
       --dry-run=false: If true, only print the object that would be sent, without creating it.
       --generator="service/v1": The name of the API generator to use.  Default is 'service/v1'.
+  -h, --help=false: help for expose
       --no-headers=false: When using the default output, don't print headers.
   -o, --output="": Output format. One of: json|yaml|template|templatefile.
       --output-version="": Output the formatted object with the given version (default api-version).
@@ -54,7 +55,6 @@ $ kubectl expose streamer --port=4100 --protocol=udp --service-name=video-stream
       --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

diff --git a/docs/kubectl-get.md b/docs/kubectl-get.md
@@ -39,6 +39,7 @@ $ kubectl get rc,services
 ### Options
 
 ```
+  -h, --help=false: help for get
       --no-headers=false: When using the default output, don't print headers.
   -o, --output="": Output format. One of: json|yaml|template|templatefile.
       --output-version="": Output the formatted object with the given version (default api-version).
@@ -59,7 +60,6 @@ $ kubectl get rc,services
       --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

diff --git a/docs/kubectl-label.md b/docs/kubectl-label.md
@@ -34,6 +34,7 @@ $ kubectl label pods foo bar-
 ### Options
 
 ```
+  -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.
       --output-version="": Output the formatted object with the given version (default api-version).
@@ -53,7 +54,6 @@ $ kubectl label pods foo bar-
       --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

diff --git a/docs/kubectl-log.md b/docs/kubectl-log.md
@@ -25,6 +25,7 @@ $ kubectl log -f 123456-7890 ruby-container
 
 ```
   -f, --follow=false: Specify if the logs should be streamed.
+  -h, --help=false: help for log
       --interactive=true: If true, prompt the user for input when required. Default true.
 ```
 
@@ -39,7 +40,6 @@ $ kubectl log -f 123456-7890 ruby-container
       --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