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 --allow-verification-with-non-compliant-keys=false
75 Allow a SignatureVerifier to use keys which are technically
76 non-compliant with RFC6962.
77 --alsologtostderr=false
80 log to standard error as well as files
81 --application-metrics-count-limit=100
84 Max number of application metrics to store (per container)
85 --as=""
88 Username to impersonate for the operation
89 --as-group=[]
92 Group to impersonate for the operation, this flag can be repeated
93 to specify multiple groups.
94 --azure-container-registry-config=""
97 Path to the file containing Azure container registry configuration
98 information.
99 --boot-id-file="/proc/sys/kernel/random/boot_id"
102 Comma-separated list of files to check for boot-id. Use the first
103 one that exists.
104 --cache-dir="/builddir/.kube/http-cache"
107 Default HTTP cache directory
108 --certificate-authority=""
111 Path to a cert file for the certificate authority
112 --client-certificate=""
115 Path to a client certificate file for TLS
116 --client-key=""
119 Path to a client key file for TLS
120 --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
123 CIDRs opened in GCE firewall for LB traffic proxy health checks
124 --cluster=""
127 The name of the kubeconfig cluster to use
128 --container-hints="/etc/cadvisor/container_hints.json"
131 location of the container hints file
132 --containerd="unix:///var/run/containerd.sock"
135 containerd endpoint
136 --context=""
139 The name of the kubeconfig context to use
140 --default-not-ready-toleration-seconds=300
143 Indicates the tolerationSeconds of the toleration for
144 notReady:NoExecute that is added by default to every pod that does not
145 already have such a toleration.
146 --default-unreachable-toleration-seconds=300
149 Indicates the tolerationSeconds of the toleration for unreach‐
150 able:NoExecute that is added by default to every pod that does not
151 already have such a toleration.
152 --docker="unix:///var/run/docker.sock"
155 docker endpoint
156 --docker-env-metadata-whitelist=""
159 a comma-separated list of environment variable keys that needs to
160 be collected for docker containers
161 --docker-only=false
164 Only report docker containers in addition to root stats
165 --docker-root="/var/lib/docker"
168 DEPRECATED: docker root is read from docker info (this is a fall‐
169 back, default: /var/lib/docker)
170 --docker-tls=false
173 use TLS to connect to docker
174 --docker-tls-ca="ca.pem"
177 path to trusted CA
178 --docker-tls-cert="cert.pem"
181 path to client certificate
182 --docker-tls-key="key.pem"
185 path to private key
186 --enable-load-reader=false
189 Whether to enable cpu load reader
190 --event-storage-age-limit="default=0"
193 Max length of time for which to store events (per type). Value is a
194 comma separated list of key values, where the keys are event types
195 (e.g.: creation, oom) or "default" and the value is a duration. Default
196 is applied to all non-specified event types
197 --event-storage-event-limit="default=0"
200 Max number of events to store (per type). Value is a comma sepa‐
201 rated list of key values, where the keys are event types (e.g.: cre‐
202 ation, oom) or "default" and the value is an integer. Default is
203 applied to all non-specified event types
204 --global-housekeeping-interval=1m0s
207 Interval between global housekeepings
208 --google-json-key=""
211 The Google Cloud Platform Service Account JSON Key to use for
212 authentication.
213 --housekeeping-interval=10s
216 Interval between container housekeepings
217 --insecure-skip-tls-verify=false
220 If true, the server's certificate will not be checked for validity.
221 This will make your HTTPS connections insecure
222 --kubeconfig=""
225 Path to the kubeconfig file to use for CLI requests.
226 --log-backtrace-at=:0
229 when logging hits line file:N, emit a stack trace
230 --log-cadvisor-usage=false
233 Whether to log the usage of the cAdvisor container
234 --log-dir=""
237 If non-empty, write log files in this directory
238 --log-flush-frequency=5s
241 Maximum number of seconds between log flushes
242 --logtostderr=true
245 log to standard error instead of files
246 --machine-id-file="/etc/machine-id,/var/lib/dbus/machine-id"
249 Comma-separated list of files to check for machine-id. Use the
250 first one that exists.
251 --match-server-version=false
254 Require server version to match client version
255 --mesos-agent="127.0.0.1:5051"
258 Mesos agent address
259 --mesos-agent-timeout=10s
262 Mesos agent timeout
263 -n, --namespace=""
266 If present, the namespace scope for this CLI request
267 --request-timeout="0"
270 The length of time to wait before giving up on a single server
271 request. Non-zero values should contain a corresponding time unit (e.g.
272 1s, 2m, 3h). A value of zero means don't timeout requests.
273 -s, --server=""
276 The address and port of the Kubernetes API server
277 --stderrthreshold=2
280 logs at or above this threshold go to stderr
281 --storage-driver-buffer-duration=1m0s
284 Writes in the storage driver will be buffered for this duration,
285 and committed to the non memory backends as a single transaction
286 --storage-driver-db="cadvisor"
289 database name
290 --storage-driver-host="localhost:8086"
293 database host:port
294 --storage-driver-password="root"
297 database password
298 --storage-driver-secure=false
301 use secure connection with database
302 --storage-driver-table="stats"
305 table name
306 --storage-driver-user="root"
309 database username
310 --token=""
313 Bearer token for authentication to the API server
314 --user=""
317 The name of the kubeconfig user to use
318 -v, --v=0
321 log level for V logs
322 --version=false
325 Print version information and quit
326 --vmodule=
329 comma-separated list of pattern=N settings for file-filtered log‐
330 ging
331
335 # Describe a node
336 kubectl describe nodes kubernetes-node-emt8.c.myproject.internal
337 # Describe a pod
339 kubectl describe pods/nginx
340 # Describe a pod identified by type and name in "pod.json"
342 kubectl describe -f pod.json
343 # Describe all pods
345 kubectl describe pods
346 # Describe pods by label name=myLabel
348 kubectl describe po -l name=myLabel
349 # Describe all pods managed by the 'frontend' replication controller (rc-created pods
351 # get the name of the rc as a prefix in the pod the name).
352 kubectl describe pods frontend
353
358 kubectl(1),
359
363 January 2015, Originally compiled by Eric Paris (eparis at redhat dot
364 com) based on the kubernetes source material, but hopefully they have
365 been automatically generated since!
366Eric Paris kubernetes User Manuals KUBERNETES(1)