kubernetes
/
website
mirror of https://github.com/kubernetes/website.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update references to "kubectl run" in docs

pull/262/head
Janet Kuo 2016-03-28 10:58:08 -07:00
parent d3cd373942
commit 6c669037ba
7 changed files with 107 additions and 109 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/admin/limitrange/index.md
View File

@ -95,16 +95,16 @@ were previously created in a namespace.
If a resource (cpu or memory) is being restricted by a limit, the user will get an error at time If a resource (cpu or memory) is being restricted by a limit, the user will get an error at time
of creation explaining why. of creation explaining why.
Let's first spin up a replication controller that creates a single container pod to demonstrate Let's first spin up a deployment that creates a single container pod to demonstrate
how default values are applied to each pod. how default values are applied to each pod.
```shell ```shell
$ kubectl run nginx --image=nginx --replicas=1 --namespace=limit-example $ kubectl run nginx --image=nginx --replicas=1 --namespace=limit-example
replicationcontroller "nginx" created deployment "nginx" created
$ kubectl get pods --namespace=limit-example $ kubectl get pods --namespace=limit-example
NAME READY STATUS RESTARTS AGE NAME READY STATUS RESTARTS AGE
nginx-aq0mf 1/1 Running 0 35s nginx-2040093540-s8vzu 1/1 Running 0 11s
$ kubectl get pods nginx-aq0mf --namespace=limit-example -o yaml | grep resources -C 8 $ kubectl get pods nginx-2040093540-s8vzu --namespace=limit-example -o yaml | grep resources -C 8
``` ```
```yaml ```yaml

59
docs/admin/namespaces/index.md
View File

