mirror of
https://github.com/k3s-io/kubernetes.git
synced 2025-09-04 18:52:38 +00:00
Add examples for kubectl describe, and make gendocs less spammy
Makes hack/{run/verify}-gendocs.sh ignore generated-timestamp-only changes so minor changes to kubectl don't have to touch the entire set of md docs.
This commit is contained in:
@@ -11,7 +11,17 @@ This command joins many API calls together to form a detailed description of a
|
||||
given resource.
|
||||
|
||||
```
|
||||
kubectl describe RESOURCE ID
|
||||
kubectl describe (RESOURCE NAME | RESOURCE/NAME)
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
// Describe a node
|
||||
$ kubectl describe nodes kubernetes-minion-emt8.c.myproject.internal
|
||||
|
||||
// Describe a pod
|
||||
$ kubectl describe pods/nginx
|
||||
```
|
||||
|
||||
### Options
|
||||
@@ -53,4 +63,4 @@ kubectl describe RESOURCE ID
|
||||
### SEE ALSO
|
||||
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
|
||||
|
||||
###### Auto generated by spf13/cobra at 2015-04-23 00:47:55.40003297 +0000 UTC
|
||||
###### Auto generated by spf13/cobra at 2015-04-23 21:21:05.485819349 +0000 UTC
|
||||
|
@@ -128,6 +128,21 @@ given resource.
|
||||
comma\-separated list of pattern=N settings for file\-filtered logging
|
||||
|
||||
|
||||
.SH EXAMPLE
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
// Describe a node
|
||||
$ kubectl describe nodes kubernetes\-minion\-emt8.c.myproject.internal
|
||||
|
||||
// Describe a pod
|
||||
$ kubectl describe pods/nginx
|
||||
|
||||
.fi
|
||||
.RE
|
||||
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBkubectl(1)\fP,
|
||||
|
Reference in New Issue
Block a user