devth/k8s-labeler

k8s-labeler

![Code Climate]([***]

镜像概述

k8s-labeler是一个Kubernetes初始化容器镜像，用于在Pod启动阶段为其添加自定义标签，帮助用户更灵活地管理和识别Kubernetes资源。

核心功能

1. 通过环境变量设置Pod标签：所有以KUBE_LABEL_为前缀的环境变量会被转换为Pod标签（前缀去除）。
2. 支持Downward API：可从Kubernetes Downward API获取Pod元数据（如名称、命名空间）作为标签值。
3. 轻量易用：作为初始化容器运行，不影响主容器的正常工作流程。

使用场景

• 为StatefulSet中的每个Pod设置唯一标签（如基于Pod名称）。
• 暴露Pod元数据（如命名空间、节点名称）作为标签，方便资源筛选与监控。
• 动态添加业务相关标签，提升资源管理效率。

配置说明

必要环境变量

• KUBE_NAMESPACE：必须设置，需与Pod所在的命名空间一致。

标签设置规则

• 环境变量格式：KUBE_LABEL_<标签键>=<标签值>，例如KUBE_LABEL_hostname=pod-123会生成标签hostname: pod-123。

Kubernetes部署示例

以下示例展示如何使用该镜像作为初始化容器，为Pod添加hostname标签（值为Pod名称）：

yaml
initContainers:
  - image: devth/k8s-labeler
    name: labeler
    env:
      - name: KUBE_NAMESPACE
        valueFrom:
          fieldRef:
            fieldPath: metadata.namespace
      - name: KUBE_LABEL_hostname
        valueFrom:
          fieldRef:
            fieldPath: metadata.name

验证标签

部署后，可通过以下命令检查Pod标签：

bash
kubectl get pod -l app=myapp --show-labels

输出示例：

NAME                     READY     STATUS    RESTARTS   AGE       LABELS
myapp-2768796676-c702s   2/2       Running   0          25m       app=myapp,hostname=myapp-2768796676-c702s,pod-template-hash=2768796676

许可证

Copyright 2017 Trevor C. Hartman
该软件采用MIT许可证开源，允许自由使用、复制、修改、分发等，详见原项目许可证说明。