1KUBERNETES(1) Jan 2015 KUBERNETES(1)
2
6 kubectl describe - Show details of a specific resource or group of
7 resources
8
12 kubectl describe [OPTIONS]
13
17 Show details of a specific resource or group of resources
18 Print a detailed description of the selected resources, including
21 related resources such as events or controllers. You may select a sin‐
22 gle object by name, all objects of that type, provide a name prefix, or
23 label selector. For example:
24 $ kubectl describe TYPE NAME_PREFIX
27 will first check for an exact match on TYPE and NAME PREFIX. If no such
30 resource exists, it will output details for every resource that has a
31 name prefixed with NAME PREFIX.
32 Use "kubectl api-resources" for a complete list of supported resources.
35
39 --all-namespaces=false
40 If present, list the requested object(s) across all namespaces.
41 Namespace in current context is ignored even if specified with --names‐
42 pace.
43 -f, --filename=[]
46 Filename, directory, or URL to files containing the resource to
47 describe
48 --include-uninitialized=false
51 If true, the kubectl command applies to uninitialized objects. If
52 explicitly set to false, this flag overrides other flags that make the
53 kubectl commands apply to uninitialized objects, e.g., "--all". Objects
54 with empty metadata.initializers are regarded as initialized.
55 -R, --recursive=false
58 Process the directory used in -f, --filename recursively. Useful
59 when you want to manage related manifests organized within the same
60 directory.
61 -l, --selector=""
64 Selector (label query) to filter on, supports '=', '==', and
65 '!='.(e.g. -l key1=value1,key2=value2)
66 --show-events=true
69 If true, display events related to the described object.
70
74 --alsologtostderr=false
75 log to standard error as well as files
76 --application-metrics-count-limit=100
79 Max number of application metrics to store (per container)
80 --as=""
83 Username to impersonate for the operation
84 --as-group=[]
87 Group to impersonate for the operation, this flag can be repeated
88 to specify multiple groups.
89 --azure-container-registry-config=""
92 Path to the file containing Azure container registry configuration
93 information.
94 --boot-id-file="/proc/sys/kernel/random/boot_id"
97 Comma-separated list of files to check for boot-id. Use the first
98 one that exists.
99 --cache-dir="/builddir/.kube/http-cache"
102 Default HTTP cache directory
103 --certificate-authority=""
106 Path to a cert file for the certificate authority
107 --client-certificate=""
110 Path to a client certificate file for TLS
111 --client-key=""
114 Path to a client key file for TLS
115 --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
118 CIDRs opened in GCE firewall for LB traffic proxy health checks
119 --cluster=""
122 The name of the kubeconfig cluster to use
123 --container-hints="/etc/cadvisor/container_hints.json"
126 location of the container hints file
127 --containerd="unix:///var/run/containerd.sock"
130 containerd endpoint
131 --context=""
134 The name of the kubeconfig context to use
135 --default-not-ready-toleration-seconds=300
138 Indicates the tolerationSeconds of the toleration for
139 notReady:NoExecute that is added by default to every pod that does not
140 already have such a toleration.
141 --default-unreachable-toleration-seconds=300
144 Indicates the tolerationSeconds of the toleration for unreach‐
145 able:NoExecute that is added by default to every pod that does not
146 already have such a toleration.
147 --docker="unix:///var/run/docker.sock"
150 docker endpoint
151 --docker-env-metadata-whitelist=""
154 a comma-separated list of environment variable keys that needs to
155 be collected for docker containers
156 --docker-only=false
159 Only report docker containers in addition to root stats
160 --docker-root="/var/lib/docker"
163 DEPRECATED: docker root is read from docker info (this is a fall‐
164 back, default: /var/lib/docker)
165 --docker-tls=false
168 use TLS to connect to docker
169 --docker-tls-ca="ca.pem"
172 path to trusted CA
173 --docker-tls-cert="cert.pem"
176 path to client certificate
177 --docker-tls-key="key.pem"
180 path to private key
181 --enable-load-reader=false
184 Whether to enable cpu load reader
185 --event-storage-age-limit="default=0"
188 Max length of time for which to store events (per type). Value is a
189 comma separated list of key values, where the keys are event types
190 (e.g.: creation, oom) or "default" and the value is a duration. Default
191 is applied to all non-specified event types
192 --event-storage-event-limit="default=0"
195 Max number of events to store (per type). Value is a comma sepa‐
196 rated list of key values, where the keys are event types (e.g.: cre‐
197 ation, oom) or "default" and the value is an integer. Default is
198 applied to all non-specified event types
199 --global-housekeeping-interval=1m0s
202 Interval between global housekeepings
203 --housekeeping-interval=10s
206 Interval between container housekeepings
207 --insecure-skip-tls-verify=false
210 If true, the server's certificate will not be checked for validity.
211 This will make your HTTPS connections insecure
212 --kubeconfig=""
215 Path to the kubeconfig file to use for CLI requests.
216 --log-backtrace-at=:0
219 when logging hits line file:N, emit a stack trace
220 --log-cadvisor-usage=false
223 Whether to log the usage of the cAdvisor container
224 --log-dir=""
227 If non-empty, write log files in this directory
228 --log-file=""
231 If non-empty, use this log file
232 --log-flush-frequency=5s
235 Maximum number of seconds between log flushes
236 --logtostderr=true
239 log to standard error instead of files
240 --machine-id-file="/etc/machine-id,/var/lib/dbus/machine-id"
243 Comma-separated list of files to check for machine-id. Use the
244 first one that exists.
245 --match-server-version=false
248 Require server version to match client version
249 --mesos-agent="127.0.0.1:5051"
252 Mesos agent address
253 --mesos-agent-timeout=10s
256 Mesos agent timeout
257 -n, --namespace=""
260 If present, the namespace scope for this CLI request
261 --password=""
264 Password for basic authentication to the API server
265 --profile="none"
268 Name of profile to capture. One of (none|cpu|heap|goroutine|thread‐
269 create|block|mutex)
270 --profile-output="profile.pprof"
273 Name of the file to write the profile to
274 --request-timeout="0"
277 The length of time to wait before giving up on a single server
278 request. Non-zero values should contain a corresponding time unit (e.g.
279 1s, 2m, 3h). A value of zero means don't timeout requests.
280 -s, --server=""
283 The address and port of the Kubernetes API server
284 --skip-headers=false
287 If true, avoid header prefixes in the log messages
288 --stderrthreshold=2
291 logs at or above this threshold go to stderr
292 --storage-driver-buffer-duration=1m0s
295 Writes in the storage driver will be buffered for this duration,
296 and committed to the non memory backends as a single transaction
297 --storage-driver-db="cadvisor"
300 database name
301 --storage-driver-host="localhost:8086"
304 database host:port
305 --storage-driver-password="root"
308 database password
309 --storage-driver-secure=false
312 use secure connection with database
313 --storage-driver-table="stats"
316 table name
317 --storage-driver-user="root"
320 database username
321 --token=""
324 Bearer token for authentication to the API server
325 --user=""
328 The name of the kubeconfig user to use
329 --username=""
332 Username for basic authentication to the API server
333 -v, --v=0
336 log level for V logs
337 --version=false
340 Print version information and quit
341 --vmodule=
344 comma-separated list of pattern=N settings for file-filtered log‐
345 ging
346
350 # Describe a node
351 kubectl describe nodes kubernetes-node-emt8.c.myproject.internal
352 # Describe a pod
354 kubectl describe pods/nginx
355 # Describe a pod identified by type and name in "pod.json"
357 kubectl describe -f pod.json
358 # Describe all pods
360 kubectl describe pods
361 # Describe pods by label name=myLabel
363 kubectl describe po -l name=myLabel
364 # Describe all pods managed by the 'frontend' replication controller (rc-created pods
366 # get the name of the rc as a prefix in the pod the name).
367 kubectl describe pods frontend
368
373 kubectl(1),
374
378 January 2015, Originally compiled by Eric Paris (eparis at redhat dot
379 com) based on the kubernetes source material, but hopefully they have
380 been automatically generated since!
381Eric Paris kubernetes User Manuals KUBERNETES(1)