From 945878d0722ab3fa4a8626dfed549aab59d35feb Mon Sep 17 00:00:00 2001 From: Denis Kolodin Date: Sun, 16 Oct 2016 12:23:27 +0300 Subject: [PATCH 1/8] Separate docker's args --- docs/hellonode.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/hellonode.md b/docs/hellonode.md index 602a383a5b..0392dc994b 100755 --- a/docs/hellonode.md +++ b/docs/hellonode.md @@ -145,7 +145,7 @@ docker stop hello_tutorial Now that the image works as intended and is all tagged with your `$PROJECT_ID`, we can push it to the [Google Container Registry](https://cloud.google.com/tools/container-registry/), a private repository for your Docker images accessible from every Google Cloud project (but also from outside Google Cloud Platform) : ```shell -gcloud docker push gcr.io/$PROJECT_ID/hello-node:v1 +gcloud docker -- push gcr.io/$PROJECT_ID/hello-node:v1 ``` If all goes well, you should be able to see the container image listed in the console: *Compute > Container Engine > Container Registry*. We now have a project-wide Docker image available which Kubernetes can access and orchestrate. @@ -336,7 +336,7 @@ We can now build and publish a new container image to the registry with an incre ```shell docker build -t gcr.io/$PROJECT_ID/hello-node:v2 . -gcloud docker push gcr.io/$PROJECT_ID/hello-node:v2 +gcloud docker -- push gcr.io/$PROJECT_ID/hello-node:v2 ``` Building and pushing this updated image should be much quicker as we take full advantage of the Docker cache. From 2b595523a5e4fe0d9237d8fef9efc02d685357b9 Mon Sep 17 00:00:00 2001 From: Denis Andrejew Date: Tue, 29 Nov 2016 16:00:28 +0000 Subject: [PATCH 2/8] fix broken link in config-best-practices.md broken link was caused by `frontend-controller.yaml` having been replaced with `frontend-deployment.yaml` --- docs/user-guide/config-best-practices.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/config-best-practices.md b/docs/user-guide/config-best-practices.md index 911ebbb79c..5cafa35f60 100644 --- a/docs/user-guide/config-best-practices.md +++ b/docs/user-guide/config-best-practices.md @@ -21,7 +21,7 @@ This document is meant to highlight and consolidate in one place configuration b - Don't specify default values unnecessarily, in order to simplify and minimize configs, and to reduce error. For example, omit the selector and labels in a `ReplicationController` if you want them to be the same as the labels in its `podTemplate`, since those fields are populated from the - `podTemplate` labels by default. See the [guestbook app's](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/guestbook/) .yaml files for some [examples](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/guestbook/frontend-controller.yaml) of this. + `podTemplate` labels by default. See the [guestbook app's](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/guestbook/) .yaml files for some [examples](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/guestbook/frontend-deployment.yaml) of this. - Put an object description in an annotation to allow better introspection. From dc0955b58c5df86ff060a270afe97545866affe1 Mon Sep 17 00:00:00 2001 From: bruceauyeung Date: Mon, 5 Dec 2016 16:33:17 +0800 Subject: [PATCH 3/8] fix incorrect link and other doc errors Signed-off-by: bruceauyeung --- docs/tutorials/kubernetes-basics/cluster-intro.html | 4 ++-- docs/tutorials/kubernetes-basics/explore-intro.html | 6 +++--- docs/tutorials/kubernetes-basics/scale-intro.html | 2 +- docs/tutorials/kubernetes-basics/update-intro.html | 6 +++--- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/tutorials/kubernetes-basics/cluster-intro.html b/docs/tutorials/kubernetes-basics/cluster-intro.html index eb7835e242..b0f72dc9eb 100644 --- a/docs/tutorials/kubernetes-basics/cluster-intro.html +++ b/docs/tutorials/kubernetes-basics/cluster-intro.html @@ -72,7 +72,7 @@ redirect_from:
-

The Master is responsible for managing the cluster. The master coordinates all activity in your cluster, such as scheduling applications, maintaining applications' desired state, scaling applications, and rolling out new updates.

+

The Master is responsible for managing the cluster. The master coordinates all activities in your cluster, such as scheduling applications, maintaining applications' desired state, scaling applications, and rolling out new updates.

A node is a VM or a physical computer that serves as a worker machine in a Kubernetes cluster. Each node has a Kubelet, which is an agent for managing the node and communicating with the Kubernetes master. The node should also have tools for handling container operations, such as Docker or rkt. A Kubernetes cluster that handles production traffic should have a minimum of three nodes.

@@ -87,7 +87,7 @@ redirect_from:

When you deploy applications on Kubernetes, you tell the master to start the application containers. The master schedules the containers to run on the cluster's nodes. The nodes communicate with the master using the Kubernetes API, which the master exposes. End users can also use the Kubernetes API directly to interact with the cluster.

-

