willfarrell/crontab

docker-crontab

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

支持的标签和Dockerfile链接

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

为什么创建此项目？

是的，我知道https://github.com/mcuadros/ofelia%EF%BC%88280MB%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%E8%AF%B7%E5%8B%BF%E8%AF%AF%E8%A7%A3%E3%80%82%E5%8F%AA%E6%98%AF%E5%AE%83%E7%BC%BA%E5%B0%91%E4%B8%80%E4%BA%9B%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%E5%85%B3%E9%94%AE%E4%BC%81%E4%B8%9A%E7%89%B9%E6%80%A7%E3%80%82

特性

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

Config.json

• name：作业文件名的可读名称，会转换为slug格式。可选。
• comment：包含在crontab条目中的注释。可选。
• schedule：Cron调度语法，详见***。例如@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。

查看https://github.com/willfarrell/docker-crontab/blob/master/config.sample.json%E8%8E%B7%E5%8F%96%E7%A4%BA%E4%BE%8B%E3%80%82

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}

TODO

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