werkspot/k8s-event-listener

K8s Event Listener

镜像概述和主要用途

K8s Event Listener是一款用于监听Kubernetes集群中指定资源变化的工具，当目标资源发生添加、更新或删除事件时，会自动调用预设的回调脚本，并将事件详情作为参数传递。该工具设计用于集群内部运行（利用服务账户令牌与API交互），也支持从集群外部通过kubeconfig连接，适用于资源监控、自动化操作触发等场景。

核心功能和特性

• 多资源支持：可监听certificatesigningrequests、ingresses、pods、serviceaccounts等Kubernetes资源类型
• 事件回调机制：资源变化时自动执行指定脚本，传递资源类型、操作类型、命名空间和资源名称参数
• 集群内外兼容：集群内默认使用服务账户令牌；外部运行需指定kubeconfig文件和上下文
• 健康检查：内置HTTP服务器提供存活（/live）和就绪（/ready）探针端点，默认监听8080端口，端口可自定义
• 缓存初始化：启动时初始化缓存，所有匹配资源在引导阶段被视为新增事件

使用场景和适用范围

• 资源变更监控：实时跟踪pod、ingress等资源的创建、更新和删除操作
• 自动化操作触发：资源变化时自动执行后续流程（如发送通知、更新配置、重启服务等）
• 外部系统集成：将Kubernetes资源事件同步至外部监控或管理平台
• CI/CD流程扩展：在资源部署或更新后触发测试、验证等CI/CD环节

使用方法和配置说明

命令行参数

运行模式配置

集群内运行

默认模式，工具使用Kubernetes注入的服务账户令牌与API交互，无需额外配置kubeconfig。需确保服务账户具有监听目标资源的权限。

集群外运行

必须通过--kube-config指定kubeconfig文件路径，并通过--kube-context指定要使用的Kubernetes上下文。

回调脚本参数说明

事件触发时，回调脚本将按以下顺序接收参数：

1. resourceType - 资源类型（如pods、ingresses）
2. action - 操作类型（add、update或delete）
3. namespace - 资源所在命名空间
4. name - 资源名称

健康检查配置

工具启动后在指定端口（默认8080）启动HTTP服务器，提供以下探针端点：

• /live - 存活探针，检查与Kubernetes API的连接性
• /ready - 就绪探针，检查与Kubernetes API的连接性

部署示例

基本使用示例

监听pod资源变化并调用当前目录下的test.sh脚本：

bash
k8s-event-listener -r pod -c ./test.sh

脚本将收到类似以下的调用：

pods add instapro-client ic-nl-tests-acc-26937c1b-webserver-7ff884c575-dvwkb
pods add instapro-gd-city-filter r-travaux-com-db-queue-worker-7585fd84c-4gxzc
pods add monitoring datadog-5swgj

Docker运行示例

集群内运行

bash
docker run -v /path/to/callback/script:/app/test.sh k8s-event-listener:latest -r pod -c /app/test.sh

集群外运行（挂载kubeconfig）

bash
docker run -v ~/.kube/config:/kubeconfig -v /path/to/callback/script:/app/test.sh k8s-event-listener:latest \
  -r pod -c /app/test.sh --kube-config /kubeconfig --kube-context my-context

Kubernetes Deployment示例

yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: k8s-event-listener
spec:
  replicas: 1
  selector:
    matchLabels:
      app: k8s-event-listener
  template:
    metadata:
      labels:
        app: k8s-event-listener
    spec:
      serviceAccountName: event-listener-sa  # 需配置具有资源监听权限的服务账户
      containers:
      - name: k8s-event-listener
        image: k8s-event-listener:latest
        args: ["-r", "pod", "-c", "/scripts/test.sh", "-p", "8080"]
        ports:
        - containerPort: 8080
        volumeMounts:
        - name: callback-scripts
          mountPath: /scripts
        livenessProbe:
          httpGet:
            path: /live
            port: 8080
          initialDelaySeconds: 5
          periodSeconds: 10
        readinessProbe:
          httpGet:
            path: /ready
            port: 8080
          initialDelaySeconds: 5
          periodSeconds: 10
      volumes:
      - name: callback-scripts
        configMap:
          name: callback-scripts-config  # 包含test.sh脚本的ConfigMap