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

Use TYPE instead of RESOURCE in help string

Browse Source 
For commands in kubectl, use TYPE in help string.
This commit is contained in:
hurf
2015-07-06 19:31:27 +08:00
parent 159ba48932
commit 33fb6170f9
21 changed files with 39 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/user-guide/kubectl/kubectl.md
View File

@@ -102,7 +102,7 @@ kubectl
* [kubectl stop](kubectl_stop.md) - Deprecated: Gracefully shut down a resource by name or filename.
* [kubectl version](kubectl_version.md) - Print the client and server version information.
###### Auto generated by spf13/cobra at 2015-08-03 05:57:27.777459508 +0000 UTC
###### Auto generated by spf13/cobra at 2015-08-05 08:34:34.582015569 +0000 UTC
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl.md?pixel)]()

2
docs/user-guide/kubectl/kubectl_api-versions.md
View File

@@ -83,7 +83,7 @@ kubectl api-versions
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
###### Auto generated by spf13/cobra at 2015-07-14 00:11:42.959722426 +0000 UTC
###### Auto generated by spf13/cobra at 2015-07-29 09:00:08.946374303 +0000 UTC
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->

5
docs/user-guide/kubectl/kubectl_delete.md
View File

@@ -49,7 +49,7 @@ submits an update to a resource right when you submit a delete, their update
will be lost along with the rest of the resource.
```
kubectl delete ([-f FILENAME] | (RESOURCE [(NAME | -l label | --all)]
kubectl delete ([-f FILENAME] | TYPE [(NAME | -l label | --all)])
```
### Examples
@@ -118,8 +118,7 @@ $ kubectl delete pods --all
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
###### Auto generated by spf13/cobra at 2015-07-31 02:09:06.816515226 +0000 UTC
###### Auto generated by spf13/cobra at 2015-08-05 08:34:34.576732162 +0000 UTC
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_delete.md?pixel)]()

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

@@ -43,9 +43,9 @@ Show details of a specific resource or group of resources.
This command joins many API calls together to form a detailed description of a
given resource or group of resources.
$ kubectl describe RESOURCE NAME_PREFIX
$ kubectl describe TYPE 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 TYPE 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 (case insensitive): pods (po), services (svc),
@@ -54,7 +54,7 @@ persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota),
namespaces (ns) or secrets.
```
kubectl describe (RESOURCE NAME_PREFIX | RESOURCE/NAME)
kubectl describe (TYPE [(NAME_PREFIX | -l label] | TYPE/NAME)
```
### Examples
@@ -114,8 +114,7 @@ $ kubectl describe pods frontend
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
###### Auto generated by spf13/cobra at 2015-07-31 07:12:36.111698336 +0000 UTC
###### Auto generated by spf13/cobra at 2015-08-05 08:29:19.076341666 +0000 UTC
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_describe.md?pixel)]()

5
docs/user-guide/kubectl/kubectl_expose.md
View File

@@ -45,7 +45,7 @@ selector for a new Service on the specified port. If no labels are specified, th
re-use the labels from the resource it exposes.
```
kubectl expose RESOURCE NAME --port=port [--protocol=TCP|UDP] [--target-port=number-or-name] [--name=name] [--public-ip=ip] [--type=type]
kubectl expose TYPE NAME --port=port [--protocol=TCP|UDP] [--target-port=number-or-name] [--name=name] [--public-ip=ip] [--type=type]
```
### Examples
@@ -118,8 +118,7 @@ $ kubectl expose rc streamer --port=4100 --protocol=udp --name=video-stream
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
###### Auto generated by spf13/cobra at 2015-07-31 17:33:19.568673976 +0000 UTC
###### Auto generated by spf13/cobra at 2015-08-05 08:29:19.08042907 +0000 UTC
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_expose.md?pixel)]()

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

