diff --git a/README.md b/README.md index 1dea47c..6cb91a9 100644 --- a/README.md +++ b/README.md @@ -112,23 +112,28 @@ Repository defined in `restic_repos`. Available variables: -| Name | Required | Description | -| ---------------- |:-----------------------------:| ----------------------------------------------------------------------------------------------------------------------- | -| `name` | yes | The name of this backup. Used together with pruning and needs to be unique. | -| `repo` | yes | The name of the repository to backup to. | -| `src` | yes | The source directory or file | -| `stdin` | no | Is this backup created from a [stdin](https://restic.readthedocs.io/en/stable/040_backup.html#reading-data-from-stdin)? | -| `stdin_cmd` | no (yes if `stdin` == `true`) | The command to produce the stdin. | -| `stdin_filename` | no | The filename used in the repository. | -| `tags` | no | Array of default tags | -| `keep_last` | no | If set, only keeps the last n snapshots. | -| `keep_hourly` | no | If set, only keeps the last n hourly snapshots. | -| `keep_daily` | no | If set, only keeps the last n daily snapshots. | -| `keep_weekly ` | no | If set, only keeps the last n weekly snapshots. | -| `keep_monthly` | no | If set, only keeps the last n monthly snapshots. | -| `keep_yearly ` | no | If set, only keeps the last n yearly snapshots. | -| `keep_within` | no | If set, only keeps snapshots in this time period. | -| `keep_tag` | no | If set, keep snapshots with this tags. | +| Name | Required (Default) | Description | +| ------------------ |:-----------------------------:| ----------------------------------------------------------------------------------------------------------------------- | +| `name` | yes | The name of this backup. Used together with pruning and scheduling and needs to be unique. | +| `repo` | yes | The name of the repository to backup to. | +| `src` | yes | The source directory or file | +| `stdin` | no | Is this backup created from a [stdin](https://restic.readthedocs.io/en/stable/040_backup.html#reading-data-from-stdin)? | +| `stdin_cmd` | no (yes if `stdin` == `true`) | The command to produce the stdin. | +| `stdin_filename` | no | The filename used in the repository. | +| `tags` | no | Array of default tags | +| `keep_last` | no | If set, only keeps the last n snapshots. | +| `keep_hourly` | no | If set, only keeps the last n hourly snapshots. | +| `keep_daily` | no | If set, only keeps the last n daily snapshots. | +| `keep_weekly ` | no | If set, only keeps the last n weekly snapshots. | +| `keep_monthly` | no | If set, only keeps the last n monthly snapshots. | +| `keep_yearly ` | no | If set, only keeps the last n yearly snapshots. | +| `keep_within` | no | If set, only keeps snapshots in this time period. | +| `keep_tag` | no | If set, keep snapshots with this tags. | +| `scheduled` | no (`false`) | If `restic_create_cron` is set to `true`, this backup is scheduled. | +| `schedule_minute` | no (`*`) | Minute when the job is run. ( 0-59, *, */2, etc ) | +| `schedule_hour` | no (`*`) | Hour when the job is run. ( 0-23, *, */2, etc ) | +| `schedule_weekday` | no (`*`) | Weekday when the job is run. ( 0-6 for Sunday-Saturday, *, etc ) | +| `schedule_month` | no (`*`) | Month when the job is run. ( 1-12, *, */2, etc ) | ## Dependencies none diff --git a/tasks/distribution/Linux.yml b/tasks/distribution/Linux.yml index 451a015..2de4a22 100644 --- a/tasks/distribution/Linux.yml +++ b/tasks/distribution/Linux.yml @@ -15,3 +15,19 @@ - item.src is defined or item.stdin is defined - item.src is defined or item.stdin and item.stdin_cmd is defined - item.repo in restic_repos + +- name: Setup CRON jobs + cron: + name: 'arillso.restic backup {{ item.name }}' + job: 'CRON=true {{ restic_script_dir }}/backup-{{ item.name }}.sh' + minute: '{{ schedule_minute | default("*") }}' + hour: '{{ schedule_hour | default("*") }}' + weekday: '{{ schedule_weekday | default("*") }}' + month: '{{ schedule_month | default("*") }}' + state: present + become: yes + when: + - restic_create_cron + - item.name is defined + - item.scheduled + with_items: '{{ restic_backups }}' \ No newline at end of file