github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-09-12 20:57:20 +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

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

@@ -3,7 +3,7 @@
.SH NAME
.PP
kubectl describe \- Show details of a specific resource
kubectl describe \- Show details of a specific resource or group of resources
.SH SYNOPSIS
@@ -13,11 +13,18 @@ kubectl describe \- Show details of a specific resource
.SH DESCRIPTION
.PP
Show details of a specific resource.
Show details of a specific resource or group of resources.
.PP
This command joins many API calls together to form a detailed description of a
given resource.
given resource or group of resources.
.PP
$ kubectl describe RESOURCE NAME\_PREFIX
.PP
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
.SH OPTIONS
@@ -142,6 +149,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
.fi
.RE