DownLoad API-容器内获取Pod信息

前言

在容器内部我们经常需要获取到pod的一些信息,比如所在node的ip与名字、pod的ip、资源限制等信息。

k8s提供了Downward API来满足上面的需求, 与ConfigMap一样的也是有两种方式将信息注入到容器变量中,分别是环境变量与volume挂载方式

准备

首先我们要知道Pod里会有一些什么信息。我们才能使用Downward API去获取,准备一个yml,启用,观察Pod信息

kube-nginx.yml

apiVersion: v1
kind: Pod
metadata: 
  name: nginx
  labels:
    app: nginx
spec:
  containers:
  - name: nginx
    image: nginx
    imagePullPolicy: IfNotPresent  #用于设置镜像拉取策略
    ports: 
    - name: nginx-port
      containerPort: 80
      protocol: TCP
    resources: #资源限制
      limits: #资源最高限制
        cpu: "0.5" #cpu限制 单位core数
        memory: "1Gi" #内存限制 单位 M/G
      requests: #容器请求的最低资源限制
        cpu: "0.4"
        memory: "512Mi"

启用该Pod,查看Pod的详细信息,这里只把一些容器里面会需要用到的信息展示出来,其它的我已删除。

大概观察一下

[root@master k8s]# kubectl get pods -o yaml
apiVersion: v1
items:
- apiVersion: v1
  kind: Pod
  metadata:
    labels:
      app: nginx
    name: nginx
    namespace: default
    resourceVersion: "2062588"
    uid: 7815a305-31de-4f4d-820d-cdc17928a90f
  spec:
    containers:
    - image: nginx
      imagePullPolicy: IfNotPresent
      name: nginx
      ports:
      - containerPort: 80
        name: nginx-port
        protocol: TCP
      resources:
        limits:
          cpu: 500m
          memory: 1Gi
        requests:
          cpu: 400m
          memory: 512Mi
    nodeName: node01
    serviceAccount: default
    serviceAccountName: default
  status:
    hostIP: 10.0.4.11
    phase: Running
    podIP: 10.244.1.21
    podIPs:
    - ip: 10.244.1.21
    qosClass: Burstable
    startTime: "2022-11-17T17:35:39Z"

从上面展示的结果来看,一般容器里面需要的信息基本都有了,下面我们来演示如何在容器中获取

hostIP: 10.0.4.11 节点的ip
podIP: 10.244.1.21
phase: Running
cpu: 500m
memory: 1Gi

环境变量方式

Pod信息获取

我们在学习ConfigMap时用到了 configMapKeyRef 来将配置引入容器环境变量。在这里我们使用一个新的词 fieldRef 来引用Pod的信息。

下面修改 kube-nginx.yml 内容如下

apiVersion: v1
kind: Pod
metadata:
  name: nginx
  labels:
    app: nginx
spec:
  containers:
  - name: nginx
    image: nginx
    imagePullPolicy: IfNotPresent  #用于设置镜像拉取策略
    ports:
    - name: nginx-port
      containerPort: 80
      protocol: TCP
    resources: #资源限制
      limits: #资源最高限制
        cpu: "0.5" #cpu限制 单位core数
        memory: "1Gi" #内存限制 单位 M/G
      requests: #容器请求的最低资源限制
        cpu: "0.4"
        memory: "512Mi"
    env:
    - name: NG_POD_IP
      valueFrom:
        fieldRef:
          fieldPath: status.podIP #Pod IP
    - name: NG_POD_NAME
      valueFrom:
        fieldRef:
          fieldPath: metadata.name # Pod name
    - name: NG_NODE_NAME
      valueFrom:
        fieldRef:
          fieldPath: spec.nodeName # 节点名称
    - name: NG_NODE_IP
      valueFrom:
        fieldRef:
          fieldPath: status.hostIP # 节点IP
    - name: NG_UID
      valueFrom:
        fieldRef:
          fieldPath: metadata.uid # 唯一标识
    - name: NG_APP_NAME
      valueFrom:
        fieldRef:
          fieldPath: metadata.labels['app'] # 获取labels信息

启用Pod

kubectl apply -f kube-nginx.yml

# 查看容器内的环境变量
[root@master k8s]# kubectl exec  nginx -- env | grep NG_ 
NG_POD_IP=10.244.1.25
NG_POD_NAME=nginx
NG_NODE_NAME=node01
NG_NODE_IP=10.0.4.11
NG_UID=cb3bfa3a-8d64-4fd7-885d-1839afa4d9c4
NG_APP_NAME=nginx

从上面打印出来的环境变量信息,说明我们需要的信息已经正确设置到了容器里面。

在上面的例子,我只是打印了Pod的基本信息,但是像 resources 中的cpu 内存限制没有在上面例子中展示,那是因为Containers中的信息不是通过fieldRef获取,而是使用 resourceFieldRef

Containers信息获取

Containers信息使用resourceFieldRef来获取,修改kube-nginx.yml 内容如下

