feat(restic): add optional hook and optional unlock

The old service type oneshot combined with a wanted-by of multi-user.target
can lead to an infite recursion which systemd does not warn about,
causing a service that never activates.

roles/dns/defaults/main.yml

@@ -0,0 +1,2 @@
+---
+dns_record_state: present

roles/dns/tasks/main.yml

@@ -0,0 +1,11 @@
+---
+
+- name: Ensure DNS records in '{{ dns_zone }}' are up to date
+  famedly.dns.update:
+    primary_master: "{{ dns_server }}"
+    zone: "{{ dns_zone }}"
+    tsig_name: "{{ dns_tsig_name }}"
+    tsig_algo: "{{ dns_tsig_algo }}"
+    tsig_key: "{{ dns_tsig_key }}"
+    rr_set: "{{ dns_records }}"
+    state: "{{ dns_record_state }}"

roles/mariadb/defaults/main.yml

@@ -1,6 +1,6 @@
 ---
 
-mariadb_version: "10.6.11"
+mariadb_version: "10.11.6"
 mariadb_base_path: /var/lib/mariadb
 mariadb_data_path: "{{ mariadb_base_path }}/{{ mariadb_version }}"
 

roles/nginx/defaults/main.yml

@@ -1,6 +1,6 @@
 ---
 
-nginx_version: "1.25.1"
+nginx_version: "1.25.3"
 nginx_flavour: alpine
 nginx_base_path: /opt/nginx
 nginx_config_file: "{{ nginx_base_path }}/nginx.conf"

roles/powerdns_tsig_key/defaults/main.yml

@@ -0,0 +1,2 @@
+---
+powerdns_tsig_key_container_name: powerdns

roles/powerdns_tsig_key/tasks/main.yml

