Skip to content

Commit

Permalink
Update kubectl help for 1.2 resources
Browse files Browse the repository at this point in the history
  • Loading branch information
@janetkuo
janetkuo committed Mar 22, 2016
1 parent d124dee commit e93b855
Show file tree
Hide file tree
Showing 29 changed files with 126 additions and 112 deletions.
4 changes: 2 additions & 2 deletions docs/man/man1/kubectl-autoscale.1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

.SH NAME
.PP
kubectl autoscale \- Auto\-scale a deployment or replication controller
kubectl autoscale \- Auto\-scale a Deployment, ReplicaSet, or ReplicationController


.SH SYNOPSIS
Expand All @@ -16,7 +16,7 @@ kubectl autoscale \- Auto\-scale a deployment or replication controller
Creates an autoscaler that automatically chooses and sets the number of pods that run in a kubernetes cluster.

.PP
Looks up a deployment or replication controller by name and creates an autoscaler that uses this deployment or replication controller as a reference.
Looks up a Deployment, ReplicaSet, or ReplicationController by name and creates an autoscaler that uses the given resource as a reference.
An autoscaler can automatically increase or decrease number of pods deployed within the system as needed.


Expand Down
10 changes: 5 additions & 5 deletions docs/man/man1/kubectl-describe.1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ will first check for an exact match on TYPE and NAME\_PREFIX. If no such resourc
exists, it will output details for every resource that has a name prefixed with NAME\_PREFIX

.PP
Possible resource types include (case insensitive): pods (po), services (svc),
replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits),
persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota),
namespaces (ns), serviceaccounts, horizontalpodautoscalers (hpa),
endpoints (ep) or secrets.
Possible resource types include (case insensitive): pods (po), services (svc), deployments,
replicasets (rs), replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits),
persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota), namespaces (ns),
serviceaccounts, ingresses (ing), horizontalpodautoscalers (hpa), daemonsets (ds), configmaps,
componentstatuses (cs), endpoints (ep), and secrets.


.SH OPTIONS
Expand Down
10 changes: 5 additions & 5 deletions docs/man/man1/kubectl-explain.1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ kubectl explain \- Documentation of resources.
Documentation of resources.

.PP
Possible resource types include: pods (po), services (svc),
replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs),
limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc),
resourcequotas (quota), namespaces (ns), horizontalpodautoscalers (hpa)
or endpoints (ep).
Possible resource types include (case insensitive): pods (po), services (svc), deployments,
replicasets (rs), replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits),
persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota), namespaces (ns),
serviceaccounts, ingresses (ing), horizontalpodautoscalers (hpa), daemonsets (ds), configmaps,
componentstatuses (cs), endpoints (ep), and secrets.


.SH OPTIONS
Expand Down
16 changes: 8 additions & 8 deletions docs/man/man1/kubectl-expose.1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

.SH NAME
.PP
kubectl expose \- Take a replication controller, service or pod and expose it as a new Kubernetes Service
kubectl expose \- Take a replication controller, service, or pod and expose it as a new Kubernetes Service


.SH SYNOPSIS
Expand All @@ -13,15 +13,15 @@ kubectl expose \- Take a replication controller, service or pod and expose it as

.SH DESCRIPTION
.PP
Take a replication controller, service, replica set, deployment or pod and expose it as a new Kubernetes service.
Take a deployment, service, replica set, replication controller, or pod and expose it as a new Kubernetes service.

.PP
Looks up a replication controller, service, replica set, deployment or pod by name and uses the selector
for that resource as the selector for a new service on the specified port. A replica set will be exposed
as a service only if it's selector is convertible to a selector that service supports, i.e. when the
replica set selector contains only the matchLabels component. Note that if no port is specified
via \-\-port and the exposed resource has multiple ports, all will be re\-used by the new service. Also
if no labels are specified, the new service will re\-use the labels from the resource it exposes.
Looks up a deployment, service, replica set, replication controller or pod by name and uses the selector
for that resource as the selector for a new service on the specified port. A deployment or replica set
will be exposed as a service only if its selector is convertible to a selector that service supports,
i.e. when the selector contains only the matchLabels component. Note that if no port is specified via
\-\-port and the exposed resource has multiple ports, all will be re\-used by the new service. Also if no
labels are specified, the new service will re\-use the labels from the resource it exposes.


.SH OPTIONS
Expand Down
10 changes: 5 additions & 5 deletions docs/man/man1/kubectl-get.1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ kubectl get \- Display one or many resources
Display one or many resources.

