website/docs/user-guide/kubectl/kubectl_describe.md

105 lines
4.1 KiB
Markdown
Raw Normal View History

2016-03-18 00:08:15 +00:00
---
---
2016-02-26 12:31:34 +00:00
## kubectl describe
Show details of a specific resource or group of resources
### Synopsis
Show details of a specific resource or group of resources.
This command joins many API calls together to form a detailed description of a
given resource or group of resources.
$ kubectl describe TYPE NAME_PREFIX
will first check for an exact match on TYPE and NAME_PREFIX. If no such resource
exists, it will output details for every resource that has a name prefixed with NAME_PREFIX
Possible resource types include (case insensitive): pods (po), services (svc), deployments,
replicasets (rs), replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits),
persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota), namespaces (ns),
serviceaccounts (sa), ingresses (ing), horizontalpodautoscalers (hpa), daemonsets (ds), configmaps,
componentstatuses (cs), endpoints (ep), and secrets.
2016-02-26 12:31:34 +00:00
```
kubectl describe (-f FILENAME | TYPE [NAME_PREFIX | -l label] | TYPE/NAME)
```
### Examples
```
# Describe a node
2016-03-07 16:51:25 +00:00
kubectl describe nodes kubernetes-minion-emt8.c.myproject.internal
2016-02-26 12:31:34 +00:00
# Describe a pod
2016-03-07 16:51:25 +00:00
kubectl describe pods/nginx
2016-02-26 12:31:34 +00:00
# Describe a pod identified by type and name in "pod.json"
2016-03-07 16:51:25 +00:00
kubectl describe -f pod.json
2016-02-26 12:31:34 +00:00
# Describe all pods
2016-03-07 16:51:25 +00:00
kubectl describe pods
2016-02-26 12:31:34 +00:00
# Describe pods by label name=myLabel
2016-03-07 16:51:25 +00:00
kubectl describe po -l name=myLabel
2016-02-26 12:31:34 +00:00
# Describe all pods managed by the 'frontend' replication controller (rc-created pods
# get the name of the rc as a prefix in the pod the name).
2016-03-07 16:51:25 +00:00
kubectl describe pods frontend
2016-02-26 12:31:34 +00:00
```
### Options
```
-f, --filename=[]: Filename, directory, or URL to a file containing the resource to describe
--include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true]
-R, --recursive[=false]: Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
2016-02-26 12:31:34 +00:00
-l, --selector="": Selector (label query) to filter on
--show-events[=true]: If true, display events related to the described object.
2016-02-26 12:31:34 +00:00
```
### Options inherited from parent commands
```
--alsologtostderr[=false]: log to standard error as well as files
--as="": Username to impersonate for the operation.
2016-02-26 12:31:34 +00:00
--certificate-authority="": Path to a cert. file for the certificate authority.
2016-03-07 16:51:25 +00:00
--client-certificate="": Path to a client certificate file for TLS.
2016-02-26 12:31:34 +00:00
--client-key="": Path to a client key file for TLS.
--cluster="": The name of the kubeconfig cluster to use
--context="": The name of the kubeconfig context to use
--insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
--kubeconfig="": Path to the kubeconfig file to use for CLI requests.
--log-backtrace-at=:0: when logging hits line file:N, emit a stack trace
--log-dir="": If non-empty, write log files in this directory
--log-flush-frequency=5s: Maximum number of seconds between log flushes
--logtostderr[=true]: log to standard error instead of files
--match-server-version[=false]: Require server version to match client version
--namespace="": If present, the namespace scope for this CLI request.
--password="": Password for basic authentication to the API server.
-s, --server="": The address and port of the Kubernetes API server
--stderrthreshold=2: logs at or above this threshold go to stderr
--token="": Bearer token for authentication to the API server.
--user="": The name of the kubeconfig user to use
--username="": Username for basic authentication to the API server.
--v=0: log level for V logs
--vmodule=: comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
###### Auto generated by spf13/cobra on 12-Aug-2016
2016-02-26 12:31:34 +00:00
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_describe.md?pixel)]()
<!-- END MUNGE: GENERATED_ANALYTICS -->