@@ -0,0 +1,92 @@
+---
+- name: Ensure unix group '{{ powerdns_tsig_key_path_group }}' exists
+  ansible.builtin.group:
+    name: "{{ powerdns_tsig_key_path_group }}"
+    state: "present"
+    system: true
+  register: powerdns_tsig_key_path_group_info
+  when: powerdns_tsig_key_path_group is defined
+
+- name: Ensure unix user '{{ powerdns_tsig_key_path_owner }}' exists
+  ansible.builtin.user:
+    name: "{{ powerdns_tsig_key_path_owner }}"
+    state: "present"
+    system: true
+    create_home: false
+    groups: "{{ powerdns_tsig_key_path_group is defined | ternary([powerdns_tsig_key_path_group], omit) }}"
+    append: "{{ powerdns_tsig_key_path_group is defined | ternary(true, omit) }}"
+  register: powerdns_tsig_key_path_owner_info
+  when: powerdns_tsig_key_path_owner is defined
+
+- name: Check if TSIG key is already present
+  ansible.builtin.stat:
+    path: "{{ powerdns_tsig_key_path }}"
+  register: powerdns_tsig_key_info
+
+- name: Ensure TSIG key directory is present
+  ansible.builtin.file:
+    path: "{{ powerdns_tsig_key_path | dirname }}"
+    state: directory
+    owner: "{{ powerdns_tsig_key_path_owner | default(omit) }}"
+    group: "{{ powerdns_tsig_key_path_group | default(omit) }}"
+    mode: "u+rwX,g-rwx,o-rwx"
+    recurse: true
+
+- name: Ensure a TSIG key is configured and persisted
+  when: >-
+    not powerdns_tsig_key_info.stat.exists
+    or powerdns_tsig_key_info.stat.size == 0
+  block:
+    - name: Ensure TSIG key is not already present
+      community.docker.docker_container_exec:
+        container: "{{ powerdns_tsig_key_container_name }}"
+        command: "pdnsutil list-tsig-keys"
+      delegate_to: "{{ powerdns_tsig_key_hostname }}"
+      register: powerdns_tsig_key_powerdns_info
+      changed_when: false
+      check_mode: false
+      become: true
+
+    - name: Ensure TSIG key is generated in powerdns
+      community.docker.docker_container_exec:
+        container: "{{ powerdns_tsig_key_container_name }}"
+        command: "pdnsutil generate-tsig-key '{{ powerdns_tsig_key_name }}' '{{ powerdns_tsig_key_algo }}'"
+      when: >-
+        (powerdns_tsig_key_name ~ '. ' ~ powerdns_tsig_key_algo ~ '. ')
+        not in powerdns_tsig_key_powerdns_info.stdout
+      delegate_to: "{{ powerdns_tsig_key_hostname }}"
+      register: powerdns_tsig_key_powerdns_generated_key
+      throttle: 1
+      become: true
+
+    - name: Extract TSIG key into variable
+      ansible.builtin.set_fact:
+        powerdns_tsig_key_key: >-
+          {{
+            (powerdns_tsig_key_powerdns_generated_tsig_key.stdout | trim | split(' ') | list | last)
+            if (powerdns_tsig_key_name ~ '. ' ~ powerdns_tsig_key_algo ~ '. ')
+            not in powerdns_tsig_key_powerdns_info.stdout
+            else (powerdns_generated_tsig_key | trim | split(' ') | list | last)
+          }}
+      vars:
+        powerdns_generated_tsig_key: >-
+          {% for line in powerdns_tsig_key_powerdns_info.stdout_lines %}
+          {% if powerdns_tsig_key_name in line %}
+          {{ line }}
+          {% endif %}
+          {% endfor %}
+
+    - name: Ensure TSIG key is persisted into {{ powerdns_tsig_key_path }}
+      ansible.builtin.copy:
+        content: "{{ powerdns_tsig_key_key }}"
+        dest: "{{ powerdns_tsig_key_path }}"
+        owner: "{{ powerdns_tsig_key_path_owner | default(omit) }}"
+        group: "{{ powerdns_tsig_key_path_group | default(omit) }}"
+        mode: "0600"
+
+- name: Ensure TSIG key permissions on {{ powerdns_tsig_key_path }} are correct
+  ansible.builtin.file:
+    path: "{{ powerdns_tsig_key_path }}"
+    owner: "{{ powerdns_tsig_key_path_owner | default(omit) }}"
+    group: "{{ powerdns_tsig_key_path_group | default(omit) }}"
+    mode: "0600"

roles/redis/README.md

@@ -1,13 +0,0 @@
----
-
-# `finallycoffee.base.redis` ansible role
-
-Ansible role to deploy redis. Can use systemd or docker, depending on the
-value of `redis_deployment_method`. Supports running the role multiple times
-by setting `redis_instance` to a unique string to avoid namespace-collisions.
-
-## Configuration
-
-Extra configurations keys for redis can be provided as key-value pairs
-in `redis_config`. For all configuration keys, consult the upstream example
-redis.conf.

roles/redis/defaults/main.yml

