kubernetes 通过环境变量向容器暴露 Pod 信息
在学习docker的时候,大家可能经常看到不少示例在docker run的时候指定环境变量(比如wordpress的docker示例就是通过环境变量传入账户和密码到容器内).这里之所以经常用到环境变量,主要基于以下两点原因
- 容器内的操作往往都是自动化的,而不像在windows会有图形界面提示输入信息或者像在linux有交互式命令可以输入程序需要的数据.也就是程序运行时需要的参数无法交互式指定,不同程序读取配置的方式又各式各样,这种情况下读取环境变量是比较通用的做法
- 容器的隔离性,在k8s里,pod是最小的逻辑单元,关于容器运行时的很多信息(pod的ip,节点的ip,申请的cpu资源,内存资源)都存在pod里,但是有些时候pod内的容器想要知道这些信息,然而容器无法直接读取到pod的所有信息,kubernetes本身提供了
download ap(下面交介绍)i
来把pod的信息传递给容器,其实就是通过环境变量把pod的信息传递给容器.
为容器定义环境变量
当创建pod的时候,可以在配置文件里使用env
字段来定义环境变量,示例如下
apiVersion: v1
kind: Pod
metadata:
name: envar-demo
labels:
purpose: demonstrate-envars
spec:
containers:
- name: envar-demo-container
image: tutum/hello-world
env:
- name: DEMO_GREETING
value: "Hello from the environment"
- name: DEMO_FAREWELL
value: "Such a sweet sorrow"
我们通过kubectl apply -f
创建它
通过执行命令kubectl exec -it envar-demo /bin/sh
进入交互式命令执行容器
输入printenv
来查看环境变量是否正确传入
/ # printenv DEMO_GREETING
Hello from the environment
/ # printenv DEMO_FAREWELL
Such a sweet sorrow
/ #
在配置文件中使用环境变量
以上我们通过交互式容器查看到了我们定义的环境变量,实际上我们在配置文件中定义的环境变量也可以在配置文件中其它位置被引用,比如做为容器初始化执行命令的参数,请看下面示例:
apiVersion: v1
kind: Pod
metadata:
name: print-greeting
spec:
containers:
- name: env-print-demo
image: tutum/hello-world
env:
- name: GREETING
value: "Warm greetings to"
- name: HONORIFIC
value: "The Most Honorable"
- name: NAME
value: "Kubernetes"
command: ["echo"]
args: ["$(GREETING) $(HONORIFIC) $(NAME)"]
与上面不同的是,上面仅仅定义了变量,这里我们引用了定义的变量.
我们通过以上配置创建容器,然后执行kubectl logs
查看输出日志
λ kubectl logs print-greeting
Warm greetings to The Most Honorable Kubernetes
可以看到,被引用的环境变量内容输出了.
downwardapi介绍及简单使用
对于一些容器类型,特别是有状态的,它运行的时候可能需要知道外部依附于pod的信息,比如pod的ip,集群ip,pod申请的内存和cpu数量等.这时候可以通过以下:
-
环境变量把这些依附于pod的字段信息传入到容器内容.(环境变量)
-
另一种方式是通过
DownwardAPIVolumeFiles
把信息传入到容器内容,这两种方式合在一起被称作downward api
示例一、使用pod的字段值作为环境变量
在此处我们创建一个只有一个容器的POD,yaml 如下:
apiVersion: v1
kind: Pod
metadata:
name: dapi-envars-fieldref
spec:
containers:
- name: test-container
image: nginx
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
在配置文件中,可以看到五个环境变量。env 字段是 EnvVars 的数组。数组中的第一个元素指定 MY_NODE_NAME 环境变量从 Pod 的 spec.nodeName 字段中获取其值。类似地,其他环境变量从 Pod 字段中获取它们的名称。
需要注意: 示例中的字段是 Pod 的字段。它们不是 Pod 中的容器的字段
创建pod:
kubectl create -f dapi-envars-pod.yaml
验证 Pod 中的容器是 running 状态:
kubectl get pods
查看容器日志:
kubectl logs dapi-envars-fieldref
输出显示选定的环境变量的值:
minikube
dapi-envars-fieldref
default
172.17.0.4
default
想要知道为什么这些值会打印在日志中,请查看配置文件的 command 和 args 字段。当容器启动时,它将 5 个环境变量的值写到标准输出中。每十秒钟重复一次。
接下来,将一个 shell 放入正在您的 Pod 中运行的容器里面:
kubectl exec -it dapi-envars-fieldref -- sh
在 shell 中,查看环境变量:
/# printenv
我们可以看到输出
root@dapi-envars-fieldref:/# printenv
KUBERNETES_SERVICE_PORT_HTTPS=443
KUBERNETES_SERVICE_PORT=443
HOSTNAME=dapi-envars-fieldref
MY_NODE_NAME=10-9-140-187
MY_POD_NAMESPACE=qos-example
PWD=/
PKG_RELEASE=1~buster
HOME=/root
KUBERNETES_PORT_443_TCP=tcp://172.20.0.1:443
MY_POD_IP=10.244.2.12
NJS_VERSION=0.4.4
TERM=xterm
MY_POD_SERVICE_ACCOUNT=default
SHLVL=1
MY_POD_NAME=dapi-envars-fieldref
KUBERNETES_PORT_443_TCP_PROTO=tcp
KUBERNETES_PORT_443_TCP_ADDR=172.20.0.1
KUBERNETES_SERVICE_HOST=172.20.0.1
KUBERNETES_PORT=tcp://172.20.0.1:443
KUBERNETES_PORT_443_TCP_PORT=443
PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
NGINX_VERSION=1.19.4
_=/usr/bin/printenv
示例一、使用容器的字段值作为环境变量
在前面的练习中,您使用 Pod 字段作为环境变量的值。在下一个练习中,您将使用容器字段用作环境变量的值。下面是一个 Pod 的配置文件,其中包含一个容器:
apiVersion: v1 kind: Pod metadata: name: dapi-envars-resourcefieldref spec: containers: - name: test-container image: k8s.gcr.io/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
在配置文件中,您可以看到四个环境变量。env 字段是 EnvVars 的数组。数组中的第一个元素指定 MY_CPU_REQUEST 环境变量从名为 test-container 的容器的 requests.cpu 字段中获取其值。类似地,其他环境变量从容器字段中获取它们的值。
创建 Pod:
kubectl create -f https://k8s.io/docs/tasks/inject-data-application/dapi-envars-container.yaml
验证 Pod 中的容器是 running 状态:
kubectl get pods
查看容器日志:
kubectl logs dapi-envars-resourcefieldref
输出展示了选定环境变量的值:
1
1
33554432
67108864