axaguildev/dailyclean-api

Daily clean Docker 镜像文档

镜像概述

Daily clean 是一个轻量级 Docker 镜像，专注于提供 Kubernetes 环境下 Pod 的自动化启停能力。通过简单配置，用户可实现指定 Kubernetes 命名空间中所有 Pod 的定时开启或关闭，从而有效管理集群资源，降低非活跃时段的资源消耗。

核心功能和特性

• 自动化启停：支持基于时间规则自动触发 Pod 的开启或关闭操作
• 命名空间级控制：针对 Kubernetes 命名空间维度进行管理，统一控制该命名空间下所有 Pod
• 轻量化设计：镜像体积小，资源占用低，适合在各类 Kubernetes 集群环境中部署
• 灵活配置：通过环境变量或配置文件即可完成定时规则及目标命名空间的设置
• Kubernetes 原生兼容：遵循 Kubernetes API 规范，支持标准的 Pod 管理操作

使用场景和适用范围

适用场景

• 开发/测试环境资源优化：非工作时间（如夜间、周末）自动关闭开发/测试环境的 Pod，释放集群资源
• 降低非活跃时段负载：针对低峰期（如业务低谷时段）的生产环境辅助 Pod 进行定时关闭
• 成本控制：通过按需启停 Pod，减少闲置资源占用，降低云服务或集群运行成本

适用范围

• 运行 Kubernetes 1.16+ 的集群环境
• 需要对 Pod 进行定时启停管理的用户或团队
• 具备 Kubernetes 集群基本操作权限的环境（需能访问 Kubernetes API）

使用方法和配置说明

前置条件

• 已安装 Docker 环境（用于直接运行镜像）或 Kubernetes 集群（用于部署为 Deployment）
• 拥有目标 Kubernetes 集群的访问权限（kubeconfig 文件或集群内 ServiceAccount 权限）

部署方式

1. 直接使用 Docker 运行

通过 docker run 命令启动容器，需挂载 Kubernetes 配置文件（kubeconfig）并设置必要环境变量：

bash
docker run -d \
  --name daily-clean \
  -v /path/to/local/kubeconfig:/root/.kube/config \  # 挂载本地 kubeconfig 文件
  -e KUBE_NAMESPACE=default \                       # 目标 Kubernetes 命名空间
  -e START_TIME=09:00 \                             # 每日 Pod 启动时间（HH:MM 格式）
  -e STOP_TIME=18:00 \                              # 每日 Pod 关闭时间（HH:MM 格式）
  -e TIMEZONE=Asia/Shanghai \                       # 时区设置（默认 UTC）
  your-registry/daily-clean:latest                  # 镜像地址（需替换为实际镜像仓库）

2. 在 Kubernetes 集群内部署

通过 Deployment 资源部署到 Kubernetes 集群，可使用集群内 ServiceAccount 进行认证：

yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: daily-clean
  namespace: kube-system
spec:
  replicas: 1
  selector:
    matchLabels:
      app: daily-clean
  template:
    metadata:
      labels:
        app: daily-clean
    spec:
      serviceAccountName: daily-clean-sa  # 需提前创建具有 Pod 管理权限的 ServiceAccount
      containers:
      - name: daily-clean
        image: your-registry/daily-clean:latest
        env:
        - name: KUBE_NAMESPACE
          value: "default"  # 目标命名空间
        - name: START_TIME
          value: "09:00"    # 启动时间
        - name: STOP_TIME
          value: "18:00"    # 关闭时间
        - name: TIMEZONE
          value: "Asia/Shanghai"  # 时区

配置参数说明

注意事项

• 确保容器具有访问 Kubernetes API 的权限（本地运行时通过挂载 kubeconfig，集群内运行时通过 ServiceAccount 绑定适当的 RBAC 角色）
• START_TIME 和 STOP_TIME 为必填参数，需确保格式正确（如 09:00 而非 9:00）
• 时区设置错误可能导致定时任务执行时间偏差，建议根据实际需求配置 TIMEZONE 参数
• 该工具会直接操作目标命名空间下的所有 Pod，生产环境使用前建议先在测试环境验证功能