Overview

Contents:

• Usage
  • Invocation
  • Caveats & Tips
  • Job definitions
  • Job triggers
  • Container-scoped configuration
  • Environment variables
  • Cryptographically secured connection to the Docker daemon
• Contributing
  • Types of Contributions
  • Get Started!
  • Pull Request Guidelines
• History
  • 1.4 (2024-06-15)
  • 1.3 (2022-08-23)
  • 1.2 (2021-06-25)
  • 1.0 (2020-03-27)
  • 1.0-rc1 (2020-02-16)
  • 0.3.1 (2019-03-02)
  • 0.3 (2019-01-06)
  • 0.3-rc1 (2018-12-18)
  • 0.2 (2018-02-23)
  • 0.2-rc3 (2017-12-23)
  • 0.2-rc2 (2017-08-05)
  • 0.2-rc1 (2017-07-01)
  • 0.1 (2017-03-02)
  • 0.1.beta3 (2017-01-22)
  • 0.1.beta2 (2016-12-08)
  • 0.1.beta1 (2016-12-04)

deck-chores

A job scheduler for Docker containers, configured via container labels.

• Documentation: https://deck-chores.readthedocs.io

• Image repositories:

  • https://github.com/funkyfuture/deck-chores/pkgs/container/deck-chores

  • https://hub.docker.com/r/funkyfuture/deck-chores

• Code repository: https://github.com/funkyfuture/deck-chores

• Issue tracker: https://github.com/funkyfuture/deck-chores/issues

• Free software: ISC license

Features

• define regular jobs to run within a container context with container and optionally with image labels

• use date, interval and cron-like triggers

• set a maximum of simultaneously running instances per job

• restrict job scheduling to one container per service

• multi-architecture image supports amd64, arm64 and arm platforms (the latter are currently not provided for download)

Example

Let’s say you want to dump the database of a Wordpress once a day. Here’s a docker-compose.yml that defines a job that will be handled by deck-chores:

version: "3.7"

services:
  wordpress:
    image: wordpress
  mysql:
    image: mariadb
    volumes:
      - ./database_dumps:/dumps
    labels:
      deck-chores.dump.command: sh -c "mysqldump --all-databases > /dumps/dump-$$(date -Idate)"
      deck-chores.dump.interval: daily

It is however recommended to use scripts with a proper shebang for such actions. Their outputs to stdout and stderr as well as their exit code will be logged by deck-chores.

Maintenance

The final release is supposed to receive monthly updates that includes updates of all updateable dependencies. If one is skipped, don’t worry. When a second maintenance release is skipped, feel free to open an issue to ask what the status is.

You can always build images upon an up-to-date base image with:

make build

Limitations

When running on a cluster of Docker Swarm nodes, each deck-chores instance can only observe the containers on the node it’s running on, and hence only restrict to run one job per service within the node’s context.

Acknowledgements

It wouldn’t be as charming to write this piece of software without these projects:

• APScheduler for managing jobs

• cerberus for processing metadata

• docker-py for Docker interaction

• flake8, mypy, pytest and tox for testing

• Python

Authors

• Frank Sachsenheim (maintaining)

• aeri4list

• alpine-digger

• Brynjar Smári Bjarnason

• Garret Hohmann