.PP
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),
horizontalpodautoscalers (hpa), serviceaccounts or secrets.
Possible resource types include (case insensitive): pods (po), services (svc), deployments,
replicasets (rs), replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits),
persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota), namespaces (ns),
serviceaccounts, ingresses (ing), horizontalpodautoscalers (hpa), daemonsets (ds), configmaps,
componentstatuses (cs), endpoints (ep), and secrets.

.PP
By specifying the output as 'template' and providing a Go template as the value
Expand Down
5 changes: 4 additions & 1 deletion docs/man/man1/kubectl-rollout-history.1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ kubectl rollout history \- view rollout history

.SH DESCRIPTION
.PP
view previous rollout revisions and configurations.
View previous rollout revisions and configurations.


.SH OPTIONS
Expand Down Expand Up @@ -128,6 +128,9 @@ view previous rollout revisions and configurations.
# View the rollout history of a deployment
kubectl rollout history deployment/abc

# View the details of deployment revision 3
kubectl rollout history deployment/abc \-\-revision=3

.fi
.RE

Expand Down
5 changes: 4 additions & 1 deletion docs/man/man1/kubectl-rollout-undo.1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ kubectl rollout undo \- undoes a previous rollout

.SH DESCRIPTION
.PP
undo rolls back to a previous rollout.
Rollback to a previous rollout.


.SH OPTIONS
Expand Down Expand Up @@ -128,6 +128,9 @@ undo rolls back to a previous rollout.
# Rollback to the previous deployment
kubectl rollout undo deployment/abc

# Rollback to deployment revision 3
kubectl rollout undo deployment/abc \-\-to\-revision=3

.fi
.RE

Expand Down
2 changes: 1 addition & 1 deletion docs/man/man1/kubectl-rollout.1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ kubectl rollout \- rollout manages a deployment

.SH DESCRIPTION
.PP
rollout manages a deployment using subcommands like "kubectl rollout undo deployment/abc"
Manages a deployment using subcommands like "kubectl rollout undo deployment/abc"


.SH OPTIONS INHERITED FROM PARENT COMMANDS
Expand Down
8 changes: 4 additions & 4 deletions docs/man/man1/kubectl-scale.1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

.SH NAME
.PP
kubectl scale \- Set a new size for a Replication Controller, Job, or Deployment.
kubectl scale \- Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job.


.SH SYNOPSIS
Expand All @@ -13,7 +13,7 @@ kubectl scale \- Set a new size for a Replication Controller, Job, or Deployment

.SH DESCRIPTION
.PP
Set a new size for a Replication Controller, Job, or Deployment.
Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job.

.PP
Scale also allows users to specify one or more preconditions for the scale action.
Expand Down Expand Up @@ -151,8 +151,8 @@ scale is sent to the server.
.RS

.nf
# Scale replication controller named 'foo' to 3.
kubectl scale \-\-replicas=3 rc/foo
# Scale a replicaset named 'foo' to 3.
kubectl scale \-\-replicas=3 rs/foo

# Scale a resource identified by type and name specified in "foo.yaml" to 3.
kubectl scale \-\-replicas=3 \-f foo.yaml
Expand Down
8 changes: 4 additions & 4 deletions docs/user-guide/kubectl/kubectl.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ kubectl
* [kubectl api-versions](kubectl_api-versions.md) - Print the supported API versions on the server, in the form of "group/version".
* [kubectl apply](kubectl_apply.md) - Apply a configuration to a resource by filename or stdin
* [kubectl attach](kubectl_attach.md) - Attach to a running container.
* [kubectl autoscale](kubectl_autoscale.md) - Auto-scale a deployment or replication controller
* [kubectl autoscale](kubectl_autoscale.md) - Auto-scale a Deployment, ReplicaSet, or ReplicationController
* [kubectl cluster-info](kubectl_cluster-info.md) - Display cluster info
* [kubectl config](kubectl_config.md) - config modifies kubeconfig files
* [kubectl convert](kubectl_convert.md) - Convert config files between different API versions
Expand All @@ -92,7 +92,7 @@ kubectl
* [kubectl edit](kubectl_edit.md) - Edit a resource on the server
* [kubectl exec](kubectl_exec.md) - Execute a command in a container.
* [kubectl explain](kubectl_explain.md) - Documentation of resources.
* [kubectl expose](kubectl_expose.md) - Take a replication controller, service or pod and expose it as a new Kubernetes Service
* [kubectl expose](kubectl_expose.md) - Take a replication controller, service, or pod and expose it as a new Kubernetes Service
* [kubectl get](kubectl_get.md) - Display one or many resources
* [kubectl label](kubectl_label.md) - Update the labels on a resource
* [kubectl logs](kubectl_logs.md) - Print the logs for a container in a pod.
Expand All @@ -104,11 +104,11 @@ kubectl
* [kubectl rolling-update](kubectl_rolling-update.md) - Perform a rolling update of the given ReplicationController.
* [kubectl rollout](kubectl_rollout.md) - rollout manages a deployment
* [kubectl run](kubectl_run.md) - Run a particular image on the cluster.
* [kubectl scale](kubectl_scale.md) - Set a new size for a Replication Controller, Job, or Deployment.
* [kubectl scale](kubectl_scale.md) - Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job.
* [kubectl uncordon](kubectl_uncordon.md) - Mark node as schedulable
* [kubectl version](kubectl_version.md) - Print the client and server version information.

