robustadev/kubewatch

Kubewatch Docker镜像文档

镜像概述与主要用途

Kubewatch是一款轻量级的Kubernetes事件监控工具，旨在实时跟踪Kubernetes集群中的资源变更事件（如Pod、Deployment、Service等资源的创建、更新、删除操作），并将事件信息及时推送至预配置的通知渠道，帮助集群管理员和DevOps团队快速掌握集群动态。

核心功能与特性

• Kubernetes资源事件监控：支持监控多种Kubernetes核心资源，包括Pod、Deployment、ReplicaSet、Service、Node等的生命周期事件
• 多通知渠道支持：可集成Slack、Email、Webhook、PagerDuty等多种通知渠道，满足不同团队的协作需求
• 事件过滤能力：支持通过配置过滤特定类型的事件或资源，避免无关通知干扰
• 轻量级部署：容器化设计，可直接通过Docker或Kubernetes Deployment快速部署，资源占用低
• 配置灵活：支持通过环境变量或配置文件自定义监控规则和通知参数

使用场景与适用范围

• 集群管理员监控：实时跟踪集群资源变更，及时发现异常操作或故障
• DevOps团队协作：应用部署、更新等操作触发通知，便于团队协同感知变更
• 故障排查辅助：当集群中发生Pod崩溃、节点异常等事件时，快速推送通知至相关人员
• 合规审计支持：记录并通知关键资源变更，满足操作审计需求

使用方法与配置说明

前提条件

• 已安装Docker环境
• 具备Kubernetes集群访问权限（需提供kubeconfig文件或集群API地址及认证信息）

基本部署方式

Docker Run命令

bash
docker run -d \
  --name kubewatch \
  -v /path/to/kubeconfig:/root/.kube/config \  # 挂载Kubernetes配置文件
  -e KUBEWATCH_RESOURCE="pod,deployment,service" \  # 要监控的资源类型，逗号分隔
  -e KUBEWATCH_SLACK_CHANNEL="#kubernetes-alerts" \  # Slack通知渠道
  -e KUBEWATCH_SLACK_TOKEN="xoxb-xxxxxxxxx-xxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx" \  # Slack API Token
  kubewatch:latest

Kubernetes部署（Deployment示例）

yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: kubewatch
  namespace: default
spec:
  replicas: 1
  selector:
    matchLabels:
      app: kubewatch
  template:
    metadata:
      labels:
        app: kubewatch
    spec:
      containers:
      - name: kubewatch
        image: kubewatch:latest
        env:
        - name: KUBEWATCH_RESOURCE
          value: "pod,deployment,node"
        - name: KUBEWATCH_SLACK_CHANNEL
          value: "#cluster-monitor"
        - name: KUBEWATCH_SLACK_TOKEN
          valueFrom:
            secretKeyRef:
              name: kubewatch-secrets
              key: slack-token
        volumeMounts:
        - name: kubeconfig
          mountPath: /root/.kube/config
          readOnly: true
      volumes:
      - name: kubeconfig
        secret:
          secretName: kubeconfig-secret  # 包含kubeconfig的Secret

配置参数说明

环境变量配置

配置文件方式

除环境变量外，也可通过挂载配置文件（默认路径/etc/kubewatch/config.yaml）进行配置，示例：

yaml
resource:
  - pod
  - deployment
  - service
slack:
  channel: "#kubernetes-alerts"
  token: "xoxb-xxxxxxxxx-xxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"
webhook:
  url: "https://your-webhook-endpoint.com"
eventFilter:
  - "pod:deleted"
  - "deployment:updated"

通知渠道配置示例

Slack渠道配置

1. 在Slack中创建专用通知渠道（如#kubernetes-alerts）
2. 创建Slack App，获取API Token（需包含chat:write权限）
3. 通过环境变量或配置文件设置KUBEWATCH_SLACK_CHANNEL和KUBEWATCH_SLACK_TOKEN

Webhook渠道配置

1. 准备接收Webhook的服务端点（需支持POST请求）
2. 通过环境变量KUBEWATCH_WEBHOOK_URL设置端点URL
3. 通知格式示例（JSON）：

json
{
  "eventType": "pod_deleted",
  "resource": "pod",
  "name": "example-pod",
  "namespace": "default",
  "timestamp": "2024-05-20T10:30:00Z",
  "message": "Pod example-pod in namespace default has been deleted"
}

注意事项

• 确保Kubewatch容器具有足够的Kubernetes API访问权限（建议使用RBAC配置最小权限）
• 通知渠道配置错误可能导致通知发送失败，建议先通过日志排查问题（可通过docker logs kubewatch查看容器日志）
• 对于大规模集群，建议配置事件过滤规则以减少通知噪声