A Kubernetes cluster can be deployed on either physical or virtual machines. To get started with Kubernetes development, you can use minikube. Minikube is a lightweight Kubernetes implementation that creates a VM on your local machine and deploys a simple cluster containing only one node. Minikube is available for Linux, Mac OS and Windows systems. The minikube CLI provides basic bootstrapping operations for working with your cluster, including start, stop, status, and delete. For this bootcamp, however, you'll use a provided online terminal with minikube pre-installed.

+

A Kubernetes cluster can be deployed on either physical or virtual machines. To get started with Kubernetes development, you can use Minikube. Minikube is a lightweight Kubernetes implementation that creates a VM on your local machine and deploys a simple cluster containing only one node. Minikube is available for Linux, Mac OS and Windows systems. The Minikube CLI provides basic bootstrapping operations for working with your cluster, including start, stop, status, and delete. For this bootcamp, however, you'll use a provided online terminal with Minikube pre-installed.

Now that you know what Kubernetes is, let’s go to the online tutorial and start our first cluster!

diff --git a/docs/tutorials/kubernetes-basics/explore-intro.html b/docs/tutorials/kubernetes-basics/explore-intro.html index 23dd27714b..b288062650 100644 --- a/docs/tutorials/kubernetes-basics/explore-intro.html +++ b/docs/tutorials/kubernetes-basics/explore-intro.html @@ -27,7 +27,7 @@

Kubernetes Pods

-

When you created a Deployment in Module 2, Kubernetes created a Pod to host your application instance. A Pod is Kubernetes abstraction that represents a group of one or more application containers (such as Docker or rkt), and some shared resources for those containers. Those resources include:

+

When you created a Deployment in Module 2, Kubernetes created a Pod to host your application instance. A Pod is Kubernetes abstraction that represents a group of one or more application containers (such as Docker or rkt), and some shared resources for those containers. Those resources include:

  • Shared storage, as Volumes
  • Networking, as a unique cluster IP address
    • @@ -106,7 +106,7 @@

    Troubleshooting with kubectl

    -

    In Module 2, you used Kubectl command-line interface. You'll continue to use it in Module 3 to get information about deployed applications and their environments. The most common operations can be done with the following kubectl commands:

    +

    In Module 2, you used Kubectl command-line interface. You'll continue to use it in Module 3 to get information about deployed applications and their environments. The most common operations can be done with the following kubectl commands:

    • kubectl get - list resources
    • kubectl describe - show detailed information about a resource
      • @@ -114,7 +114,7 @@
    • kubectl exec - execute a command on a container in a pod
    -

    You can use these commands to see when applications were deployed, what their current status is, where they are running and what their configuration is.

    +

    You can use these commands to see when applications were deployed, what their current statuses are, where they are running and what their configurations are.

    Now that we know more about our cluster components and the command line, let’s explore our application.

    diff --git a/docs/tutorials/kubernetes-basics/scale-intro.html b/docs/tutorials/kubernetes-basics/scale-intro.html index 7d046756f9..4a552f68ba 100644 --- a/docs/tutorials/kubernetes-basics/scale-intro.html +++ b/docs/tutorials/kubernetes-basics/scale-intro.html @@ -25,7 +25,7 @@

    Scaling an application

    -

    In the previous modules we created a Deployment, and then exposed it publicly via a Service . The Deployment created only one Pod for running our application. When traffic increases, we will need to scale the application to keep up with user demand.

    +

    In the previous modules we created a Deployment, and then exposed it publicly via a Service. The Deployment created only one Pod for running our application. When traffic increases, we will need to scale the application to keep up with user demand.

    Scaling is accomplished by changing the number of replicas in a Deployment

    diff --git a/docs/tutorials/kubernetes-basics/update-intro.html b/docs/tutorials/kubernetes-basics/update-intro.html index 411bef8d4f..73b8477df7 100644 --- a/docs/tutorials/kubernetes-basics/update-intro.html +++ b/docs/tutorials/kubernetes-basics/update-intro.html @@ -25,10 +25,10 @@

    Updating an application

    -

    Users expect applications to be available all the time and developers are expected to deploy new versions of them several times a day. In Kubernetes this is done with rolling updates. Rolling updates allows Deployments to occur with zero downtime by incrementally updating Pods instances with new ones. The new Pods will be scheduled on Nodes with available resources.

    +

    Users expect applications to be available all the time and developers are expected to deploy new versions of them several times a day. In Kubernetes this is done with rolling updates. Rolling updates allow Deployments' update to take place with zero downtime by incrementally updating Pods instances with new ones. The new Pods will be scheduled on Nodes with available resources.

    In the previous module we scaled our application to run multiple instances. This is a requirement for performing updates without affecting application availability. By default, the maximum number of Pods that can be unavailable during the update and the maximum number of new Pods that can be created, is one. Both options can be configured to either numbers or percentages (of Pods). - In Kubernetes, updates are versioned and any Deployment update can be reverted to a previously (stable) version.

    + In Kubernetes, updates are versioned and any Deployment update can be reverted to previous (stable) version.

    @@ -39,7 +39,7 @@
-

Rolling updates allows Deployments update with zero downtime by incrementally updating Pods instances with new ones.

+

