52 lines
1.6 KiB
Markdown
52 lines
1.6 KiB
Markdown
|
# Borg backup role
|
||
|
|
This role installs Borg backup on backupservers and clients. The role contains a wrapper-script 'borg-backup' to ease the usage on the client. Supported options include borg-backup info | init | list | backup | mount. Automysqlbackup will run as pre-backup command if it's installed.
|
||
|
|
The role supports both self hosted and rsync.net as Borg server.
|
||
|
|
|
||
|
|
|
||
|
|
## Required variables
|
||
|
|
Define a group backupservers in your inventory with one or multiple hosts. The default location where the backups will be saved is /var/backup/repos/.
|
||
|
|
```
|
||
|
|
infra:
|
||
|
|
[backupservers]
|
||
|
|
backup1.fiaas.co
|
||
|
|
```
|
||
|
|
|
||
|
|
group\_vars/all.yml:
|
||
|
|
```
|
||
|
|
backupservers:
|
||
|
|
- fqdn: backup1.fiaas.co
|
||
|
|
user: borgbackup
|
||
|
|
type: normal
|
||
|
|
home: /backup/
|
||
|
|
pool: repos
|
||
|
|
options: ""
|
||
|
|
- fqdn: yourhost.rsync.net
|
||
|
|
user: userid
|
||
|
|
type: rsync.net
|
||
|
|
home: ""
|
||
|
|
pool: repos
|
||
|
|
options: "--remote-path=borg1"
|
||
|
|
```
|
||
|
|
Contains the list of server you want to use on a certain client.
|
||
|
|
Allows to override backup servers on group or host level.
|
||
|
|
*WARNING: the trailing / in item.home is required.*
|
||
|
|
|
||
|
|
Define a borg\_passphrase for every host.
|
||
|
|
host\_vars\client1:
|
||
|
|
```
|
||
|
|
borg\_passphrase: Ahl9EiNohr5koosh1Wohs3Shoo3ooZ6p
|
||
|
|
```
|
||
|
|
|
||
|
|
*Make sure to check the configured defaults for this role, which contains the list of default locations being backed up in backup_include.* Override this in your inventory where required.
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
Configure Borg on the server and on a client:
|
||
|
|
```
|
||
|
|
ansible-playbook -i inventory/test playbooks/backup.yml -l backup1.fiaas.co
|
||
|
|
ansible-playbook -i inventory/test playbooks/backup.yml -l client1.fiaas.co
|
||
|
|
```
|
||
|
|
|
||
|
|
## Further reading
|
||
|
|
https://borgbackup.readthedocs.io/en/stable/
|