From 0427711c4299b7da6dff97bb5b964194e90a3c38 Mon Sep 17 00:00:00 2001 From: feihujiang Date: Wed, 2 Sep 2015 17:56:29 +0800 Subject: [PATCH] Fixes upper case letters in kubectl examples --- docs/man/man1/kubectl-attach.1 | 6 +++--- docs/man/man1/kubectl-exec.1 | 6 +++--- docs/man/man1/kubectl-expose.1 | 6 +++--- docs/man/man1/kubectl-logs.1 | 6 +++--- docs/man/man1/kubectl-port-forward.1 | 8 ++++---- docs/man/man1/kubectl-run.1 | 4 ++-- docs/user-guide/kubectl/kubectl_attach.md | 8 ++++---- docs/user-guide/kubectl/kubectl_exec.md | 8 ++++---- docs/user-guide/kubectl/kubectl_expose.md | 8 ++++---- docs/user-guide/kubectl/kubectl_logs.md | 8 ++++---- docs/user-guide/kubectl/kubectl_port-forward.md | 10 +++++----- docs/user-guide/kubectl/kubectl_run.md | 6 +++--- pkg/kubectl/cmd/attach.go | 6 +++--- pkg/kubectl/cmd/exec.go | 6 +++--- pkg/kubectl/cmd/expose.go | 6 +++--- pkg/kubectl/cmd/log.go | 6 +++--- pkg/kubectl/cmd/portforward.go | 8 ++++---- pkg/kubectl/cmd/run.go | 4 ++-- 18 files changed, 60 insertions(+), 60 deletions(-) diff --git a/docs/man/man1/kubectl-attach.1 b/docs/man/man1/kubectl-attach.1 index c52d396b49dfd..55de8f34243a9 100644 --- a/docs/man/man1/kubectl-attach.1 +++ b/docs/man/man1/kubectl-attach.1 @@ -133,13 +133,13 @@ Attach to a a process that is already running inside an existing container. .RS .nf -# get output from running pod 123456\-7890, using the first container by default +# Get output from running pod 123456\-7890, using the first container by default $ kubectl attach 123456\-7890 -# get output from ruby\-container from pod 123456\-7890 +# Get output from ruby\-container from pod 123456\-7890 $ kubectl attach 123456\-7890 \-c ruby\-container date -# switch to raw terminal mode, sends stdin to 'bash' in ruby\-container from pod 123456\-780 +# Switch to raw terminal mode, sends stdin to 'bash' in ruby\-container from pod 123456\-780 # and sends stdout/stderr from 'bash' back to the client $ kubectl attach 123456\-7890 \-c ruby\-container \-i \-t diff --git a/docs/man/man1/kubectl-exec.1 b/docs/man/man1/kubectl-exec.1 index 53bca656b828a..942f9a21bf4a1 100644 --- a/docs/man/man1/kubectl-exec.1 +++ b/docs/man/man1/kubectl-exec.1 @@ -137,13 +137,13 @@ Execute a command in a container. .RS .nf -# get output from running 'date' from pod 123456\-7890, using the first container by default +# Get output from running 'date' from pod 123456\-7890, using the first container by default $ kubectl exec 123456\-7890 date -# get output from running 'date' in ruby\-container from pod 123456\-7890 +# Get output from running 'date' in ruby\-container from pod 123456\-7890 $ kubectl exec 123456\-7890 \-c ruby\-container date -# switch to raw terminal mode, sends stdin to 'bash' in ruby\-container from pod 123456\-780 +# Switch to raw terminal mode, sends stdin to 'bash' in ruby\-container from pod 123456\-780 # and sends stdout/stderr from 'bash' back to the client $ kubectl exec 123456\-7890 \-c ruby\-container \-i \-t \-\- bash \-il diff --git a/docs/man/man1/kubectl-expose.1 b/docs/man/man1/kubectl-expose.1 index fffa7c633857f..cb48a3ad21f9b 100644 --- a/docs/man/man1/kubectl-expose.1 +++ b/docs/man/man1/kubectl-expose.1 @@ -212,13 +212,13 @@ re\-use the labels from the resource it exposes. .RS .nf -# Creates a service for a replicated nginx, which serves on port 80 and connects to the containers on port 8000. +# 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 -# Creates a service for a replication controller identified by type and name specified in "nginx\-controller.yaml", which serves on port 80 and connects to the containers on port 8000. +# Create a service for a replication controller identified by type and name specified in "nginx\-controller.yaml", which serves on port 80 and connects to the containers on port 8000. $ kubectl expose \-f nginx\-controller.yaml \-\-port=80 \-\-target\-port=8000 -# Creates a second service based on the above service, exposing the container port 8443 as port 443 with the name "nginx\-https" +# Create a second service based on the above service, exposing the container port 8443 as port 443 with the name "nginx\-https" $ kubectl expose service nginx \-\-port=443 \-\-target\-port=8443 \-\-name=nginx\-https # Create a service for a replicated streaming application on port 4100 balancing UDP traffic and named 'video\-stream'. diff --git a/docs/man/man1/kubectl-logs.1 b/docs/man/man1/kubectl-logs.1 index c2ebb6943ae8c..83b2f7b0a265f 100644 --- a/docs/man/man1/kubectl-logs.1 +++ b/docs/man/man1/kubectl-logs.1 @@ -137,13 +137,13 @@ Print the logs for a container in a pod. If the pod has only one container, the .RS .nf -# Returns snapshot of ruby\-container logs from pod 123456\-7890. +# Return snapshot of ruby\-container logs from pod 123456\-7890. $ kubectl logs 123456\-7890 ruby\-container -# Returns snapshot of previous terminated ruby\-container logs from pod 123456\-7890. +# Return snapshot of previous terminated ruby\-container logs from pod 123456\-7890. $ kubectl logs \-p 123456\-7890 ruby\-container -# Starts streaming of ruby\-container logs from pod 123456\-7890. +# Start streaming of ruby\-container logs from pod 123456\-7890. $ kubectl logs \-f 123456\-7890 ruby\-container .fi diff --git a/docs/man/man1/kubectl-port-forward.1 b/docs/man/man1/kubectl-port-forward.1 index 5cb224f00b1d4..4f158b237c02b 100644 --- a/docs/man/man1/kubectl-port-forward.1 +++ b/docs/man/man1/kubectl-port-forward.1 @@ -126,16 +126,16 @@ Forward one or more local ports to a pod. .nf -# listens on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in the pod +# Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in the pod $ kubectl port\-forward mypod 5000 6000 -# listens on port 8888 locally, forwarding to 5000 in the pod +# Listen on port 8888 locally, forwarding to 5000 in the pod $ kubectl port\-forward mypod 8888:5000 -# listens on a random port locally, forwarding to 5000 in the pod +# Listen on a random port locally, forwarding to 5000 in the pod $ kubectl port\-forward mypod :5000 -# listens on a random port locally, forwarding to 5000 in the pod +# Listen on a random port locally, forwarding to 5000 in the pod $ kubectl port\-forward mypod 0:5000 .fi diff --git a/docs/man/man1/kubectl-run.1 b/docs/man/man1/kubectl-run.1 index ebdfacce30e5b..88dc6300517ad 100644 --- a/docs/man/man1/kubectl-run.1 +++ b/docs/man/man1/kubectl-run.1 @@ -200,10 +200,10 @@ Creates a replication controller to manage the created container(s). .RS .nf -# Starts a single instance of nginx. +# Start a single instance of nginx. $ kubectl run nginx \-\-image=nginx -# Starts a replicated instance of nginx. +# Start a replicated instance of nginx. $ kubectl run nginx \-\-image=nginx \-\-replicas=5 # Dry run. Print the corresponding API objects without creating them. diff --git a/docs/user-guide/kubectl/kubectl_attach.md b/docs/user-guide/kubectl/kubectl_attach.md index 14856822d7e85..e6d0126dfcf79 100644 --- a/docs/user-guide/kubectl/kubectl_attach.md +++ b/docs/user-guide/kubectl/kubectl_attach.md @@ -47,13 +47,13 @@ kubectl attach POD -c CONTAINER ### Examples ``` -# get output from running pod 123456-7890, using the first container by default +# Get output from running pod 123456-7890, using the first container by default $ kubectl attach 123456-7890 -# get output from ruby-container from pod 123456-7890 +# Get output from ruby-container from pod 123456-7890 $ kubectl attach 123456-7890 -c ruby-container date -# switch to raw terminal mode, sends stdin to 'bash' in ruby-container from pod 123456-780 +# Switch to raw terminal mode, sends stdin to 'bash' in ruby-container from pod 123456-780 # and sends stdout/stderr from 'bash' back to the client $ kubectl attach 123456-7890 -c ruby-container -i -t ``` @@ -99,7 +99,7 @@ $ kubectl attach 123456-7890 -c ruby-container -i -t * [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra at 2015-08-21 17:18:05.165905157 +0000 UTC +###### Auto generated by spf13/cobra at 2015-09-02 09:55:50.948089316 +0000 UTC [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_attach.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_exec.md b/docs/user-guide/kubectl/kubectl_exec.md index 14d6ae0e74c25..bec8202b442e6 100644 --- a/docs/user-guide/kubectl/kubectl_exec.md +++ b/docs/user-guide/kubectl/kubectl_exec.md @@ -47,13 +47,13 @@ kubectl exec POD [-c CONTAINER] -- COMMAND [args...] ### Examples ``` -# get output from running 'date' from pod 123456-7890, using the first container by default +# Get output from running 'date' from pod 123456-7890, using the first container by default $ kubectl exec 123456-7890 date -# get output from running 'date' in ruby-container from pod 123456-7890 +# Get output from running 'date' in ruby-container from pod 123456-7890 $ kubectl exec 123456-7890 -c ruby-container date -# switch to raw terminal mode, sends stdin to 'bash' in ruby-container from pod 123456-780 +# Switch to raw terminal mode, sends stdin to 'bash' in ruby-container from pod 123456-780 # and sends stdout/stderr from 'bash' back to the client $ kubectl exec 123456-7890 -c ruby-container -i -t -- bash -il ``` @@ -100,7 +100,7 @@ $ kubectl exec 123456-7890 -c ruby-container -i -t -- bash -il * [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra at 2015-08-21 17:18:05.166032952 +0000 UTC +###### Auto generated by spf13/cobra at 2015-09-02 09:55:50.948300118 +0000 UTC [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_exec.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_expose.md b/docs/user-guide/kubectl/kubectl_expose.md index b41ebd0a7890b..a98ed70224f7f 100644 --- a/docs/user-guide/kubectl/kubectl_expose.md +++ b/docs/user-guide/kubectl/kubectl_expose.md @@ -51,13 +51,13 @@ kubectl expose (-f FILENAME | TYPE NAME) --port=port [--protocol=TCP|UDP] [--tar ### Examples ``` -# Creates a service for a replicated nginx, which serves on port 80 and connects to the containers on port 8000. +# 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 -# Creates a service for a replication controller identified by type and name specified in "nginx-controller.yaml", which serves on port 80 and connects to the containers on port 8000. +# Create a service for a replication controller identified by type and name specified in "nginx-controller.yaml", which serves on port 80 and connects to the containers on port 8000. $ kubectl expose -f nginx-controller.yaml --port=80 --target-port=8000 -# Creates a second service based on the above service, exposing the container port 8443 as port 443 with the name "nginx-https" +# Create a second service based on the above service, exposing the container port 8443 as port 443 with the name "nginx-https" $ kubectl expose service nginx --port=443 --target-port=8443 --name=nginx-https # Create a service for a replicated streaming application on port 4100 balancing UDP traffic and named 'video-stream'. @@ -122,7 +122,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-08-28 07:41:48.540439457 +0000 UTC +###### Auto generated by spf13/cobra at 2015-09-03 03:58:51.196935872 +0000 UTC [![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_logs.md b/docs/user-guide/kubectl/kubectl_logs.md index e28dc9116e387..45c36b7ed4b9e 100644 --- a/docs/user-guide/kubectl/kubectl_logs.md +++ b/docs/user-guide/kubectl/kubectl_logs.md @@ -47,13 +47,13 @@ kubectl logs [-f] [-p] POD [-c CONTAINER] ### Examples ``` -# Returns snapshot of ruby-container logs from pod 123456-7890. +# Return snapshot of ruby-container logs from pod 123456-7890. $ kubectl logs 123456-7890 ruby-container -# Returns snapshot of previous terminated ruby-container logs from pod 123456-7890. +# Return snapshot of previous terminated ruby-container logs from pod 123456-7890. $ kubectl logs -p 123456-7890 ruby-container -# Starts streaming of ruby-container logs from pod 123456-7890. +# Start streaming of ruby-container logs from pod 123456-7890. $ kubectl logs -f 123456-7890 ruby-container ``` @@ -99,7 +99,7 @@ $ kubectl logs -f 123456-7890 ruby-container * [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra at 2015-08-21 17:18:05.165044878 +0000 UTC +###### Auto generated by spf13/cobra at 2015-09-02 09:55:50.94749958 +0000 UTC [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_logs.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_port-forward.md b/docs/user-guide/kubectl/kubectl_port-forward.md index 1800978db3c06..84a6780bff661 100644 --- a/docs/user-guide/kubectl/kubectl_port-forward.md +++ b/docs/user-guide/kubectl/kubectl_port-forward.md @@ -48,16 +48,16 @@ kubectl port-forward POD [LOCAL_PORT:]REMOTE_PORT [...[LOCAL_PORT_N:]REMOTE_PORT ``` -# listens on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in the pod +# Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in the pod $ kubectl port-forward mypod 5000 6000 -# listens on port 8888 locally, forwarding to 5000 in the pod +# Listen on port 8888 locally, forwarding to 5000 in the pod $ kubectl port-forward mypod 8888:5000 -# listens on a random port locally, forwarding to 5000 in the pod +# Listen on a random port locally, forwarding to 5000 in the pod $ kubectl port-forward mypod :5000 -# listens on a random port locally, forwarding to 5000 in the pod +# Listen on a random port locally, forwarding to 5000 in the pod $ kubectl port-forward mypod 0:5000 ``` @@ -100,7 +100,7 @@ $ kubectl port-forward mypod 0:5000 * [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra at 2015-08-21 17:18:05.166148947 +0000 UTC +###### Auto generated by spf13/cobra at 2015-09-02 09:55:50.948456523 +0000 UTC [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_port-forward.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_run.md b/docs/user-guide/kubectl/kubectl_run.md index 54a7c3b4a95ac..1e96ae8a74b26 100644 --- a/docs/user-guide/kubectl/kubectl_run.md +++ b/docs/user-guide/kubectl/kubectl_run.md @@ -48,10 +48,10 @@ kubectl run NAME --image=image [--port=port] [--replicas=replicas] [--dry-run=bo ### Examples ``` -# Starts a single instance of nginx. +# Start a single instance of nginx. $ kubectl run nginx --image=nginx -# Starts a replicated instance of nginx. +# Start a replicated instance of nginx. $ kubectl run nginx --image=nginx --replicas=5 # Dry run. Print the corresponding API objects without creating them. @@ -127,7 +127,7 @@ $ kubectl run nginx --image=nginx --command -- ... * [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra at 2015-08-26 09:03:39.976311407 +0000 UTC +###### Auto generated by spf13/cobra at 2015-09-02 09:55:50.948932668 +0000 UTC [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_run.md?pixel)]() diff --git a/pkg/kubectl/cmd/attach.go b/pkg/kubectl/cmd/attach.go index 4830d53a6f72c..e3433121d176b 100644 --- a/pkg/kubectl/cmd/attach.go +++ b/pkg/kubectl/cmd/attach.go @@ -33,13 +33,13 @@ import ( ) const ( - attach_example = `# get output from running pod 123456-7890, using the first container by default + attach_example = `# Get output from running pod 123456-7890, using the first container by default $ kubectl attach 123456-7890 -# get output from ruby-container from pod 123456-7890 +# Get output from ruby-container from pod 123456-7890 $ kubectl attach 123456-7890 -c ruby-container date -# switch to raw terminal mode, sends stdin to 'bash' in ruby-container from pod 123456-780 +# Switch to raw terminal mode, sends stdin to 'bash' in ruby-container from pod 123456-780 # and sends stdout/stderr from 'bash' back to the client $ kubectl attach 123456-7890 -c ruby-container -i -t` ) diff --git a/pkg/kubectl/cmd/exec.go b/pkg/kubectl/cmd/exec.go index 5d5feb15686a7..97fc428ceb0bb 100644 --- a/pkg/kubectl/cmd/exec.go +++ b/pkg/kubectl/cmd/exec.go @@ -33,13 +33,13 @@ import ( ) const ( - exec_example = `# get output from running 'date' from pod 123456-7890, using the first container by default + exec_example = `# Get output from running 'date' from pod 123456-7890, using the first container by default $ kubectl exec 123456-7890 date -# get output from running 'date' in ruby-container from pod 123456-7890 +# Get output from running 'date' in ruby-container from pod 123456-7890 $ kubectl exec 123456-7890 -c ruby-container date -# switch to raw terminal mode, sends stdin to 'bash' in ruby-container from pod 123456-780 +# Switch to raw terminal mode, sends stdin to 'bash' in ruby-container from pod 123456-780 # and sends stdout/stderr from 'bash' back to the client $ kubectl exec 123456-7890 -c ruby-container -i -t -- bash -il` ) diff --git a/pkg/kubectl/cmd/expose.go b/pkg/kubectl/cmd/expose.go index bc210489ff0c8..033dd517e5c4f 100644 --- a/pkg/kubectl/cmd/expose.go +++ b/pkg/kubectl/cmd/expose.go @@ -40,13 +40,13 @@ Looks up a replication controller or service by name and uses the selector for t selector for a new Service on the specified port. If no labels are specified, the new service will re-use the labels from the resource it exposes.` - expose_example = `# Creates a service for a replicated nginx, which serves on port 80 and connects to the containers on port 8000. + 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 -# Creates a service for a replication controller identified by type and name specified in "nginx-controller.yaml", which serves on port 80 and connects to the containers on port 8000. +# Create a service for a replication controller identified by type and name specified in "nginx-controller.yaml", which serves on port 80 and connects to the containers on port 8000. $ kubectl expose -f nginx-controller.yaml --port=80 --target-port=8000 -# Creates a second service based on the above service, exposing the container port 8443 as port 443 with the name "nginx-https" +# Create a second service based on the above service, exposing the container port 8443 as port 443 with the name "nginx-https" $ kubectl expose service nginx --port=443 --target-port=8443 --name=nginx-https # Create a service for a replicated streaming application on port 4100 balancing UDP traffic and named 'video-stream'. diff --git a/pkg/kubectl/cmd/log.go b/pkg/kubectl/cmd/log.go index e81ffda05ee94..c96d4e110862c 100644 --- a/pkg/kubectl/cmd/log.go +++ b/pkg/kubectl/cmd/log.go @@ -29,13 +29,13 @@ import ( ) const ( - log_example = `# Returns snapshot of ruby-container logs from pod 123456-7890. + log_example = `# Return snapshot of ruby-container logs from pod 123456-7890. $ kubectl logs 123456-7890 ruby-container -# Returns snapshot of previous terminated ruby-container logs from pod 123456-7890. +# Return snapshot of previous terminated ruby-container logs from pod 123456-7890. $ kubectl logs -p 123456-7890 ruby-container -# Starts streaming of ruby-container logs from pod 123456-7890. +# Start streaming of ruby-container logs from pod 123456-7890. $ kubectl logs -f 123456-7890 ruby-container` ) diff --git a/pkg/kubectl/cmd/portforward.go b/pkg/kubectl/cmd/portforward.go index 742c26d918551..75b11603a8f13 100644 --- a/pkg/kubectl/cmd/portforward.go +++ b/pkg/kubectl/cmd/portforward.go @@ -30,16 +30,16 @@ import ( const ( portforward_example = ` -# listens on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in the pod +# Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in the pod $ kubectl port-forward mypod 5000 6000 -# listens on port 8888 locally, forwarding to 5000 in the pod +# Listen on port 8888 locally, forwarding to 5000 in the pod $ kubectl port-forward mypod 8888:5000 -# listens on a random port locally, forwarding to 5000 in the pod +# Listen on a random port locally, forwarding to 5000 in the pod $ kubectl port-forward mypod :5000 -# listens on a random port locally, forwarding to 5000 in the pod +# Listen on a random port locally, forwarding to 5000 in the pod $ kubectl port-forward mypod 0:5000` ) diff --git a/pkg/kubectl/cmd/run.go b/pkg/kubectl/cmd/run.go index 877265f8fbadd..db04d4ff99dff 100644 --- a/pkg/kubectl/cmd/run.go +++ b/pkg/kubectl/cmd/run.go @@ -35,10 +35,10 @@ import ( const ( run_long = `Create and run a particular image, possibly replicated. Creates a replication controller to manage the created container(s).` - run_example = `# Starts a single instance of nginx. + run_example = `# Start a single instance of nginx. $ kubectl run nginx --image=nginx -# Starts a replicated instance of nginx. +# Start a replicated instance of nginx. $ kubectl run nginx --image=nginx --replicas=5 # Dry run. Print the corresponding API objects without creating them.