libretic/ansible_role_restic
6
0
Fork 0
mirror of https://github.com/roles-ansible/ansible_role_restic/ synced 2024-12-13 05:10:18 +01:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #16 from roles-ansible/chng

Browse source 
improve systemd timer and add mail_on_error option
This commit is contained in:
L3D 2021-07-05 16:23:32 +02:00 committed by GitHub
commit c961e1b281
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 61 additions and 156 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
CHANGELOG.md
View file

@ -1,19 +0,0 @@
> @ changelog /Users/mleutenegger/Desktop/Syntro/Ansible/ansible.restic
> git-chglog 0.2.8..
<a name="unreleased"></a>
## [Unreleased]
### 🍰 Added
- git-chglog
- github workflows ([#25](https://github.com/syntro-opensource/ansible.silverstripe/issues/25))
- example for backup syntax ([#24](https://github.com/syntro-opensource/ansible.silverstripe/issues/24))
<a name="0.2.8"></a>
## [0.2.8] - 2020-09-08
## History
For versions before 0.2.9, see [HISTORY.md](HISTORY.md)
[Unreleased]: https://github.com/syntro-opensource/ansible.silverstripe/compare/0.2.8...HEAD
[0.2.8]: https://github.com/syntro-opensource/ansible.silverstripe/compare/0.2.7...0.2.8

97
HISTORY.md
View file

@ -1,97 +0,0 @@
# Changelog
This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
and [human-readable changelog](https://keepachangelog.com/en/1.0.0/).
## Unreleased
## [0.2.8] 2020-09-08
### Added
* Sanity check for restic binary
* Support for the Backblaze B2 backend
## [0.2.7] 2020-08-05
### Added
* Config option to exclude files
* Contributing guide
## [0.2.6] 2020-06-05
### Changed
* Password now use `regex_escape()` filter in templates
## [0.2.5] - 2020-06-02
### Fixed:
* AWS credentials are now supplied to the initialising step
* Cronjob step does not fail if `scheduled` parameter is not set on repo
* init respects `'config already initialized'` string
## [0.2.4] - 2020-06-01
### Added
* `aws_default_region` for repos
## 0.2.3 - 2020-05-18
### Fixed
* extraction path is actually generated
## [0.2.2]
### Changed
* Updated default Restic version to `'0.9.6'`
### Fixed
* Backup scripts use bash (@maciekmm)
* SFTP Link correctly renders in MD
## [0.2.1]
### Fixed
* Crontab entries are now created correctly (@dnmvisser)
* Molecule now correctly runs lint (@mleutenegger)
## [0.2.0]
### Added
* S3 Support
## [0.1.5]
### Changed
* Path generation for `forget` task now checks if `src` is actually filled and not only defined.
### Added
* `prune` option for automatic pruning during forget
## [0.1.4]
### Changed
* `--keep-tags` tags are correctly applied to the forget command
* Backup policies now also check if the respective variable actually contains a value
### Added
* Added a template which only adds credentials for use with `source` on linux distros
## [0.1.3]
### Changed
* Creating script dir before templating out scripts
## [0.1.2]
### Changed
* build sucessfully completes
## [0.1.1]
### Changed
* `restic_url` is now set in defaults
## 0.1.0
### Added
* initial release
[Unreleased]: https://github.com/arillso/ansible.restic/compare/0.2.8...HEAD
[0.2.8]: https://github.com/arillso/ansible.restic/compare/0.2.7...0.2.8
[0.2.7]: https://github.com/arillso/ansible.restic/compare/0.2.6...0.2.7
[0.2.6]: https://github.com/arillso/ansible.restic/compare/0.2.5...0.2.6
[0.2.5]: https://github.com/arillso/ansible.restic/compare/0.2.4...0.2.5
[0.2.4]: https://github.com/arillso/ansible.restic/compare/0.2.3...0.2.4
[0.2.3]: https://github.com/arillso/ansible.restic/compare/0.2.2...0.2.3
[0.2.2]: https://github.com/arillso/ansible.restic/compare/0.2.1...0.2.2
[0.2.1]: https://github.com/arillso/ansible.restic/compare/0.2.0...0.2.1
[0.2.0]: https://github.com/arillso/ansible.restic/compare/0.1.5...0.2.0
[0.1.5]: https://github.com/arillso/ansible.restic/compare/0.1.4...0.1.5
[0.1.4]: https://github.com/arillso/ansible.restic/compare/0.1.3...0.1.4
[0.1.3]: https://github.com/arillso/ansible.restic/compare/0.1.2...0.1.3
[0.1.2]: https://github.com/arillso/ansible.restic/compare/0.1.1...0.1.2
[0.1.1]: https://github.com/arillso/ansible.restic/compare/0.1.0...0.1.1

12
README.md
View file

@ -119,7 +119,7 @@ Repository defined in `restic_repos`.
Available variables:
| 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 |
@ -136,12 +136,16 @@ Available variables:
| `keep_within` | no | If set, only keeps snapshots in this time period. |
| `keep_tag` | no | If set, keep snapshots with this tags. Make sure to specify a list. |
| `prune` | no (`false`) | If `true`, the `restic forget` command in the script has the [`--prune` option](https://restic.readthedocs.io/en/stable/060_forget.html#removing-backup-snapshots) appended. |
| `scheduled` | no (`false`) | If `restic_create_cron` is set to `true`, this backup is scheduled. |
| `scheduled` | no (`false`) | If `restic_create_cron` is set to `true`, this backup is scheduled and tries to create a systemd timer unit. If it fails, it is creating a cronjob. |
| `schedule_oncalendar` | ``'*-*-* 02:00:00'`` | The time for the systemd timer. Please notice the randomDelaySec option. By Default the backup is done every night at 2 am (+0-4h). But only if scheduled is true. |
| `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_hour` | no (`2`) | 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 ) |
| `exclude` | no (`{}`) | Allows you to specify files to exclude. See [Exclude](#exclude) for reference. |
| `disable_logging` | no | Optionally disable logging |
| `mail_on_error` | no | Optionally send a mail if the backupjob will fail *(mailx is required)* |
| `mail_address` | if `mail_on_error` is true | The mail addressto recive mails if you enabled ``mail_on_error``. |
Example:
```yaml
@ -151,7 +155,7 @@ restic_backups:
repo: remove
src: /path/to/data
scheduled: true
schedule_hour: 3
schedule_oncalendar: '*-*-* 01:00:00'
```
> You can also specify restic_backups as an array, which is a legacy feature and

4
defaults/main.yml
View file

@ -13,5 +13,9 @@ restic_create_cron: false
restic_dir_owner: '{{ ansible_user | default(ansible_user_id) }}'
restic_dir_group: '{{ ansible_user | default(ansible_user_id) }}'
# timer defaults
restic_systemd_timer_randomizeddelaysec: '4h'
restic_systemd_timer_default_OnCalendar: '*-*-* 02:00:00'
# perform simple version check for this role? (true is recomended)
submodules_versioncheck: false

2
tasks/configure.yml
View file

@ -23,4 +23,4 @@
loop: "{{ restic_repos|dict2items }}"
when:
- item.value.init is defined
- item.value.init
- item.value.init|bool

40
tasks/timer.yml
View file

@ -1,21 +1,4 @@
---
- name: cleanup old CRON jobs from migration
ansible.builtin.cron:
name: 'arillso.restic backup {{ item.name }}'
job: 'CRON=true {{ restic_script_dir }}/backup-{{ item.name }}.sh'
minute: '{{ item.schedule_minute | default("*") }}'
hour: '{{ item.schedule_hour | default("*") }}'
weekday: '{{ item.schedule_weekday | default("*") }}'
month: '{{ item.schedule_month | default("*") }}'
state: absent
become: true
no_log: true
with_items: '{{ restic_backups }}'
when:
- restic_create_cron
- item.name is defined
- item.scheduled | default(false)
- name: create systemd timer
block:
- name: copy systemd timer
@ -87,9 +70,28 @@
- restic_create_cron
- item.name is defined
- item.scheduled | default(false)
- name: delete old cronjob entry if available
ansible.builtin.cron:
name: "do1jlr.restic backup {{ item.name }}"
job: "CRON=true {{ restic_script_dir }}/backup-{{ item.name | replace(' ', '') }}.sh"
minute: '{{ item.schedule_minute | default("*") }}'
hour: '{{ item.schedule_hour | default("2") }}'
weekday: '{{ item.schedule_weekday | default("*") }}'
month: '{{ item.schedule_month | default("*") }}'
state: absent
cron_file: '/etc/crontab'
user: 'root'
become: true
no_log: true
with_items: '{{ restic_backups }}'
when:
- restic_create_cron
- item.name is defined
- item.scheduled | default(false)
when: ansible_service_mgr == 'systemd'
rescue:
- name: set ceonjo intead of systemd
- name: set cronjob intead of systemd
set_fact:
restic_force_cron: true
@ -99,7 +101,7 @@
name: "do1jlr.restic backup {{ item.name }}"
job: "CRON=true {{ restic_script_dir }}/backup-{{ item.name | replace(' ', '') }}.sh"
minute: '{{ item.schedule_minute | default("*") }}'
hour: '{{ item.schedule_hour | default("*") }}'
hour: '{{ item.schedule_hour | default("2") }}'
weekday: '{{ item.schedule_weekday | default("*") }}'
month: '{{ item.schedule_month | default("*") }}'
state: present

4
templates/restic.timer.j2
View file

@ -2,8 +2,8 @@
Description=Run restic backup {{ item.name }} every night
[Timer]
OnCalendar=*-*-* 02:00:00
RandomizedDelaySec=3h
OnCalendar={{ restic_systemd_timer_default_OnCalendar }}
RandomizedDelaySec={{ restic_systemd_timer_randomizeddelaysec }}
Persistent=yes
[Install]

11
templates/restic_script_Linux.j2
View file

@ -32,6 +32,8 @@ export B2_ACCOUNT_KEY={{ restic_repos[item.repo].b2_account_key }}
{% if item.src is defined %}
BACKUP_SOURCE={{ item.src }}
{% endif %}
set -uxo pipefail
{#
Define Tags
@ -131,6 +133,8 @@ else
echo "$(date -u '+%Y-%m-%d %H:%M:%S') ERROR" >> {{ backup_result_log }}
fi
{#
Define stdin forget commands
#}
@ -140,4 +144,11 @@ then
echo "$(date -u '+%Y-%m-%d %H:%M:%S') OK" >> {{ forget_result_log }}
else
echo "$(date -u '+%Y-%m-%d %H:%M:%S') ERROR" >> {{ forget_result_log }}
{% if item.mail_on_error is defined and item.mail_on_error == true %}
mail -s "restic backup failed on {{ ansible_hostname }}" {{ item.mail_address }} <<< "Something went wrong while running restic backup script running at {{ ansible_hostname }} at $(date -u '+%Y-%m-%d %H:%M:%S').
{%- if item.src is defined -%}
{{ ' ' }}We tried to backup '{{ item.src }}'.
{%- endif -%}
{{ ' ' }}Please repair the restic-{{ item.name | replace(' ', '') }} job."
{% endif %}
fi

2
vars/main.yml
View file

@ -10,5 +10,5 @@ restic_os_variables:
paths:
- 'vars'
playbook_version_number: 8 # should be int
playbook_version_number: 11 # should be int
playbook_version_path: 'do1jlr.restic.version'