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 --recursive=false Print the fields of fields (Currently only 1
44 level deep)
45
49 --as="" Username to impersonate for the operation. User could be a
50 regular user or a service account in a namespace.
51 --as-group=[] Group to impersonate for the operation, this flag
54 can be repeated to specify multiple groups.
55 --as-uid="" UID to impersonate for the operation.
58 --azure-container-registry-config="" Path to the file containing
61 Azure container registry configuration information.
62 --cache-dir="/builddir/.kube/cache" Default cache directory
65 --certificate-authority="" Path to a cert file for the certificate
68 authority
69 --client-certificate="" Path to a client certificate file for TLS
72 --client-key="" Path to a client key file for TLS
75 --cluster="" The name of the kubeconfig cluster to use
78 --context="" The name of the kubeconfig context to use
81 --disable-compression=false If true, opt-out of response compres‐
84 sion for all requests to the server
85 --insecure-skip-tls-verify=false If true, the server's certificate
88 will not be checked for validity. This will make your HTTPS connections
89 insecure
90 --kubeconfig="" Path to the kubeconfig file to use for CLI re‐
93 quests.
94 --match-server-version=false Require server version to match
97 client version
98 -n, --namespace="" If present, the namespace scope for this CLI
101 request
102 --password="" Password for basic authentication to the API server
105 --profile="none" Name of profile to capture. One of
108 (none|cpu|heap|goroutine|threadcreate|block|mutex)
109 --profile-output="profile.pprof" Name of the file to write the
112 profile to
113 --request-timeout="0" The length of time to wait before giving up
116 on a single server request. Non-zero values should contain a corre‐
117 sponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't time‐
118 out requests.
119 -s, --server="" The address and port of the Kubernetes API server
122 --tls-server-name="" Server name to use for server certificate
125 validation. If it is not provided, the hostname used to contact the
126 server is used
127 --token="" Bearer token for authentication to the API server
130 --user="" The name of the kubeconfig user to use
133 --username="" Username for basic authentication to the API server
136 --version=false Print version information and quit
139 --warnings-as-errors=false Treat warnings received from the server
142 as errors and exit with a non-zero exit code
143
147 # Get the documentation of the resource and its fields
148 kubectl explain pods
149 # Get the documentation of a specific field of a resource
151 kubectl explain pods.spec.containers
152
157 kubectl(1),
158
162 January 2015, Originally compiled by Eric Paris (eparis at redhat dot
163 com) based on the kubernetes source material, but hopefully they have
164 been automatically generated since!
165Manuals User KUBERNETES(1)(kubernetes)