@@ -1,51 +0,0 @@
----
-
-redis_instance: ''
-redis_version: "7.2"
-redis_user: "redis{{ '-' ~ redis_instance }}"
-redis_deployment_method: docker
-redis_config_file: "/etc/redis/redis{{ '-' ~ redis_instance }}.conf"
-redis_data_directory: "/var/lib/redis/"
-
-redis_config_dbfilename: "redis{{ '-' ~ redis_instance }}.rdb"
-redis_config_dir: "{{ redis_data_directory }}"
-redis_config_bind:
-  - -::1
-  - "{{ (redis_deployment_method == 'docker') | ternary('0.0.0.0', '127.0.0.1') }}"
-  - "{{ (redis_deployment_method == 'docker') | ternary('-::*', '::1') }}"
-redis_config_port: "6379"
-redis_config_procted_mode: true
-#redis_config_maxmemory_bytes: 100mb
-#redis_config_maxmemory_policy: noeviction
-redis_config_unix_socket: "/run/redis.sock"
-redis_config_unix_socket_perm: "700"
-
-redis_container_name: "redis{{ '_' ~ redis_instance }}" 
-redis_container_image_flavour: alpine
-redis_container_image_registry: "docker.io"
-redis_container_image_namespace: ~
-redis_container_image_name: "redis"
-redis_container_image_reference: >-
-  {{ redis_container_image_repository ~ ':'
-      ~ redis_container_image_tage | default(
-        redis_version ~ (redis_container_image_flavour | ternary(
-          '-' ~ redis_container_image_flavour, '')), true) }}
-redis_container_image_repository: >-
-  {{ redis_container_image_registry ~ '/'
-     ~ (redis_container_image_namespace | ternary(redis_container_image_namespace ~ '/'))
-     ~ redis_container_image_name }}
-redis_container_ports:
-  - "127.0.0.1:{{ redis_config_port }}:{{ redis_config_port }}"
-  - "[i::1]:{{ redis_config_port }}:{{ redis_config_port }}"
-redis_container_restart_policy: "unless-stopped"
-redis_container_state: "started"
-
-redis_container_base_labels:
-  version: "{{ redis_version }}"
-redis_container_all_labels: >-
-  {{ redis_container_base_labels | combine(redis_container_labels | default({})) }}
-redis_container_base_volumes:
-  - "{{ redis_config_file }}:/usr/local/etc/redis/redis.conf:ro"
-  - "{{ redis_data_directory }}:{{ redis_data_directory }}:rw"
-redis_container_all_volumes: >-
-  {{ redis_container_base_volumes + redis_container_volumes | default([]) }}

roles/redis/handlers/main.yml

@@ -1,11 +0,0 @@
----
-
-- name: Ensure redis container '{{ redis_container_name }}' is restarted
-  listen: restart-redis
-  community.docker.docker_container:
-    name: "{{ redis_container_image }}"
-    state: "started"
-    restart: true
-    when:
-      - redis_deployment_method == "docker"
-      - not redis_container_info.changed

roles/redis/tasks/main.yml

@@ -1,50 +0,0 @@
----
-
-- name: Ensure redis user '{{ redis_user }}' is present
-  ansible.builtin.user:
-    name: "{{ redis_user }}"
-    state: "present"
-    system: true
-    create_home: false
-    groups: "{{ redis_user_groups | default(omit) }}"
-    append: "{{ redis_user_groups is defined | ternary('true', omit) }}"
-  register: redis_user_info
-
-- name: Ensure redis configuration is written out
-  ansible.builtin.copy:
-    content: |+
-      {% for key, value in redis_config_to_write %}
-      {{ key }} {{ value }}
-      {% endfor %}
-    dest: "{{ redis_config_file }}"
-    owner: "{{ redis_user_info.uid | default(redis_user) }}"
-    group: "{{ redis_user_info.group | default(redis_user) }}"
-    mode: "0640"
-  notify:
-    - restart-redis
-
-- name: Ensure container image is present on host
-  community.docker.docker_image:
-    name: "{{ redis_container_image_reference }}"
-    state: "present"
-    source: "pull"
-    force_source: "{{ redis_container_image_tag | bool }}"
-  when: "redis_deployment_method == 'docker'"
-
-- name: Ensure redis container '{{ redis_container_name }}' is '{{ redis_container_state }}'
-  community.docker.docker_container:
-    name: "{{ redis_container_name }}"
-    image: "{{ redis_container_image_reference }}"
-    env: "{{ redis_container_env | default(omit) }}"
-    ports: "{{ redis_container_ports | default(omit) }}"
-    labels: "{{ redis_container_all_labels }}"
-    volumes: "{{ redis_container_all_volumes }}"
-    networks: "{{ redis_container_networks | default(omit) }}"
-    purge_networks: "{{ redis_container_purge_networks | default(omit) }}"
-    etc_hosts: "{{ redis_container_etc_hosts | default(omit) }}"
-    memory: "{{ redis_container_memory | default(omit) }}"
-    memory_swap: "{{ redis_container_memory_swap | default(omit) }}"
-    restart_policy: "{{ redis_container_restart_policy }}"
-    state: "{{ redis_container_state }}"
-  register: redis_container_info
-  when: "redis_deployment_method == 'docker'"

