1KUBERNETES(1) Jan 2015 KUBERNETES(1)
2
6 kubectl explain - Documentation of resources
7
11 kubectl explain [OPTIONS]
12
16 List the fields for supported resources
17 This command describes the fields associated with each supported API
20 resource. Fields are identified via a simple JSONPath identifier:
21 <type>.<fieldName>[.<fieldName>]
24 Add the --recursive flag to display all of the fields at once without
27 descriptions. Information about each field is retrieved from the server
28 in OpenAPI format.
29 Use "kubectl api-resources" for a complete list of supported resources.
32
36 --api-version=""
37 Get different explanations for particular API version
38 --recursive=false
41 Print the fields of fields (Currently only 1 level deep)
42
46 --allow-verification-with-non-compliant-keys=false
47 Allow a SignatureVerifier to use keys which are technically
48 non-compliant with RFC6962.
49 --alsologtostderr=false
52 log to standard error as well as files
53 --application-metrics-count-limit=100
56 Max number of application metrics to store (per container)
57 --as=""
60 Username to impersonate for the operation
61 --as-group=[]
64 Group to impersonate for the operation, this flag can be repeated
65 to specify multiple groups.
66 --azure-container-registry-config=""
69 Path to the file containing Azure container registry configuration
70 information.
71 --boot-id-file="/proc/sys/kernel/random/boot_id"
74 Comma-separated list of files to check for boot-id. Use the first
75 one that exists.
76 --cache-dir="/builddir/.kube/http-cache"
79 Default HTTP cache directory
80 --certificate-authority=""
83 Path to a cert file for the certificate authority
84 --client-certificate=""
87 Path to a client certificate file for TLS
88 --client-key=""
91 Path to a client key file for TLS
92 --cloud-provider-gce-lb-src-cidrs=130.211.0.0/22,209.85.152.0/22,209.85.204.0/22,35.191.0.0/16
95 CIDRs opened in GCE firewall for LB traffic proxy health checks
96 --cluster=""
99 The name of the kubeconfig cluster to use
100 --container-hints="/etc/cadvisor/container_hints.json"
103 location of the container hints file
104 --containerd="unix:///var/run/containerd.sock"
107 containerd endpoint
108 --context=""
111 The name of the kubeconfig context to use
112 --default-not-ready-toleration-seconds=300
115 Indicates the tolerationSeconds of the toleration for
116 notReady:NoExecute that is added by default to every pod that does not
117 already have such a toleration.
118 --default-unreachable-toleration-seconds=300
121 Indicates the tolerationSeconds of the toleration for unreach‐
122 able:NoExecute that is added by default to every pod that does not
123 already have such a toleration.
124 --docker="unix:///var/run/docker.sock"
127 docker endpoint
128 --docker-env-metadata-whitelist=""
131 a comma-separated list of environment variable keys that needs to
132 be collected for docker containers
133 --docker-only=false
136 Only report docker containers in addition to root stats
137 --docker-root="/var/lib/docker"
140 DEPRECATED: docker root is read from docker info (this is a fall‐
141 back, default: /var/lib/docker)
142 --docker-tls=false
145 use TLS to connect to docker
146 --docker-tls-ca="ca.pem"
149 path to trusted CA
150 --docker-tls-cert="cert.pem"
153 path to client certificate
154 --docker-tls-key="key.pem"
157 path to private key
158 --enable-load-reader=false
161 Whether to enable cpu load reader
162 --event-storage-age-limit="default=0"
165 Max length of time for which to store events (per type). Value is a
166 comma separated list of key values, where the keys are event types
167 (e.g.: creation, oom) or "default" and the value is a duration. Default
168 is applied to all non-specified event types
169 --event-storage-event-limit="default=0"
172 Max number of events to store (per type). Value is a comma sepa‐
173 rated list of key values, where the keys are event types (e.g.: cre‐
174 ation, oom) or "default" and the value is an integer. Default is
175 applied to all non-specified event types
176 --global-housekeeping-interval=1m0s
179 Interval between global housekeepings
180 --google-json-key=""
183 The Google Cloud Platform Service Account JSON Key to use for
184 authentication.
185 --housekeeping-interval=10s
188 Interval between container housekeepings
189 --insecure-skip-tls-verify=false
192 If true, the server's certificate will not be checked for validity.
193 This will make your HTTPS connections insecure
194 --kubeconfig=""
197 Path to the kubeconfig file to use for CLI requests.
198 --log-backtrace-at=:0
201 when logging hits line file:N, emit a stack trace
202 --log-cadvisor-usage=false
205 Whether to log the usage of the cAdvisor container
206 --log-dir=""
209 If non-empty, write log files in this directory
210 --log-flush-frequency=5s
213 Maximum number of seconds between log flushes
214 --logtostderr=true
217 log to standard error instead of files
218 --machine-id-file="/etc/machine-id,/var/lib/dbus/machine-id"
221 Comma-separated list of files to check for machine-id. Use the
222 first one that exists.
223 --match-server-version=false
226 Require server version to match client version
227 --mesos-agent="127.0.0.1:5051"
230 Mesos agent address
231 --mesos-agent-timeout=10s
234 Mesos agent timeout
235 -n, --namespace=""
238 If present, the namespace scope for this CLI request
239 --request-timeout="0"
242 The length of time to wait before giving up on a single server
243 request. Non-zero values should contain a corresponding time unit (e.g.
244 1s, 2m, 3h). A value of zero means don't timeout requests.
245 -s, --server=""
248 The address and port of the Kubernetes API server
249 --stderrthreshold=2
252 logs at or above this threshold go to stderr
253 --storage-driver-buffer-duration=1m0s
256 Writes in the storage driver will be buffered for this duration,
257 and committed to the non memory backends as a single transaction
258 --storage-driver-db="cadvisor"
261 database name
262 --storage-driver-host="localhost:8086"
265 database host:port
266 --storage-driver-password="root"
269 database password
270 --storage-driver-secure=false
273 use secure connection with database
274 --storage-driver-table="stats"
277 table name
278 --storage-driver-user="root"
281 database username
282 --token=""
285 Bearer token for authentication to the API server
286 --user=""
289 The name of the kubeconfig user to use
290 -v, --v=0
293 log level for V logs
294 --version=false
297 Print version information and quit
298 --vmodule=
301 comma-separated list of pattern=N settings for file-filtered log‐
302 ging
303
307 # Get the documentation of the resource and its fields
308 kubectl explain pods
309 # Get the documentation of a specific field of a resource
311 kubectl explain pods.spec.containers
312
317 kubectl(1),
318
322 January 2015, Originally compiled by Eric Paris (eparis at redhat dot
323 com) based on the kubernetes source material, but hopefully they have
324 been automatically generated since!
325Eric Paris kubernetes User Manuals KUBERNETES(1)