mirror of
https://github.com/k3s-io/kubernetes.git
synced 2025-07-23 03:41:45 +00:00
Fixes upper case letters in kubectl examples
This commit is contained in:
parent
9c4802420b
commit
0427711c42
@ -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
|
||||
|
||||
|
@ -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
|
||||
|
||||
|
@ -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'.
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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.
|
||||
|
@ -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
|
||||
|
||||
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
|
||||
[]()
|
||||
|
@ -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
|
||||
|
||||
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
|
||||
[]()
|
||||
|
@ -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
|
||||
|
||||
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
|
||||
[]()
|
||||
|
@ -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
|
||||
|
||||
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
|
||||
[]()
|
||||
|
@ -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
|
||||
|
||||
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
|
||||
[]()
|
||||
|
@ -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 -- <cmd> <arg1> ... <argN>
|
||||
|
||||
* [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
|
||||
|
||||
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
|
||||
[]()
|
||||
|
@ -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`
|
||||
)
|
||||
|
@ -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`
|
||||
)
|
||||
|
@ -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'.
|
||||
|
@ -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`
|
||||
)
|
||||
|
||||
|
@ -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`
|
||||
)
|
||||
|
||||
|
@ -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.
|
||||
|
Loading…
Reference in New Issue
Block a user