blob: 1e9a6347d2d9ff52f61639647620c19a3f440617 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
Ansible Role: BorgBackup
========================
An ansible role that installs and configures a cron task for BorgBackup on a
client and (delegated) server.
This allows you to very simply add backups to your hosts.
The documentation assumes basic knowledge about BorgBackup. You can get up to
speed with Borg by reading their excellent documentation on
<https://borgbackup.readthedocs.io>.
How it works
------------
```mermaid
sequenceDiagram
participant Ansible
participant borg-client
participant borg-server
Ansible->>borg-server: Install dependencies
Ansible->>borg-client: Install dependencies
Ansible->>borg-server: Setup Repository
Ansible->>borg-client: Setup Repository
Ansible->>borg-client: Setup backup job
borg-client->>Ansible: Store decryption keys
borg-client-->borg-server: Do Backup
```
Installation
------------
via ansible-galaxy
```sh
ansible-galaxy collection install kliwniloc.borgbackup
```
```yaml
# requirements.yml
- src: kliwniloc.borgbackup
```
via git
```sh
ansible-galaxy collection install git+https://github.com/kliwniloc/ansible-role-borgbackup.git,main
```
```yaml
# requirements.yml
- src: https://github.com/kliwniloc/ansible-role-borgbackup
version: master
name: kliwniloc.borgbackup
```
Role Variables
--------------
For (much) more details see `defaults/main.yml`
```yaml
################################### Required ###################################
# The borg server host to delegate the server tasks to
borg_server_host: ""
# The public ssh key of the borg server
borg_server_host_ssh_key: ""
################################### Optional ###################################
# The borg server host to push backups to as it will be used in the backup job
borg_server_host_url: "{{ borg_server_host }}"
# The repository name that the borg repository is created
borg_backup_name_format: "{hostname}-{now:%Y-%m-%dT%H:%M:%S}"
# Location for repositories on the borg server
borg_server_user_home: /opt/borg
# Name for the repository (unique on borg server)
borg_repo_name: "{{ inventory_hostname }}"
# Borg backup name format (for cron job)
borg_backup_name_format: "{hostname}-{now:%Y-%m-%dT%H:%M:%S}"
# Should the repo be append only?
borg_mode_append_only: false
# What compression to use in the backup?
borg_compression: zstd
# Directories to include in the backup
borg_included_dirs: []
# Directories to exclude in the backup
borg_excluded_dirs: []
# Passphrase to use with borg
borg_passphrase: ""
# Where to store the decryption keys on the local machine
borg_decryption_keys_yaml_path: "{{ inventory_dir }}/decryption_keys.yml"
# Settings for the backup cron job
borg_cron_time:
minute: 0
hour: 3
```
Example Playbooks
-----------------
Simple Playbook
```yaml
- name: >
Add Borg backup to the borg-client and save the
decryption keys alongside the playbook
hosts: borg-client
roles:
- role: kliwniloc.borgbackup
borg_server_host: borg-server
borg_server_host_ssh_key: ssh-rsa AAAAAAAA...
borg_decryption_keys_yaml_path: "{{ playbook_dir }}/decryption_keys.yml"
borg_included_dirs:
- /home
- /opt/project
```
Multiple Backup servers
```yaml
- name: >
Add Borg backup with multiple borg servers to the borg-client and
save the decryption keys alongside the playbook
hosts: borg-client
vars:
borg_included_dirs:
- /home
- /opt/project
roles:
- role: kliwniloc.borgbackup
borg_server_host: borg-server1
borg_server_host_ssh_key: ssh-rsa AAAAAAAA...
- role: kliwniloc.borgbackup
borg_server_host: borg-server2
borg_server_host_ssh_key: ssh-rsa BBBBBBBB...
```
Dependencies
------------
None.
License
-------
MIT
|
