From c75926444269dd1748d7750fb1ad1ea3fcc83f4a Mon Sep 17 00:00:00 2001 From: Victor Marmol Date: Wed, 11 Feb 2015 15:25:45 -0800 Subject: [PATCH] Updating docs with new CLI flag output. --- docs/kubectl.md | 238 ++++++++++++++++++++++++++++-------------------- 1 file changed, 139 insertions(+), 99 deletions(-) diff --git a/docs/kubectl.md b/docs/kubectl.md index 354ce068b1..02580dc864 100644 --- a/docs/kubectl.md +++ b/docs/kubectl.md @@ -11,12 +11,14 @@ Usage: ``` kubectl version [flags] - Available Flags: +Flags: + -c, --client=false: Client version only (no server required). + +Global Flags: --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. - -c, --client=false: Client version only (no server required). --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 @@ -47,9 +49,14 @@ Usage: ``` kubectl proxy [flags] - Available Flags: - --alsologtostderr=false: log to standard error as well as files +Flags: --api-prefix="/api/": Prefix to serve the proxied API under. + -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. + +Global Flags: + --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. @@ -66,7 +73,6 @@ Usage: --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. - -p, --port=8001: The port on which to run the proxy. -s, --server="": The address 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. @@ -74,8 +80,6 @@ Usage: --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 - -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. ``` @@ -109,7 +113,16 @@ Usage: ``` kubectl get [(-o|--output=)json|yaml|template|...] [] [flags] - Available Flags: +Flags: + --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). + -l, --selector="": Selector (label query) to filter on + -t, --template="": Template string or path to template file to use when -o=template or -o=templatefile. + -w, --watch=false: After listing/getting the requested object, watch for changes. + --watch-only=false: Watch for changes to the requested object(s), without listing/getting first. + +Global Flags: --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. @@ -127,20 +140,13 @@ Usage: --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. - --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). - -l, --selector="": Selector (label query) to filter on -s, --server="": The address of the Kubernetes API server --stderrthreshold=2: logs at or above this threshold go to stderr - -t, --template="": Template string or path to template file to use when -o=template or -o=templatefile. --token="": Bearer token for authentication to the API server. --user="": The name of the kubeconfig user to use --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 - -w, --watch=false: After listing/getting the requested object, watch for changes. - --watch-only=false: Watch for changes to the requested object(s), without listing/getting first. ``` @@ -154,7 +160,8 @@ Usage: ``` kubectl describe [flags] - Available Flags: + +Global Flags: --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. @@ -163,6 +170,7 @@ Usage: --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 describe --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 @@ -198,7 +206,10 @@ Usage: ``` kubectl create -f filename [flags] - Available Flags: +Flags: + -f, --filename=[]: Filename, directory, or URL to file to use to create the resource + +Global Flags: --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. @@ -207,7 +218,6 @@ Usage: --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 - -f, --filename=[]: Filename, directory, or URL to file to use to create the resource -h, --help=false: help for create --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. @@ -247,7 +257,11 @@ Usage: ``` kubectl update -f filename [flags] - Available Flags: +Flags: + -f, --filename=[]: Filename, directory, or URL to file to use to update the resource. + --patch="": A JSON document to override the existing resource. The resource is downloaded, patched with the JSON, then updated. + +Global Flags: --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. @@ -256,7 +270,6 @@ Usage: --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 - -f, --filename=[]: Filename, directory, or URL to file to use to update the resource. -h, --help=false: help for update --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. @@ -266,7 +279,6 @@ Usage: --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. - --patch="": A JSON document to override the existing resource. The resource is downloaded, patched with the JSON, then updated. -s, --server="": The address 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. @@ -307,7 +319,11 @@ Usage: ``` kubectl delete ([-f filename] | ( [( | -l