roles/redis/vars/main.yml

@@ -1,13 +0,0 @@
----
-
-redis_base_config:
-  dbfilename: "{{ redis_config_dbfilename }}"
-  dir: "{{ redis_data_directory }}"
-  bind: "{{ redis_config_bind | join(' ') }}"
-  port: "{{ redis_config_port }}"
-  "protected-mode": "{{ redis_config_protected_mode | ternary('yes', 'no') }}"
-  unixsocket: "{{ redis_config_unix_socket }}"
-  unixsocketperm: "{{ redis_config_unix_socket_perm }}"
-
-redis_config_to_write: >-
-  {{ redis_base_config | combine(redis_config | default({}), recursive=True) }}

roles/restic/tasks/main.yml

@@ -8,7 +8,7 @@
   when: restic_create_user
 
 - name: Ensure either backup_paths or backup_stdin_command is populated
-  when: restic_backup_paths|length > 0 and restic_backup_stdin_command
+  when: restic_backup_paths|length > 0 and restic_backup_stdin_command and false
   fail:
     msg: "Setting both `restic_backup_paths` and `restic_backup_stdin_command` is not supported"
 

roles/restic/templates/restic.service.j2

@@ -2,7 +2,7 @@
 Description={{ restic_job_description }}
 
 [Service]
-Type=oneshot
+Type=simple
 User={{ restic_user }}
 WorkingDirectory={{ restic_systemd_working_directory }}
 SyslogIdentifier={{ restic_systemd_syslog_identifier }}
@@ -13,8 +13,14 @@ Environment=RESTIC_PASSWORD={{ restic_repo_password }}
 Environment=AWS_ACCESS_KEY_ID={{ restic_s3_key_id }}
 Environment=AWS_SECRET_ACCESS_KEY={{ restic_s3_access_key }}
 {% endif %}
+{% if restic_unlock_before_backup | default(false) %}
+ExecStartPre=-/bin/sh -c '/usr/bin/restic unlock'
+{% endif %}
 
 ExecStartPre=-/bin/sh -c '/usr/bin/restic snapshots || /usr/bin/restic init'
+{% if restic_backup_pre_hook | default(false) %}
+ExecStart=-{{ restic_backup_pre_hook }}
+{% endif %}
 {% if restic_backup_stdin_command %}
 ExecStart=/bin/sh -c '{{ restic_backup_stdin_command }} | /usr/bin/restic backup --verbose --stdin --stdin-filename {{ restic_backup_stdin_command_filename }}'
 {% else %}
@@ -22,7 +28,7 @@ ExecStart=/usr/bin/restic --verbose backup {{ restic_backup_paths | join(' ') }}
 {% endif %}
 ExecStartPost=/usr/bin/restic forget --prune --keep-within={{ restic_policy.keep_within }} --keep-hourly={{ restic_policy.hourly }} --keep-daily={{ restic_policy.daily }} --keep-weekly={{ restic_policy.weekly }} --keep-monthly={{ restic_policy.monthly }}
 ExecStartPost=-/usr/bin/restic snapshots
+{% if restic_backup_post_hook | default(false) %}
+ExecStartPost=-{{ restic_backup_post_hook }}
+{% endif %}
 ExecStartPost=/usr/bin/restic check
-
-[Install]
-WantedBy=multi-user.target

roles/restic/templates/restic.timer.j2

@@ -1,9 +1,8 @@
 [Unit]
-Description=Run {{ restic_job_name }}
+Description=Run {{ restic_timer_description | default(restic_job_name) }}
 
 [Timer]
 OnCalendar={{ restic_policy.frequency }}
-Persistent=True
 Unit={{ restic_systemd_unit_naming_scheme }}.service
 
 [Install]