feat: make backup role universal by passing paths as variables

README.md

@@ -1,5 +1,3 @@
 # Ansible Collection
 
-Opinionated set of roles to configure reasonable defaults for newly provisioned virtual machines. The repository provides a ready-to-use Ansible Collection (`studio.ansible`) containing reusable roles.
+Opinionated set of roles to configure reasonable defaults for newly provisioned Debian / Ubuntu VMs running Docker. The repository provides a ready-to-use Ansible Collection (`studio.ansible`) containing reusable roles.
-
-Currently only supports Debian-based systems.

roles/backup/defaults/main.yml

@@ -0,0 +1,14 @@
+# ansible/roles/backup/defaults/main.yml
+---
+## Directories to include in the backup
+backup_include_paths:
+  - /etc
+  - /opt/docker
+
+## Directories to exclude from the backup
+backup_exclude_paths: [] ## Nothing to exclude
+
+## Restic retention policy
+backup_retention_daily: 7
+backup_retention_weekly: 4
+backup_retention_monthly: 6

roles/backup/tasks/main.yml

@@ -0,0 +1,31 @@
+---
+- name: Install Restic
+  ansible.builtin.apt:
+    name: restic
+    state: present
+  become: true
+
+- name: Deploy restic backup script
+  ansible.builtin.template:
+    src: restic-backup.sh.j2
+    dest: /usr/local/bin/restic-backup.sh
+    mode: "0700" # Only root can read/execute this because it contains secrets
+
+- name: Deploy restic systemd service
+  ansible.builtin.template:
+    src: restic-backup.service.j2
+    dest: /etc/systemd/system/restic-backup.service
+    mode: "0644"
+
+- name: Deploy restic systemd timer
+  ansible.builtin.template:
+    src: restic-backup.timer.j2
+    dest: /etc/systemd/system/restic-backup.timer
+    mode: "0644"
+
+- name: Enable and start backup timer
+  ansible.builtin.systemd:
+    name: restic-backup.timer
+    enabled: yes
+    state: started
+    daemon_reload: yes

roles/backup/templates/restic-backup.service.j2

@@ -0,0 +1,7 @@
+[Unit]
+Description=Run Restic Backup
+After=network-online.target
+
+[Service]
+Type=oneshot
+ExecStart=/usr/local/bin/restic-backup.sh

roles/backup/templates/restic-backup.sh.j2

@@ -0,0 +1,30 @@
+#!/bin/bash
+## Ansible managed
+
+## Secrets are passed via Ansible Vault variables
+export RESTIC_REPOSITORY="{{ vault_restic_repo_url }}"
+export RESTIC_PASSWORD="{{ vault_restic_password }}"
+export AWS_ACCESS_KEY_ID="{{ vault_aws_access_key }}"
+export AWS_SECRET_ACCESS_KEY="{{ vault_aws_secret_key }}"
+
+set -e
+
+echo "Starting Restic Backup at $(date)"
+
+## Run the backup using paths and exclusions defined in group_vars
+restic backup \
+{% for path in backup_include_paths %}
+  "{{ path }}" \
+{% endfor %}
+{% for path in backup_exclude_paths %}
+  --exclude "{{ path }}" \
+{% endfor %}
+  --cleanup-cache
+
+restic forget \
+  --prune \
+  --keep-daily {{ backup_retention_daily }} \
+  --keep-weekly {{ backup_retention_weekly }} \
+  --keep-monthly {{ backup_retention_monthly }}
+
+echo "Restic backup completed at $(date)"

roles/backup/templates/restic-backup.timer.j2

@@ -0,0 +1,10 @@
+[Unit]
+Description=Run Restic Backup Daily at 4:00 AM
+
+[Timer]
+OnCalendar=*-*-* 04:00:00
+Persistent=true
+RandomizedDelaySec=1800
+
+[Install]
+WantedBy=timers.target

roles/base/tasks/main.yml

@@ -10,6 +10,7 @@
     update_cache: true
     upgrade: dist
     cache_valid_time: 3600
+  when: ansible_facts['os_family'] == "Debian" ## only on Debian / Ubuntu systems
   become: true
 
 - name: Install essential system utilities
@@ -25,6 +26,7 @@
       - unattended-upgrades
     state: present
     update_cache: true
+  when: ansible_facts['os_family'] == "Debian"
   become: true
 #
 # - name: Enable unattended-upgrades

roles/docker/tasks/main.yml

@@ -5,6 +5,7 @@
       - docker.io
       - docker-compose
     state: present
+  when: ansible_facts['os_family'] == "Debian" ## Debian / Ubuntu
   become: true
 
 - name: Ensure Docker service is running

roles/security/tasks/main.yml

@@ -24,6 +24,7 @@
     name:
       - fail2ban
     state: present
+  when: ansible_facts['os_family'] == "Debian"
   become: true
 
 - name: Start fail2ban
@@ -31,3 +32,4 @@
     name: fail2ban
     state: started
     enabled: yes
+  when: ansible_facts['os_family'] == "Debian"