rhemsjapan/k8s-pod-count-checker

k8s-pod-count-checker

镜像概述和主要用途

k8s-pod-count-checker是一个用于在Kubernetes集群中监控Pod数量的Docker镜像。该镜像能够根据指定的命名空间、标签或Pod名筛选出处于Running状态的Pod并进行计数，当Pod数量低于设定的阈值时，可通过RHEMS BADGES服务发送Slack通知，适用于Kubernetes集群中Pod数量的监控与异常告警场景。

核心功能和特性

• 灵活的Pod筛选：支持按命名空间（Namespace）、标签（Label）或Pod名（通过关键字匹配）筛选目标Pod
• 状态监控：仅统计处于Running状态的Pod
• 阈值告警：当符合条件的Pod数量低于设定阈值时触发告警
• Slack通知集成：通过RHEMS BADGES服务实现Slack通知功能
• 配置化部署：通过环境变量进行参数配置，支持Kubernetes CronJob定期执行

使用场景和适用范围

• Kubernetes集群中关键应用的Pod数量监控
• 需要保障特定服务Pod数量不低于最小运行要求的场景
• 运维监控流程中Pod异常减少的实时告警
• CI/CD流水线中Pod部署状态的辅助监控

使用方法和配置说明

准备工作

创建必要文件

需创建以下文件结构：

bash
.
├── clusterrolebinding.yaml  # 集群角色绑定配置
├── serviceaccount.yaml      # 服务账户配置
├── cron-pod-counter.yaml    # CronJob配置
├── dockerhub.yaml           # 私有镜像仓库密钥（如需）
├── kustomization.yaml       # Kustomize配置
└── pod-counter-env          # 环境变量配置文件

文件详细配置

1. ClusterRoleBinding (clusterrolebinding.yaml)

用于授予pod-count-checker查看其他命名空间Pod的权限，需与后续创建的ServiceAccount名称匹配。

yaml
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
  name: admin-clusterrolebinding-batch
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: ClusterRole
  name: cluster-admin
subjects:
- kind: ServiceAccount
  name: {SA_NAME}  # 服务账户名称，需与serviceaccount.yaml中一致
  namespace: {NS_NAME}  # 命名空间名称

2. ServiceAccount (serviceaccount.yaml)

定义用于运行pod-count-checker的服务账户，名称需与ClusterRoleBinding中配置一致。

yaml
apiVersion: v1
kind: ServiceAccount
metadata:
  name: {SA_NAME}  # 服务账户名称

3. 环境变量配置文件 (pod-counter-env)

通过环境变量配置pod-count-checker的运行参数，后续将通过此文件生成ConfigMap。

ini
TARGET_NS=NS_NAME  # 目标命名空间
THRESHOLD=THRESHOLD_NUM  # 阈值数量
API_TOKEN=xxxxxxxx-0123-4567-8901-234567890123  # RHEMS BADGES项目API令牌
ORG=organization_name  # RHEMS BADGES组织名
REPO=repo_name  # RHEMS BADGES仓库名
BRANCH=branch_name  # RHEMS BADGES分支名
APP_NAME=app_name  # 应用名称
CRONJOB=* * * * *  # CronJob调度规则
MEMO=memo  # 备注信息
SLACK_SUCCESS=slack_channnel_setting_name  # 成功时通知的Slack频道配置名
SLACK_FAILED=slack_channnel_setting_name  # 失败时通知的Slack频道配置名
# LABEL_KEY=KEY  # 可选，Pod标签键（需与LABEL_VALUE同时设置）
# LABEL_VALUE=VALUE  # 可选，Pod标签值（需与LABEL_KEY同时设置）
GREP_POD_NAME=GREP_STRING  # 可选，Pod名关键字匹配

4. CronJob (cron-pod-counter.yaml)

定义定期执行Pod数量检查的CronJob，需指定正确的ServiceAccount。

yaml
apiVersion: batch/v1
kind: CronJob
metadata:
  name: cron-pod-counter
  labels:
    app: cron-pod-counter
spec:
  schedule: "* * * * *"  # Cron调度规则，可根据env文件中的CRONJOB参数调整
  jobTemplate:
    spec:
      template:
        spec:
          serviceAccount: {SA_NAME}  # 服务账户名称，需与前面配置一致
          containers:
          - name: cron-pod-counter
            image: rhemsjapan/k8s-pod-count-checker
            imagePullPolicy: IfNotPresent
            envFrom:
              - configMapRef:
                  name: pod-counter-env  # 从ConfigMap加载环境变量

5. Secret (dockerhub.yaml) - 私有仓库时需配置

当从私有Docker仓库拉取镜像时，需配置镜像拉取密钥，详情参考Kubernetes文档。

yaml
apiVersion: v1
kind: Secret
metadata:
  name: regcred
type: kubernetes.io/dockerconfigjson
data:
  .dockerconfigjson: UmVhbGx5IHJlYWxseSByZWVlZWVlZWVlZWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWxsbGxsbGxsbGxsbGxsbGxsbGxsbGxsbGxsbGxsbGx5eXl5eXl5eXl5eXl5eXl5eXl5eSBsbGxsbGxsbGxsbGxsbG9vb29vb29vb29vb29vb29vb29vb29vb29vb25ubm5ubm5ubm5ubm5ubm5ubm5ubm5ubmdnZ2dnZ2dnZ2dnZ2dnZ2dnZ2cgYXV0aCBrZXlzCg==  # 需替换为实际的base64编码的dockerconfigjson

6. Kustomization配置 (kustomization.yaml)

Kustomize配置文件，用于集中管理资源和配置。

yaml
namespace: {NS_NAME}  # 目标命名空间

resources:
  - clusterrolebinding.yaml
  - serviceaccount.yaml
  - dockerhub.yaml  # 私有仓库时需包含
  - cron-pod-counter.yaml

configMapGenerator:
- name: pod-counter-env
  envs:
    - pod-counter-env  # 从环境变量文件生成ConfigMap

部署步骤

使用Kustomize应用配置：

bash
kubectl apply -k .

环境变量说明