github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-09-08 12:41:58 +00:00
Code Issues Projects Releases Wiki Activity

Update kubectl describe help to document prefix matching behavior

Browse Source
This commit is contained in:
Jeff Lowdermilk
2015-07-07 16:57:37 -07:00
parent e29b76d46e
commit 229cbd472d
4 changed files with 52 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/kubectl_describe.md
View File

@@ -1,17 +1,22 @@
## kubectl describe
Show details of a specific resource
Show details of a specific resource or group of resources
### Synopsis
Show details of a specific resource.
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.
given resource or group of resources.
$ kubectl describe RESOURCE NAME_PREFIX
will first check for an exact match on RESOURCE and NAME_PREFIX. If no such resource
exists, it will output details for every resource that has a name prefixed with NAME_PREFIX
```
kubectl describe (RESOURCE NAME | RESOURCE/NAME)
kubectl describe (RESOURCE NAME_PREFIX | RESOURCE/NAME)
```
### Examples
@@ -25,6 +30,10 @@ $ kubectl describe pods/nginx
// 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
@@ -66,6 +75,6 @@ $ kubectl describe po -l name=myLabel
### SEE ALSO
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
###### Auto generated by spf13/cobra at 2015-06-12 06:44:05.105790085 +0000 UTC
###### Auto generated by spf13/cobra at 2015-07-07 23:45:47.075376625 +0000 UTC
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/kubectl_describe.md?pixel)]()