mirror of
https://github.com/k3s-io/kubernetes.git
synced 2025-10-30 21:30:16 +00:00
129 lines
4.7 KiB
Markdown
129 lines
4.7 KiB
Markdown
<!-- BEGIN MUNGE: UNVERSIONED_WARNING -->
|
|
|
|
<!-- BEGIN STRIP_FOR_RELEASE -->
|
|
|
|
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
|
|
width="25" height="25">
|
|
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
|
|
width="25" height="25">
|
|
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
|
|
width="25" height="25">
|
|
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
|
|
width="25" height="25">
|
|
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
|
|
width="25" height="25">
|
|
|
|
<h2>PLEASE NOTE: This document applies to the HEAD of the source tree</h2>
|
|
|
|
If you are using a released version of Kubernetes, you should
|
|
refer to the docs that go with that version.
|
|
|
|
<!-- TAG RELEASE_LINK, added by the munger automatically -->
|
|
<strong>
|
|
The latest release of this document can be found
|
|
[here](http://releases.k8s.io/release-1.1/docs/user-guide/kubectl/kubectl_describe.md).
|
|
|
|
Documentation for other releases can be found at
|
|
[releases.k8s.io](http://releases.k8s.io).
|
|
</strong>
|
|
--
|
|
|
|
<!-- END STRIP_FOR_RELEASE -->
|
|
|
|
<!-- END MUNGE: UNVERSIONED_WARNING -->
|
|
|
|
## 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),
|
|
replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits),
|
|
persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota),
|
|
namespaces (ns), serviceaccounts, horizontalpodautoscalers (hpa),
|
|
endpoints (ep) or secrets.
|
|
|
|
```
|
|
kubectl describe (-f FILENAME | TYPE [NAME_PREFIX | -l label] | TYPE/NAME)
|
|
```
|
|
|
|
### Examples
|
|
|
|
```
|
|
# Describe a node
|
|
$ kubectl describe nodes kubernetes-minion-emt8.c.myproject.internal
|
|
|
|
# Describe a pod
|
|
$ kubectl describe pods/nginx
|
|
|
|
# Describe a pod identified by type and name in "pod.json"
|
|
$ kubectl describe -f pod.json
|
|
|
|
# Describe all pods
|
|
$ kubectl describe pods
|
|
|
|
# Describe pods by label name=myLabel
|
|
$ kubectl describe po -l name=myLabel
|
|
|
|
# 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).
|
|
$ kubectl describe pods frontend
|
|
```
|
|
|
|
### Options
|
|
|
|
```
|
|
-f, --filename=[]: Filename, directory, or URL to a file containing the resource to describe
|
|
-l, --selector="": Selector (label query) to filter on
|
|
```
|
|
|
|
### Options inherited from parent commands
|
|
|
|
```
|
|
--alsologtostderr[=false]: log to standard error as well as files
|
|
--api-version="": The API version to use when talking to the server
|
|
--certificate-authority="": Path to a cert. file for the certificate authority.
|
|
--client-certificate="": Path to a client certificate file for TLS.
|
|
--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 8-Dec-2015
|
|
|
|
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
|
|
[]()
|
|
<!-- END MUNGE: GENERATED_ANALYTICS -->
|