Update kubectl help for 1.2 resources

This commit is contained in:
Janet Kuo
2016-03-21 14:00:43 -07:00
parent d124deeb2f
commit e93b855242
29 changed files with 126 additions and 112 deletions

View File

@@ -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
@@ -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.

View File

@@ -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

View File

@@ -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

View File

@@ -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
@@ -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

View File

@@ -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

View File

@@ -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
@@ -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

View File

@@ -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
@@ -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

View File

@@ -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

View File

@@ -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
@@ -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.
@@ -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