Rolling updates allow Deployments' update to take place with zero downtime by incrementally updating Pods instances with new ones.

From 2b226de2643a2b5199e637423abdf6f6c3ae2e06 Mon Sep 17 00:00:00 2001 From: steveperry-53 Date: Mon, 5 Dec 2016 15:32:19 -0800 Subject: [PATCH 4/8] Replace $REPO with http://k8s.io. --- .../port-forward-access-application-cluster.md | 3 +-- docs/tasks/administer-cluster/assign-pods-nodes.md | 3 +-- .../configure-pod-container/assign-cpu-ram-container.md | 3 +-- .../define-command-argument-container.md | 3 +-- .../define-environment-variable-container.md | 3 +-- .../determine-reason-pod-failure.md | 9 ++++----- .../run-stateless-application-deployment.md | 7 +++---- 7 files changed, 12 insertions(+), 19 deletions(-) diff --git a/docs/tasks/access-application-cluster/port-forward-access-application-cluster.md b/docs/tasks/access-application-cluster/port-forward-access-application-cluster.md index b3d8db38dd..41726c0afd 100644 --- a/docs/tasks/access-application-cluster/port-forward-access-application-cluster.md +++ b/docs/tasks/access-application-cluster/port-forward-access-application-cluster.md @@ -25,8 +25,7 @@ for database debugging. 1. Create a pod: - export REPO=https://raw.githubusercontent.com/kubernetes/kubernetes.github.io/master - kubectl create -f $REPO/docs/tasks/access-application-cluster/redis-master.yaml + kubectl create -f http://k8s.io/docs/tasks/access-application-cluster/redis-master.yaml The output of a successful command verifies that the pod was created: diff --git a/docs/tasks/administer-cluster/assign-pods-nodes.md b/docs/tasks/administer-cluster/assign-pods-nodes.md index f778e87e4b..4468b92701 100644 --- a/docs/tasks/administer-cluster/assign-pods-nodes.md +++ b/docs/tasks/administer-cluster/assign-pods-nodes.md @@ -59,8 +59,7 @@ a `disktype=ssd` label. 1. Use the configuration file to create a pod that will get scheduled on your chosen node: - export REPO=https://raw.githubusercontent.com/kubernetes/kubernetes.github.io/master - kubectl create -f $REPO/docs/tasks/administer-cluster/pod.yaml + kubectl create -f http://k8s.io/docs/tasks/administer-cluster/pod.yaml 1. Verify that the pod is running on your chosen node: diff --git a/docs/tasks/configure-pod-container/assign-cpu-ram-container.md b/docs/tasks/configure-pod-container/assign-cpu-ram-container.md index 5b05afedb8..2e852a7660 100644 --- a/docs/tasks/configure-pod-container/assign-cpu-ram-container.md +++ b/docs/tasks/configure-pod-container/assign-cpu-ram-container.md @@ -43,8 +43,7 @@ for the `Pod`: 1. Create a Pod based on the YAML configuration file: - export REPO=https://raw.githubusercontent.com/kubernetes/kubernetes.github.io/master - kubectl create -f $REPO/docs/tasks/configure-pod-container/cpu-ram.yaml + kubectl create -f http://k8s.io/docs/tasks/configure-pod-container/cpu-ram.yaml 1. Display information about the pod: diff --git a/docs/tasks/configure-pod-container/define-command-argument-container.md b/docs/tasks/configure-pod-container/define-command-argument-container.md index 22ac9b5e04..85befe43e0 100644 --- a/docs/tasks/configure-pod-container/define-command-argument-container.md +++ b/docs/tasks/configure-pod-container/define-command-argument-container.md @@ -39,8 +39,7 @@ file for the Pod defines a command and two arguments: 1. Create a Pod based on the YAML configuration file: - export REPO=https://raw.githubusercontent.com/kubernetes/kubernetes.github.io/master - kubectl create -f $REPO/docs/tasks/configure-pod-container/commands.yaml + kubectl create -f http://k8s.io/docs/tasks/configure-pod-container/commands.yaml 1. List the running Pods: diff --git a/docs/tasks/configure-pod-container/define-environment-variable-container.md b/docs/tasks/configure-pod-container/define-environment-variable-container.md index 2cba3c55f1..25e90c7fb4 100644 --- a/docs/tasks/configure-pod-container/define-environment-variable-container.md +++ b/docs/tasks/configure-pod-container/define-environment-variable-container.md @@ -33,8 +33,7 @@ Pod: 1. Create a Pod based on the YAML configuration file: - export REPO=https://raw.githubusercontent.com/kubernetes/kubernetes.github.io/master - kubectl create -f $REPO/docs/tasks/configure-pod-container/envars.yaml + kubectl create -f http://k8s.io/docs/tasks/configure-pod-container/envars.yaml 1. List the running Pods: diff --git a/docs/tasks/debug-application-cluster/determine-reason-pod-failure.md b/docs/tasks/debug-application-cluster/determine-reason-pod-failure.md index f0f611e235..5710150a76 100644 --- a/docs/tasks/debug-application-cluster/determine-reason-pod-failure.md +++ b/docs/tasks/debug-application-cluster/determine-reason-pod-failure.md @@ -32,12 +32,11 @@ In this exercise, you create a Pod that runs one container. The configuration file specifies a command that runs when the container starts. -{% include code.html language="yaml" file="termination.yaml" ghlink="/docs/tasks/debug-pod-container/termination.yaml" %} +{% include code.html language="yaml" file="termination.yaml" ghlink="/docs/tasks/debug-application-cluster/termination.yaml" %} 1. Create a Pod based on the YAML configuration file: - export REPO=https://raw.githubusercontent.com/kubernetes/kubernetes.github.io/master - kubectl create -f $REPO/docs/tasks/debug-pod-container/termination.yaml + kubectl create -f http://k8s.io/docs/tasks/debug-application-cluster/termination.yaml In the YAML file, in the `cmd` and `args` fields, you can see that the container sleeps for 10 seconds and then writes "Sleep expired" to @@ -70,7 +69,7 @@ the container starts. 1. Use a Go template to filter the output so that it includes only the termination message: - + ``` {% raw %} kubectl get pod termination-demo -o go-template="{{range .status.containerStatuses}}{{.lastState.terminated.message}}{{end}}"{% endraw %} ``` @@ -99,7 +98,7 @@ Set `terminationMessagePath` as shown here: {% capture whatsnext %} -* See the `terminationMessagePath` field in +* See the `terminationMessagePath` field in [Container](/docs/api-reference/v1/definitions#_v1_container). * Learn about [retrieving logs](/docs/user-guide/logging/). * Learn about [Go templates](https://golang.org/pkg/text/template/). diff --git a/docs/tutorials/stateless-application/run-stateless-application-deployment.md b/docs/tutorials/stateless-application/run-stateless-application-deployment.md index 755e52ebfe..7ea6efa408 100644 --- a/docs/tutorials/stateless-application/run-stateless-application-deployment.md +++ b/docs/tutorials/stateless-application/run-stateless-application-deployment.md @@ -37,8 +37,7 @@ a Deployment that runs the nginx:1.7.9 Docker image: 1. Create a Deployment based on the YAML file: - export REPO=https://raw.githubusercontent.com/kubernetes/kubernetes.github.io/master - kubectl create -f $REPO/docs/tutorials/stateless-application/deployment.yaml + kubectl create -f http://k8s.io/docs/tutorials/stateless-application/deployment.yaml 1. Display information about the Deployment: @@ -81,7 +80,7 @@ specifies that the deployment should be updated to use nginx 1.8. 1. Apply the new YAML file: - kubectl apply -f $REPO/docs/tutorials/stateless-application/deployment-update.yaml + kubectl apply -f http://k8s.io/docs/tutorials/stateless-application/deployment-update.yaml 1. Watch the deployment create pods with new names and delete the old pods: @@ -97,7 +96,7 @@ should have four pods: 1. Apply the new YAML file: - kubectl apply -f $REPO/docs/tutorials/stateless-application/deployment-scale.yaml + kubectl apply -f http://k8s.io/docs/tutorials/stateless-application/deployment-scale.yaml 1. Verify that the Deployment has four pods: From 03658685ad36a1a664ff341171b488f45709b333 Mon Sep 17 00:00:00 2001 From: bruceauyeung Date: Tue, 6 Dec 2016 17:12:23 +0800 Subject: [PATCH 5/8] fix incorrect links and other doc errors in tutorials Signed-off-by: bruceauyeung --- docs/tutorials/kubernetes-basics/deploy-intro.html | 4 ++-- docs/tutorials/kubernetes-basics/expose-intro.html | 4 ++-- .../expose-external-ip-address-service.md | 2 +- .../stateless-application/expose-external-ip-address.md | 4 ++-- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/tutorials/kubernetes-basics/deploy-intro.html b/docs/tutorials/kubernetes-basics/deploy-intro.html index 3664398794..f7f80982bf 100644 --- a/docs/tutorials/kubernetes-basics/deploy-intro.html +++ b/docs/tutorials/kubernetes-basics/deploy-intro.html @@ -70,7 +70,7 @@

