diff --git a/docs/man/man1/kubectl-autoscale.1 b/docs/man/man1/kubectl-autoscale.1 index 5bb443ffea0..da4f50c8a8e 100644 --- a/docs/man/man1/kubectl-autoscale.1 +++ b/docs/man/man1/kubectl-autoscale.1 @@ -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. diff --git a/docs/man/man1/kubectl-describe.1 b/docs/man/man1/kubectl-describe.1 index 5b5e6d5ee9f..1bbf7130dcc 100644 --- a/docs/man/man1/kubectl-describe.1 +++ b/docs/man/man1/kubectl-describe.1 @@ -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 diff --git a/docs/man/man1/kubectl-explain.1 b/docs/man/man1/kubectl-explain.1 index b2ee6c8bf42..fb013367298 100644 --- a/docs/man/man1/kubectl-explain.1 +++ b/docs/man/man1/kubectl-explain.1 @@ -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 diff --git a/docs/man/man1/kubectl-expose.1 b/docs/man/man1/kubectl-expose.1 index a8342e55d42..efadb138f5a 100644 --- a/docs/man/man1/kubectl-expose.1 +++ b/docs/man/man1/kubectl-expose.1 @@ -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 diff --git a/docs/man/man1/kubectl-get.1 b/docs/man/man1/kubectl-get.1 index 32edbe930f6..2580bceba77 100644 --- a/docs/man/man1/kubectl-get.1 +++ b/docs/man/man1/kubectl-get.1 @@ -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 diff --git a/docs/man/man1/kubectl-rollout-history.1 b/docs/man/man1/kubectl-rollout-history.1 index 7f9d5b3aa62..03e98b36cf3 100644 --- a/docs/man/man1/kubectl-rollout-history.1 +++ b/docs/man/man1/kubectl-rollout-history.1 @@ -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 diff --git a/docs/man/man1/kubectl-rollout-undo.1 b/docs/man/man1/kubectl-rollout-undo.1 index 84769c2d0a3..20807f7ed34 100644 --- a/docs/man/man1/kubectl-rollout-undo.1 +++ b/docs/man/man1/kubectl-rollout-undo.1 @@ -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 diff --git a/docs/man/man1/kubectl-rollout.1 b/docs/man/man1/kubectl-rollout.1 index 5bf9c5bb6dc..f2e8eb7a88c 100644 --- a/docs/man/man1/kubectl-rollout.1 +++ b/docs/man/man1/kubectl-rollout.1 @@ -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 diff --git a/docs/man/man1/kubectl-scale.1 b/docs/man/man1/kubectl-scale.1 index 9c8374928e4..d0f7c075bd7 100644 --- a/docs/man/man1/kubectl-scale.1 +++ b/docs/man/man1/kubectl-scale.1 @@ -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 diff --git a/docs/user-guide/kubectl/kubectl.md b/docs/user-guide/kubectl/kubectl.md index bd124aba61b..cc8c9aff3f9 100644 --- a/docs/user-guide/kubectl/kubectl.md +++ b/docs/user-guide/kubectl/kubectl.md @@ -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 @@ -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. @@ -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 [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_autoscale.md b/docs/user-guide/kubectl/kubectl_autoscale.md index 4f6e709d13c..d7dcb0d9638 100644 --- a/docs/user-guide/kubectl/kubectl_autoscale.md +++ b/docs/user-guide/kubectl/kubectl_autoscale.md @@ -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. ``` @@ -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 [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_autoscale.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_describe.md b/docs/user-guide/kubectl/kubectl_describe.md index 1b0ce3013d8..9ba3845b789 100644 --- a/docs/user-guide/kubectl/kubectl_describe.md +++ b/docs/user-guide/kubectl/kubectl_describe.md @@ -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) @@ -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 [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_describe.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_explain.md b/docs/user-guide/kubectl/kubectl_explain.md index 25582762a0e..4b05cc70563 100644 --- a/docs/user-guide/kubectl/kubectl_explain.md +++ b/docs/user-guide/kubectl/kubectl_explain.md @@ -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 @@ -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 [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_explain.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_expose.md b/docs/user-guide/kubectl/kubectl_expose.md index 1b5fb12f669..8e67cb9ead9 100644 --- a/docs/user-guide/kubectl/kubectl_expose.md +++ b/docs/user-guide/kubectl/kubectl_expose.md @@ -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] @@ -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 [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_expose.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_get.md b/docs/user-guide/kubectl/kubectl_get.md index 05b7ae25b72..0d3910cebfa 100644 --- a/docs/user-guide/kubectl/kubectl_get.md +++ b/docs/user-guide/kubectl/kubectl_get.md @@ -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). @@ -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 [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_get.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_rollout.md b/docs/user-guide/kubectl/kubectl_rollout.md index e9ee52ddaeb..3242d8aa00e 100644 --- a/docs/user-guide/kubectl/kubectl_rollout.md +++ b/docs/user-guide/kubectl/kubectl_rollout.md @@ -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 @@ -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 [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_rollout.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_rollout_history.md b/docs/user-guide/kubectl/kubectl_rollout_history.md index 95a91f6d2ac..9c97642d2d8 100644 --- a/docs/user-guide/kubectl/kubectl_rollout_history.md +++ b/docs/user-guide/kubectl/kubectl_rollout_history.md @@ -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] @@ -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 @@ -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 [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_rollout_history.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_rollout_undo.md b/docs/user-guide/kubectl/kubectl_rollout_undo.md index 118e2fb9293..e8db87b7e9c 100644 --- a/docs/user-guide/kubectl/kubectl_rollout_undo.md +++ b/docs/user-guide/kubectl/kubectl_rollout_undo.md @@ -39,7 +39,7 @@ undoes a previous rollout ### Synopsis -undo rolls back to a previous rollout. +Rollback to a previous rollout. ``` kubectl rollout undo (TYPE NAME | TYPE/NAME) [flags] @@ -50,6 +50,9 @@ kubectl rollout undo (TYPE NAME | TYPE/NAME) [flags] ``` # Rollback to the previous deployment kubectl rollout undo deployment/abc + +# Rollback to deployment revision 3 +kubectl rollout undo deployment/abc --to-revision=3 ``` ### Options @@ -90,7 +93,7 @@ kubectl rollout undo 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 [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_rollout_undo.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_scale.md b/docs/user-guide/kubectl/kubectl_scale.md index f681e88561b..bd5d8afcf59 100644 --- a/docs/user-guide/kubectl/kubectl_scale.md +++ b/docs/user-guide/kubectl/kubectl_scale.md @@ -34,12 +34,12 @@ Documentation for other releases can be found at ## kubectl scale -Set a new size for a Replication Controller, Job, or Deployment. +Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job. ### Synopsis -Set a new size for a Replication Controller, Job, or Deployment. +Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job. Scale also allows users to specify one or more preconditions for the scale action. If --current-replicas or --resource-version is specified, it is validated before the @@ -53,8 +53,8 @@ kubectl scale [--resource-version=version] [--current-replicas=count] --replicas ### Examples ``` -# 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 @@ -112,7 +112,7 @@ kubectl scale --replicas=3 job/cron * [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 [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_scale.md?pixel)]() diff --git a/pkg/kubectl/cmd/autoscale.go b/pkg/kubectl/cmd/autoscale.go index 2e54c3c0e56..0541f75272e 100644 --- a/pkg/kubectl/cmd/autoscale.go +++ b/pkg/kubectl/cmd/autoscale.go @@ -31,7 +31,7 @@ import ( const ( autoscaleLong = `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.` autoscaleExample = `# Auto scale a deployment "foo", with the number of pods between 2 to 10, target CPU utilization at a default value that server applies: @@ -45,7 +45,7 @@ func NewCmdAutoscale(f *cmdutil.Factory, out io.Writer) *cobra.Command { filenames := []string{} cmd := &cobra.Command{ Use: "autoscale (-f FILENAME | TYPE NAME | TYPE/NAME) [--min=MINPODS] --max=MAXPODS [--cpu-percent=CPU] [flags]", - Short: "Auto-scale a deployment or replication controller", + Short: "Auto-scale a Deployment, ReplicaSet, or ReplicationController", Long: autoscaleLong, Example: autoscaleExample, Run: func(cmd *cobra.Command, args []string) { diff --git a/pkg/kubectl/cmd/describe.go b/pkg/kubectl/cmd/describe.go index 466caa6c807..0f780d611a7 100644 --- a/pkg/kubectl/cmd/describe.go +++ b/pkg/kubectl/cmd/describe.go @@ -49,11 +49,7 @@ $ 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.` +` + kubectl.PossibleResourceTypes describe_example = `# Describe a node kubectl describe nodes kubernetes-minion-emt8.c.myproject.internal diff --git a/pkg/kubectl/cmd/explain.go b/pkg/kubectl/cmd/explain.go index 2fe12fc12da..6b868f5de29 100644 --- a/pkg/kubectl/cmd/explain.go +++ b/pkg/kubectl/cmd/explain.go @@ -36,11 +36,7 @@ kubectl explain pods.spec.containers` explainLong = `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).` +` + kubectl.PossibleResourceTypes ) // NewCmdExplain returns a cobra command for swagger docs diff --git a/pkg/kubectl/cmd/expose.go b/pkg/kubectl/cmd/expose.go index 4661801f8bf..785449382fe 100644 --- a/pkg/kubectl/cmd/expose.go +++ b/pkg/kubectl/cmd/expose.go @@ -37,14 +37,14 @@ type ExposeOptions struct { } const ( - expose_long = `Take a replication controller, service, replica set, deployment or pod and expose it as a new Kubernetes service. + expose_long = `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.` expose_example = `# Create a service for a replicated nginx, which serves on port 80 and connects to the containers on port 8000. kubectl expose rc nginx --port=80 --target-port=8000 @@ -73,7 +73,7 @@ func NewCmdExposeService(f *cmdutil.Factory, out io.Writer) *cobra.Command { cmd := &cobra.Command{ Use: "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]", - Short: "Take a replication controller, service or pod and expose it as a new Kubernetes Service", + Short: "Take a replication controller, service, or pod and expose it as a new Kubernetes Service", Long: expose_long, Example: expose_example, Run: func(cmd *cobra.Command, args []string) { diff --git a/pkg/kubectl/cmd/get.go b/pkg/kubectl/cmd/get.go index 5ba06cdbbe5..8dd5f01e13b 100644 --- a/pkg/kubectl/cmd/get.go +++ b/pkg/kubectl/cmd/get.go @@ -38,11 +38,7 @@ type GetOptions struct { const ( get_long = `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. +` + kubectl.PossibleResourceTypes + ` 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).` diff --git a/pkg/kubectl/cmd/rollout/rollout.go b/pkg/kubectl/cmd/rollout/rollout.go index 2397a10f411..ab5b2e6bc98 100644 --- a/pkg/kubectl/cmd/rollout/rollout.go +++ b/pkg/kubectl/cmd/rollout/rollout.go @@ -24,7 +24,7 @@ import ( ) const ( - rollout_long = `rollout manages a deployment using subcommands like "kubectl rollout undo deployment/abc"` + rollout_long = `Manages a deployment using subcommands like "kubectl rollout undo deployment/abc"` rollout_example = `# Rollback to the previous deployment kubectl rollout undo deployment/abc` rollout_valid_resources = `Valid resource types include: diff --git a/pkg/kubectl/cmd/rollout/rollout_history.go b/pkg/kubectl/cmd/rollout/rollout_history.go index 5b487acda98..63a101af063 100644 --- a/pkg/kubectl/cmd/rollout/rollout_history.go +++ b/pkg/kubectl/cmd/rollout/rollout_history.go @@ -35,9 +35,12 @@ type HistoryOptions struct { } const ( - history_long = `view previous rollout revisions and configurations.` + history_long = `View previous rollout revisions and configurations.` history_example = `# View the rollout history of a deployment -kubectl rollout history deployment/abc` +kubectl rollout history deployment/abc + +# View the details of deployment revision 3 +kubectl rollout history deployment/abc --revision=3` ) func NewCmdRolloutHistory(f *cmdutil.Factory, out io.Writer) *cobra.Command { diff --git a/pkg/kubectl/cmd/rollout/rollout_undo.go b/pkg/kubectl/cmd/rollout/rollout_undo.go index 4dba41275f2..c3ac66d908e 100644 --- a/pkg/kubectl/cmd/rollout/rollout_undo.go +++ b/pkg/kubectl/cmd/rollout/rollout_undo.go @@ -42,9 +42,12 @@ type UndoOptions struct { } const ( - undo_long = `undo rolls back to a previous rollout.` + undo_long = `Rollback to a previous rollout.` undo_example = `# Rollback to the previous deployment -kubectl rollout undo deployment/abc` +kubectl rollout undo deployment/abc + +# Rollback to deployment revision 3 +kubectl rollout undo deployment/abc --to-revision=3` ) func NewCmdRolloutUndo(f *cmdutil.Factory, out io.Writer) *cobra.Command { diff --git a/pkg/kubectl/cmd/scale.go b/pkg/kubectl/cmd/scale.go index b16f90cd9c5..551f4427d55 100644 --- a/pkg/kubectl/cmd/scale.go +++ b/pkg/kubectl/cmd/scale.go @@ -37,14 +37,14 @@ type ScaleOptions struct { } const ( - scale_long = `Set a new size for a Replication Controller, Job, or Deployment. + scale_long = `Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job. Scale also allows users to specify one or more preconditions for the scale action. If --current-replicas or --resource-version is specified, it is validated before the scale is attempted, and it is guaranteed that the precondition holds true when the scale is sent to the server.` - scale_example = `# Scale replication controller named 'foo' to 3. -kubectl scale --replicas=3 rc/foo + scale_example = `# 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 @@ -67,7 +67,7 @@ func NewCmdScale(f *cmdutil.Factory, out io.Writer) *cobra.Command { Use: "scale [--resource-version=version] [--current-replicas=count] --replicas=COUNT (-f FILENAME | TYPE NAME)", // resize is deprecated Aliases: []string{"resize"}, - Short: "Set a new size for a Replication Controller, Job, or Deployment.", + Short: "Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job.", Long: scale_long, Example: scale_example, Run: func(cmd *cobra.Command, args []string) { diff --git a/pkg/kubectl/kubectl.go b/pkg/kubectl/kubectl.go index 844a5378196..39cd1681a2d 100644 --- a/pkg/kubectl/kubectl.go +++ b/pkg/kubectl/kubectl.go @@ -28,7 +28,15 @@ import ( "k8s.io/kubernetes/pkg/api/unversioned" ) -const kubectlAnnotationPrefix = "kubectl.kubernetes.io/" +const ( + kubectlAnnotationPrefix = "kubectl.kubernetes.io/" + // TODO: auto-generate this + PossibleResourceTypes = `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.` +) type NamespaceInfo struct { Namespace string