diff --git a/docs/kubectl-clusterinfo.md b/docs/kubectl-clusterinfo.md index 8b5bfff601729..90d8995ebd2d1 100644 --- 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 index 106e7203a54a3..fde779c9af07f 100644 --- 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 index 9e4e3062c7cd8..7b271f4ec6cfa 100644 --- 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 index a956753902eef..b316a976ce630 100644 --- a/docs/kubectl-config-set-credentials.md +++ b/docs/kubectl-config-set-credentials.md @@ -41,7 +41,14 @@ $ 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 @@ -49,15 +56,11 @@ $ kubectl set-credentials cluster-admin --client-certificate=~/.kube/admin.crt - ``` --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 index 1be356a5cb43d..16e970735dc09 100644 --- 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 index 3e327de079004..ca6f75e2f509d 100644 --- 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 index 11f6e0f7b8825..ee24b9c650e31 100644 --- 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 index dd50f1eab8191..afe81c4005601 100644 --- 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 index 56cef264f0b18..b5e9fdb4aec20 100644 --- 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 index 52f8ea32fba93..5499da03e6eee 100644 --- 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 index c92da2baeeaa3..5b5cc713ba376 100644 --- 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 index 50d0373b78e0e..e79c4526fd8fe 100644 --- 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 index 3fdda08552a06..e2b75f1087161 100644 --- 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 index e785ddb0954e1..b3ee07eee00be 100644 --- 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 index fcdf18472cd1c..87d247cf38c36 100644 --- 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 index c3ace001b1c93..41f2d3e6d7f24 100644 --- 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 index 47974b1044784..1e3510ad9344b 100644 --- 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 diff --git a/docs/kubectl-namespace.md b/docs/kubectl-namespace.md index e78ae43294d41..7f7c68961b0cb 100644 --- a/docs/kubectl-namespace.md +++ b/docs/kubectl-namespace.md @@ -14,6 +14,12 @@ namespace has been superceded by the context.namespace field of .kubeconfig file kubectl namespace [namespace] ``` +### Options + +``` + -h, --help=false: help for namespace +``` + ### Options inherrited from parent commands ``` @@ -25,7 +31,6 @@ kubectl namespace [namespace] --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-port-forward.md b/docs/kubectl-port-forward.md index 468dc2356efe4..b7c44b12f91bd 100644 --- a/docs/kubectl-port-forward.md +++ b/docs/kubectl-port-forward.md @@ -31,6 +31,7 @@ $ kubectl port-forward -p mypod 0:5000 ### Options ``` + -h, --help=false: help for port-forward -p, --pod="": Pod name ``` @@ -45,7 +46,6 @@ $ kubectl port-forward -p mypod 0:5000 --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-proxy.md b/docs/kubectl-proxy.md index e8f2a0d5c4888..48f37e41b7ee0 100644 --- a/docs/kubectl-proxy.md +++ b/docs/kubectl-proxy.md @@ -26,6 +26,7 @@ $ kubectl proxy --api-prefix=k8s-api ``` --api-prefix="/api/": Prefix to serve the proxied API under. + -h, --help=false: help for proxy -p, --port=8001: The port on which to run the proxy. -w, --www="": Also serve static files from the given directory under the specified prefix. -P, --www-prefix="/static/": Prefix to serve static files under, if static file directory is specified. @@ -42,7 +43,6 @@ $ kubectl proxy --api-prefix=k8s-api --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-resize.md b/docs/kubectl-resize.md index d528aecf1d800..42a44a066ad81 100644 --- a/docs/kubectl-resize.md +++ b/docs/kubectl-resize.md @@ -30,6 +30,7 @@ $ kubectl resize --current-replicas=2 --replicas=3 replicationcontrollers foo ``` --current-replicas=-1: Precondition for current size. Requires that the current size of the replication controller match this value in order to resize. + -h, --help=false: help for resize --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 resize. ``` @@ -45,7 +46,6 @@ $ kubectl resize --current-replicas=2 --replicas=3 replicationcontrollers foo --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-rollingupdate.md b/docs/kubectl-rollingupdate.md index 9f0c33a6dcfc8..3e34d2242d29b 100644 --- a/docs/kubectl-rollingupdate.md +++ b/docs/kubectl-rollingupdate.md @@ -29,6 +29,7 @@ $ cat frontend-v2.json | kubectl rollingupdate frontend-v1 -f - ``` -f, --filename="": Filename or URL to file to use to create the new controller. + -h, --help=false: help for rollingupdate --poll-interval="3s": Time delay between polling controller status after update. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". --timeout="5m0s": Max time to wait for a controller to update before giving up. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". --update-period="1m0s": Time to wait between updating pods. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". @@ -45,7 +46,6 @@ $ cat frontend-v2.json | kubectl rollingupdate frontend-v1 -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-run-container.md b/docs/kubectl-run-container.md index da469a69ce535..dfbde8a8d1b88 100644 --- a/docs/kubectl-run-container.md +++ b/docs/kubectl-run-container.md @@ -33,6 +33,7 @@ $ kubectl run-container nginx --image=dockerfile/nginx --overrides='{ "apiVersio ``` --dry-run=false: If true, only print the object that would be sent, without sending it. --generator="run-container/v1": The name of the API generator to use. Default is 'run-container-controller/v1'. + -h, --help=false: help for run-container --image="": The image for the container to run. -l, --labels="": Labels to apply to the pod(s) created by this call to run-container. --no-headers=false: When using the default output, don't print headers. @@ -55,7 +56,6 @@ $ kubectl run-container nginx --image=dockerfile/nginx --overrides='{ "apiVersio --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-stop.md b/docs/kubectl-stop.md index 2a56f2ea19699..4da057ad76604 100644 --- a/docs/kubectl-stop.md +++ b/docs/kubectl-stop.md @@ -35,6 +35,7 @@ $ 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 + -h, --help=false: help for stop -l, --selector="": Selector (label query) to filter on ``` @@ -49,7 +50,6 @@ $ kubectl stop -f path/to/resources --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-update.md b/docs/kubectl-update.md index be76088fc6188..52af1e12a52dd 100644 --- a/docs/kubectl-update.md +++ b/docs/kubectl-update.md @@ -30,6 +30,7 @@ $ kubectl update pods my-pod --patch='{ "apiVersion": "v1beta1", "desiredState": ``` -f, --filename=[]: Filename, directory, or URL to file to use to update the resource. + -h, --help=false: help for update --patch="": A JSON document to override the existing resource. The resource is downloaded, patched with the JSON, then updated. ``` @@ -44,7 +45,6 @@ $ kubectl update pods my-pod --patch='{ "apiVersion": "v1beta1", "desiredState": --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-version.md b/docs/kubectl-version.md index 9dadaa4910ec0..a2c3f1ab298f1 100644 --- a/docs/kubectl-version.md +++ b/docs/kubectl-version.md @@ -15,6 +15,7 @@ kubectl version ``` -c, --client=false: Client version only (no server required). + -h, --help=false: help for version ``` ### Options inherrited from parent commands @@ -28,7 +29,6 @@ kubectl version --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/man/man1/kubectl-clusterinfo.1 b/docs/man/man1/kubectl-clusterinfo.1 index a59393d0d3ab6..9f0c6cc5b8845 100644 --- a/docs/man/man1/kubectl-clusterinfo.1 +++ b/docs/man/man1/kubectl-clusterinfo.1 @@ -16,6 +16,12 @@ kubectl clusterinfo \- 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 clusterinfo + + .SH OPTIONS INHERITED FROM PARENT COMMANDS .PP \fB\-\-alsologtostderr\fP=false @@ -49,10 +55,6 @@ Display addresses of the master and services with label kubernetes.io/cluster\-s \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/man/man1/kubectl-config-set-cluster.1 b/docs/man/man1/kubectl-config-set-cluster.1 index b10b169fc2f0a..7eec68fd9440d 100644 --- a/docs/man/man1/kubectl-config-set-cluster.1 +++ b/docs/man/man1/kubectl-config-set-cluster.1 @@ -18,28 +18,40 @@ Specifying a name that already exists will merge new fields on top of existing v .SH OPTIONS +.PP +\fB\-\-api\-version\fP="" + api\-version for the cluster entry in .kubeconfig + +.PP +\fB\-\-certificate\-authority\fP="" + path to certificate\-authority for the cluster entry in .kubeconfig + .PP \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 + +.PP +\fB\-\-server\fP="" + server for the cluster entry in .kubeconfig + .SH OPTIONS INHERITED FROM PARENT COMMANDS .PP \fB\-\-alsologtostderr\fP=false log to standard error as well as files -.PP -\fB\-\-api\-version\fP="" - The API version to use when talking to the server - .PP \fB\-a\fP, \fB\-\-auth\-path\fP="" Path to the auth info file. If missing, prompt the user. Only used if using https. -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - .PP \fB\-\-client\-certificate\fP="" Path to a client key file for TLS. @@ -64,14 +76,6 @@ Specifying a name that already exists will merge new fields on top of existing v \fB\-\-global\fP=false use the .kubeconfig from /home/username -.PP -\fB\-h\fP, \fB\-\-help\fP=false - help for config - -.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. - .PP \fB\-\-kubeconfig\fP="" use a particular .kubeconfig file @@ -108,10 +112,6 @@ Specifying a name that already exists will merge new fields on top of existing v \fB\-\-password\fP="" Password for basic authentication to the API server. -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - .PP \fB\-\-stderrthreshold\fP=2 logs at or above this threshold go to stderr diff --git a/docs/man/man1/kubectl-config-set-context.1 b/docs/man/man1/kubectl-config-set-context.1 index 5f2795b6f753f..e8636e4bde67c 100644 --- a/docs/man/man1/kubectl-config-set-context.1 +++ b/docs/man/man1/kubectl-config-set-context.1 @@ -17,6 +17,24 @@ Sets a context entry in .kubeconfig Specifying a name that already exists will merge new fields on top of existing values for those fields. +.SH OPTIONS +.PP +\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 + +.PP +\fB\-\-user\fP="" + user for the context entry in .kubeconfig + + .SH OPTIONS INHERITED FROM PARENT COMMANDS .PP \fB\-\-alsologtostderr\fP=false @@ -42,10 +60,6 @@ Specifying a name that already exists will merge new fields on top of existing v \fB\-\-client\-key\fP="" Path to a client key file for TLS. -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - .PP \fB\-\-context\fP="" The name of the kubeconfig context to use @@ -58,10 +72,6 @@ Specifying a name that already exists will merge new fields on top of existing v \fB\-\-global\fP=false use the .kubeconfig from /home/username -.PP -\fB\-h\fP, \fB\-\-help\fP=false - help for config - .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. @@ -94,10 +104,6 @@ Specifying a name that already exists will merge new fields on top of existing v \fB\-\-match\-server\-version\fP=false Require server version to match client version -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - .PP \fB\-\-password\fP="" Password for basic authentication to the API server. @@ -114,10 +120,6 @@ Specifying a name that already exists will merge new fields on top of existing v \fB\-\-token\fP="" Bearer token for authentication to the API server. -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - .PP \fB\-\-username\fP="" Username for basic authentication to the API server. diff --git a/docs/man/man1/kubectl-config-set-credentials.1 b/docs/man/man1/kubectl-config-set-credentials.1 index 2774c4711491c..039bbc9d4d26e 100644 --- a/docs/man/man1/kubectl-config-set-credentials.1 +++ b/docs/man/man1/kubectl-config-set-credentials.1 @@ -33,10 +33,38 @@ Bearer token and basic auth are mutually exclusive. .SH OPTIONS +.PP +\fB\-\-auth\-path\fP="" + auth\-path for the user entry in .kubeconfig + +.PP +\fB\-\-client\-certificate\fP="" + path to client\-certificate for the user entry in .kubeconfig + +.PP +\fB\-\-client\-key\fP="" + path to client\-key for the user entry in .kubeconfig + .PP \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 + +.PP +\fB\-\-token\fP="" + token for the user entry in .kubeconfig + +.PP +\fB\-\-username\fP="" + username for the user entry in .kubeconfig + .SH OPTIONS INHERITED FROM PARENT COMMANDS .PP @@ -47,22 +75,10 @@ Bearer token and basic auth are mutually exclusive. \fB\-\-api\-version\fP="" The API version to use when talking to the server -.PP -\fB\-a\fP, \fB\-\-auth\-path\fP="" - Path to the auth info file. If missing, prompt the user. Only used if using https. - .PP \fB\-\-certificate\-authority\fP="" Path to a cert. file for the certificate authority. -.PP -\fB\-\-client\-certificate\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - .PP \fB\-\-cluster\fP="" The name of the kubeconfig cluster to use @@ -79,10 +95,6 @@ Bearer token and basic auth are mutually exclusive. \fB\-\-global\fP=false use the .kubeconfig from /home/username -.PP -\fB\-h\fP, \fB\-\-help\fP=false - help for config - .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. @@ -119,10 +131,6 @@ Bearer token and basic auth are mutually exclusive. \fB\-\-namespace\fP="" If present, the namespace scope for this CLI request. -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - .PP \fB\-s\fP, \fB\-\-server\fP="" The address and port of the Kubernetes API server @@ -131,18 +139,10 @@ Bearer token and basic auth are mutually exclusive. \fB\-\-stderrthreshold\fP=2 logs at or above this threshold go to stderr -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - .PP \fB\-\-user\fP="" The name of the kubeconfig user to use -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - .PP \fB\-\-v\fP=0 log level for V logs diff --git a/docs/man/man1/kubectl-config-set.1 b/docs/man/man1/kubectl-config-set.1 index eb854db0ff925..5c9782b27cfc5 100644 --- a/docs/man/man1/kubectl-config-set.1 +++ b/docs/man/man1/kubectl-config-set.1 @@ -18,6 +18,12 @@ 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 @@ -59,10 +65,6 @@ PROPERTY\_VALUE is the new value you wish to set. \fB\-\-global\fP=false use the .kubeconfig from /home/username -.PP -\fB\-h\fP, \fB\-\-help\fP=false - help for config - .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/man/man1/kubectl-config-unset.1 b/docs/man/man1/kubectl-config-unset.1 index 76cf676c374bb..61786eb63d786 100644 --- a/docs/man/man1/kubectl-config-unset.1 +++ b/docs/man/man1/kubectl-config-unset.1 @@ -17,6 +17,12 @@ 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 @@ -58,10 +64,6 @@ PROPERTY\_NAME is a dot delimited name where each token represents either a attr \fB\-\-global\fP=false use the .kubeconfig from /home/username -.PP -\fB\-h\fP, \fB\-\-help\fP=false - help for config - .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/man/man1/kubectl-config-use-context.1 b/docs/man/man1/kubectl-config-use-context.1 index dc03a9def717c..f0c92ebecd4d5 100644 --- a/docs/man/man1/kubectl-config-use-context.1 +++ b/docs/man/man1/kubectl-config-use-context.1 @@ -16,6 +16,12 @@ 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 @@ -57,10 +63,6 @@ Sets the current\-context in a .kubeconfig file \fB\-\-global\fP=false use the .kubeconfig from /home/username -.PP -\fB\-h\fP, \fB\-\-help\fP=false - help for config - .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/man/man1/kubectl-config-view.1 b/docs/man/man1/kubectl-config-view.1 index 2d64119a44ce8..934da061c1b84 100644 --- a/docs/man/man1/kubectl-config-view.1 +++ b/docs/man/man1/kubectl-config-view.1 @@ -20,6 +20,10 @@ You can use \-\-output=template \-\-template=TEMPLATE to extract specific values .SH OPTIONS +.PP +\fB\-h\fP, \fB\-\-help\fP=false + help for view + .PP \fB\-\-merge\fP=true merge together the full hierarchy of .kubeconfig files @@ -83,10 +87,6 @@ You can use \-\-output=template \-\-template=TEMPLATE to extract specific values \fB\-\-global\fP=false use the .kubeconfig from /home/username -.PP -\fB\-h\fP, \fB\-\-help\fP=false - help for config - .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/man/man1/kubectl-config.1 b/docs/man/man1/kubectl-config.1 index bea2aca70a681..0b2d55b16e771 100644 --- a/docs/man/man1/kubectl-config.1 +++ b/docs/man/man1/kubectl-config.1 @@ -25,6 +25,14 @@ config modifies .kubeconfig files using subcommands like "kubectl config set cur \fB\-\-global\fP=false use the .kubeconfig from /home/username +.PP +\fB\-h\fP, \fB\-\-help\fP=false + help for config + +.PP +\fB\-\-kubeconfig\fP="" + use a particular .kubeconfig file + .PP \fB\-\-local\fP=false use the .kubeconfig in the current directory @@ -63,18 +71,10 @@ config modifies .kubeconfig files using subcommands like "kubectl config set cur \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. -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - .PP \fB\-\-log\_backtrace\_at\fP=:0 when logging hits line file:N, emit a stack trace diff --git a/docs/man/man1/kubectl-create.1 b/docs/man/man1/kubectl-create.1 index 18b4435c069c7..ca9b27364c7dd 100644 --- a/docs/man/man1/kubectl-create.1 +++ b/docs/man/man1/kubectl-create.1 @@ -24,6 +24,10 @@ 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 + .SH OPTIONS INHERITED FROM PARENT COMMANDS .PP @@ -58,10 +62,6 @@ JSON and YAML formats are accepted. \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/man/man1/kubectl-delete.1 b/docs/man/man1/kubectl-delete.1 index 2ce3b2c4d0553..73db055a68ee3 100644 --- a/docs/man/man1/kubectl-delete.1 +++ b/docs/man/man1/kubectl-delete.1 @@ -37,6 +37,10 @@ will be lost along with the rest of the resource. \fB\-f\fP, \fB\-\-filename\fP=[] Filename, directory, or URL to a file containing the resource to delete +.PP +\fB\-h\fP, \fB\-\-help\fP=false + help for delete + .PP \fB\-l\fP, \fB\-\-selector\fP="" Selector (label query) to filter on @@ -75,10 +79,6 @@ will be lost along with the rest of the resource. \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/man/man1/kubectl-describe.1 b/docs/man/man1/kubectl-describe.1 index 378e6d09557c6..c28d455f35dc3 100644 --- a/docs/man/man1/kubectl-describe.1 +++ b/docs/man/man1/kubectl-describe.1 @@ -20,6 +20,12 @@ This command joins many API calls together to form a detailed description of a given resource. +.SH OPTIONS +.PP +\fB\-h\fP, \fB\-\-help\fP=false + help for describe + + .SH OPTIONS INHERITED FROM PARENT COMMANDS .PP \fB\-\-alsologtostderr\fP=false @@ -53,10 +59,6 @@ given resource. \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/man/man1/kubectl-exec.1 b/docs/man/man1/kubectl-exec.1 index 31ed5cfa5ff4e..5324972cbcb6b 100644 --- a/docs/man/man1/kubectl-exec.1 +++ b/docs/man/man1/kubectl-exec.1 @@ -21,6 +21,10 @@ Execute a command in a container. \fB\-c\fP, \fB\-\-container\fP="" Container name +.PP +\fB\-h\fP, \fB\-\-help\fP=false + help for exec + .PP \fB\-p\fP, \fB\-\-pod\fP="" Pod name @@ -67,10 +71,6 @@ Execute a command in a container. \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/man/man1/kubectl-expose.1 b/docs/man/man1/kubectl-expose.1 index 01cf84115fc93..529b99b3f04a1 100644 --- a/docs/man/man1/kubectl-expose.1 +++ b/docs/man/man1/kubectl-expose.1 @@ -37,6 +37,10 @@ as the selector for a new Service on the specified port. \fB\-\-generator\fP="service/v1" The name of the API generator to use. Default is 'service/v1'. +.PP +\fB\-h\fP, \fB\-\-help\fP=false + help for expose + .PP \fB\-\-no\-headers\fP=false When using the default output, don't print headers. @@ -112,10 +116,6 @@ as the selector for a new Service on the specified port. \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/man/man1/kubectl-get.1 b/docs/man/man1/kubectl-get.1 index 2719398d9a773..1c9cd2f059135 100644 --- a/docs/man/man1/kubectl-get.1 +++ b/docs/man/man1/kubectl-get.1 @@ -25,6 +25,10 @@ of the \-\-template flag, you can filter the attributes of the fetched resource( .SH OPTIONS +.PP +\fB\-h\fP, \fB\-\-help\fP=false + help for get + .PP \fB\-\-no\-headers\fP=false When using the default output, don't print headers. @@ -88,10 +92,6 @@ of the \-\-template flag, you can filter the attributes of the fetched resource( \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/man/man1/kubectl-label.1 b/docs/man/man1/kubectl-label.1 index c835a1025463b..704ac370dc7fb 100644 --- a/docs/man/man1/kubectl-label.1 +++ b/docs/man/man1/kubectl-label.1 @@ -21,6 +21,10 @@ If \-\-resource\-version is specified, then updates will use this resource versi .SH OPTIONS +.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. @@ -80,10 +84,6 @@ If \-\-resource\-version is specified, then updates will use this resource versi \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/man/man1/kubectl-log.1 b/docs/man/man1/kubectl-log.1 index bf0bd6853e31b..3cea9c327827f 100644 --- a/docs/man/man1/kubectl-log.1 +++ b/docs/man/man1/kubectl-log.1 @@ -21,6 +21,10 @@ 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 log + .PP \fB\-\-interactive\fP=true If true, prompt the user for input when required. Default true. @@ -59,10 +63,6 @@ Print the logs for a container in a pod. If the pod has only one container, the \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/man/man1/kubectl-namespace.1 b/docs/man/man1/kubectl-namespace.1 index ca35a13e2de10..6f0a0819c56ff 100644 --- a/docs/man/man1/kubectl-namespace.1 +++ b/docs/man/man1/kubectl-namespace.1 @@ -19,6 +19,12 @@ SUPERCEDED: Set and view the current Kubernetes namespace scope for command lin namespace has been superceded 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 @@ -52,10 +58,6 @@ namespace has been superceded by the context.namespace field of .kubeconfig file \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/man/man1/kubectl-port-forward.1 b/docs/man/man1/kubectl-port-forward.1 index 912ce1e9e562a..48d8fa16b830c 100644 --- a/docs/man/man1/kubectl-port-forward.1 +++ b/docs/man/man1/kubectl-port-forward.1 @@ -17,6 +17,10 @@ Forward 1 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 @@ -55,10 +59,6 @@ Forward 1 or more local ports to a pod. \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/man/man1/kubectl-proxy.1 b/docs/man/man1/kubectl-proxy.1 index a7fda879767f1..5ac2fcd5a1feb 100644 --- a/docs/man/man1/kubectl-proxy.1 +++ b/docs/man/man1/kubectl-proxy.1 @@ -21,6 +21,10 @@ Run a proxy to the Kubernetes API server. \fB\-\-api\-prefix\fP="/api/" Prefix to serve the proxied API under. +.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. @@ -67,10 +71,6 @@ Run a proxy to the Kubernetes API server. \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/man/man1/kubectl-resize.1 b/docs/man/man1/kubectl-resize.1 index 4e84205af019c..9d2d25ab5c1d3 100644 --- a/docs/man/man1/kubectl-resize.1 +++ b/docs/man/man1/kubectl-resize.1 @@ -27,6 +27,10 @@ resize is sent to the server. \fB\-\-current\-replicas\fP=\-1 Precondition for current size. Requires that the current size of the replication controller match this value in order to resize. +.PP +\fB\-h\fP, \fB\-\-help\fP=false + help for resize + .PP \fB\-\-replicas\fP=\-1 The new desired number of replicas. Required. @@ -69,10 +73,6 @@ resize is sent to the server. \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/man/man1/kubectl-rollingupdate.1 b/docs/man/man1/kubectl-rollingupdate.1 index 7b656253225b4..103cfc10628e1 100644 --- a/docs/man/man1/kubectl-rollingupdate.1 +++ b/docs/man/man1/kubectl-rollingupdate.1 @@ -26,6 +26,10 @@ existing controller and overwrite at least one (common) label in its replicaSele \fB\-f\fP, \fB\-\-filename\fP="" Filename or URL to file to use to create the new controller. +.PP +\fB\-h\fP, \fB\-\-help\fP=false + help for rollingupdate + .PP \fB\-\-poll\-interval\fP="3s" Time delay between polling controller status after update. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". @@ -72,10 +76,6 @@ existing controller and overwrite at least one (common) label in its replicaSele \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/man/man1/kubectl-run-container.1 b/docs/man/man1/kubectl-run-container.1 index f156496d80dee..2076d1debc796 100644 --- a/docs/man/man1/kubectl-run-container.1 +++ b/docs/man/man1/kubectl-run-container.1 @@ -26,6 +26,10 @@ Creates a replication controller to manage the created container(s). \fB\-\-generator\fP="run\-container/v1" The name of the API generator to use. Default is 'run\-container\-controller/v1'. +.PP +\fB\-h\fP, \fB\-\-help\fP=false + help for run\-container + .PP \fB\-\-image\fP="" The image for the container to run. @@ -97,10 +101,6 @@ Creates a replication controller to manage the created container(s). \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/man/man1/kubectl-stop.1 b/docs/man/man1/kubectl-stop.1 index 9ab05bbff1b7a..029474cce06ae 100644 --- a/docs/man/man1/kubectl-stop.1 +++ b/docs/man/man1/kubectl-stop.1 @@ -29,6 +29,10 @@ If the resource is resizable it will be resized to 0 before deletion. \fB\-f\fP, \fB\-\-filename\fP=[] Filename, directory, or URL to file of resource(s) to be stopped +.PP +\fB\-h\fP, \fB\-\-help\fP=false + help for stop + .PP \fB\-l\fP, \fB\-\-selector\fP="" Selector (label query) to filter on @@ -67,10 +71,6 @@ If the resource is resizable it will be resized to 0 before deletion. \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/man/man1/kubectl-update.1 b/docs/man/man1/kubectl-update.1 index 33660c234e858..f400c93a6c5f2 100644 --- a/docs/man/man1/kubectl-update.1 +++ b/docs/man/man1/kubectl-update.1 @@ -24,6 +24,10 @@ JSON and YAML formats are accepted. \fB\-f\fP, \fB\-\-filename\fP=[] Filename, directory, or URL to file to use to update the resource. +.PP +\fB\-h\fP, \fB\-\-help\fP=false + help for update + .PP \fB\-\-patch\fP="" A JSON document to override the existing resource. The resource is downloaded, patched with the JSON, then updated. @@ -62,10 +66,6 @@ JSON and YAML formats are accepted. \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/man/man1/kubectl-version.1 b/docs/man/man1/kubectl-version.1 index 9b082d525dc9e..1640fdd5b75ad 100644 --- a/docs/man/man1/kubectl-version.1 +++ b/docs/man/man1/kubectl-version.1 @@ -21,6 +21,10 @@ 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 @@ -55,10 +59,6 @@ Print the client and server version information. \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.