###### Auto generated by spf13/cobra on 2-Mar-2016
###### Auto generated by spf13/cobra on 22-Mar-2016

<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl.md?pixel)]()
Expand Down
6 changes: 3 additions & 3 deletions docs/user-guide/kubectl/kubectl_autoscale.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,14 @@ Documentation for other releases can be found at

## kubectl autoscale

Auto-scale a deployment or replication controller
Auto-scale a Deployment, ReplicaSet, or ReplicationController

### Synopsis


Creates an autoscaler that automatically chooses and sets the number of pods that run in a kubernetes cluster.

Looks up a deployment or replication controller by name and creates an autoscaler that uses this deployment or replication controller as a reference.
Looks up a Deployment, ReplicaSet, or ReplicationController by name and creates an autoscaler that uses the given resource as a reference.
An autoscaler can automatically increase or decrease number of pods deployed within the system as needed.

```
Expand Down Expand Up @@ -110,7 +110,7 @@ kubectl autoscale rc foo --max=5 --cpu-percent=80

* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager

###### Auto generated by spf13/cobra on 2-Mar-2016
###### Auto generated by spf13/cobra on 22-Mar-2016

<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_autoscale.md?pixel)]()
Expand Down
12 changes: 6 additions & 6 deletions docs/user-guide/kubectl/kubectl_describe.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,11 @@ $ kubectl describe TYPE NAME_PREFIX
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 resource types include (case insensitive): pods (po), services (svc),
replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits),
persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota),
namespaces (ns), serviceaccounts, horizontalpodautoscalers (hpa),
endpoints (ep) or secrets.
Possible resource types include (case insensitive): pods (po), services (svc), deployments,
replicasets (rs), replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits),
persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota), namespaces (ns),
serviceaccounts, ingresses (ing), horizontalpodautoscalers (hpa), daemonsets (ds), configmaps,
componentstatuses (cs), endpoints (ep), and secrets.

```
kubectl describe (-f FILENAME | TYPE [NAME_PREFIX | -l label] | TYPE/NAME)
Expand Down Expand Up @@ -120,7 +120,7 @@ kubectl describe pods frontend

* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager

###### Auto generated by spf13/cobra on 2-Mar-2016
###### Auto generated by spf13/cobra on 22-Mar-2016

<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_describe.md?pixel)]()
Expand Down
12 changes: 6 additions & 6 deletions docs/user-guide/kubectl/kubectl_explain.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,11 @@ Documentation of resources.

Documentation of resources.

Possible resource types include: pods (po), services (svc),
replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs),
limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc),
resourcequotas (quota), namespaces (ns), horizontalpodautoscalers (hpa)
or endpoints (ep).
Possible resource types include (case insensitive): pods (po), services (svc), deployments,
replicasets (rs), replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits),
persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota), namespaces (ns),
serviceaccounts, ingresses (ing), horizontalpodautoscalers (hpa), daemonsets (ds), configmaps,
componentstatuses (cs), endpoints (ep), and secrets.