You can create and manage a Deployment by using the Kubernetes command line interface, Kubectl. Kubectl uses the Kubernetes API to interact with the cluster. In this module, you'll learn the most common Kubectl commands needed to create Deployments that run your applications on a Kubernetes cluster.

-

When you create a Deployment, you'll need to specify the container image for your application and the number of replicas that you want to run. You can change that information later by updating your Deployment; Modules 5 and 6 of the bootcamp discuss how you can update your Deployments.

+

When you create a Deployment, you'll need to specify the container image for your application and the number of replicas that you want to run. You can change that information later by updating your Deployment; Modules 5 and 6 of the bootcamp discuss how you can scale and update your Deployments.

@@ -85,7 +85,7 @@
-

For our first Deployment, we’ll use a NodeJS application packaged in a Docker container. The source code and the Dockerfile are available in the GitHub repository for the Kubernetes Bootcamp.

+

For our first Deployment, we’ll use a Node.js application packaged in a Docker container. The source code and the Dockerfile are available in the GitHub repository for the Kubernetes Bootcamp.

Now that you know what Deployments are, let’s go to the online tutorial and deploy our first app!

diff --git a/docs/tutorials/kubernetes-basics/expose-intro.html b/docs/tutorials/kubernetes-basics/expose-intro.html index 8506bf8d9d..524e051c68 100644 --- a/docs/tutorials/kubernetes-basics/expose-intro.html +++ b/docs/tutorials/kubernetes-basics/expose-intro.html @@ -71,7 +71,7 @@

