github/kubernetes
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add a better help message for kubectl describe

Browse Source 
When resource type isn't given in the command, print the possible
resource types. Also added the resource type description in help
strings.
This commit is contained in:
hurf
2015-07-07 11:14:28 +08:00
parent c6161824db
commit 6dd8a1dfa4
5 changed files with 39 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/man/man1/kubectl-describe.1
View File

@@ -26,6 +26,12 @@ $ 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
.PP
Possible resources include pods (po), replicationcontrollers (rc), services
(svc), nodes (no), events (ev), componentstatuses (cs), limitRanges (limits),
persistentVolumes (pv), persistentVolumeClaims (pvc), resourceQuotas (quota)
or secrets.
.SH OPTIONS
.PP

7
docs/user-guide/kubectl/kubectl_describe.md
View File

@@ -29,6 +29,11 @@ $ 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
Possible resources include pods (po), replicationcontrollers (rc), services
(svc), nodes (no), events (ev), componentstatuses (cs), limitRanges (limits),
persistentVolumes (pv), persistentVolumeClaims (pvc), resourceQuotas (quota)
or secrets.
```
kubectl describe (RESOURCE NAME_PREFIX | RESOURCE/NAME)
```
@@ -89,7 +94,7 @@ $ kubectl describe pods frontend
### SEE ALSO
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
###### Auto generated by spf13/cobra at 2015-07-14 00:11:42.955631296 +0000 UTC
###### Auto generated by spf13/cobra at 2015-07-14 08:21:33.374469932 +0000 UTC
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->