komodorio/k8s-watcher

k8s-watcher 镜像文档

概述

k8s-watcher 是一个用于监控 Kubernetes 集群资源事件的工具，能够实时检测集群中各类资源（如 Pod、Deployment、Service 等）的创建、更新、删除等操作，并将事件信息通过指定渠道发送通知，帮助用户及时掌握集群资源动态。

核心功能和特性

• 资源监控：支持监控 Kubernetes 集群中多种资源类型，包括但不限于 Pod、Deployment、StatefulSet、DaemonSet、Service、ConfigMap、Secret 等
• 事件捕获：可捕获资源的创建（Created）、更新（Updated）、删除（Deleted）等关键事件类型
• 多渠道通知：支持通过 Slack、Email、Webhook 等多种渠道发送事件通知
• 灵活过滤：可通过命名空间、资源标签、事件类型等条件过滤需要关注的事件
• 配置化管理：支持通过配置文件或环境变量自定义监控规则和通知设置

使用场景和适用范围

• 集群运维监控：实时跟踪集群资源变更，辅助运维人员掌握集群状态
• 资源变更审计：记录关键资源的变更历史，满足合规审计需求
• 故障预警：当关键资源（如核心服务 Pod）发生异常删除或更新时，及时发送告警
• 团队协作：向团队成员同步集群资源变更信息，提升协作效率

使用方法和配置说明

安装方式

k8s-watcher 通常通过 Helm Chart 部署到 Kubernetes 集群中：

bash
# 添加 Helm 仓库
helm repo add komodorio https://helm-charts.komodor.io

# 安装 k8s-watcher
helm install k8s-watcher komodorio/k8s-watcher --namespace k8s-watcher --create-namespace

配置参数

通过 values.yaml 文件或 --set 参数进行配置，主要配置项包括：

部署示例

1. 基本部署（监控默认资源）

bash
helm install k8s-watcher komodorio/k8s-watcher \
  --namespace k8s-watcher \
  --create-namespace \
  --set notifications.slack.enabled=true \
  --set notifications.slack.webhookUrl="https://hooks.slack.com/services/XXX/XXX/XXX"

2. 自定义监控资源和命名空间

bash
helm install k8s-watcher komodorio/k8s-watcher \
  --namespace k8s-watcher \
  --create-namespace \
  --set watch.resources=["pods", "services", "configmaps"] \
  --set watch.namespaces=["default", "kube-system"] \
  --set watch.events=["deleted"] \
  --set notifications.webhook.enabled=true \
  --set notifications.webhook.url="https://your-webhook-endpoint.com"

事件通知格式

事件通知通常包含以下信息：

• 事件类型（创建/更新/删除）
• 资源类型和名称
• 命名空间
• 事件发生时间
• 资源变更详情（如更新前后的配置对比）

注意事项

• 确保 k8s-watcher 服务账户具有足够的 RBAC 权限，以获取集群资源事件（推荐使用 cluster-admin 权限或自定义包含 list、watch 权限的 ClusterRole）
• 对于大规模集群，建议合理配置资源过滤规则，避免事件风暴
• 通知渠道需提前配置（如 Slack Webhook、SMTP 服务器等），确保通知可正常送达