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 --alsologtostderr=false
47 log to standard error as well as files
48 --application-metrics-count-limit=100
51 Max number of application metrics to store (per container)
52 --as=""
55 Username to impersonate for the operation
56 --as-group=[]
59 Group to impersonate for the operation, this flag can be repeated
60 to specify multiple groups.
61 --azure-container-registry-config=""
64 Path to the file containing Azure container registry configuration
65 information.
66 --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 --cache-dir="/builddir/.kube/http-cache"
74 Default HTTP cache directory
75 --certificate-authority=""
78 Path to a cert file for the certificate authority
79 --client-certificate=""
82 Path to a client certificate file for TLS
83 --client-key=""
86 Path to a client key file for TLS
87 --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 --cluster=""
94 The name of the kubeconfig cluster to use
95 --container-hints="/etc/cadvisor/container_hints.json"
98 location of the container hints file
99 --containerd="/run/containerd/containerd.sock"
102 containerd endpoint
103 --containerd-namespace="k8s.io"
106 containerd namespace
107 --context=""
110 The name of the kubeconfig context to use
111 --default-not-ready-toleration-seconds=300
114 Indicates the tolerationSeconds of the toleration for
115 notReady:NoExecute that is added by default to every pod that does not
116 already have such a toleration.
117 --default-unreachable-toleration-seconds=300
120 Indicates the tolerationSeconds of the toleration for unreach‐
121 able:NoExecute that is added by default to every pod that does not
122 already have such a toleration.
123 --docker="unix:///var/run/docker.sock"
126 docker endpoint
127 --docker-env-metadata-whitelist=""
130 a comma-separated list of environment variable keys that needs to
131 be collected for docker containers
132 --docker-only=false
135 Only report docker containers in addition to root stats
136 --docker-root="/var/lib/docker"
139 DEPRECATED: docker root is read from docker info (this is a fall‐
140 back, default: /var/lib/docker)
141 --docker-tls=false
144 use TLS to connect to docker
145 --docker-tls-ca="ca.pem"
148 path to trusted CA
149 --docker-tls-cert="cert.pem"
152 path to client certificate
153 --docker-tls-key="key.pem"
156 path to private key
157 --enable-load-reader=false
160 Whether to enable cpu load reader
161 --event-storage-age-limit="default=0"
164 Max length of time for which to store events (per type). Value is a
165 comma separated list of key values, where the keys are event types
166 (e.g.: creation, oom) or "default" and the value is a duration. Default
167 is applied to all non-specified event types
168 --event-storage-event-limit="default=0"
171 Max number of events to store (per type). Value is a comma sepa‐
172 rated list of key values, where the keys are event types (e.g.: cre‐
173 ation, oom) or "default" and the value is an integer. Default is
174 applied to all non-specified event types
175 --global-housekeeping-interval=1m0s
178 Interval between global housekeepings
179 --housekeeping-interval=10s
182 Interval between container housekeepings
183 --insecure-skip-tls-verify=false
186 If true, the server's certificate will not be checked for validity.
187 This will make your HTTPS connections insecure
188 --kubeconfig=""
191 Path to the kubeconfig file to use for CLI requests.
192 --log-backtrace-at=:0
195 when logging hits line file:N, emit a stack trace
196 --log-cadvisor-usage=false
199 Whether to log the usage of the cAdvisor container
200 --log-dir=""
203 If non-empty, write log files in this directory
204 --log-file=""
207 If non-empty, use this log file
208 --log-file-max-size=1800
211 Defines the maximum size a log file can grow to. Unit is megabytes.
212 If the value is 0, the maximum file size is unlimited.
213 --log-flush-frequency=5s
216 Maximum number of seconds between log flushes
217 --logtostderr=true
220 log to standard error instead of files
221 --machine-id-file="/etc/machine-id,/var/lib/dbus/machine-id"
224 Comma-separated list of files to check for machine-id. Use the
225 first one that exists.
226 --match-server-version=false
229 Require server version to match client version
230 -n, --namespace=""
233 If present, the namespace scope for this CLI request
234 --password=""
237 Password for basic authentication to the API server
238 --profile="none"
241 Name of profile to capture. One of (none|cpu|heap|goroutine|thread‐
242 create|block|mutex)
243 --profile-output="profile.pprof"
246 Name of the file to write the profile to
247 --request-timeout="0"
250 The length of time to wait before giving up on a single server
251 request. Non-zero values should contain a corresponding time unit (e.g.
252 1s, 2m, 3h). A value of zero means don't timeout requests.
253 -s, --server=""
256 The address and port of the Kubernetes API server
257 --skip-headers=false
260 If true, avoid header prefixes in the log messages
261 --skip-log-headers=false
264 If true, avoid headers when opening log files
265 --stderrthreshold=2
268 logs at or above this threshold go to stderr
269 --storage-driver-buffer-duration=1m0s
272 Writes in the storage driver will be buffered for this duration,
273 and committed to the non memory backends as a single transaction
274 --storage-driver-db="cadvisor"
277 database name
278 --storage-driver-host="localhost:8086"
281 database host:port
282 --storage-driver-password="root"
285 database password
286 --storage-driver-secure=false
289 use secure connection with database
290 --storage-driver-table="stats"
293 table name
294 --storage-driver-user="root"
297 database username
298 --token=""
301 Bearer token for authentication to the API server
302 --update-machine-info-interval=5m0s
305 Interval between machine info updates.
306 --user=""
309 The name of the kubeconfig user to use
310 --username=""
313 Username for basic authentication to the API server
314 -v, --v=0
317 number for the log level verbosity
318 --version=false
321 Print version information and quit
322 --vmodule=
325 comma-separated list of pattern=N settings for file-filtered log‐
326 ging
327
331 # Get the documentation of the resource and its fields
332 kubectl explain pods
333 # Get the documentation of a specific field of a resource
335 kubectl explain pods.spec.containers
336
341 kubectl(1),
342
346 January 2015, Originally compiled by Eric Paris (eparis at redhat dot
347 com) based on the kubernetes source material, but hopefully they have
348 been automatically generated since!
349Eric Paris kubernetes User Manuals KUBERNETES(1)