crazymax/swarm-cronjob

swarm-cronjob Docker镜像文档

镜像概述和主要用途

swarm-cronjob是一款专为Docker Swarm集群设计的定时任务调度工具镜像，旨在解决Swarm原生缺乏时间驱动任务调度能力的问题。该镜像允许用户通过标准cron表达式定义定时规则，在Swarm集群中创建、运行和管理定时任务，支持与Swarm服务无缝集成，实现任务的自动化调度与生命周期管理。

核心功能和特性

• 标准cron表达式支持：兼容POSIX标准cron语法，支持分钟、小时、日、月、周等时间维度的精确调度
• Swarm原生集成：基于Swarm API实现任务调度，与Swarm服务模型深度融合，支持服务扩缩容、滚动更新等特性
• 任务状态监控：实时跟踪任务执行状态，提供成功/失败状态反馈，支持日志输出与审计
• 失败重试机制：可配置任务失败后的重试策略，包括重试次数、重试间隔等参数
• 灵活配置方式：支持环境变量、配置文件、Docker Config/Secret等多种配置方式，适应不同部署场景
• 轻量级设计：镜像体积小巧，资源占用低，适合在Swarm管理节点部署运行

使用场景和适用范围

• 定期维护任务：如日志清理、临时文件删除、系统资源监控报告生成等
• 数据操作任务：数据库定时备份、数据同步、ETL流程执行、报表数据计算等
• 服务管理任务：Swarm服务状态检查、依赖服务健康检测、定时重启异常服务等
• 自动化运维场景：CI/CD流程中的定时构建触发、镜像仓库清理、证书自动更新等

使用方法和配置说明

前置要求

• Docker Engine 19.03+ 环境
• 已初始化的Docker Swarm集群（需至少1个管理节点）
• 管理节点需授予镜像访问Docker Socket的权限（用于调用Swarm API）

基本部署（Swarm Service）

通过docker service create直接部署到Swarm集群：

bash
docker service create \
  --name swarm-cronjob \
  --constraint "node.role == manager" \  # 仅在管理节点运行
  --mount type=bind,source=/var/run/docker.sock,target=/var/run/docker.sock \  # 挂载Docker Socket
  --env "LOG_LEVEL=info" \  # 日志级别（debug/info/warn/error）
  --env "TZ=Asia/Shanghai" \  # 时区配置
  crazy-max/swarm-cronjob

堆栈部署（Docker Compose）

创建docker-compose.yml文件，通过docker stack deploy部署：

yaml
version: '3.8'

services:
  swarm-cronjob:
    image: crazy-max/swarm-cronjob
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock:ro  # 只读挂载Docker Socket
    environment:
      - LOG_LEVEL=info
      - TZ=Asia/Shanghai
      - CHECK_INTERVAL=60s  # 任务状态检查间隔（默认60秒）
    deploy:
      placement:
        constraints:
          - node.role == manager  # 限制在管理节点运行
      resources:
        limits:
          cpus: '0.5'
          memory: 128M

部署命令：

bash
docker stack deploy -c docker-compose.yml swarm-cronjob

任务配置示例

通过Docker Config或本地文件定义定时任务，配置文件格式为YAML，示例（jobs.yaml）：

yaml
jobs:
  - name: "daily-backup"  # 任务名称（唯一）
    schedule: "0 3 * * *"  # 每天凌晨3点执行（cron表达式）
    job:
      image: "busybox:latest"
      command: ["sh", "-c", "echo 'Performing daily backup...' && sleep 30"]
      deploy:
        replicas: 1
        restart_policy:
          condition: none  # 任务完成后不重启
  - name: "hourly-cleanup"
    schedule: "0 * * * *"  # 每小时执行一次
    job:
      image: "alpine:latest"
      command: ["rm", "-rf", "/tmp/*"]
      deploy:
        placement:
          constraints:
            - node.labels.env == "prod"  # 仅在prod标签节点执行

挂载配置文件到容器（修改docker-compose.yml）：

yaml
volumes:
  - ./jobs.yaml:/etc/swarm-cronjob/jobs.yaml:ro  # 挂载任务配置文件

环境变量配置

注意事项

• 需确保部署节点具备Swarm管理权限（仅管理节点可调用Swarm API）
• 任务容器需配置适当的资源限制，避免影响Swarm集群稳定性
• 敏感配置建议通过Docker Secret管理，避免明文存储
• 生产环境建议启用日志持久化，便于任务执行审计与问题排查