github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-31 23:37:01 +00:00
Code Issues Projects Releases Wiki Activity

Better help message for get and describe

Browse Source 
Add tips for shortcut ns and ep.
This commit is contained in:
hurf 2015-07-30 16:43:42 +08:00
parent 41de62b465
commit 029ed15be5
7 changed files with 23 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -28,9 +28,9 @@ exists, it will output details for every resource that has a name prefixed with
.PP .PP
Possible resources include (case insensitive): pods (po), services (svc), Possible resources include (case insensitive): pods (po), services (svc),
replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs), replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits),
limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc), persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota),
resourcequotas (quota) or secrets. namespaces (ns) or secrets.
.SH OPTIONS .SH OPTIONS

2
docs/man/man1/kubectl-get.1
View File

@ -19,7 +19,7 @@ Display one or many resources.
Possible resources include (case insensitive): pods (po), services (svc), Possible resources include (case insensitive): pods (po), services (svc),
replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs), replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs),
limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc), limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc),
resourcequotas (quota) or secrets. resourcequotas (quota), namespaces (ns), endpoints (ep) or secrets.
.PP .PP
By specifying the output as 'template' and providing a Go template as the value By specifying the output as 'template' and providing a Go template as the value

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

@ -49,9 +49,9 @@ will first check for an exact match on RESOURCE and NAME_PREFIX. If no such reso
exists, it will output details for every resource that has a name prefixed with NAME_PREFIX exists, it will output details for every resource that has a name prefixed with NAME_PREFIX
Possible resources include (case insensitive): pods (po), services (svc), Possible resources include (case insensitive): pods (po), services (svc),
replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs), replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits),
limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc), persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota),
resourcequotas (quota) or secrets. namespaces (ns) or secrets.
``` ```
kubectl describe (RESOURCE NAME_PREFIX | RESOURCE/NAME) kubectl describe (RESOURCE NAME_PREFIX | RESOURCE/NAME)
@ -114,7 +114,7 @@ $ kubectl describe pods frontend
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager * [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
###### Auto generated by spf13/cobra at 2015-07-15 01:43:24.778753787 +0000 UTC ###### Auto generated by spf13/cobra at 2015-07-31 07:12:36.111698336 +0000 UTC
<!-- BEGIN MUNGE: GENERATED_ANALYTICS --> <!-- BEGIN MUNGE: GENERATED_ANALYTICS -->

4
docs/user-guide/kubectl/kubectl_get.md
View File

@ -43,7 +43,7 @@ Display one or many resources.
Possible resources include (case insensitive): pods (po), services (svc), Possible resources include (case insensitive): pods (po), services (svc),
replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs), replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs),
limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc), limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc),
resourcequotas (quota) or secrets. resourcequotas (quota), namespaces (ns), endpoints (ep) or secrets.
By specifying the output as 'template' and providing a Go template as the value By specifying the output as 'template' and providing a Go template as the value
of the --template flag, you can filter the attributes of the fetched resource(s). of the --template flag, you can filter the attributes of the fetched resource(s).
@ -125,7 +125,7 @@ $ kubectl get rc/web service/frontend pods/web-pod-13je7
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager * [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
###### Auto generated by spf13/cobra at 2015-07-15 01:43:24.778535128 +0000 UTC ###### Auto generated by spf13/cobra at 2015-07-30 08:43:29.371131796 +0000 UTC
<!-- BEGIN MUNGE: GENERATED_ANALYTICS --> <!-- BEGIN MUNGE: GENERATED_ANALYTICS -->

11
pkg/kubectl/cmd/cmd.go
View File

@ -95,13 +95,14 @@ __custom_func() {
* pods (aka 'po') * pods (aka 'po')
* replicationcontrollers (aka 'rc') * replicationcontrollers (aka 'rc')
* services (aka 'svc') * services (aka 'svc')
* nodes (aka 'no')
* events (aka 'ev') * events (aka 'ev')
* nodes (aka 'no')
* namespaces (aka 'ns')
* secrets * secrets
* limits * persistentvolumes (aka 'pv')
* persistentVolumes (aka 'pv') * persistentvolumeclaims (aka 'pvc')
* persistentVolumeClaims (aka 'pvc') * limitranges (aka 'limits')
* quota * resourcequotas (aka 'quota')
` `
) )

6
pkg/kubectl/cmd/describe.go
View File

@ -43,9 +43,9 @@ will first check for an exact match on RESOURCE and NAME_PREFIX. If no such reso
exists, it will output details for every resource that has a name prefixed with NAME_PREFIX exists, it will output details for every resource that has a name prefixed with NAME_PREFIX
Possible resources include (case insensitive): pods (po), services (svc), Possible resources include (case insensitive): pods (po), services (svc),
replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs), replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits),
limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc), persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota),
resourcequotas (quota) or secrets.` namespaces (ns) or secrets.`
describe_example = `// Describe a node describe_example = `// Describe a node
$ kubectl describe nodes kubernetes-minion-emt8.c.myproject.internal $ kubectl describe nodes kubernetes-minion-emt8.c.myproject.internal

6
pkg/kubectl/cmd/get.go
View File

@ -35,7 +35,7 @@ const (
Possible resources include (case insensitive): pods (po), services (svc), Possible resources include (case insensitive): pods (po), services (svc),
replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs), replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs),
limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc), limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc),
resourcequotas (quota) or secrets. resourcequotas (quota), namespaces (ns), endpoints (ep) or secrets.
By specifying the output as 'template' and providing a Go template as the value By specifying the output as 'template' and providing a Go template as the value
of the --template flag, you can filter the attributes of the fetched resource(s).` of the --template flag, you can filter the attributes of the fetched resource(s).`
@ -100,7 +100,9 @@ func RunGet(f *cmdutil.Factory, out io.Writer, cmd *cobra.Command, args []string
} }
if len(args) == 0 { if len(args) == 0 {
fmt.Fprint(out, "You must specify the type of resource to get. ", valid_resources) fmt.Fprint(out, "You must specify the type of resource to get. ", valid_resources, ` * componentstatuses (aka 'cs')
* endpoints (aka 'ep')
`)
return cmdutil.UsageError(cmd, "Required resource not specified.") return cmdutil.UsageError(cmd, "Required resource not specified.")
} }