A Service provides load balancing of traffic across the contained set of Pods. This is useful when a service is created to group all Pods from a specific Deployment (our application will make use of this in the next module, when we’ll have multiple instances running).

-

Services are also responsible for service-discovery within the cluster (covered in Module 6). This will for example allow a frontend service (like a web server) to receive traffic from a backend service (like a database) without worrying about Pods.

+

Services are also responsible for service-discovery within the cluster (covered in Accessing the Service). This will for example allow a frontend service (like a web server) to receive traffic from a backend service (like a database) without worrying about Pods.

Services match a set of Pods using Label Selectors, a grouping primitive that allows logical operation on Labels.

@@ -119,7 +119,7 @@

Labels can be attached to objects at the creation time or later and can be modified at any time. The kubectl run command sets some default Labels/Label Selectors on the new Pods/ Deployment. The link between Labels and Label Selectors defines the relationship between the Deployment and the Pods it creates.

-

Let’s expose now our application with the help of a Service, and apply some new Labels.

+

Now let’s expose our application with the help of a Service, and apply some new Labels.


diff --git a/docs/tutorials/stateless-application/expose-external-ip-address-service.md b/docs/tutorials/stateless-application/expose-external-ip-address-service.md index 58d60f7bd6..e9da4f7a37 100644 --- a/docs/tutorials/stateless-application/expose-external-ip-address-service.md +++ b/docs/tutorials/stateless-application/expose-external-ip-address-service.md @@ -103,7 +103,7 @@ provides load balancing for an application that has two running instances. curl http://: - where `` us the public IP address of your node, + where `` is the public IP address of your node, and `` is the NodePort value for your service. The response to a successful request is a hello message: diff --git a/docs/tutorials/stateless-application/expose-external-ip-address.md b/docs/tutorials/stateless-application/expose-external-ip-address.md index 56606d511c..be47728120 100644 --- a/docs/tutorials/stateless-application/expose-external-ip-address.md +++ b/docs/tutorials/stateless-application/expose-external-ip-address.md @@ -64,7 +64,7 @@ external IP address. NAME CLUSTER-IP EXTERNAL-IP PORT(S) AGE my-service 10.3.245.137 104.198.205.71 8080/TCP 54s - Note: If the external IP address is shown as , wait for a minute + Note: If the external IP address is shown as \, wait for a minute and enter the same command again. 1. Display detailed information about the Service: @@ -110,7 +110,7 @@ external IP address. curl http://: - where `` us the external IP address of your Service, + where `` is the external IP address of your Service, and `` is the value of `Port` in your Service description. The response to a successful request is a hello message: From 9e7294be08c0b93344571a9eab89cdab99596551 Mon Sep 17 00:00:00 2001 From: Andrew Watson Date: Tue, 6 Dec 2016 10:21:43 -0500 Subject: [PATCH 6/8] fixing broken link to container initialization doc --- docs/user-guide/production-pods.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/production-pods.md b/docs/user-guide/production-pods.md index bf85fdaf8f..5a6c56dc11 100644 --- a/docs/user-guide/production-pods.md +++ b/docs/user-guide/production-pods.md @@ -204,7 +204,7 @@ The status of the init containers is returned as another annotation - `pod.beta. Init containers support all of the same features as normal containers, including resource limits, volumes, and security settings. The resource requests and limits for an init container are handled slightly different than normal containers since init containers are run one at a time instead of all at once - any limits or quotas will be applied based on the largest init container resource quantity, rather than as the sum of quantities. Init containers do not support readiness probes since they will run to completion before the pod can be ready. -[Complete Init Container Documentation](/docs/user-guide/pods/init-containers.md) +[Complete Init Container Documentation](/docs/user-guide/pods/init-container/) ## Lifecycle hooks and termination notice From af6a4286880e7e487f70c012731423f63072cbf7 Mon Sep 17 00:00:00 2001 From: Jared Date: Tue, 6 Dec 2016 17:30:17 -0800 Subject: [PATCH 7/8] Update authentication.md --- docs/admin/authentication.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/admin/authentication.md b/docs/admin/authentication.md index 3d73f527bf..a3726cbf2d 100644 --- a/docs/admin/authentication.md +++ b/docs/admin/authentication.md @@ -35,8 +35,8 @@ or be treated as an anonymous user. ## Authentication strategies Kubernetes uses client certificates, bearer tokens, an authenticating proxy, or HTTP basic auth to -authenticate API requests through authentication plugins. As HTTP request are -made to the API server plugins attempts to associate the following attributes +authenticate API requests through authentication plugins. As HTTP requests are +made to the API server, plugins attempt to associate the following attributes with the request: * Username: a string which identifies the end user. Common values might be `kube-admin` or `jane@example.com`. From b650f662dd83578538eea5a5cb6ae95f02856859 Mon Sep 17 00:00:00 2001 From: Sam Ghods Date: Thu, 27 Oct 2016 04:47:04 -0700 Subject: [PATCH 8/8] Fix grammatical issues in node.md --- docs/admin/node.md | 202 +++++++++++++++++++++++---------------------- 1 file changed, 105 insertions(+), 97 deletions(-) diff --git a/docs/admin/node.md b/docs/admin/node.md index 78ef3c4b2e..01e8f8bae7 100644 --- a/docs/admin/node.md +++ b/docs/admin/node.md @@ -11,44 +11,39 @@ assignees: ## What is a node? -`Node` is a worker machine in Kubernetes, previously known as `Minion`. Node +A `node` is a worker machine in Kubernetes, previously known as a `minion`. A node may be a VM or physical machine, depending on the cluster. Each node has -the services necessary to run [Pods](/docs/user-guide/pods) and is managed by the master -components. The services on a node include docker, kubelet and network proxy. See +the services necessary to run [pods](/docs/user-guide/pods) and is managed by the master +components. The services on a node include Docker, kubelet and kube-proxy. See [The Kubernetes Node](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/design/architecture.md#the-kubernetes-node) section in the architecture design doc for more details. ## Node Status -Node status describes current status of a node. For now, there are the following -pieces of information: +A node's status is comprised of the following information. -### Node Addresses +### Addresses The usage of these fields varies depending on your cloud provider or bare metal configuration. * HostName: The hostname as reported by the node's kernel. Can be overridden via the kubelet `--hostname-override` parameter. +* ExternalIP: Typically the IP address of the node that is externally routable (available from outside the cluster). +* InternalIP: Typically the IP address of the node that is routable only within the cluster. -* ExternalIP: Generally the IP address of the node that is externally routable (available from outside the cluster) +### Phase -* InternalIP: Generally the IP address of the node that is routable only within the cluster +Deprecated: node phase is no longer used. - -### Node Phase - -Deprecated: Node Phase is no longer used - -### Node Condition +### Condition The `conditions` field describes the status of all `Running` nodes. | Node Condition | Description | |----------------|-------------| -| `OutOfDisk` | `True` if insufficient free space on the node for adding new pods, otherwise `False` | -| `Ready` | `True` if the node is healthy ready to accept pods, `False` if the node is not healthy and is not accepting pods, and `Unknown` if the Node Controller has not heard from the node in the last 40 seconds | +| `OutOfDisk` | `True` if there is insufficient free space on the node for adding new pods, otherwise `False` | +| `Ready` | `True` if the node is healthy and ready to accept pods, `False` if the node is not healthy and is not accepting pods, and `Unknown` if the node controller has not heard from the node in the last 40 seconds | -Node condition is represented as a JSON object. For example, the following response describes a healthy node: -conditions mean the node is in sane state: +The node condition is represented as a JSON object. For example, the following response describes a healthy node. ```json "conditions": [ @@ -59,28 +54,31 @@ conditions mean the node is in sane state: ] ``` -If the Status of the Ready condition -is Unknown or False for more than five minutes, then all of the Pods on the node are terminated by the Node Controller. +If the Status of the Ready condition is Unknown or False for more than five +minutes, then all of the pods on the node are terminated by the node +controller. (The timeout length is configurable by the `--pod-eviction-timeout` +parameter on the controller manager.) -### Node Capacity +### Capacity -Describes the resources available on the node: CPUs, memory and the maximum +Describes the resources available on the node: CPU, memory and the maximum number of pods that can be scheduled onto the node. -### Node Info +### Info -General information about the node, for instance kernel version, Kubernetes version -(kubelet version, kube-proxy version), docker version (if used), OS name. +General information about the node, such as kernel version, Kubernetes version +(kubelet and kube-proxy version), Docker version (if used), OS name. The information is gathered by Kubelet from the node. -## Node Management +## Management -Unlike [Pods](/docs/user-guide/pods) and [Services](/docs/user-guide/services), a Node is not inherently -created by Kubernetes: it is either taken from cloud providers like Google Compute Engine, -or from your pool of physical or virtual machines. What this means is that when -Kubernetes creates a node, it is really just creating an object that represents the node in its internal state. -After creation, Kubernetes will check whether the node is valid or not. -For example, if you try to create a node from the following content: +Unlike [pods](/docs/user-guide/pods) and [services](/docs/user-guide/services), +a node is not inherently created by Kubernetes: it is created externally by cloud +providers like Google Compute Engine, or exists in your pool of physical or virtual +machines. What this means is that when Kubernetes creates a node, it is really +just creating an object that represents the node. After creation, Kubernetes +will check whether the node is valid or not. For example, if you try to create +a node from the following content: ```json { @@ -95,117 +93,127 @@ For example, if you try to create a node from the following content: } ``` -Kubernetes will create a Node object internally (the representation), and -validate the node by health checking based on the `metadata.name` field: we -assume `metadata.name` can be resolved. If the node is valid, i.e. all necessary -services are running, it is eligible to run a Pod; otherwise, it will be -ignored for any cluster activity, until it becomes valid. Note that Kubernetes -will keep the object for the invalid node unless it is explicitly deleted by the client, and it will keep -checking to see if it becomes valid. +Kubernetes will create a node object internally (the representation), and +validate the node by health checking based on the `metadata.name` field (we +assume `metadata.name` can be resolved). If the node is valid, i.e. all necessary +services are running, it is eligible to run a pod; otherwise, it will be +ignored for any cluster activity until it becomes valid. Note that Kubernetes +will keep the object for the invalid node unless it is explicitly deleted by +the client, and it will keep checking to see if it becomes valid. -Currently, there are three components that interact with the Kubernetes node interface: Node Controller, Kubelet, and kubectl. +Currently, there are three components that interact with the Kubernetes node +interface: node controller, kubelet, and kubectl. ### Node Controller -Node controller is a component in Kubernetes master which manages Node -objects. +The node controller is a Kubernetes master component which manages various +aspects of nodes. -Node controller has mutliple roles in Node's life. First is assigning a CIDR block to -the Node when it is registered (if CIDR assignment is turned on). Second is keeping the -node controller's list of nodes up to date with the cloud provider's list of available -machines. When running in cloud environment whenever a node is unhealthy node controller -asks cloud provider if the VM for that node is still available. If not, the node +The node controller has multiple roles in a node's life. The first is assigning a +CIDR block to the node when it is registered (if CIDR assignment is turned on). + +The second is keeping the node controller's internal list of nodes up to date with +the cloud provider's list of available machines. When running in a cloud +environment, whenever a node is unhealthy the node controller asks the cloud +provider if the VM for that node is still available. If not, the node controller deletes the node from its list of nodes. -Third responsibiliy is monitoring Node's health. Node controller is responsible for updating -the NodeReady condition of NodeStatus to ConditionUnknown when a node becomes unreachable -(i.e. node controller stops receiving heartbeats e.g. due to the node being down), and then -later evicting all the pods from the node (using graceful termination) if the node continues -to be unreachable (the current timeouts are 40s to start reporting ConditionUnknown and 5m -after that to start evicting pods). Node controller checks the state of each node every -`--node-monitor-period` seconds. +The third is monitoring the nodes' health. The node controller is +responsible for updating the NodeReady condition of NodeStatus to +ConditionUnknown when a node becomes unreachable (i.e. the node controller stops +receiving heartbeats for some reason, e.g. due to the node being down), and then later evicting +all the pods from the node (using graceful termination) if the node continues +to be unreachable. (The default timeouts are 40s to start reporting +ConditionUnknown and 5m after that to start evicting pods.) The node controller +checks the state of each node every `--node-monitor-period` seconds. -In 1.4 release we updated the logic of node controller to better handle cases when a -big number of Nodes have problems with reaching the master machine (e.g. because -master machine has networking problem). Starting with 1.4 node controller will look at the -state of all Nodes in the cluster when making a decision about pod eviction. +In Kubernetes 1.4, we updated the logic of the node controller to better handle +cases when a big number of nodes have problems with reaching the master +(e.g. because the master has networking problem). Starting with 1.4, the node +controller will look at the state of all nodes in the cluster when making a +decision about pod eviction. -In most cases, node controller limits the eviction rate to `--node-eviction-rate` (default 0.1) -per second, meaning it won't evict pods from more than 1 node per 10 seconds. +In most cases, node controller limits the eviction rate to +`--node-eviction-rate` (default 0.1) per second, meaning it won't evict pods +from more than 1 node per 10 seconds. -The node eviction behavior changes when a node in a given availability zone becomes unhealthy, -node controller checks what percentage of nodes in the zone are unhealthy (NodeReady condition -is ConditionUnknown or ConditionFalse) at the same time. If the fraction of unhealthy nodes is -at least `--unhealthy-zone-threshold` (default 0.55) then the eviction rate is reduced: if -the cluster is small (i.e. has less than or equal to `--large-cluster-size-threshold` -nodes - default 50) then evictions are stopped, otherwise the eviction rate is reduced to -`--secondary-node-eviction-rate` (default 0.01) per second. The reason these policies are -implemented per availability zone is because one availability zone might become partitioned -from the master while the others remain connected. If your cluster does not span multiple cloud -provider availability zones, then there is only one availability zone, namely the whole cluster. +The node eviction behavior changes when a node in a given availability zone +becomes unhealthy. The node controller checks what percentage of nodes in the zone +are unhealthy (NodeReady condition is ConditionUnknown or ConditionFalse) at +the same time. If the fraction of unhealthy nodes is at least +`--unhealthy-zone-threshold` (default 0.55) then the eviction rate is reduced: +if the cluster is small (i.e. has less than or equal to +`--large-cluster-size-threshold` nodes - default 50) then evictions are +stopped, otherwise the eviction rate is reduced to +`--secondary-node-eviction-rate` (default 0.01) per second. The reason these +policies are implemented per availability zone is because one availability zone +might become partitioned from the master while the others remain connected. If +your cluster does not span multiple cloud provider availability zones, then +there is only one availability zone (the whole cluster). -A key reason for spreading your nodes across availability zones is so that workload can be -shifted to healthy zones when one entire zone goes down. To enable this behavior, if all -nodes in a zone are unhealthy then node controller evicts at the normal rate `--node-eviction-rate`. -The corner case for that is when all zones are completely unhealthy (i.e. there's no healthy node in -the cluster). In such case node controller assumes that there's some problem with master machine -connectivity and stops all evictions until any connectivity is restored. +A key reason for spreading your nodes across availability zones is so that the +workload can be shifted to healthy zones when one entire zone goes down. +Therefore, if all nodes in a zone are unhealthy then node controller evicts at +the normal rate `--node-eviction-rate`. The corner case is when all zones are +completely unhealthy (i.e. there are no healthy nodes in the cluster). In such +case, the node controller assumes that there's some problem with master +connectivity and stops all evictions until some connectivity is restored. ### Self-Registration of Nodes -When kubelet flag `--register-node` is true (the default), the kubelet will attempt to +When the kubelet flag `--register-node` is true (the default), the kubelet will attempt to register itself with the API server. This is the preferred pattern, used by most distros. For self-registration, the kubelet is started with the following options: - - `--api-servers=` tells the kubelet the location of the apiserver. - - `--kubeconfig` tells kubelet where to find credentials to authenticate itself to the apiserver. - - `--cloud-provider=` tells the kubelet how to talk to a cloud provider to read metadata about itself. - - `--register-node` tells the kubelet to create its own node resource. + - `--api-servers=` - Location of the apiservers. + - `--kubeconfig=` - Path to credentials to authenticate itself to the apiserver. + - `--cloud-provider=` - How to talk to a cloud provider to read metadata about itself. + - `--register-node` - Automatically register with the API server. Currently, any kubelet is authorized to create/modify any node resource, but in practice it only creates/modifies -its own. (In the future, we plan to limit authorization to only allow a kubelet to modify its own Node resource.) +its own. (In the future, we plan to only allow a kubelet to modify its own node resource.) #### Manual Node Administration -A cluster administrator can create and modify Node objects. +A cluster administrator can create and modify node objects. -If the administrator wishes to create node objects manually, set kubelet flag +If the administrator wishes to create node objects manually, set the kubelet flag `--register-node=false`. -The administrator can modify Node resources (regardless of the setting of `--register-node`). -Modifications include setting labels on the Node, and marking it unschedulable. +The administrator can modify node resources (regardless of the setting of `--register-node`). +Modifications include setting labels on the node and marking it unschedulable. Labels on nodes can be used in conjunction with node selectors on pods to control scheduling, -e.g. to constrain a Pod to only be eligible to run on a subset of the nodes. +e.g. to constrain a pod to only be eligible to run on a subset of the nodes. -Making a node unscheduleable will prevent new pods from being scheduled to that -node, but will not affect any existing pods on the node. This is useful as a -preparatory step before a node reboot, etc. For example, to mark a node +Marking a node as unscheduleable will prevent new pods from being scheduled to that +node, but will not affect any existing pods on the node. This is useful as a +preparatory step before a node reboot, etc. For example, to mark a node unschedulable, run this command: ```shell -kubectl patch nodes $NODENAME -p '{"spec": {"unschedulable": true}}' +kubectl cordon $NODENAME ``` Note that pods which are created by a daemonSet controller bypass the Kubernetes scheduler, -and do not respect the unschedulable attribute on a node. The assumption is that daemons belong on +and do not respect the unschedulable attribute on a node. The assumption is that daemons belong on the machine even if it is being drained of applications in preparation for a reboot. ### Node capacity -The capacity of the node (number of cpus and amount of memory) is part of the node resource. -Normally, nodes register themselves and report their capacity when creating the node resource. If +The capacity of the node (number of cpus and amount of memory) is part of the node object. +Normally, nodes register themselves and report their capacity when creating the node object. If you are doing [manual node administration](#manual-node-administration), then you need to set node capacity when adding a node. The Kubernetes scheduler ensures that there are enough resources for all the pods on a node. It checks that the sum of the limits of containers on the node is no greater than the node capacity. It -includes all containers started by kubelet, but not containers started directly by docker, nor +includes all containers started by the kubelet, but not containers started directly by Docker nor processes not in containers. -If you want to explicitly reserve resources for non-Pod processes, you can create a placeholder -pod. Use the following template: +If you want to explicitly reserve resources for non-pod processes, you can create a placeholder +pod. Use the following template: ```yaml apiVersion: v1