Revitalized the borg role

README

@@ -0,0 +1,16 @@
+There are several variables you can define to configure a machines response to the borg role :
+- is_borg_server: a boolean that indicates if a machine will act as a borg server
+- borg_server: a string that contains a borg servers hostname
+- borg_jobs: a list of dict, one item per job with the following keys:
+  - name: the name of the borg job
+  - path: an optional path containing the files to backup
+  - command_to_pipe: an optional command to pipe the backup data from
+  - pre_command: an optional command to run before a job
+  - post_command: an optional command to run after a job
+
+To be valid, a borg job entry needs to have exactly one of the path or command_to_pipe keys.
+
+Here are some job examples :
+- { name: etc, path: "/etc" }
+- { name: mysqldump, command_to_pipe: "/usr/bin/mysqldump -h {{ mysql_server }} -u{{ ansible_hostname }} -p{{ ansible_local.mysql_client.password }} --single-transaction --add-drop-database -B {{ ansible_hostname }}" }
+- { name: gitea, path: "/tmp/gitea.zip", pre_command: "echo '/usr/local/sbin/gitea -C /etc/gitea -c /etc/gitea/app.ini dump -f /tmp/gitea.zip' | su -l _gitea", post_command: "rm -f /tmp/gitea.zip" }

files/borg.fact

@@ -4,19 +4,21 @@
 #     ~~~~                                                           ~~~~     #
 ###############################################################################
 
-echo '{'
+printf "{\n"
 if [ -e '/root/.ssh/borg.pub' ]; then
-    pubkey=`cat /root/.ssh/borg.pub | tr -d "\n"`
-    echo -ne '  "pubkey": "'$pubkey'"'
-    pubkey_prefix=",\n"
+	pubkey=`cat /root/.ssh/borg.pub | tr -d "\n"`
+	printf "  \"pubkey\": \"$pubkey\""
+	pubkey_prefix=",\n"
 fi
 if [ -e '/srv/borg/repos/' ]; then
-    echo -ne "${pubkey_prefix:-}"'  "repos": {'"\n"
-    for repo in `ls /srv/borg/repos/`; do
-        id=`awk '/^id =/ {print $3}' /srv/borg/repos/${repo}/config`
-        echo -ne ${repo_prefix:-}'    "'$repo'": "'$id'"'
-        repo_prefix=",\n"
-    done
-    echo -ne "\n  }"
+	printf "${pubkey_prefix:-}  \"repos\": {\n"
+	for repo in `ls /srv/borg/repos/`; do
+		if [ -e "/srv/borg/repos/${repo}/config" ]; then
+			id=`awk '/^id =/ {print $3}' /srv/borg/repos/${repo}/config`
+			printf "${repo_prefix:-}    \"$repo\": \"$id\""
+			repo_prefix=",\n"
+		fi
+	done
+	printf "\n  }"
 fi
-echo -ne "\n}"
+printf "\n}"

tasks/client.yml

@@ -27,10 +27,7 @@
   delegate_to: "{{ borg_server }}"
 
 - name: create borg client repo on server
-  command: "borg init --encryption=none /srv/borg/repos/{{ ansible_hostname }}"
-  become: yes
-  become_method: su
-  become_user: borg
+  shell: "echo \"borg init --encryption=none /srv/borg/repos/{{ ansible_hostname }}\" | su -l borg"
   delegate_to: "{{ borg_server }}"
   args:
     creates: "/srv/borg/repos/{{ ansible_hostname }}/config"
@@ -56,10 +53,15 @@
 
 - name: make the repo known to the client
   copy:
-    dest: "/root/.config/borg/security/{{ hostvars[borg_server]['ansible_local']['borg']['repos'][ansible_hostname] }}/key-type"
-    content: "2"
+    dest: "/root/.config/borg/security/{{ hostvars[borg_server]['ansible_local']['borg']['repos'][ansible_hostname] }}/{{ item.dest }}"
+    content: "{{ item.content }}"
     owner: root
     mode: 0600
