1KUBERNETES(1)(kubernetes) KUBERNETES(1)(kubernetes)
2Eric Paris Jan 2015
6
9 kubectl describe - Show details of a specific resource or group of re‐
10 sources
11
15 kubectl describe [OPTIONS]
16
20 Show details of a specific resource or group of resources.
21 Print a detailed description of the selected resources, including re‐
24 lated resources such as events or controllers. You may select a single
25 object by name, all objects of that type, provide a name prefix, or la‐
26 bel selector. For example:
27 $ kubectl describe TYPE NAME_PREFIX
30 will first check for an exact match on TYPE and NAME_PREFIX. If no such
33 resource exists, it will output details for every resource that has a
34 name prefixed with NAME_PREFIX.
35 Use "kubectl api-resources" for a complete list of supported resources.
38
42 -A, --all-namespaces=false If present, list the requested ob‐
43 ject(s) across all namespaces. Namespace in current context is ignored
44 even if specified with --namespace.
45 --chunk-size=500 Return large lists in chunks rather than all at
48 once. Pass 0 to disable. This flag is beta and may change in the fu‐
49 ture.
50 -f, --filename=[] Filename, directory, or URL to files containing
53 the resource to describe
54 -k, --kustomize="" Process the kustomization directory. This flag
57 can't be used together with -f or -R.
58 -R, --recursive=false Process the directory used in -f, --filename
61 recursively. Useful when you want to manage related manifests organized
62 within the same directory.
63 -l, --selector="" Selector (label query) to filter on, supports
66 '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). Matching objects
67 must satisfy all of the specified label constraints.
68 --show-events=true If true, display events related to the de‐
71 scribed object.
72
76 --as="" Username to impersonate for the operation. User could be a
77 regular user or a service account in a namespace.
78 --as-group=[] Group to impersonate for the operation, this flag
81 can be repeated to specify multiple groups.
82 --as-uid="" UID to impersonate for the operation.
85 --azure-container-registry-config="" Path to the file containing
88 Azure container registry configuration information.
89 --cache-dir="/builddir/.kube/cache" Default cache directory
92 --certificate-authority="" Path to a cert file for the certificate
95 authority
96 --client-certificate="" Path to a client certificate file for TLS
99 --client-key="" Path to a client key file for TLS
102 --cluster="" The name of the kubeconfig cluster to use
105 --context="" The name of the kubeconfig context to use
108 --insecure-skip-tls-verify=false If true, the server's certificate
111 will not be checked for validity. This will make your HTTPS connections
112 insecure
113 --kubeconfig="" Path to the kubeconfig file to use for CLI re‐
116 quests.
117 --match-server-version=false Require server version to match
120 client version
121 -n, --namespace="" If present, the namespace scope for this CLI
124 request
125 --password="" Password for basic authentication to the API server
128 --profile="none" Name of profile to capture. One of
131 (none|cpu|heap|goroutine|threadcreate|block|mutex)
132 --profile-output="profile.pprof" Name of the file to write the
135 profile to
136 --request-timeout="0" The length of time to wait before giving up
139 on a single server request. Non-zero values should contain a corre‐
140 sponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't time‐
141 out requests.
142 -s, --server="" The address and port of the Kubernetes API server
145 --tls-server-name="" Server name to use for server certificate
148 validation. If it is not provided, the hostname used to contact the
149 server is used
150 --token="" Bearer token for authentication to the API server
153 --user="" The name of the kubeconfig user to use
156 --username="" Username for basic authentication to the API server
159 --version=false Print version information and quit
162 --warnings-as-errors=false Treat warnings received from the server
165 as errors and exit with a non-zero exit code
166
170 # Describe a node
171 kubectl describe nodes kubernetes-node-emt8.c.myproject.internal
172 # Describe a pod
174 kubectl describe pods/nginx
175 # Describe a pod identified by type and name in "pod.json"
177 kubectl describe -f pod.json
178 # Describe all pods
180 kubectl describe pods
181 # Describe pods by label name=myLabel
183 kubectl describe po -l name=myLabel
184 # Describe all pods managed by the 'frontend' replication controller
186 # (rc-created pods get the name of the rc as a prefix in the pod name)
187 kubectl describe pods frontend
188
193 kubectl(1),
194
198 January 2015, Originally compiled by Eric Paris (eparis at redhat dot
199 com) based on the kubernetes source material, but hopefully they have
200 been automatically generated since!
201Manuals User KUBERNETES(1)(kubernetes)