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

Fix hits in help strings of kubectl get command

Browse Source 
Removed duplicated 'nodes (no)', added 'secret' for resource type.
Use actual long resource name to avoid confusion.
This commit is contained in:
hurf
2015-07-06 19:36:06 +08:00
parent 9c47e0d20c
commit 4f9c486308
6 changed files with 26 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -27,10 +27,10 @@ will first check for an exact match on RESOURCE and NAME\_PREFIX. If no such res
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
.PP .PP
Possible resources include pods (po), replicationcontrollers (rc), services Possible resources include (case insensitive): pods (po), services (svc),
(svc), nodes (no), events (ev), componentstatuses (cs), limitRanges (limits), replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs),
persistentVolumes (pv), persistentVolumeClaims (pvc), resourceQuotas (quota) limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc),
or secrets. resourcequotas (quota) or secrets.
.SH OPTIONS .SH OPTIONS

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

@@ -16,10 +16,10 @@ kubectl get \- Display one or many resources
Display one or many resources. Display one or many resources.
.PP .PP
Possible resources include pods (po), replication controllers (rc), services Possible resources include (case insensitive): pods (po), services (svc),
(svc), nodes, events (ev), component statuses (cs), limit ranges (limits), replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs),
nodes (no), persistent volumes (pv), persistent volume claims (pvc) limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc),
or resource quotas (quota). resourcequotas (quota) 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

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

@@ -37,10 +37,10 @@ $ kubectl describe RESOURCE NAME_PREFIX
will first check for an exact match on RESOURCE and NAME_PREFIX. If no such resource 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 exists, it will output details for every resource that has a name prefixed with NAME_PREFIX
Possible resources include pods (po), replicationcontrollers (rc), services Possible resources include (case insensitive): pods (po), services (svc),
(svc), nodes (no), events (ev), componentstatuses (cs), limitRanges (limits), replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs),
persistentVolumes (pv), persistentVolumeClaims (pvc), resourceQuotas (quota) limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc),
or secrets. resourcequotas (quota) or secrets.
``` ```
kubectl describe (RESOURCE NAME_PREFIX | RESOURCE/NAME) kubectl describe (RESOURCE NAME_PREFIX | RESOURCE/NAME)
@@ -102,7 +102,7 @@ $ kubectl describe pods frontend
### SEE ALSO ### SEE ALSO
* [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-14 08:21:33.374469932 +0000 UTC ###### Auto generated by spf13/cobra at 2015-07-15 01:43:24.778753787 +0000 UTC
<!-- BEGIN MUNGE: GENERATED_ANALYTICS --> <!-- BEGIN MUNGE: GENERATED_ANALYTICS -->

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

@@ -29,10 +29,10 @@ Display one or many resources
Display one or many resources. Display one or many resources.
Possible resources include pods (po), replication controllers (rc), services Possible resources include (case insensitive): pods (po), services (svc),
(svc), nodes, events (ev), component statuses (cs), limit ranges (limits), replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs),
nodes (no), persistent volumes (pv), persistent volume claims (pvc) limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc),
or resource quotas (quota). resourcequotas (quota) 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).
@@ -113,7 +113,7 @@ $ kubectl get rc/web service/frontend pods/web-pod-13je7
### SEE ALSO ### SEE ALSO
* [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-14 00:11:42.955450097 +0000 UTC ###### Auto generated by spf13/cobra at 2015-07-15 01:43:24.778535128 +0000 UTC
<!-- BEGIN MUNGE: GENERATED_ANALYTICS --> <!-- BEGIN MUNGE: GENERATED_ANALYTICS -->

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

@@ -42,10 +42,10 @@ $ kubectl describe RESOURCE NAME_PREFIX
will first check for an exact match on RESOURCE and NAME_PREFIX. If no such resource 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 exists, it will output details for every resource that has a name prefixed with NAME_PREFIX
Possible resources include pods (po), replicationcontrollers (rc), services Possible resources include (case insensitive): pods (po), services (svc),
(svc), nodes (no), events (ev), componentstatuses (cs), limitRanges (limits), replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs),
persistentVolumes (pv), persistentVolumeClaims (pvc), resourceQuotas (quota) limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc),
or secrets.` resourcequotas (quota) 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

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

@@ -32,10 +32,10 @@ import (
const ( const (
get_long = `Display one or many resources. get_long = `Display one or many resources.
Possible resources include pods (po), replication controllers (rc), services Possible resources include (case insensitive): pods (po), services (svc),
(svc), nodes, events (ev), component statuses (cs), limit ranges (limits), replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs),
nodes (no), persistent volumes (pv), persistent volume claims (pvc) limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc),
or resource quotas (quota). resourcequotas (quota) 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).`