@ -17,12 +17,12 @@ This example demonstrates how to use Kubernetes namespaces to subdivide your clu
This example assumes the following: This example assumes the following:
1. You have an [existing Kubernetes cluster](/docs/getting-started-guides/). 1. You have an [existing Kubernetes cluster](/docs/getting-started-guides/).
2. You have a basic understanding of Kubernetes _[pods](/docs/user-guide/pods)_, _[services](/docs/user-guide/services)_, and _[replication controllers](/docs/user-guide/replication-controller)_. 2. You have a basic understanding of Kubernetes _[Pods](/docs/user-guide/pods)_, _[Services](/docs/user-guide/services)_, and _[Deployments](/docs/user-guide/deployments)_.
### Step One: Understand the default namespace ### Step One: Understand the default namespace
By default, a Kubernetes cluster will instantiate a default namespace when provisioning the cluster to hold the default set of pods, By default, a Kubernetes cluster will instantiate a default namespace when provisioning the cluster to hold the default set of Pods,
services, and replication controllers used by the cluster. Services, and Deployments used by the cluster.
Assuming you have a fresh cluster, you can introspect the available namespace's by doing the following: Assuming you have a fresh cluster, you can introspect the available namespace's by doing the following:
@ -38,12 +38,12 @@ For this exercise, we will create two additional Kubernetes namespaces to hold o
Let's imagine a scenario where an organization is using a shared Kubernetes cluster for development and production use cases. Let's imagine a scenario where an organization is using a shared Kubernetes cluster for development and production use cases.
The development team would like to maintain a space in the cluster where they can get a view on the list of pods, services, and replication controllers The development team would like to maintain a space in the cluster where they can get a view on the list of Pods, Services, and Deployments
they use to build and run their application. In this space, Kubernetes resources come and go, and the restrictions on who can or cannot modify resources they use to build and run their application. In this space, Kubernetes resources come and go, and the restrictions on who can or cannot modify resources
are relaxed to enable agile development. are relaxed to enable agile development.
The operations team would like to maintain a space in the cluster where they can enforce strict procedures on who can or cannot manipulate the set of The operations team would like to maintain a space in the cluster where they can enforce strict procedures on who can or cannot manipulate the set of
pods, services, and replication controllers that run the production site. pods, services, and Deployments that run the production site.
One pattern this organization could follow is to partition the Kubernetes cluster into two namespaces: development and production. One pattern this organization could follow is to partition the Kubernetes cluster into two namespaces: development and production.
@ -77,11 +77,11 @@ production name=production Active
### Step Three: Create pods in each namespace ### Step Three: Create pods in each namespace
A Kubernetes namespace provides the scope for pods, services, and replication controllers in the cluster. A Kubernetes namespace provides the scope for Pods, Services, and Deployments in the cluster.
Users interacting with one namespace do not see the content in another namespace. Users interacting with one namespace do not see the content in another namespace.
To demonstrate this, let's spin up a simple replication controller and pod in the development namespace. To demonstrate this, let's spin up a simple Deployment and Pods in the development namespace.
We first check what is the current context: We first check what is the current context:
@ -178,18 +178,18 @@ Let's create some content.
```shell ```shell
$ kubectl run snowflake --image=kubernetes/serve_hostname --replicas=2 $ kubectl run snowflake --image=kubernetes/serve_hostname --replicas=2
``` ```
We have just created a deployment whose replica size is 2 that is running the pod called snowflake with a basic container that just serves the hostname.
We have just created a replication controller whose replica size is 2 that is running the pod called snowflake with a basic container that just serves the hostname. Note that `kubectl run` creates deployments only on kubernetes cluster >= v1.2. If you are running older versions, it creates replication controllers instead.
```shell ```shell
$ kubectl get rc $ kubectl get deployment
CONTROLLER CONTAINER(S) IMAGE(S) SELECTOR REPLICAS NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE
snowflake snowflake kubernetes/serve_hostname run=snowflake 2 snowflake 2 2 2 2 2m
$ kubectl get pods $ kubectl get pods -l run=snowflake
NAME READY STATUS RESTARTS AGE NAME READY STATUS RESTARTS AGE
snowflake-8w0qn 1/1 Running 0 22s snowflake-3968820950-9dgr8 1/1 Running 0 2m
snowflake-jrpzb 1/1 Running 0 22s snowflake-3968820950-vgc4n 1/1 Running 0 2m
``` ```
And this is great, developers are able to do what they want, and they do not have to worry about affecting content in the production namespace. And this is great, developers are able to do what they want, and they do not have to worry about affecting content in the production namespace.
@ -200,14 +200,11 @@ Let's switch to the production namespace and show how resources in one namespace
$ kubectl config use-context prod $ kubectl config use-context prod
``` ```
The production namespace should be empty. The production namespace should be empty, and the following commands should return nothing.
```shell ```shell
$ kubectl get rc $ kubectl get deployment
CONTROLLER CONTAINER(S) IMAGE(S) SELECTOR REPLICAS
$ kubectl get pods $ kubectl get pods
NAME READY STATUS RESTARTS AGE
``` ```
Production likes to run cattle, so let's create some cattle pods. Production likes to run cattle, so let's create some cattle pods.
@ -215,17 +212,17 @@ Production likes to run cattle, so let's create some cattle pods.
```shell ```shell
$ kubectl run cattle --image=kubernetes/serve_hostname --replicas=5 $ kubectl run cattle --image=kubernetes/serve_hostname --replicas=5
$ kubectl get rc $ kubectl get deployment
CONTROLLER CONTAINER(S) IMAGE(S) SELECTOR REPLICAS NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE
cattle cattle kubernetes/serve_hostname run=cattle 5 cattle 5 5 5 5 10s
$ kubectl get pods kubectl get pods -l run=cattle
NAME READY STATUS RESTARTS AGE NAME READY STATUS RESTARTS AGE
cattle-97rva 1/1 Running 0 12s cattle-2263376956-41xy6 1/1 Running 0 34s
cattle-i9ojn 1/1 Running 0 12s cattle-2263376956-kw466 1/1 Running 0 34s
cattle-qj3yv 1/1 Running 0 12s cattle-2263376956-n4v97 1/1 Running 0 34s
cattle-yc7vn 1/1 Running 0 12s cattle-2263376956-p5p3i 1/1 Running 0 34s
cattle-zz7ea 1/1 Running 0 12s cattle-2263376956-sxpth 1/1 Running 0 34s
``` ```
At this point, it should be clear that the resources users create in one namespace are hidden from the other namespace. At this point, it should be clear that the resources users create in one namespace are hidden from the other namespace.

