From a9a81a99bff5d4d43b73a8bc2088e915f90a6f0d Mon Sep 17 00:00:00 2001 From: houjun41544 Date: Thu, 14 Sep 2017 11:00:13 +0800 Subject: [PATCH 1/2] Add inject-data-application and two docs in it. --- .../dapi-envars-container.yaml | 45 ++++ .../dapi-envars-pod.yaml | 38 ++++ .../dapi-volume-resources.yaml | 54 +++++ .../inject-data-application/dapi-volume.yaml | 39 ++++ ...nward-api-volume-expose-pod-information.md | 209 ++++++++++++++++++ ...ronment-variable-expose-pod-information.md | 153 +++++++++++++ 6 files changed, 538 insertions(+) create mode 100644 cn/docs/tasks/inject-data-application/dapi-envars-container.yaml create mode 100644 cn/docs/tasks/inject-data-application/dapi-envars-pod.yaml create mode 100644 cn/docs/tasks/inject-data-application/dapi-volume-resources.yaml create mode 100644 cn/docs/tasks/inject-data-application/dapi-volume.yaml create mode 100644 cn/docs/tasks/inject-data-application/downward-api-volume-expose-pod-information.md create mode 100644 cn/docs/tasks/inject-data-application/environment-variable-expose-pod-information.md diff --git a/cn/docs/tasks/inject-data-application/dapi-envars-container.yaml b/cn/docs/tasks/inject-data-application/dapi-envars-container.yaml new file mode 100644 index 0000000000..8b3b3a39d3 --- /dev/null +++ b/cn/docs/tasks/inject-data-application/dapi-envars-container.yaml @@ -0,0 +1,45 @@ +apiVersion: v1 +kind: Pod +metadata: + name: dapi-envars-resourcefieldref +spec: + containers: + - name: test-container + image: gcr.io/google_containers/busybox:1.24 + command: [ "sh", "-c"] + args: + - while true; do + echo -en '\n'; + printenv MY_CPU_REQUEST MY_CPU_LIMIT; + printenv MY_MEM_REQUEST MY_MEM_LIMIT; + sleep 10; + done; + resources: + requests: + memory: "32Mi" + cpu: "125m" + limits: + memory: "64Mi" + cpu: "250m" + env: + - name: MY_CPU_REQUEST + valueFrom: + resourceFieldRef: + containerName: test-container + resource: requests.cpu + - name: MY_CPU_LIMIT + valueFrom: + resourceFieldRef: + containerName: test-container + resource: limits.cpu + - name: MY_MEM_REQUEST + valueFrom: + resourceFieldRef: + containerName: test-container + resource: requests.memory + - name: MY_MEM_LIMIT + valueFrom: + resourceFieldRef: + containerName: test-container + resource: limits.memory + restartPolicy: Never diff --git a/cn/docs/tasks/inject-data-application/dapi-envars-pod.yaml b/cn/docs/tasks/inject-data-application/dapi-envars-pod.yaml new file mode 100644 index 0000000000..00762373b3 --- /dev/null +++ b/cn/docs/tasks/inject-data-application/dapi-envars-pod.yaml @@ -0,0 +1,38 @@ +apiVersion: v1 +kind: Pod +metadata: + name: dapi-envars-fieldref +spec: + containers: + - name: test-container + image: gcr.io/google_containers/busybox + command: [ "sh", "-c"] + args: + - while true; do + echo -en '\n'; + printenv MY_NODE_NAME MY_POD_NAME MY_POD_NAMESPACE; + printenv MY_POD_IP MY_POD_SERVICE_ACCOUNT; + sleep 10; + done; + env: + - name: MY_NODE_NAME + valueFrom: + fieldRef: + fieldPath: spec.nodeName + - name: MY_POD_NAME + valueFrom: + fieldRef: + fieldPath: metadata.name + - name: MY_POD_NAMESPACE + valueFrom: + fieldRef: + fieldPath: metadata.namespace + - name: MY_POD_IP + valueFrom: + fieldRef: + fieldPath: status.podIP + - name: MY_POD_SERVICE_ACCOUNT + valueFrom: + fieldRef: + fieldPath: spec.serviceAccountName + restartPolicy: Never diff --git a/cn/docs/tasks/inject-data-application/dapi-volume-resources.yaml b/cn/docs/tasks/inject-data-application/dapi-volume-resources.yaml new file mode 100644 index 0000000000..65770f283f --- /dev/null +++ b/cn/docs/tasks/inject-data-application/dapi-volume-resources.yaml @@ -0,0 +1,54 @@ +apiVersion: v1 +kind: Pod +metadata: + name: kubernetes-downwardapi-volume-example-2 +spec: + containers: + - name: client-container + image: gcr.io/google_containers/busybox:1.24 + command: ["sh", "-c"] + args: + - while true; do + echo -en '\n'; + if [[ -e /etc/cpu_limit ]]; then + echo -en '\n'; cat /etc/cpu_limit; fi; + if [[ -e /etc/cpu_request ]]; then + echo -en '\n'; cat /etc/cpu_request; fi; + if [[ -e /etc/mem_limit ]]; then + echo -en '\n'; cat /etc/mem_limit; fi; + if [[ -e /etc/mem_request ]]; then + echo -en '\n'; cat /etc/mem_request; fi; + sleep 5; + done; + resources: + requests: + memory: "32Mi" + cpu: "125m" + limits: + memory: "64Mi" + cpu: "250m" + volumeMounts: + - name: podinfo + mountPath: /etc + readOnly: false + volumes: + - name: podinfo + downwardAPI: + items: + - path: "cpu_limit" + resourceFieldRef: + containerName: client-container + resource: limits.cpu + - path: "cpu_request" + resourceFieldRef: + containerName: client-container + resource: requests.cpu + - path: "mem_limit" + resourceFieldRef: + containerName: client-container + resource: limits.memory + - path: "mem_request" + resourceFieldRef: + containerName: client-container + resource: requests.memory + diff --git a/cn/docs/tasks/inject-data-application/dapi-volume.yaml b/cn/docs/tasks/inject-data-application/dapi-volume.yaml new file mode 100644 index 0000000000..7126cefae5 --- /dev/null +++ b/cn/docs/tasks/inject-data-application/dapi-volume.yaml @@ -0,0 +1,39 @@ +apiVersion: v1 +kind: Pod +metadata: + name: kubernetes-downwardapi-volume-example + labels: + zone: us-est-coast + cluster: test-cluster1 + rack: rack-22 + annotations: + build: two + builder: john-doe +spec: + containers: + - name: client-container + image: gcr.io/google_containers/busybox + command: ["sh", "-c"] + args: + - while true; do + if [[ -e /etc/labels ]]; then + echo -en '\n\n'; cat /etc/labels; fi; + if [[ -e /etc/annotations ]]; then + echo -en '\n\n'; cat /etc/annotations; fi; + sleep 5; + done; + volumeMounts: + - name: podinfo + mountPath: /etc + readOnly: false + volumes: + - name: podinfo + downwardAPI: + items: + - path: "labels" + fieldRef: + fieldPath: metadata.labels + - path: "annotations" + fieldRef: + fieldPath: metadata.annotations + diff --git a/cn/docs/tasks/inject-data-application/downward-api-volume-expose-pod-information.md b/cn/docs/tasks/inject-data-application/downward-api-volume-expose-pod-information.md new file mode 100644 index 0000000000..98a738be69 --- /dev/null +++ b/cn/docs/tasks/inject-data-application/downward-api-volume-expose-pod-information.md @@ -0,0 +1,209 @@ +--- +title: 通过文件将Pod信息呈现给容器 +--- + +{% capture overview %} + +此页面描述Pod如何使用DownwardAPIVolumeFile把自己的信息呈现给pod中运行的容器。DownwardAPIVolumeFile可以呈现pod的字段和容器字段。 + +{% endcapture %} + + +{% capture prerequisites %} + +{% include task-tutorial-prereqs.md %} + +{% endcapture %} + +{% capture steps %} + +## Downward API + +有两种方式可以将Pod和Container字段呈现给运行中的容器： + +* [环境变量](/docs/tasks/configure-pod-container/environment-variable-expose-pod-information/) +* DownwardAPIVolumeFile + +这两种呈现Pod和Container字段的方式都称为*Downward API*。 + +## 存储Pod字段 + +在这个练习中，你将创建一个包含一个容器的pod。这是该pod的配置文件： + +{% include code.html language="yaml" file="dapi-volume.yaml" ghlink="/cn/docs/tasks/inject-data-application/dapi-volume.yaml" %} + +在配置文件中，你可以看到Pod有一个`downwardAPI`类型的Volume，并且挂载到容器中的`/etc`。 + +查看`downwardAPI`下面的`items`数组。每个数组元素都是一个[DownwardAPIVolumeFile](/docs/resources-reference/{{page.version}}/#downwardapivolumefile-v1-core)。 +第一个元素指示Pod的`metadata.labels`字段的值保存在名为`labels`的文件中。 +第二个元素指示Pod的`annotations`字段的值保存在名为`annotations`的文件中。 + +**注意:** 本示例中的字段是Pod字段，不是Pod中容器的字段。 +{: .note} + +创建Pod： + +```shell +kubectl create -f https://k8s.io/cn/docs/tasks/inject-data-application/dapi-volume.yaml +``` + +验证Pod中的容器运行正常： + +```shell +kubectl get pods +``` + +查看容器的日志： + +```shell +kubectl logs kubernetes-downwardapi-volume-example +``` + +输出显示`labels`和`annotations`文件的内容： + +```shell +cluster="test-cluster1" +rack="rack-22" +zone="us-est-coast" + +build="two" +builder="john-doe" +``` + +进入Pod中运行的容器，打开一个shell： + +``` +kubectl exec -it kubernetes-downwardapi-volume-example -- sh +``` + +在该shell中，查看`labels`文件： + +```shell +/# cat /etc/labels +``` + +输出显示Pod的所有labels都已写入`labels`文件。 + +```shell +cluster="test-cluster1" +rack="rack-22" +zone="us-est-coast" +``` + +同样，查看`annotations`文件： + +```shell +/# cat /etc/annotations +``` + +查看`/etc`目录下的文件： + +```shell +/# ls -laR /etc +``` + +在输出中可以看到，`labels` 和 `annotations`文件都在一个临时子目录中：这个例子，`..2982_06_02_21_47_53.299460680`。在`/etc`目录中，`..data`是一个指向临时子目录 +的符号链接。`/etc`目录中，`labels` 和 `annotations`也是符号链接。 + +``` +drwxr-xr-x ... Feb 6 21:47 ..2982_06_02_21_47_53.299460680 +lrwxrwxrwx ... Feb 6 21:47 ..data -> ..2982_06_02_21_47_53.299460680 +lrwxrwxrwx ... Feb 6 21:47 annotations -> ..data/annotations +lrwxrwxrwx ... Feb 6 21:47 labels -> ..data/labels + +/etc/..2982_06_02_21_47_53.299460680: +total 8 +-rw-r--r-- ... Feb 6 21:47 annotations +-rw-r--r-- ... Feb 6 21:47 labels +``` + +用符号链接可实现元数据的动态原子刷新；更新将写入一个新的临时目录，然后`..data`符号链接完成原子更新，通过使用[rename(2)](http://man7.org/linux/man-pages/man2/rename.2.html)。 + +退出shell： + +```shell +/# exit +``` + +## 存储容器字段 + +前面的练习中，你将Pod字段保存到DownwardAPIVolumeFile中。接下来这个练习，你将存储容器字段。这里是包含一个容器的pod的配置文件： + +{% include code.html language="yaml" file="dapi-volume-resources.yaml" ghlink="/cn/docs/tasks/inject-data-application/dapi-volume-resources.yaml" %} + +在这个配置文件中，你可以看到Pod有一个`downwardAPI`类型的Volume,并且挂载到容器的`/etc`目录。 + +查看`downwardAPI`下面的`items`数组。每个数组元素都是一个DownwardAPIVolumeFile。 + +第一个元素指定名为`client-container`的容器中`limits.cpu`字段的值应保存在名为`cpu_limit`的文件中。 + +创建Pod： + +```shell +kubectl create -f https://k8s.io/cn/docs/tasks/inject-data-application/dapi-volume-resources.yaml +``` + +进入Pod中运行的容器，打开一个shell： + +``` +kubectl exec -it kubernetes-downwardapi-volume-example-2 -- sh +``` + +在shell中，查看`cpu_limit`文件： + +```shell +/# cat /etc/cpu_limit +``` +你可以使用同样的命令查看`cpu_request`, `mem_limit` 和`mem_request` 文件. + +{% endcapture %} + +{% capture discussion %} + +## Capabilities of the Downward API + +下面这些信息可以通过环境变量和DownwardAPIVolumeFiles提供给容器： + +* node的name +* node的IP +* Pod的name +* Pod的namespace +* Pod的IP address +* Pod的service account name +* Pod的UID +* Container的CPU limit +* Container的CPU request +* Container的memory limit +* Container的memory request + +此外，以下信息可通过DownwardAPIVolumeFiles获得： + +* Pod的labels +* Pod的annotations + +**Note:** 如果容器未指定CPU和memory limits，则Downward API默认为节点可分配值。 +{: .note} + +## 投射密钥到指定路径并且指定文件权限 + +你可以将密钥投射到指定路径并且指定每个文件的访问权限。更多信息，请参阅[Secrets](/docs/concepts/configuration/secret/). + +## Downward API的动机 + +对于容器来说，有时候拥有自己的信息是很有用的，可避免与Kubernetes过度耦合。Downward API使得容器使用自己或者集群的信息，而不必通过Kubernetes client或API server。 + +一个例子是有一个现有的应用假定要用一个非常熟悉的环境变量来保存一个唯一标识。一种可能是给应用增加处理层，但这样是冗余和易出错的，而且它违反了低耦合的目标。更好的选择是使用Pod名称作为标识，把Pod名称注入这个环境变量中。 +{% endcapture %} + + +{% capture whatsnext %} + +* [PodSpec](/docs/resources-reference/{{page.version}}/#podspec-v1-core) +* [Volume](/docs/resources-reference/{{page.version}}/#volume-v1-core) +* [DownwardAPIVolumeSource](/docs/resources-reference/{{page.version}}/#downwardapivolumesource-v1-core) +* [DownwardAPIVolumeFile](/docs/resources-reference/{{page.version}}/#downwardapivolumefile-v1-core) +* [ResourceFieldSelector](/docs/resources-reference/{{page.version}}/#resourcefieldselector-v1-core) + +{% endcapture %} + +{% include templates/task.md %} diff --git a/cn/docs/tasks/inject-data-application/environment-variable-expose-pod-information.md b/cn/docs/tasks/inject-data-application/environment-variable-expose-pod-information.md new file mode 100644 index 0000000000..1eb2c074e1 --- /dev/null +++ b/cn/docs/tasks/inject-data-application/environment-variable-expose-pod-information.md @@ -0,0 +1,153 @@ +--- +title: 通过环境变量将Pod信息呈现给容器 +--- + +{% capture overview %} + +此页面显示了Pod如何使用环境变量把自己的信息呈现给pod中运行的容器。环境变量可以呈现pod的字段和容器字段。 + +有两种方式可以将Pod和Container字段呈现给运行中的容器： +环境变量 和[DownwardAPIVolumeFiles](/docs/resources-reference/{{page.version}}/#downwardapivolumefile-v1-core). +这两种呈现Pod和Container字段的方式都称为*Downward API*。 + +{% endcapture %} + + +{% capture prerequisites %} + +{% include task-tutorial-prereqs.md %} + +{% endcapture %} + + +{% capture steps %} + +## Downward API + +有两种方式可以将Pod和Container字段呈现给运行中的容器： + +* 环境变量 +* [DownwardAPIVolumeFiles](/docs/resources-reference/{{page.version}}/#downwardapivolumefile-v1-core) + +这两种呈现Pod和Container字段的方式都称为*Downward API*。 + + +## 用Pod字段作为环境变量的值 + +在这个练习中，你将创建一个包含一个容器的pod。这是该pod的配置文件： + +{% include code.html language="yaml" file="dapi-envars-pod.yaml" ghlink="/cn/docs/tasks/inject-data-application/dapi-envars-pod.yaml" %} + +这个配置文件中，你可以看到五个环境变量。`env`字段是一个[EnvVars](/docs/resources-reference/{{page.version}}/#envvar-v1-core)类型的数组。 +数组中第一个元素指定`MY_NODE_NAME`这个环境变量从Pod的`spec.nodeName`字段获取变量值。同样，其它环境变量也是从Pod的字段获取它们的变量值。 + +**注意:** 本示例中的字段是Pod字段，不是Pod中容器的字段。 +{: .note} + +创建Pod： + +```shell +kubectl create -f https://k8s.io/cn/docs/tasks/inject-data-application/dapi-envars-pod.yaml +``` + +验证Pod中的容器运行正常： + +``` +kubectl get pods +``` + +查看容器日志： + +``` +kubectl logs dapi-envars-fieldref +``` + +输出信息显示了所选择的环境变量的值： + +``` +minikube +dapi-envars-fieldref +default +172.17.0.4 +default +``` + +要了解为什么这些值在日志中，请查看配置文件中的`command` 和 `args`字段。 当容器启动时，它将五个环境变量的值写入stdout。每十秒重复执行一次。 + +接下来，进入Pod中运行的容器，打开一个shell： + +``` +kubectl exec -it dapi-envars-fieldref -- sh +``` + +在shell中，查看环境变量： + +``` +/# printenv +``` + +输出信息显示环境变量已经指定为Pod的字段的值。 + +``` +MY_POD_SERVICE_ACCOUNT=default +... +MY_POD_NAMESPACE=default +MY_POD_IP=172.17.0.4 +... +MY_NODE_NAME=minikube +... +MY_POD_NAME=dapi-envars-fieldref +``` + +## 用容器字段作为环境变量的值 + +前面的练习中，你将Pod字段作为环境变量的值。接下来这个练习，你将用容器字段作为环境变量的值。这里是包含一个容器的pod的配置文件： + +{% include code.html language="yaml" file="dapi-envars-container.yaml" ghlink="/cn/docs/tasks/inject-data-application/dapi-envars-container.yaml" %} + +这个配置文件中，你可以看到四个环境变量。`env`字段是一个[EnvVars](/docs/resources-reference/{{page.version}}/#envvar-v1-core) +类型的数组。数组中第一个元素指定`MY_CPU_REQUEST`这个环境变量从容器的`requests.cpu`字段获取变量值。同样，其它环境变量也是从容器的字段获取它们的变量值。 + +创建Pod： + +```shell +kubectl create -f https://k8s.io/cn/docs/tasks/inject-data-application/dapi-envars-container.yaml +``` + +验证Pod中的容器运行正常： + +``` +kubectl get pods +``` + +查看容器日志： + +``` +kubectl logs dapi-envars-resourcefieldref +``` + +输出信息显示了所选择的环境变量的值： + +``` +1 +1 +33554432 +67108864 +``` + +{% endcapture %} + +{% capture whatsnext %} + +* [给容器定义环境变量](/docs/tasks/configure-pod-container/define-environment-variable-container/) +* [PodSpec](/docs/resources-reference/{{page.version}}/#podspec-v1-core) +* [Container](/docs/resources-reference/{{page.version}}/#container-v1-core) +* [EnvVar](/docs/resources-reference/{{page.version}}/#envvar-v1-core) +* [EnvVarSource](/docs/resources-reference/{{page.version}}/#envvarsource-v1-core) +* [ObjectFieldSelector](/docs/resources-reference/{{page.version}}/#objectfieldselector-v1-core) +* [ResourceFieldSelector](/docs/resources-reference/{{page.version}}/#resourcefieldselector-v1-core) + +{% endcapture %} + + +{% include templates/task.md %} From 492d7e32eb5d8168d91f2365bf55c1cd7fc5fdba Mon Sep 17 00:00:00 2001 From: houjun41544 Date: Mon, 25 Sep 2017 11:44:17 +0800 Subject: [PATCH 2/2] modify --- ...nward-api-volume-expose-pod-information.md | 26 +++++++++---------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/cn/docs/tasks/inject-data-application/downward-api-volume-expose-pod-information.md b/cn/docs/tasks/inject-data-application/downward-api-volume-expose-pod-information.md index 98a738be69..bbb7162888 100644 --- a/cn/docs/tasks/inject-data-application/downward-api-volume-expose-pod-information.md +++ b/cn/docs/tasks/inject-data-application/downward-api-volume-expose-pod-information.md @@ -164,22 +164,22 @@ kubectl exec -it kubernetes-downwardapi-volume-example-2 -- sh 下面这些信息可以通过环境变量和DownwardAPIVolumeFiles提供给容器： -* node的name -* node的IP -* Pod的name -* Pod的namespace -* Pod的IP address -* Pod的service account name +* 节点名称 +* 节点IP +* Pod名称 +* Pod名字空间 +* Pod IP地址 +* Pod服务帐号名称 * Pod的UID -* Container的CPU limit -* Container的CPU request -* Container的memory limit -* Container的memory request +* 容器的CPU约束 +* 容器的CPU请求值 +* 容器的内存约束 +* 容器的内存请求值 此外，以下信息可通过DownwardAPIVolumeFiles获得： -* Pod的labels -* Pod的annotations +* Pod的标签 +* Pod的注释 **Note:** 如果容器未指定CPU和memory limits，则Downward API默认为节点可分配值。 {: .note} @@ -190,7 +190,7 @@ kubectl exec -it kubernetes-downwardapi-volume-example-2 -- sh ## Downward API的动机 -对于容器来说，有时候拥有自己的信息是很有用的，可避免与Kubernetes过度耦合。Downward API使得容器使用自己或者集群的信息，而不必通过Kubernetes client或API server。 +对于容器来说，有时候拥有自己的信息是很有用的，可避免与Kubernetes过度耦合。Downward API使得容器使用自己或者集群的信息，而不必通过Kubernetes客户端或API服务器。 一个例子是有一个现有的应用假定要用一个非常熟悉的环境变量来保存一个唯一标识。一种可能是给应用增加处理层，但这样是冗余和易出错的，而且它违反了低耦合的目标。更好的选择是使用Pod名称作为标识，把Pod名称注入这个环境变量中。 {% endcapture %}