@@ -40,7 +40,7 @@ Display one or many resources
Display one or many resources.
Possible resources include (case insensitive): pods (po), services (svc),
Possible resource types include (case insensitive): pods (po), services (svc),
replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs),
limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc),
resourcequotas (quota), namespaces (ns), endpoints (ep) or secrets.
@@ -49,7 +49,7 @@ 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).
```
kubectl get [(-o|--output=)json|yaml|template|wide|...] (RESOURCE [NAME] | RESOURCE/NAME ...)
kubectl get [(-o|--output=)json|yaml|template|wide|...] (TYPE [(NAME | -l label] | TYPE/NAME ...)
```
### Examples
@@ -125,8 +125,7 @@ $ kubectl get rc/web service/frontend pods/web-pod-13je7
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
###### Auto generated by spf13/cobra at 2015-07-30 08:43:29.371131796 +0000 UTC
###### Auto generated by spf13/cobra at 2015-08-05 08:29:19.076072367 +0000 UTC
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_get.md?pixel)]()

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

@@ -45,7 +45,7 @@ If --overwrite is true, then existing labels can be overwritten, otherwise attem
If --resource-version is specified, then updates will use this resource version, otherwise the existing resource-version will be used.
```
kubectl label [--overwrite] RESOURCE NAME KEY_1=VAL_1 ... KEY_N=VAL_N [--resource-version=version]
kubectl label [--overwrite] TYPE NAME KEY_1=VAL_1 ... KEY_N=VAL_N [--resource-version=version]
```
### Examples
@@ -115,7 +115,7 @@ $ kubectl label pods foo bar-
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
###### Auto generated by spf13/cobra at 2015-07-14 00:11:42.958329854 +0000 UTC
###### Auto generated by spf13/cobra at 2015-07-30 07:40:18.746222333 +0000 UTC
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->

5
docs/user-guide/kubectl/kubectl_patch.md
View File

@@ -45,7 +45,7 @@ JSON and YAML formats are accepted.
Please refer to the models in https://htmlpreview.github.io/?https://github.com/GoogleCloudPlatform/kubernetes/HEAD/docs/api-reference/definitions.html to find if a field is mutable.
```
kubectl patch RESOURCE NAME -p PATCH
kubectl patch TYPE NAME -p PATCH
```
### Examples
@@ -100,8 +100,7 @@ kubectl patch pod valid-pod -p '{"spec":{"containers":[{"name":"kubernetes-serve
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
###### Auto generated by spf13/cobra at 2015-08-01 00:12:16.314479678 +0000 UTC
###### Auto generated by spf13/cobra at 2015-08-05 08:29:19.076903307 +0000 UTC
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_patch.md?pixel)]()

5
docs/user-guide/kubectl/kubectl_scale.md
View File

@@ -46,7 +46,7 @@ scale is attempted, and it is guaranteed that the precondition holds true when t
scale is sent to the server.
```
kubectl scale [--resource-version=version] [--current-replicas=count] --replicas=COUNT RESOURCE NAME
kubectl scale [--resource-version=version] [--current-replicas=count] --replicas=COUNT TYPE NAME
```
### Examples
@@ -106,8 +106,7 @@ $ kubectl scale --replicas=5 rc/foo rc/bar
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
###### Auto generated by spf13/cobra at 2015-07-30 08:50:55.94117889 +0000 UTC
###### Auto generated by spf13/cobra at 2015-08-05 08:29:19.077655801 +0000 UTC
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_scale.md?pixel)]()

6
docs/user-guide/kubectl/kubectl_stop.md
View File

@@ -40,14 +40,14 @@ Deprecated: Gracefully shut down a resource by name or filename.
Deprecated: Gracefully shut down a resource by name or filename.
stop command is deprecated, all its functionalities are covered by delete command.
The stop command is deprecated, all its functionalities are covered by delete command.
See 'kubectl delete --help' for more details.
Attempts to shut down and delete a resource that supports graceful termination.
If the resource is scalable it will be scaled to 0 before deletion.
```
kubectl stop (-f FILENAME | RESOURCE (NAME | -l label | --all))
kubectl stop (-f FILENAME | TYPE (NAME | -l label | --all))
```
### Examples
@@ -112,7 +112,7 @@ $ kubectl stop -f path/to/resources
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
###### Auto generated by spf13/cobra at 2015-07-29 09:18:59.539597953 +0000 UTC
###### Auto generated by spf13/cobra at 2015-07-30 07:40:18.745881487 +0000 UTC
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->