nullhe4d/crontab

docker-crontab

一个简单的 docker 包装器，允许在其他容器中运行复杂的 cron 任务。

支持的标签和 Dockerfile 链接

• https://github.com/willfarrell/docker-crontab/blob/master/Dockerfile
• https://github.com/willfarrell/docker-crontab/blob/1.0.0/Dockerfile
• https://github.com/willfarrell/docker-crontab/blob/0.6.0/Dockerfile

为什么选择此镜像？

是的，我知道 https://github.com/mcuadros/ofelia%EF%BC%88%E5%88%9B%E5%BB%BA%E6%AD%A4%E9%A1%B9%E7%9B%AE%E6%97%B6%E5%85%B6%E5%A4%A7%E5%B0%8F%E8%B6%85%E8%BF%87250MB%EF%BC%89%EF%BC%8C%E5%AE%83%E6%98%AF%E6%9C%AC%E9%A1%B9%E7%9B%AE%E7%9A%84%E4%B8%BB%E8%A6%81%E7%81%B5%E6%84%9F%E6%9D%A5%E6%BA%90%E3%80%82%E8%BF%99%E6%98%AF%E4%B8%80%E4%B8%AA%E5%BE%88%E6%A3%92%E7%9A%84%E9%A1%B9%E7%9B%AE%EF%BC%8C%E4%BD%86%E5%AE%83%E7%BC%BA%E5%B0%91%E6%88%91%E8%AE%A4%E4%B8%BA%E6%94%AF%E6%8C%81Docker%E5%8F%91%E5%B1%95%E6%96%B9%E5%90%91%E6%89%80%E9%9C%80%E7%9A%84%E6%9F%90%E4%BA%9B%E5%85%B3%E9%94%AE%E4%BC%81%E4%B8%9A%E7%BA%A7%E7%89%B9%E6%80%A7%E3%80%82

核心功能和特性

• 支持易读的调度语法。
• 允许添加注释，方便提醒 update_script.sh 等脚本的实际用途。
• 使用 image 启动镜像。
• 使用 container 在容器中运行命令。
• 使用 project 在扩展容器实例上运行命令。
• 支持通过 trigger 在 cron 任务完成后触发其他容器中的脚本。

使用场景和适用范围

• 需要在多个容器间协调定时任务的场景。
• 需要为定时任务添加注释以提高可维护性的场景。
• 需要在任务完成后自动触发后续操作（如服务重启、配置更新）的场景。
• 需要通过 Docker Compose/Swarm 管理跨服务定时任务的场景。

配置文件说明

配置文件支持 json、toml 或 yaml 格式，可定义为数组或映射（顶层键将被忽略，可用于组织命令）。

• name：人类可读的任务名称，将用作作业文件名（会转换为slug格式）。可选。
• comment：包含在 crontab 条目中的注释。可选。
• schedule：Crontab 调度语法，如 [***] 所述。例如 @hourly、@every 1h30m、* * * * *。必填。
• command：在 crontab 容器或 docker 容器/镜像中运行的命令。必填。
• image：Docker 镜像名称（例如 library/alpine:3.5）。可选。
• project：Docker Compose/Swarm 项目名称。可选，仅在包含 container 时适用。
• container：完整容器名称或设置 project 时的容器别名。如果包含 image，则此参数被忽略。可选。
• dockerargs：用于完全控制的 docker run/exec 命令行参数。默认为 。
• trigger：docker-crontab 子集对象数组。子集包含：image、project、container、command、dockerargs。
• onstart：在 crontab 容器启动时运行命令，设置为 true。可选，默认值为 false。

查看 config-samples 获取示例。

json
[{
  "schedule": "@every 5m",
  "command": "/usr/sbin/logrotate /etc/logrotate.conf"
}, {
  "comment": "重新生成证书然后重载 nginx",
  "schedule": "43 6,18 * * *",
  "command": "sh -c 'dehydrated --cron --out /etc/ssl --domain ${LE_DOMAIN} --challenge dns-01 --hook dehydrated-dns'",
  "dockerargs": "--env-file /opt/crontab/env/letsencrypt.env -v webapp_nginx_tls_cert:/etc/ssl -v webapp_nginx_acme_challenge:/var/www/.well-known/acme-challenge",
  "image": "willfarrell/letsencrypt",
  "trigger": [{
    "command": "sh -c '/etc/scripts/make_hpkp ${NGINX_DOMAIN} && /usr/sbin/nginx -t && /usr/sbin/nginx -s reload'",
    "project": "conduit",
    "container": "nginx"
  }],
  "onstart": true
}]

使用方法和配置说明

命令行

bash
docker build -t crontab .
docker run -d \
    -v /var/run/docker.sock:/var/run/docker.sock:ro \
    -v ./env:/opt/env:ro \
    -v /path/to/config/dir:/opt/crontab:rw \
    -v /path/to/logs:/var/log/crontab:rw \
    crontab

与 docker-compose 配合使用

1. 确定 docker-compose 容器使用的网络名称
   • 使用 docker network ls 查看现有网络
   • 如果 docker-compose.yml 在 my_dir 目录中，网络可能为 my_dir_default
   • 否则参考 docker-compose 文档
2. 在 docker-crontab 的 config.json 中添加 dockerargs
   • 使用 --network NETWORK_NAME 将新容器连接到 docker-compose 网络
   • 使用 --rm --name NAME 使用命名容器
   • 例如："dockerargs": "--network my_dir_default --rm --name my-best-cron-job"

Dockerfile 示例

Dockerfile
FROM willfarrell/crontab

COPY config.json ${HOME_DIR}/

Logrotate Dockerfile 示例

Dockerfile
FROM willfarrell/crontab

RUN apk add --no-cache logrotate
RUN echo "*/5 *	* * *  /usr/sbin/logrotate /etc/logrotate.conf" >> /etc/crontabs/logrotate
COPY logrotate.conf /etc/logrotate.conf

CMD ["crond", "-f"]

日志记录（开发中）

所有 stdout 输出会被捕获、格式化并保存到 /var/log/crontab/jobs.log。设置 LOG_FILE 为 /dev/null 可禁用日志记录。

示例日志：e6ced859-1563-493b-b1b1-5a190b29e938 2017-06-18T01:27:10+0000 [info] Start Cronjob **map-a-vol** map a volume

Grok 模式：CRONTABLOG %{DATA:request_id} %{TIMESTAMP_ISO8601:timestamp} \[%{LOGLEVEL:severity}\] %{GREEDYDATA:message}

待办事项

• 支持文件更改时自动重新生成 crontab（通过 HUP 信号？）
• 支持在主机机器上运行命令（使用 --privileged？）
• 编写测试
• 设置 TravisCI