update docs using spf13/cobra generator

2025-09-12 12:48:51 +00:00 · 2015-04-12 15:04:39 -04:00
parent 263dc981db
commit faf60a3cab
30 changed files with 82 additions and 158 deletions
--- a/docs/kubectl_get.md
+++ b/docs/kubectl_get.md
@@ -0,0 +1,88 @@
+## kubectl get
+
+Display one or many resources
+
+### Synopsis
+
+
+Display one or many resources.
+
+Possible resources include pods (po), replication controllers (rc), services
+(svc), minions (mi), or events (ev).
+
+By specifying the output as 'template' and providing a Go template as the value
+of the --template flag, you can filter the attributes of the fetched resource(s).
+
+```
+kubectl get [(-o|--output=)json|yaml|template|...] (RESOURCE [NAME] | RESOURCE/NAME ...)
+```
+
+### Examples
+
+```
+// List all pods in ps output format.
+$ kubectl get pods
+
+// List a single replication controller with specified NAME in ps output format.
+$ kubectl get replicationController web
+
+// List a single pod in JSON output format.
+$ kubectl get -o json pod web-pod-13je7
+
+// Return only the phase value of the specified pod.
+$ kubectl get -o template web-pod-13je7 --template={{.status.phase}} --api-version=v1beta3
+
+// List all replication controllers and services together in ps output format.
+$ kubectl get rc,services
+
+// List one or more resources by their type and names
+$ kubectl get rc/web service/frontend pods/web-pod-13je7
+```
+
+### 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).
+  -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.  The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]
+  -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.
+```
+
+### 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
+      --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
+      --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
+```
+
+### SEE ALSO
+* [kubectl](kubectl.md)	 - kubectl controls the Kubernetes cluster manager
+
+###### Auto generated by spf13/cobra at 2015-04-12 19:00:26.836684094 +0000 UTC