apiVersion: v1
kind: Pod
metadata:
  name: nginx
  labels:
    app: nginx
spec:
  containers:
  - name: nginx
    image: nginx
    imagePullPolicy: IfNotPresent  #用于设置镜像拉取策略
    ports:
    - name: nginx-port
      containerPort: 80
      protocol: TCP
    resources: #资源限制
      limits: #资源最高限制
        cpu: "1.2" #cpu限制 单位core数
        memory: "1Gi" #内存限制 单位 M/G
      requests: #容器请求的最低资源限制
        cpu: "0.8"
        memory: "512Mi"
    env:
    - name: NG_REQUEST_CPU
      valueFrom:
        resourceFieldRef:
          containerName: nginx
          resource: requests.cpu
    - name: NG_REQUEST_MEMORY
      valueFrom:
        resourceFieldRef:
          containerName: nginx
          resource: requests.memory
    - name: NG_LIMITS_CPU
      valueFrom:
        resourceFieldRef:
          containerName: nginx
          resource: limits.cpu
    - name: NG_LIMITS_MEMORY
      valueFrom:
        resourceFieldRef:
          containerName: nginx
          resource: limits.memory

启动Pod,查看容器环境变量

[root@master k8s]# kubectl exec  nginx -- env | grep NG_
NG_REQUEST_MEMORY=536870912
NG_LIMITS_CPU=2
NG_LIMITS_MEMORY=1073741824
NG_REQUEST_CPU=1

Volume 挂载方式

通过volume挂载方式可以将Pod信息或 Containers信息挂载为容器的文件

注意:通过volume的方式不能将status的信息设置进来了,我之前尝试着想设置 status.hostIP,结果报错,提示说不支持,只支持 "metadata.annotations", "metadata.labels", "metadata.name", "metadata.namespace", "metadata.uid"

* spec.volumes[0].downwardAPI.fieldRef.fieldPath: Unsupported value: "status.hostIP": supported values: "metadata.annotations", "metadata.labels", "metadata.name", "metadata.namespace", "metadata.uid"

使用 explain 查看 explain pod.spec.volumes.downwardAPI.items,也是显示只支持 annotations, labels, name namespace

kubectl explain pod.spec.volumes.downwardAPI.items
FIELDS:
   fieldRef     <Object>
     Required: Selects a field of the pod: only annotations, labels, name and
     namespace are supported.
   resourceFieldRef     <Object>
     Selects a resource of the container: only resources limits and requests
     (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently
     supported.

那么我们就按照支持的内容修改kube-nginx.yml 内容如下

apiVersion: v1
kind: Pod
metadata:
  name: nginx
  labels:
    app: nginx
spec:
  containers:
  - name: nginx
    image: nginx
    imagePullPolicy: IfNotPresent  #用于设置镜像拉取策略
    ports:
    - name: nginx-port
      containerPort: 80
      protocol: TCP
    resources: #资源限制
      limits: #资源最高限制
        cpu: "1.2" #cpu限制 单位core数
        memory: "1Gi" #内存限制 单位 M/G
      requests: #容器请求的最低资源限制
        cpu: "0.8"
        memory: "512Mi"
    volumeMounts: 
    - name: "podinfo"
      mountPath: "/etc/podinfo"
  volumes:
    - name: podinfo
      downwardAPI:
        items:
        - path: "labels"   
          fieldRef:
            fieldPath: metadata.labels # 获取labels信息
        - path: "limits_cpu"
          resourceFieldRef:
            containerName: nginx
            resource: limits.cpu
        - path: "requests_memory"
          resourceFieldRef:
            containerName: nginx
            resource: requests.memory

查看/etc/podinfo下的文件,并且查看每个文件内容

[root@master k8s]# kubectl exec -it nginx -- ls -lrt /etc/podinfo
total 0
lrwxrwxrwx 1 root root 22 Nov 19 19:07 requests_memory -> ..data/requests_memory
lrwxrwxrwx 1 root root 17 Nov 19 19:07 limits_cpu -> ..data/limits_cpu
lrwxrwxrwx 1 root root 13 Nov 19 19:07 labels -> ..data/labels
[root@master k8s]# kubectl exec -it nginx -- cat /etc/podinfo/labels         
app="nginx"
[root@master k8s]# kubectl exec -it nginx -- cat /etc/podinfo/limits_cpu     
2
[root@master k8s]# kubectl exec -it nginx -- cat /etc/podinfo/requests_memory
536870912

通过上面展示的数据信息,表明我们已经成功通过 volume 将Pod信息以及 Containers信息挂载到容器里。

Downward API 就介绍到这里,后面会介绍Pod的生命周期与重启策略。


欢迎关注,学习不迷路!

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,793评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,567评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,342评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,825评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,814评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,680评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,033评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,687评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,175评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,668评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,775评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,419评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,020评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,978评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,206评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,092评论 2 351
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,510评论 2 343

推荐阅读更多精彩内容