```
kubectl explain RESOURCE
Expand Down Expand Up @@ -98,7 +98,7 @@ kubectl explain pods.spec.containers

* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager

###### Auto generated by spf13/cobra on 2-Mar-2016
###### Auto generated by spf13/cobra on 22-Mar-2016

<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_explain.md?pixel)]()
Expand Down
18 changes: 9 additions & 9 deletions docs/user-guide/kubectl/kubectl_expose.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,19 +34,19 @@ Documentation for other releases can be found at

## kubectl expose

Take a replication controller, service or pod and expose it as a new Kubernetes Service
Take a replication controller, service, or pod and expose it as a new Kubernetes Service

### Synopsis


Take a replication controller, service, replica set, deployment or pod and expose it as a new Kubernetes service.
Take a deployment, service, replica set, replication controller, or pod and expose it as a new Kubernetes service.

Looks up a replication controller, service, replica set, deployment or pod by name and uses the selector
for that resource as the selector for a new service on the specified port. A replica set will be exposed
as a service only if it's selector is convertible to a selector that service supports, i.e. when the
replica set selector contains only the matchLabels component. Note that if no port is specified
via --port and the exposed resource has multiple ports, all will be re-used by the new service. Also
if no labels are specified, the new service will re-use the labels from the resource it exposes.
Looks up a deployment, service, replica set, replication controller or pod by name and uses the selector
for that resource as the selector for a new service on the specified port. A deployment or replica set
will be exposed as a service only if its selector is convertible to a selector that service supports,
i.e. when the selector contains only the matchLabels component. Note that if no port is specified via
--port and the exposed resource has multiple ports, all will be re-used by the new service. Also if no
labels are specified, the new service will re-use the labels from the resource it exposes.

```
kubectl expose (-f FILENAME | TYPE NAME) [--port=port] [--protocol=TCP|UDP] [--target-port=number-or-name] [--name=name] [--external-ip=external-ip-of-service] [--type=type]
Expand Down Expand Up @@ -137,7 +137,7 @@ kubectl expose deployment nginx --port=80 --target-port=8000

* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager

###### Auto generated by spf13/cobra on 19-Mar-2016
###### Auto generated by spf13/cobra on 22-Mar-2016

<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_expose.md?pixel)]()
Expand Down
12 changes: 6 additions & 6 deletions docs/user-guide/kubectl/kubectl_get.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,11 @@ Display one or many resources

Display one or many resources.

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),
horizontalpodautoscalers (hpa), serviceaccounts or secrets.
Possible resource types include (case insensitive): pods (po), services (svc), deployments,
replicasets (rs), replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits),
persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota), namespaces (ns),
serviceaccounts, ingresses (ing), horizontalpodautoscalers (hpa), daemonsets (ds), configmaps,
componentstatuses (cs), endpoints (ep), and secrets.

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).
Expand Down Expand Up @@ -132,7 +132,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 on 2-Mar-2016
###### Auto generated by spf13/cobra on 22-Mar-2016

<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_get.md?pixel)]()
Expand Down
4 changes: 2 additions & 2 deletions docs/user-guide/kubectl/kubectl_rollout.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ rollout manages a deployment
### Synopsis


rollout manages a deployment using subcommands like "kubectl rollout undo deployment/abc"
Manages a deployment using subcommands like "kubectl rollout undo deployment/abc"

```
kubectl rollout SUBCOMMAND
Expand Down Expand Up @@ -87,7 +87,7 @@ kubectl rollout undo deployment/abc
* [kubectl rollout resume](kubectl_rollout_resume.md) - Resume a paused resource
* [kubectl rollout undo](kubectl_rollout_undo.md) - undoes a previous rollout

###### Auto generated by spf13/cobra on 2-Mar-2016
###### Auto generated by spf13/cobra on 21-Mar-2016

<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_rollout.md?pixel)]()
Expand Down
7 changes: 5 additions & 2 deletions docs/user-guide/kubectl/kubectl_rollout_history.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ view rollout history
### Synopsis


view previous rollout revisions and configurations.
View previous rollout revisions and configurations.

```
kubectl rollout history (TYPE NAME | TYPE/NAME) [flags]
Expand All @@ -50,6 +50,9 @@ kubectl rollout history (TYPE NAME | TYPE/NAME) [flags]
```
# View the rollout history of a deployment
kubectl rollout history deployment/abc
# View the details of deployment revision 3
kubectl rollout history deployment/abc --revision=3
```

### Options
Expand Down Expand Up @@ -90,7 +93,7 @@ kubectl rollout history deployment/abc

* [kubectl rollout](kubectl_rollout.md) - rollout manages a deployment

###### Auto generated by spf13/cobra on 2-Mar-2016
###### Auto generated by spf13/cobra on 21-Mar-2016

<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_rollout_history.md?pixel)]()
Expand Down
Loading

1 comment on commit e93b855

@k8s-teamcity-mesosphere
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TeamCity OSS :: Kubernetes Mesos :: 4 - Smoke Tests Build 19736 outcome was SUCCESS
Summary: Tests passed: 1, ignored: 265 Build time: 00:06:00

Please sign in to comment.