scottcrossen/kube-node-labels

kube-node-labels 镜像文档

镜像概述

kube-node-labels镜像旨在解决Kubernetes Pod无法直接访问所在节点标签的问题，通过init容器模式将节点标签信息提取并存储到共享卷中，供Pod内的应用容器通过脚本便捷访问节点标签，如主机名、区域、可用区等拓扑信息。

核心功能与特性

• 节点标签提取：通过init容器从Kubernetes API获取当前节点的标签信息
• 脚本化访问：提供label.sh和topology.sh两个脚本，支持直接查询指定标签
• 默认值支持：查询不存在的标签时可指定默认值，避免空输出
• 灵活挂载：通过共享卷将标签信息传递给主容器，无需直接暴露API访问权限
• 轻量级设计：基于精简基础镜像，资源占用低，适合作为init容器使用

使用场景

• 需要根据节点标签动态配置应用参数的场景
• 应用需要获取所在节点的拓扑信息（如区域、可用区）以实现高可用部署
• 基于节点特性（如硬件配置、自定义标签）调整应用行为
• 日志或监控系统需要记录Pod所在节点的详细标签信息

使用方法

前提条件

• 拥有Kubernetes集群管理员权限，能够创建ClusterRole和ClusterRoleBinding
• 目标Namespace已存在

步骤1：创建RBAC权限

由于访问节点标签需要特定权限，需创建ClusterRole、ClusterRoleBinding和ServiceAccount：

yaml
cat << EOF | kubectl apply -f -
---
kind: ClusterRole
apiVersion: rbac.authorization.k8s.io/v1
metadata:
  name: print-region
  namespace: default
rules:
  - apiGroups: [""]
    resources: ["nodes"]
    verbs: ["get"]
---
kind: ClusterRoleBinding
apiVersion: rbac.authorization.k8s.io/v1
metadata:
  name: print-region
  namespace: default
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: ClusterRole
  name: print-region
subjects:
  - kind: ServiceAccount
    name: print-region
    namespace: default
---
kind: ServiceAccount
apiVersion: v1
metadata:
  name: print-region
  namespace: default
EOF

步骤2：创建包含init容器的Job

通过Job示例演示如何使用该镜像获取节点标签：

yaml
cat << EOF | kubectl apply -f -
---
apiVersion: batch/v1
kind: Job
metadata:
  name: print-region
  namespace: default
spec:
  ttlSecondsAfterFinished: 60
  template:
    metadata:
      labels:
        app: print-region
    spec:
      restartPolicy: Never
      serviceAccountName: print-region  # 使用步骤1创建的ServiceAccount
      containers:
      - name: main
        image: alpine
        command:
        - /bin/sh
        args:
        - -c
        - >-
          echo "Hostname:                 '\$(/node-data/label.sh kubernetes.io/hostname)'" && \
          echo "Hostname With Default:    '\$(/node-data/label.sh kubernetes.io/hostname N/A)'" && \
          echo "Nonexistent:              '\$(/node-data/label.sh nonexistent)'" && \
          echo "Nonexistent With Default: '\$(/node-data/label.sh nonexistent N/A)'" && \
          echo "Topology:                 '\$(/node-data/topology.sh)'" && \
          echo "Topology With Default:    '\$(/node-data/topology.sh N/A)'"
        volumeMounts:
        - name: node-data  # 挂载共享卷，访问init容器生成的标签信息
          mountPath: /node-data
      initContainers:
      - name: init
        image: scottcrossen/kube-node-labels:1.1.0  # 使用kube-node-labels镜像
        imagePullPolicy: IfNotPresent
        env:
        - name: NODE  # 从Pod spec获取当前节点名称
          valueFrom:
            fieldRef:
              fieldPath: spec.nodeName
        - name: OUTPUT_DIR  # 标签信息输出目录，需与主容器挂载路径对应
          value: /output
        volumeMounts:
        - name: node-data  # 挂载共享卷，存储标签信息
          mountPath: /output
      volumes:
      - name: node-data  # 定义emptyDir共享卷
        emptyDir: {}
EOF

步骤3：查看结果

通过Job日志验证节点标签是否成功获取：

bash
kubectl -n default logs -f jobs/print-region

预期输出示例：

Hostname:                 'minikube'
Hostname With Default:    'minikube'
Nonexistent:              ''
Nonexistent With Default: 'N/A'
Topology:                 'host=minikube'
Topology With Default:    'region=N/A,zone=N/A,host=minikube'

配置说明

环境变量

脚本使用说明

label.sh

• 功能：查询指定节点标签的值
• 使用格式：label.sh <label-key> [default-value]
• 示例：
  • 查询主机名标签：label.sh kubernetes.io/hostname
  • 查询不存在的标签并指定默认值：label.sh nonexistent-label N/A

topology.sh

• 功能：查询节点的拓扑标签（region、zone、host）
• 使用格式：topology.sh [default-value]
• 示例：
  • 默认查询：topology.sh
  • 指定默认值：topology.sh N/A

注意事项

• 该镜像需要通过init容器运行，且需与主容器共享emptyDir卷
• 节点标签访问权限需通过ClusterRole配置，Role无法跨命名空间访问节点资源
• 本地开发环境（如minikube）可能默认不包含region/zone等云环境标签，生产环境（如GKE、EKS）通常已配置这些标签
• 确保ServiceAccount与ClusterRoleBinding正确关联，否则会出现权限不足错误