velero-watchdog Docker镜像文档

1. 镜像概述与主要用途

velero-watchdog 是一款轻量级应用，旨在监控 Kubernetes（K8s）环境中 Velero 备份任务的状态。其核心目标是通过实时追踪 Velero 备份的执行情况，帮助用户及时发现备份失败、超时或异常状态，确保数据备份流程的可靠性。

2. 核心功能与特性

2.1 核心功能

• Velero 备份状态监控：实时检查 Velero 备份任务的运行状态（如成功、失败、超时、进行中）。
• 异常状态检测：自动识别备份失败、超时或未按计划执行的任务。

2.2 主要特性

• 轻量级设计：资源占用低，适合在资源受限的 K8s 环境中部署。
• Kubernetes 原生集成：通过 Kubernetes API 与 Velero 交互，无需额外依赖。
• 可配置性：支持自定义监控间隔、告警规则等参数（具体配置需参考源码）。

3. 使用场景与适用范围

3.1 适用场景

• Kubernetes 集群中使用 Velero 进行数据备份的环境。
• 需要实时监控备份任务状态，确保备份流程正常执行的场景。
• 需及时发现并处理备份失败、超时等异常情况的场景。

3.2 适用人群

• DevOps 工程师
• SRE（站点可靠性工程师）
• 负责 Kubernetes 集群数据备份与恢复的系统管理员

4. 使用方法与配置说明

4.1 前提条件

• 已部署 Kubernetes 集群（版本需兼容 Velero 要求）。
• 已在集群中部署 Velero。
• 容器运行环境（Docker 或 Kubernetes）。
• 具备访问 Kubernetes API 的权限（用于获取 Velero 备份信息）。

4.2 Docker 部署示例

4.2.1 docker run 命令

bash
docker run -d \
  --name velero-watchdog \
  -e KUBECONFIG=/etc/kubeconfig \
  -e VELERO_NAMESPACE=velero \  # Velero 部署的命名空间
  -e MONITOR_INTERVAL=300 \      # 监控间隔（秒，默认300）
  -v /path/to/local/kubeconfig:/etc/kubeconfig \  # 挂载本地 KUBECONFIG 文件
  seriohub/velero-watchdog:latest

4.2.2 Docker Compose 配置

yaml
version: '3'
services:
  velero-watchdog:
    image: seriohub/velero-watchdog:latest
    container_name: velero-watchdog
    environment:
      - KUBECONFIG=/etc/kubeconfig
      - VELERO_NAMESPACE=velero
      - MONITOR_INTERVAL=300
    volumes:
      - /path/to/local/kubeconfig:/etc/kubeconfig  # 替换为本地 KUBECONFIG 路径
    restart: unless-stopped

4.3 环境变量配置说明

注意：更多配置参数（如告警通知方式、备份超时阈值等）请参考 GitHub 源码 获取最新说明。

5. 注意事项

• 确保容器内的 KUBECONFIG 文件具有足够权限访问 Velero 资源（建议使用最小权限原则配置 RBAC）。
• 镜像标签建议指定具体版本（如 v1.0.0），避免直接使用 latest 导致版本不可控。
• 详细功能与配置请以 GitHub 仓库 的最新文档为准。