+  loop:
+    - { dest: key-type, content: "2" }
+    - { dest: location, content: "ssh://borg@{{ borg_server }}/srv/borg/repos/{{ ansible_hostname }}" }
+    - { dest: manifest-timestamp, content: "{{ ansible_date_time['iso8601_micro'] }}" }
+  changed_when: false
 
 - name: deploy borg backup script
   template:
@@ -68,23 +70,6 @@
     owner: root
     mode: 0500
 
-- name: activate borg cron on alpine
-  lineinfile:
-    line: '0 23 * * * /usr/local/bin/adyxax_backup.sh'
-    path: /etc/crontabs/root
-  when: ansible_os_family == 'Alpine'
-
-- name: activate borg cron on gentoo or redhat
-  file:
-    state: link
-    src: /usr/local/bin/adyxax_backup.sh
-    dest: /etc/cron.daily/backup
-  when: ansible_os_family == 'Gentoo' or ansible_os_family == 'RedHat'
-
-- name: activate borg cron on openbsd
-  lineinfile:
-    line: '0 23 * * * /usr/local/bin/adyxax_backup.sh'
-    path: /var/cron/tabs/root
-  when: ansible_os_family == 'OpenBSD'
-  notify: restart openbsd cron
+- name: Run OS specific tasks
+  include_tasks: "roles/borg/tasks/client_{{ ansible_distribution }}.yml"
 ...

tasks/client_Alpine.yml

@@ -0,0 +1,6 @@
+---
+- name: activate borg cron
+  lineinfile:
+    line: '0 23 * * * /usr/local/bin/adyxax_backup.sh'
+    path: /etc/crontabs/root
+...

tasks/client_Gentoo.yml

@@ -0,0 +1,7 @@
+---
+- name: activate borg cron
+  file:
+    state: link
+    src: /usr/local/bin/adyxax_backup.sh
+    dest: /etc/cron.daily/backup
+...

tasks/client_OpenBSD.yml

@@ -0,0 +1,7 @@
+---
+- name: activate borg cron
+  lineinfile:
+    line: '0 23 * * * /usr/local/bin/adyxax_backup.sh'
+    path: /var/cron/tabs/root
+  notify: restart openbsd cron
+...

tasks/client_RedHat.yml

@@ -0,0 +1,7 @@
+---
+- name: activate borg cron
+  file:
+    state: link
+    src: /usr/local/bin/adyxax_backup.sh
+    dest: /etc/cron.daily/backup
+...

tasks/client_Ubuntu.yml

@@ -0,0 +1,7 @@
+---
+- name: activate borg cron
+  file:
+    state: link
+    src: /usr/local/bin/adyxax_backup.sh
+    dest: /etc/cron.daily/backup
+...

tasks/server.yml

@@ -7,6 +7,7 @@
 - name: Create borg user on server
   user:
     name: borg
+    group: borg
     shell: /bin/sh
     home: /srv/borg
     createhome: yes

templates/backup.sh.j2

@@ -9,11 +9,17 @@ export PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
 export BORG_RSH="ssh -i /root/.ssh/borg" 
 
 {% for job in borg_jobs %}
+{% if job.pre_command is defined %}
+{{ job.pre_command }}
+{% endif %}
 {% if job.command_to_pipe is defined %}
 {{ job.command_to_pipe }} | borg create borg@{{ borg_server }}:/srv/borg/repos/{{ ansible_hostname }}::{{ job.name }}-{now} {{ job.path | default('-') }}
 {% else %}
 borg create borg@{{ borg_server }}:/srv/borg/repos/{{ ansible_hostname }}::{{ job.name }}-{now} {{ job.path }}
 {% endif %}
+{% if job.post_command is defined %}
+{{ job.post_command }}
+{% endif %}
 {% endfor %}
 
 borg prune borg@{{ borg_server }}:/srv/borg/repos/{{ ansible_hostname }} {{ borg_prune_arguments }}

vars/Debian.yml

@@ -0,0 +1,4 @@
+---
+borg_packages:
+  - borgbackup
+...