funkyfuture/deck-chores

deck-chores

镜像概述和主要用途

deck-chores 是一款通过容器标签配置的Docker容器作业调度器，允许用户在容器上下文中定义定期运行的任务。它支持多种触发方式，可限制任务并发实例，并能在单个服务中仅允许一个容器运行作业，适用于需要在Docker环境中自动化执行定时任务的场景。

• 文档：[***]
• 镜像仓库：https://hub.docker.com/r/funkyfuture/deck-chores
• 代码仓库：https://github.com/funkyfuture/deck-chores
• 问题跟踪：https://github.com/funkyfuture/deck-chores/issues
• 许可协议：ISC（自由软件）

核心功能和特性

• 任务定义：通过容器标签（可选结合镜像标签）在容器上下文中定义定期作业
• 触发方式：支持日期、间隔和类cron触发器
• 并发控制：可设置每个作业的最大同时运行实例数
• 服务限制：限制每个服务仅一个容器运行作业
• 多架构支持：镜像支持 amd64、arm64 和 armv7l 平台，无需模拟器

使用场景和适用范围

适用于需要在Docker容器中自动化执行定期任务的场景，例如数据库备份、日志清理、数据同步等。通过容器标签配置，无需修改容器内部即可添加定时任务，简化管理流程。

使用方法和配置说明

核心功能示例

以下示例展示如何通过 docker-compose.yml 配置数据库每日备份任务：

yaml
version: "3.7"

services:
  wordpress:
    image: wordpress
  mysql:
    image: mariadb
    volumes:
      - ./database_dumps:/dumps  # 挂载备份目录
    labels:
      # 定义备份命令：将所有数据库导出到/dumps目录，文件名包含日期
      deck-chores.dump.command: sh -c "mysqldump --all-databases > /dumps/dump-$(date -Idate)"
      # 触发间隔：每日执行
      deck-chores.dump.interval: daily

注意：建议使用带shebang的脚本执行复杂操作，其标准输出、错误输出及退出码将由deck-chores记录日志。

维护与更新

• 定期更新：正式版本每月更新，包含所有可更新依赖的升级。若连续两次维护更新未发布，可提交issue询问状态。
• 构建镜像：如需基于最新基础镜像构建，可执行以下命令：

  bash
  make build
  

限制

在 Docker Swarm 集群环境中，每个deck-chores实例仅能观察所在节点的容器，因此"每个服务运行一个作业"的限制仅在节点范围内生效。

致谢

本项目的开发依赖以下开源项目：

• APScheduler：任务管理
• cerberus：元数据处理
• docker-py：Docker交互
• flake8、mypy、pytest、tox：测试工具
• Python：编程语言

作者

• Frank Sachsenheim（维护者）
• aeri4list
• alpine-digger
• Brynjar Smári Bjarnason
• Garret Hohmann