38
docs/admin/resourcequota/index.md
View File

@ -69,38 +69,40 @@ Pod authors rarely specify resource requests and limits for their pods.
Since we applied a quota to our project, let's see what happens when an end-user creates a pod that has unbounded Since we applied a quota to our project, let's see what happens when an end-user creates a pod that has unbounded
cpu and memory by creating an nginx container. cpu and memory by creating an nginx container.
To demonstrate, lets create a replication controller that runs nginx: To demonstrate, lets create a Deployment that runs nginx:
```shell ```shell
$ kubectl run nginx --image=nginx --replicas=1 --namespace=quota-example $ kubectl run nginx --image=nginx --replicas=1 --namespace=quota-example
replicationcontroller "nginx" created deployment "nginx" created
``` ```
Now let's look at the pods that were created. This creates a Deployment "nginx" with its underlying resource, a ReplicaSet, which handles the creation and deletion of Pod replicas. Now let's look at the pods that were created.
```shell ```shell
$ kubectl get pods --namespace=quota-example $ kubectl get pods --namespace=quota-example
NAME READY STATUS RESTARTS AGE NAME READY STATUS RESTARTS AGE
``` ```
What happened? I have no pods! Let's describe the replication controller to get a view of what is happening. What happened? I have no pods! Let's describe the ReplicaSet managed by the nginx Deployment to get a view of what is happening.
Note that `kubectl describe rs` works only on kubernetes cluster >= v1.2. If you are running older versions, use `kubectl describe rc` instead.
```shell ```shell
kubectl describe rc nginx --namespace=quota-example $ kubectl describe rs -l run=nginx --namespace=quota-example
Name: nginx Name: nginx-2040093540
Namespace: quota-example Namespace: quota-example
Image(s): nginx Image(s): nginx
Selector: run=nginx Selector: pod-template-hash=2040093540,run=nginx
Labels: run=nginx Labels: pod-template-hash=2040093540,run=nginx
Replicas: 0 current / 1 desired Replicas: 0 current / 1 desired
Pods Status: 0 Running / 0 Waiting / 0 Succeeded / 0 Failed Pods Status: 0 Running / 0 Waiting / 0 Succeeded / 0 Failed
No volumes. No volumes.
Events: Events:
FirstSeen LastSeen Count From SubobjectPath Reason Message FirstSeen LastSeen Count From SubobjectPath Type Reason Message
42s 11s 3 {replication-controller } FailedCreate Error creating: Pod "nginx-" is forbidden: Must make a non-zero request for memory since it is tracked by quota. --------- -------- ----- ---- ------------- -------- ------ -------
48s 26s 4 {replicaset-controller } Warning FailedCreate Error creating: pods "nginx-2040093540-" is forbidden: Failed quota: quota: must specify cpu,memory
``` ```
The Kubernetes API server is rejecting the replication controllers requests to create a pod because our pods The Kubernetes API server is rejecting the ReplicaSet requests to create a pod because our pods
do not specify any memory usage *request*. do not specify any memory usage *request*.
So let's set some default values for the amount of cpu and memory a pod can consume: So let's set some default values for the amount of cpu and memory a pod can consume:
@ -111,22 +113,22 @@ limitrange "limits" created
$ kubectl describe limits limits --namespace=quota-example $ kubectl describe limits limits --namespace=quota-example
Name: limits Name: limits
Namespace: quota-example Namespace: quota-example
Type Resource Min Max Request Limit Limit/Request Type Resource Min Max Default Request Default Limit Max Limit/Request Ratio
---- -------- --- --- ------- ----- ------------- ---- -------- --- --- --------------- ------------- -----------------------
Container memory - - 256Mi 512Mi - Container cpu - - 100m 200m -
Container cpu - - 100m 200m - Container memory - - 256Mi 512Mi -
``` ```
Now any time a pod is created in this namespace, if it has not specified any resource request/limit, the default Now any time a pod is created in this namespace, if it has not specified any resource request/limit, the default
amount of cpu and memory per container will be applied, and the request will be used as part of admission control. amount of cpu and memory per container will be applied, and the request will be used as part of admission control.
Now that we have applied default resource *request* for our namespace, our replication controller should be able to Now that we have applied default resource *request* for our namespace, our Deployment should be able to
create its pods. create its pods.
```shell ```shell
$ kubectl get pods --namespace=quota-example $ kubectl get pods --namespace=quota-example
NAME READY STATUS RESTARTS AGE NAME READY STATUS RESTARTS AGE
nginx-fca65 1/1 Running 0 1m nginx-2040093540-miohp 1/1 Running 0 5s
``` ```
And if we print out our quota usage in the namespace: And if we print out our quota usage in the namespace:

