realbase/k8s-cron-worker

Cron任务执行Sidecar镜像

镜像概述

该镜像作为Sidecar容器，设计用于部署在工作节点（Worker）旁，专门负责定时任务（Cron Jobs）的调度与执行。通过将定时任务逻辑与主应用解耦，实现任务执行的独立管理，减轻工作节点负载，同时确保定时任务的稳定运行与可观测性。

核心功能与特性

• 定时任务调度：支持标准Cron表达式，精确控制任务执行频率（如分钟、小时、日、月、周级别的调度）。
• 与工作节点协同：可与主工作节点共享网络、存储等资源，便于访问主应用依赖的服务或数据。
• 轻量级设计：基于精简基础镜像构建，资源占用低，适合在资源受限环境中部署。
• 任务日志记录：内置日志系统，记录任务执行状态、输出及错误信息，支持日志持久化。
• 失败重试机制：任务执行失败时可自动重试，支持自定义重试次数与间隔。

使用场景与适用范围

• 微服务架构：在微服务集群中，为需要定时执行任务的服务（如数据同步、报表生成、清理任务等）提供独立的任务执行单元。
• 资源隔离需求：当主应用不宜承担定时任务负载（如高CPU/内存消耗的周期性任务）时，通过Sidecar实现任务与主应用的资源隔离。
• 共享资源场景：需访问主应用网络或存储资源的定时任务（如数据库备份、本地文件处理等）。
• 分布式系统：在分布式环境中协调跨节点的定时任务执行，避免重复调度。

使用方法与配置说明

基本部署（Docker Run）

bash
docker run -d \
  --name cron-sidecar \
  --network=worker-network  # 与工作节点共享网络
  -v /host/path/to/cron/config:/etc/cron.d  # 挂载Cron任务配置文件
  -v /host/path/to/logs:/var/log/cron  # 挂载日志目录（可选）
  -e CRON_SCHEDULE="*/5 * * * *"  # 任务执行频率（默认：每分钟）
  -e LOG_LEVEL="info"  # 日志级别（支持debug/info/warn/error，默认info）
  -e RETRY_COUNT=3  # 失败重试次数（默认3次）
  your-registry/cron-sidecar:latest

Docker Compose配置

yaml
version: '3'
services:
  worker:
    image: your-worker-image:latest
    # 工作节点配置...
    
  cron-sidecar:
    image: your-registry/cron-sidecar:latest
    depends_on:
      - worker
    network_mode: service:worker  # 共享工作节点网络命名空间
    volumes:
      - ./cron-config:/etc/cron.d  # 本地Cron配置目录
      - ./cron-logs:/var/log/cron  # 日志持久化
    environment:
      - CRON_SCHEDULE="0 3 * * *"  # 每天凌晨3点执行
      - LOG_LEVEL="debug"
      - RETRY_COUNT=5

配置说明

1. Cron任务配置文件

在挂载的/etc/cron.d目录中创建任务配置文件（如my-task），格式如下：

# 分钟 小时 日 月 周 用户 命令
*/5 * * * * root /usr/local/bin/your-task-script.sh >> /var/log/cron/my-task.log 2>&1

注意：配置文件需符合系统Cron格式，且文件名不含扩展名。

2. 环境变量参数

3. 日志管理

默认日志路径为/var/log/cron/，可通过挂载宿主机目录实现持久化。日志文件命名格式为[任务名].log，包含任务执行时间、输出及错误信息。

注意事项

• 确保Sidecar容器与工作节点在同一网络，或通过network_mode: service:worker共享网络命名空间，以访问主应用服务。
• Cron任务脚本需具有可执行权限，建议在Dockerfile中通过chmod +x设置。
• 对于敏感信息（如数据库密码），建议通过环境变量或 secrets 管理，避免硬编码在任务脚本中。