1KUBERNETES(1)                      Jan 2015                      KUBERNETES(1)
2
3
4

NAME

6       kubectl explain - Documentation of resources
7
8
9

SYNOPSIS

11       kubectl explain [OPTIONS]
12
13
14

DESCRIPTION

16       List the fields for supported resources
17
18
19       This  command  describes  the fields associated with each supported API
20       resource. Fields are identified via a simple JSONPath identifier:
21
22
23       <type>.<fieldName>[.<fieldName>]
24
25
26       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
30
31       Use "kubectl api-resources" for a complete list of supported resources.
32
33
34

OPTIONS

36       --api-version=""
37           Get different explanations for particular API version
38
39
40       --recursive=false
41           Print the fields of fields (Currently only 1 level deep)
42
43
44

OPTIONS INHERITED FROM PARENT COMMANDS

46       --alsologtostderr=false
47           log to standard error as well as files
48
49
50       --application-metrics-count-limit=100
51           Max number of application metrics to store (per container)
52
53
54       --as=""
55           Username to impersonate for the operation
56
57
58       --as-group=[]
59           Group to impersonate for the operation, this flag can  be  repeated
60       to specify multiple groups.
61
62
63       --azure-container-registry-config=""
64           Path  to the file containing Azure container registry configuration
65       information.
66
67
68       --boot-id-file="/proc/sys/kernel/random/boot_id"
69           Comma-separated list of files to check for boot-id. Use  the  first
70       one that exists.
71
72
73       --cache-dir="/builddir/.kube/http-cache"
74           Default HTTP cache directory
75
76
77       --certificate-authority=""
78           Path to a cert file for the certificate authority
79
80
81       --client-certificate=""
82           Path to a client certificate file for TLS
83
84
85       --client-key=""
86           Path to a client key file for TLS
87
88
89       --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
90           CIDRs opened in GCE firewall for LB traffic proxy  health checks
91
92
93       --cluster=""
94           The name of the kubeconfig cluster to use
95
96
97       --container-hints="/etc/cadvisor/container_hints.json"
98           location of the container hints file
99
100
101       --containerd="unix:///var/run/containerd.sock"
102           containerd endpoint
103
104
105       --context=""
106           The name of the kubeconfig context to use
107
108
109       --default-not-ready-toleration-seconds=300
110           Indicates   the   tolerationSeconds   of   the    toleration    for
111       notReady:NoExecute  that is added by default to every pod that does not
112       already have such a toleration.
113
114
115       --default-unreachable-toleration-seconds=300
116           Indicates the tolerationSeconds  of  the  toleration  for  unreach‐
117       able:NoExecute  that  is  added  by  default to every pod that does not
118       already have such a toleration.
119
120
121       --docker="unix:///var/run/docker.sock"
122           docker endpoint
123
124
125       --docker-env-metadata-whitelist=""
126           a comma-separated list of environment variable keys that  needs  to
127       be collected for docker containers
128
129
130       --docker-only=false
131           Only report docker containers in addition to root stats
132
133
134       --docker-root="/var/lib/docker"
135           DEPRECATED:  docker  root is read from docker info (this is a fall‐
136       back, default: /var/lib/docker)
137
138
139       --docker-tls=false
140           use TLS to connect to docker
141
142
143       --docker-tls-ca="ca.pem"
144           path to trusted CA
145
146
147       --docker-tls-cert="cert.pem"
148           path to client certificate
149
150
151       --docker-tls-key="key.pem"
152           path to private key
153
154
155       --enable-load-reader=false
156           Whether to enable cpu load reader
157
158
159       --event-storage-age-limit="default=0"
160           Max length of time for which to store events (per type). Value is a
161       comma  separated  list  of  key  values, where the keys are event types
162       (e.g.: creation, oom) or "default" and the value is a duration. Default
163       is applied to all non-specified event types
164
165
166       --event-storage-event-limit="default=0"
167           Max  number  of  events to store (per type). Value is a comma sepa‐
168       rated list of key values, where the keys are event  types  (e.g.:  cre‐
169       ation,  oom)  or  "default"  and  the  value  is an integer. Default is
170       applied to all non-specified event types
171
172
173       --global-housekeeping-interval=1m0s
174           Interval between global housekeepings
175
176
177       --housekeeping-interval=10s
178           Interval between container housekeepings
179
180
181       --insecure-skip-tls-verify=false
182           If true, the server's certificate will not be checked for validity.
183       This will make your HTTPS connections insecure
184
185
186       --kubeconfig=""
187           Path to the kubeconfig file to use for CLI requests.
188
189
190       --log-backtrace-at=:0
191           when logging hits line file:N, emit a stack trace
192
193
194       --log-cadvisor-usage=false
195           Whether to log the usage of the cAdvisor container
196
197
198       --log-dir=""
199           If non-empty, write log files in this directory
200
201
202       --log-file=""
203           If non-empty, use this log file
204
205
206       --log-flush-frequency=5s
207           Maximum number of seconds between log flushes
208
209
210       --logtostderr=true
211           log to standard error instead of files
212
213
214       --machine-id-file="/etc/machine-id,/var/lib/dbus/machine-id"
215           Comma-separated  list  of  files  to  check for machine-id. Use the
216       first one that exists.
217
218
219       --match-server-version=false
220           Require server version to match client version
221
222
223       --mesos-agent="127.0.0.1:5051"
224           Mesos agent address
225
226
227       --mesos-agent-timeout=10s
228           Mesos agent timeout
229
230
231       -n, --namespace=""
232           If present, the namespace scope for this CLI request
233
234
235       --password=""
236           Password for basic authentication to the API server
237
238
239       --profile="none"
240           Name of profile to capture. One of (none|cpu|heap|goroutine|thread‐
241       create|block|mutex)
242
243
244       --profile-output="profile.pprof"
245           Name of the file to write the profile to
246
247
248       --request-timeout="0"
249           The  length  of  time  to  wait before giving up on a single server
250       request. Non-zero values should contain a corresponding time unit (e.g.
251       1s, 2m, 3h). A value of zero means don't timeout requests.
252
253
254       -s, --server=""
255           The address and port of the Kubernetes API server
256
257
258       --skip-headers=false
259           If true, avoid header prefixes in the log messages
260
261
262       --stderrthreshold=2
263           logs at or above this threshold go to stderr
264
265
266       --storage-driver-buffer-duration=1m0s
267           Writes  in  the  storage driver will be buffered for this duration,
268       and committed to the non memory backends as a single transaction
269
270
271       --storage-driver-db="cadvisor"
272           database name
273
274
275       --storage-driver-host="localhost:8086"
276           database host:port
277
278
279       --storage-driver-password="root"
280           database password
281
282
283       --storage-driver-secure=false
284           use secure connection with database
285
286
287       --storage-driver-table="stats"
288           table name
289
290
291       --storage-driver-user="root"
292           database username
293
294
295       --token=""
296           Bearer token for authentication to the API server
297
298
299       --user=""
300           The name of the kubeconfig user to use
301
302
303       --username=""
304           Username for basic authentication to the API server
305
306
307       -v, --v=0
308           log level for V logs
309
310
311       --version=false
312           Print version information and quit
313
314
315       --vmodule=
316           comma-separated list of pattern=N settings for  file-filtered  log‐
317       ging
318
319
320

EXAMPLE

322                # Get the documentation of the resource and its fields
323                kubectl explain pods
324
325                # Get the documentation of a specific field of a resource
326                kubectl explain pods.spec.containers
327
328
329
330

SEE ALSO

332       kubectl(1),
333
334
335

HISTORY

337       January  2015,  Originally compiled by Eric Paris (eparis at redhat dot
338       com) based on the kubernetes source material, but hopefully  they  have
339       been automatically generated since!
340
341
342
343Eric Paris                  kubernetes User Manuals              KUBERNETES(1)
Impressum