This site won't get any more updates, see github repo for most recent docs.
This role fully automates the setup process of borg backup, using borgmatic. Borgmatic is a wrapper for borg that makes several tasks much easier, for example backing up MySQL / MariaDB or PostgreSQL databases.
Supported OS:
This role used to install borg / borgmatic via pip which is deprecated. You might try this method but generally speaking you should set
borgmatic_via_pip: falseandapprise_via_pip: false
Requirements:
When using ssh as backend this role will also handles the necessary key based tasks, so Ansible needs access to the backup target machine.
Here is a sample config. This is from group_vars/all.yml so every host has the same config.
borgmatic_compression: "zstd"
borgmatic_keepdaily: 9
borgmatic_keepweekly: 2
borgmatic_keepmonthly: 2
borgmatic_cron_hourrange_start: 2
borgmatic_cron_hourrange_end: 4
borgmatic_apprise: true
borgmatic_apprise_user: "notify"
borgmatic_apprise_password: "secret"
borgmatic_apprise_hostname: "matrix.libcom.de"
borgmatic_apprise_matrixroom: "!uRjlIhFDS39DSRztLY:libcom.de"
borgmatic_hooks_on_error:
- "/usr/local/bin/apprise_borgmatic.sh \"{configuration_filename}\" \"{repository}\" \"{error}\""
You an then set the encryption passphrase individually per host like this:
borgmatic_encpassphrase: "yoursupersecurepassphrase"
It would be advisable to set the backup target in a group var for your site.
borgmatic_repositories:
- "ssh://backupuser@backuptargetsystem1.libcom.de/./subfoldername/{{ inventory_hostname }}"
borgmatic_sshkey_user: "backupuser"
borgmatic_sshkey_targethost: "backuptargetsystem1.libcom.de"
If you don't want to manage the ssh key port maybe because you just cannot integrate the backup target machine into Ansible, set
borgmatic_ssh_manage: False
Backups are scheduled via cron. The time when it will run will be randomized between 1 and 6 in the morning. You can override the time directly
borgmatic_cron_hour: 1
borgmatic_cron_minute: 3
or define another range within which the time will be randomized
borgmatic_cron_hourrange_start: 1
borgmatic_cron_hourrange_end: 6
borgmatic_cron_minuterange_start: 1
borgmatic_cron_minuterange_end: 59
If you don't want to have the cron job managed via the role, set
borgmatic_cron_manage: False
It is a good idea to get notified when something goes wrong during the backup process. That's why there is optional apprise support.
Set borgmatic_apprise to true and apprise will be setup. Apprise is IMHO the best notification wrapper currently. It supports an incredible number of services to get you notified. My Ansible implementation though currently only supports notifications via Matrix chat. (Pull requests welcome).
For matrix notification via apprise to work you would also want to set those variables
tags_allhosts.yml:borgmatic_apprise: true
tags_allhosts.yml:borgmatic_apprise_user: "notify"
tags_allhosts.yml:borgmatic_apprise_password: "secretpassword"
tags_allhosts.yml:borgmatic_apprise_hostname: "matrix.libcom.de"
tags_allhosts.yml:borgmatic_apprise_matrixroom: "!uRQiJBDsdfjiJHJKHuSDFLY:libcom.de"