2
docs/user-guide/config-best-practices.md
View File

@ -108,6 +108,6 @@ This document is meant to highlight and consolidate in one place configuration b
- Use kubectl bulk operations (via files and/or labels) for get and delete. See [label selectors](/docs/user-guide/labels/#label-selectors) and [using labels effectively](/docs/user-guide/managing-deployments/#using-labels-effectively). - Use kubectl bulk operations (via files and/or labels) for get and delete. See [label selectors](/docs/user-guide/labels/#label-selectors) and [using labels effectively](/docs/user-guide/managing-deployments/#using-labels-effectively).
- Use `kubectl run` and `expose` to quickly create and expose single container replication controllers. See the [quick start guide](/docs/user-guide/quick-start/) for an example. - Use `kubectl run` and `expose` to quickly create and expose single container Deployments. See the [quick start guide](/docs/user-guide/quick-start/) for an example.

25
docs/user-guide/debugging-services.md
View File

@ -3,7 +3,7 @@
An issue that comes up rather frequently for new installations of Kubernetes is An issue that comes up rather frequently for new installations of Kubernetes is
that `Services` are not working properly. You've run all your `Pod`s and that `Services` are not working properly. You've run all your `Pod`s and
`ReplicationController`s, but you get no response when you try to access them. `Deployment`s, but you get no response when you try to access them.
This document will hopefully help you to figure out what's going wrong. This document will hopefully help you to figure out what's going wrong.
* TOC * TOC
@ -85,16 +85,15 @@ $ kubectl run hostnames --image=gcr.io/google_containers/serve_hostname \
--labels=app=hostnames \ --labels=app=hostnames \
--port=9376 \ --port=9376 \
--replicas=3 --replicas=3
CONTROLLER CONTAINER(S) IMAGE(S) SELECTOR REPLICAS deployment "hostnames" created
hostnames hostnames gcr.io/google_containers/serve_hostname app=hostnames 3
``` ```
Note that this is the same as if you had started the `ReplicationController` with Note that this is the same as if you had started the `Deployment` with
the following YAML: the following YAML:
```yaml ```yaml
apiVersion: v1 apiVersion: extensions/v1beta1
kind: ReplicationController kind: Deployment
metadata: metadata:
name: hostnames name: hostnames
spec: spec:
@ -118,10 +117,10 @@ Confirm your `Pod`s are running:
```shell ```shell
$ kubectl get pods -l app=hostnames $ kubectl get pods -l app=hostnames
NAME READY STATUS RESTARTS AGE NAME READY STATUS RESTARTS AGE
hostnames-0uton 1/1 Running 0 12s hostnames-632524106-bbpiw 1/1 Running 0 2m
hostnames-bvc05 1/1 Running 0 12s hostnames-632524106-ly40y 1/1 Running 0 2m
hostnames-yp2kp 1/1 Running 0 12s hostnames-632524106-tlaok 1/1 Running 0 2m
``` ```
## Does the Service exist? ## Does the Service exist?
@ -156,7 +155,7 @@ So we have a culprit, let's create the `Service`. As before, this is for the
walk-through - you can use your own `Service`'s details here. walk-through - you can use your own `Service`'s details here.
```shell ```shell
$ kubectl expose rc hostnames --port=80 --target-port=9376 $ kubectl expose deployment hostnames --port=80 --target-port=9376
service "hostnames" exposed service "hostnames" exposed
``` ```
@ -164,8 +163,8 @@ And read it back, just to be sure:
```shell ```shell
$ kubectl get svc hostnames $ kubectl get svc hostnames
NAME CLUSTER_IP EXTERNAL_IP PORT(S) SELECTOR AGE NAME CLUSTER-IP EXTERNAL-IP PORT(S) AGE
hostnames 10.0.0.1 <none> 80/TCP run=hostnames 1h hostnames 10.0.0.226 <none> 80/TCP 5s
``` ```
As before, this is the same as if you had started the `Service` with YAML: As before, this is the same as if you had started the `Service` with YAML:

36
docs/user-guide/docker-cli-to-kubectl.md
View File

@ -8,7 +8,7 @@ In this doc, we introduce the Kubernetes command line for interacting with the a
#### docker run #### docker run
How do I run an nginx container and expose it to the world? Checkout [kubectl run](/docs/user-guide/kubectl/kubectl_run). How do I run an nginx Deployment and expose it to the world? Checkout [kubectl run](/docs/user-guide/kubectl/kubectl_run).
With docker: With docker:
@ -25,12 +25,13 @@ With kubectl:
```shell ```shell
# start the pod running nginx # start the pod running nginx
$ kubectl run --image=nginx nginx-app --port=80 --env="DOMAIN=cluster" $ kubectl run --image=nginx nginx-app --port=80 --env="DOMAIN=cluster"
replicationcontroller "nginx-app" created deployment "nginx-app" created
# expose a port through with a service # expose a port through with a service
$ kubectl expose rc nginx-app --port=80 --name=nginx-http $ kubectl expose deployment nginx-app --port=80 --name=nginx-http
service "nginx-http" exposed
``` ```
With kubectl, we create a [replication controller](/docs/user-guide/replication-controller) which will make sure that N pods are running nginx (where N is the number of replicas stated in the spec, which defaults to 1). We also create a [service](/docs/user-guide/services) with a selector that matches the replication controller's selector. See the [Quick start](/docs/user-guide/quick-start) for more information. With kubectl, we create a [Deployment](/docs/user-guide/deployments) which will make sure that N pods are running nginx (where N is the number of replicas stated in the spec, which defaults to 1). We also create a [service](/docs/user-guide/services) with a selector that matches the Deployment's selector. See the [Quick start](/docs/user-guide/quick-start) for more information.
By default images are run in the background, similar to `docker run -d ...`, if you want to run things in the foreground, use: By default images are run in the background, similar to `docker run -d ...`, if you want to run things in the foreground, use:
@ -40,8 +41,8 @@ kubectl run [-i] [--tty] --attach <name> --image=<image>
Unlike `docker run ...`, if `--attach` is specified, we attach to `stdin`, `stdout` and `stderr`, there is no ability to control which streams are attached (`docker -a ...`). Unlike `docker run ...`, if `--attach` is specified, we attach to `stdin`, `stdout` and `stderr`, there is no ability to control which streams are attached (`docker -a ...`).
Because we start a replication controller for your container, it will be restarted if you terminate the attached process (e.g. `ctrl-c`), this is different than `docker run -it`. Because we start a Deployment for your container, it will be restarted if you terminate the attached process (e.g. `ctrl-c`), this is different than `docker run -it`.
To destroy the replication controller (and it's pods) you need to run `kubectl delete rc <name>` To destroy the Deployment (and its pods) you need to run `kubectl delete deployment <name>`
#### docker ps #### docker ps
@ -180,20 +181,19 @@ a9ec34d98787
With kubectl: With kubectl:
```shell ```shell
$ kubectl get rc nginx-app $ kubectl get deployment nginx-app
CONTROLLER CONTAINER(S) IMAGE(S) SELECTOR REPLICAS NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE
nginx-app nginx-app nginx run=nginx-app 1 nginx-app 1 1 1 1 2m
$ kubectl get po $ kubectl get po -l run=nginx-app
NAME READY STATUS RESTARTS AGE NAME READY STATUS RESTARTS AGE
nginx-app-aualv 1/1 Running 0 16s nginx-app-2883164633-aklf7 1/1 Running 0 2m
$ kubectl delete rc nginx-app $ kubectl delete deployment nginx-app
NAME READY STATUS RESTARTS AGE deployment "nginx-app" deleted
nginx-app-aualv 1/1 Running 0 16s $ kubectl get po -l run=nginx-app
$ kubectl get po # Return nothing
NAME READY STATUS RESTARTS AGE
``` ```
Notice that we don't delete the pod directly. With kubectl we want to delete the replication controller that owns the pod. If we delete the pod directly, the replication controller will recreate the pod. Notice that we don't delete the pod directly. With kubectl we want to delete the Deployment that owns the pod. If we delete the pod directly, the Deployment will recreate the pod.
#### docker login #### docker login

36
docs/user-guide/pods/single-container.md
View File

@ -14,11 +14,11 @@ as storage volumes and IP addresses.
Single-container pods can be created with the `run` command. The Single-container pods can be created with the `run` command. The
pod's properties are specified with flags on the command line. pod's properties are specified with flags on the command line.
The `run` command creates a replication controller to monitor the pod(s). The `run` command creates a Deployment to monitor the pod(s).
The controller watches for failed pods and will start up new pods as required The Deployment watches for failed pods and will start up new pods as required
to maintain the specified number. to maintain the specified number.
Note: If you don't want a replication controller to monitor your pod (e.g. your pod Note: If you don't want a Deployment to monitor your pod (e.g. your pod
is writing non-persistent data which won't survive a restart, or your pod is is writing non-persistent data which won't survive a restart, or your pod is
intended to be very short-lived), you can intended to be very short-lived), you can
[create a pod directly with the `create` command](/docs/user-guide/pods/multi-container/). [create a pod directly with the `create` command](/docs/user-guide/pods/multi-container/).
@ -36,16 +36,16 @@ $ kubectl run NAME
Where: Where:
* `NAME` (required) is the name of the container to create. This value is also * `NAME` (required) is the name of the container to create. This value is also
applied as the name of the replication controller, and as the prefix of the applied as the name of the Deployment, and as the prefix of the
pod name. For example: pod name. For example:
```shell ```shell
$ kubectl run example --image=nginx $ kubectl run example --image=nginx
replicationcontroller "example" created deployment "example" created
$ kubectl get pods $ kubectl get pods -l run=example
NAME READY STATUS RESTARTS AGE NAME READY STATUS RESTARTS AGE
example-xypvc 1/1 Running 0 13s example-1934187764-scau1 1/1 Running 0 13s
``` ```
* `--image=IMAGE` (required) is the Docker container image to use for this * `--image=IMAGE` (required) is the Docker container image to use for this
container. container.
@ -54,7 +54,7 @@ Where:
one pod will be created. one pod will be created.
* `--labels=key=value` specifies one or more labels to attach to the pod. In * `--labels=key=value` specifies one or more labels to attach to the pod. In
addition to any labels specified here, `run` attaches a label of addition to any labels specified here, `run` attaches a label of
the format `run=NAME`. This is used by the replication controller the format `run=NAME`. This is used by the Deployment
to target the pods created by the command. to target the pods created by the command.
There are additional flags that can be specified. For a complete list, run: There are additional flags that can be specified. For a complete list, run:
@ -68,21 +68,21 @@ There are additional flags that can be specified. For a complete list, run:
## Deleting a pod ## Deleting a pod
If your pod was created using the `run` command, kubernetes creates a If your pod was created using the `run` command, kubernetes creates a
[replication controller](/docs/user-guide/replication-controller/) [Deployment](/docs/user-guide/deployments/)
to manage the pod. Pods managed by a replication controller are rescheduled if to manage the pod. Pods managed by a Deployment are rescheduled if
they go away, including being deleted by `kubectl delete pod`. To permanently they go away, including being deleted by `kubectl delete pod`. To permanently
delete the pod, delete its replication controller. delete the pod, delete its Deployment.
First, find the controller's name: First, find the Deployment's name:
```shell ```shell
$ kubectl get rc $ kubectl get deployment
CONTROLLER CONTAINER(S) IMAGE(S) SELECTOR REPLICAS NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE
example example busybox run=example 1 example 1 1 1 1 1m
``` ```
Then, `delete` the controller: Then, `delete` the Deployment:
```shell ```shell
$ kubectl delete rc CONTROLLER_NAME $ kubectl delete deployment DEPLOYMENT_NAME
``` ```