1KUBERNETES(1)(kubernetes) KUBERNETES(1)(kubernetes)
2Eric Paris Jan 2015
6
9 kubectl explain - Get documentation for a resource
10
14 kubectl explain [OPTIONS]
15
19 List the fields for supported resources.
20 This command describes the fields associated with each supported API
23 resource. Fields are identified via a simple JSONPath identifier:
24 .[.]
27 Add the --recursive flag to display all of the fields at once without
30 descriptions. Information about each field is retrieved from the server
31 in OpenAPI format.
32 Use "kubectl api-resources" for a complete list of supported resources.
35
39 --api-version="" Get different explanations for particular API
40 version (API group/version)
41 --output="plaintext" Format in which to render the schema (plain‐
44 text, plaintext-openapiv2)
45 --recursive=false Print the fields of fields (Currently only 1
48 level deep)
49
53 --as="" Username to impersonate for the operation. User could be a
54 regular user or a service account in a namespace.
55 --as-group=[] Group to impersonate for the operation, this flag
58 can be repeated to specify multiple groups.
59 --as-uid="" UID to impersonate for the operation.
62 --azure-container-registry-config="" Path to the file containing
65 Azure container registry configuration information.
66 --cache-dir="/builddir/.kube/cache" Default cache directory
69 --certificate-authority="" Path to a cert file for the certificate
72 authority
73 --client-certificate="" Path to a client certificate file for TLS
76 --client-key="" Path to a client key file for TLS
79 --cluster="" The name of the kubeconfig cluster to use
82 --context="" The name of the kubeconfig context to use
85 --disable-compression=false If true, opt-out of response compres‐
88 sion for all requests to the server
89 --insecure-skip-tls-verify=false If true, the server's certificate
92 will not be checked for validity. This will make your HTTPS connections
93 insecure
94 --kubeconfig="" Path to the kubeconfig file to use for CLI re‐
97 quests.
98 --match-server-version=false Require server version to match
101 client version
102 -n, --namespace="" If present, the namespace scope for this CLI
105 request
106 --password="" Password for basic authentication to the API server
109 --profile="none" Name of profile to capture. One of
112 (none|cpu|heap|goroutine|threadcreate|block|mutex)
113 --profile-output="profile.pprof" Name of the file to write the
116 profile to
117 --request-timeout="0" The length of time to wait before giving up
120 on a single server request. Non-zero values should contain a corre‐
121 sponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't time‐
122 out requests.
123 -s, --server="" The address and port of the Kubernetes API server
126 --tls-server-name="" Server name to use for server certificate
129 validation. If it is not provided, the hostname used to contact the
130 server is used
131 --token="" Bearer token for authentication to the API server
134 --user="" The name of the kubeconfig user to use
137 --username="" Username for basic authentication to the API server
140 --version=false Print version information and quit
143 --warnings-as-errors=false Treat warnings received from the server
146 as errors and exit with a non-zero exit code
147
151 # Get the documentation of the resource and its fields
152 kubectl explain pods
153 # Get the documentation of a specific field of a resource
155 kubectl explain pods.spec.containers
156
161 kubectl(1),
162
166 January 2015, Originally compiled by Eric Paris (eparis at redhat dot
167 com) based on the kubernetes source material, but hopefully they have
168 been automatically generated since!
169Manuals User KUBERNETES(1)(kubernetes)