feat(restic): Use RESTIC_PASSWORD_FILE instead of RESTIC_PASSWORD

README.md

@@ -13,7 +13,7 @@ and configuring basic system utilities like gnupg, ssh etc
 
 - [`gnupg`](roles/gnupg/README.md): configures gnupg on the target system
 
-- [`lego`](roles/lego/README.md): runs [lego (LetsEncrypt Go]](https://github.com/go-acme/lego),
+- [`lego`](roles/lego/README.md): runs [lego (LetsEncrypt Go)](https://github.com/go-acme/lego),
   a ACME client written in go, using systemd (timers). Multi-instance capable.
 
 - [`mariadb`](roles/mariadb/README.md): runs [MariaDB Server](https://mariadb.org/), one of the world's most popular open source relational database

galaxy.yml

@@ -1,14 +1,22 @@
 namespace: finallycoffee
 name: base
-version: 0.1.1
+version: 0.1.2
 readme: README.md
 authors:
 - transcaffeine <transcaffeine@finally.coffee>
 description: Roles for base services which are common dependencies other services like databases
 dependencies:
-  "community.docker": "^1.10.0"
+  "community.docker": "^3.0.0"
 license_file: LICENSE.md
 build_ignore:
 - '*.tar.gz'
 repository: https://git.finally.coffee/finallycoffee/base
-issues: https://git.finally.coffee/finallycoffee/base/issues
+issues: https://codeberg.org/finallycoffee/ansible-collection-base/issues
+tags:
+  - docker
+  - elastic
+  - lego
+  - mariadb
+  - minio
+  - nginx
+  - restic

roles/lego/defaults/main.yml

@@ -58,7 +58,7 @@ lego_systemd_timer_name: "lego-{{ lego_instance }}.timer"
 lego_systemd_timer_template: lego.timer.j2
 lego_systemd_timer_calendar: "*-*-* *:00/15:00"
 
-lego_architecture: "amd64"
+lego_architecture: "{{ 'arm64' if ansible_architecture == 'aarch64' else 'amd64' }}"
 lego_os: "linux"
 lego_binary_allow_net_bind_service: false
 

roles/nginx/README.md

@@ -26,3 +26,8 @@ For exposing this server to the host and/or internet, the `nginx_container_ports
 from host to container), `nginx_container_networks` (docker networking) or `nginx_container_labels`
 (for label-based routing discovery like traefik) can be used. The options correspond to the arguments
 of the `community.docker.docker_container` module.
+
+## Deployment methods
+
+Set `nginx_deployment_method` to either `docker` or `podman` to use the respective ansible modules for
+creating and managing the container and its image. See all supported methods in `nginx_deployment_methods`.

roles/nginx/defaults/main.yml

@@ -1,9 +1,10 @@
 ---
-
-nginx_version: "1.26.2"
+nginx_version: "1.27.2"
 nginx_flavour: alpine
 nginx_base_path: /opt/nginx
 nginx_config_file: "{{ nginx_base_path }}/nginx.conf"
+nginx_state: present
+nginx_deployment_method: docker
 
 nginx_container_name: nginx
 nginx_container_image_reference: >-
@@ -26,6 +27,9 @@ nginx_container_image_repository: >-
 nginx_container_image_registry: "docker.io"
 nginx_container_image_name: "nginx"
 nginx_container_image_tag: ~
+nginx_container_image_source: pull
+nginx_container_state: >-2
+  {{ (nginx_state == 'present') | ternary('started', 'absent') }}
 
 nginx_container_restart_policy: "unless-stopped"
 nginx_container_volumes:

roles/nginx/meta/main.yml

@@ -0,0 +1,12 @@
+---
+allow_duplicates: true
+dependencies: []
+galaxy_info:
+  role_name: nginx
+  description: Deploy nginx, a webserver
+  galaxy_tags:
+    - nginx
+    - http
+    - webserver
+    - docker
+    - podman

roles/nginx/tasks/deploy-docker.yml

@@ -0,0 +1,28 @@
+---
+- name: Ensure docker container image '{{ nginx_container_image_reference }}' is {{ nginx_state }}
+  community.docker.docker_image:
+    name: "{{ nginx_container_image_reference }}"
+    state: "{{ nginx_state }}"
+    source: "{{ nginx_container_image_source }}"
+    force_source: >-2
+      {{ nginx_container_image_force_source
+        | default(nginx_container_image_tag | default(false, true)) }}
+  register: nginx_container_image_info
+  until: nginx_container_image_info is success
+  retries: 5
+  delay: 3
+
+- name: Ensure docker container '{{ nginx_container_name }}' is {{ nginx_container_state }}
+  community.docker.docker_container:
+    name: "{{ nginx_container_name }}"
+    image: "{{ nginx_container_image_reference }}"
+    env: "{{ nginx_container_env | default(omit, true) }}"
+    user: "{{ nginx_container_user | default(omit, true) }}"
+    ports: "{{ nginx_container_ports | default(omit, true) }}"
+    labels: "{{ nginx_container_labels | default(omit, true) }}"
+    volumes: "{{ nginx_container_volumes | default(omit, true) }}"
+    etc_hosts: "{{ nginx_container_etc_hosts | default(omit, true) }}"
+    networks: "{{ nginx_container_networks | default(omit, true) }}"
+    purge_networks: "{{ nginx_container_purge_networks | default(omit, true) }}"
+    restart_policy: "{{ nginx_container_restart_policy }}"
+    state: "{{ nginx_container_state }}"

roles/nginx/tasks/deploy-podman.yml

@@ -0,0 +1,27 @@
+---
+- name: Ensure container image '{{ nginx_container_image_reference }}' is {{ nginx_state }}
+  containers.podman.podman_image:
+    name: "{{ nginx_container_image_reference }}"
+    state: "{{ nginx_state }}"
+    pull: "{{ nginx_container_image_source == 'pull' }}"
+    force: >-2
+      {{ nginx_container_image_force_source
+        | default(nginx_container_image_tag | default(false, true)) }}
+  register: nginx_container_image_info
+  until: nginx_container_image_info is success
+  retries: 5
+  delay: 3
+
+- name: Ensure container '{{ nginx_container_name }}' is {{ nginx_container_state }}
+  containers.podman.podman_container:
+    name: "{{ nginx_container_name }}"
+    image: "{{ nginx_container_image_reference }}"
+    env: "{{ nginx_container_env | default(omit, true) }}"
+    user: "{{ nginx_container_user | default(omit, true) }}"
+    ports: "{{ nginx_container_ports | default(omit, true) }}"
+    labels: "{{ nginx_container_labels | default(omit, true) }}"
+    volumes: "{{ nginx_container_volumes | default(omit, true) }}"
+    etc_hosts: "{{ nginx_container_etc_hosts | default(omit, true) }}"
+    network: "{{ nginx_container_networks | default(omit, true) }}"
+    restart_policy: "{{ nginx_container_restart_policy }}"
+    state: "{{ nginx_container_state }}"

roles/nginx/tasks/main.yml

@@ -1,10 +1,30 @@
 ---
+- name: Check if state is supported
+  ansible.builtin.fail:
+    msg: >-2
+      Unsupported state '{{ nginx_state }}'. Supported
+      states are {{ nginx_states | join(', ') }}.
+  when: nginx_state not in nginx_states
 
-- name: Ensure base path '{{ nginx_base_path }}' exists
+- name: Check if deployment_method is supported
+  ansible.builtin.fail:
+    msg: >-2
+      Unsupported state '{{ nginx_deployment_method }}'. Supported
+      states are {{ nginx_deployment_methods | join(', ') }}.
+  when: nginx_deployment_method not in nginx_deployment_methods
+
+- name: Ensure nginx config file is {{ nginx_state }}
+  ansible.builtin.file:
+    path: "{{ nginx_config_file }}"
+    state: "{{ nginx_state }}"
+  when: nginx_state == 'absent'
+
+- name: Ensure base path '{{ nginx_base_path }}' is {{ nginx_state }}
   ansible.builtin.file:
     path: "{{ nginx_base_path }}"
-    state: directory
-    mode: 0755
+    mode: "0755"
+    state: >-2
+      {{ (nginx_state == 'present') | ternary('directory', 'absent') }}
 
 - name: Ensure nginx config file is templated
   ansible.builtin.copy:
@@ -13,25 +33,8 @@
     mode: 0640
   notify:
     - restart-nginx
+  when: nginx_state == 'present'
 
-- name: Ensure docker container image is present
-  community.docker.docker_image:
-    name: "{{ nginx_container_image_reference }}"
-    state: present
-    source: pull
-    force_source: "{{ nginx_container_image_tag is defined and nginx_container_image_tag | string != '' }}"
-
-- name: Ensure docker container '{{ nginx_container_name }}' is running
-  community.docker.docker_container:
-    name: "{{ nginx_container_name }}"
-    image: "{{ nginx_container_image_reference }}"
-    env: "{{ nginx_container_env | default(omit, true) }}"
-    user: "{{ nginx_container_user | default(omit, true) }}"
-    ports: "{{ nginx_container_ports | default(omit, true) }}"
-    labels: "{{ nginx_container_labels | default(omit, true) }}"
-    volumes: "{{ nginx_container_volumes | default(omit, true) }}"
-    etc_hosts: "{{ nginx_container_etc_hosts | default(omit, true) }}"
-    networks: "{{ nginx_container_networks | default(omit, true) }}"
-    purge_networks: "{{ nginx_container_purge_networks | default(omit, true) }}"
-    restart_policy: "{{ nginx_container_restart_policy }}"
-    state: started
+- name: Deploy using {{ nginx_deployment_method }}
+  ansible.builtin.include_tasks:
+    file: "deploy-{{ nginx_deployment_method }}.yml"

roles/nginx/vars/main.yml

@@ -0,0 +1,7 @@
+---
+nginx_states:
+  - present
+  - absent
+nginx_deployment_methods:
+  - docker
+  - podman

roles/powerdns_tsig_key/README.md

@@ -21,5 +21,5 @@ The usage example below assumes `powerdns` is running in a container named `powe
         powerdns_tsig_key_container_name: 'powerdns'
 ```
 
-> [!INFO]
+> [!NOTE]
 > Support for non-docker deployments is pending.

roles/restic/defaults/main.yml

@@ -51,6 +51,11 @@ restic_user: root
 restic_create_user: false
 restic_start_job_on_unit_change: false
 
+restic_base_path: /opt/restic
+resitc_credentials_base_path: "/var/lib/restic/{{ restic_job_name }}/"
+restic_password_file_path: "{{ resitc_credentials_base_path }}/restic-passwd"
+restic_password_file_mode: 0600 #should not be less restrictive
+
 restic_job_name: ~
 restic_job_description: "Restic backup job for {{ restic_job_name }}"
 restic_systemd_unit_naming_scheme: "restic.{{ restic_job_name }}"

roles/restic/tasks/main.yml

@@ -6,6 +6,23 @@
     state: present
     system: true
   when: restic_create_user
+  register: restic_user_res
+
+- name: Ensure base directory for restic is created
+  ansible.builtin.file:
+    path: "{{ restic_base_path }}"
+    state: directory
+    owner: "{{ restic_user_res.uid | default(root) }}"
+    group: "{{ restic_user_res.group | default(root) }}"
+    mode: "0755"
+
+- name: Ensure credentials directory for restic is created
+  ansible.builtin.file:
+    path: "{{ resitc_credentials_base_path }}"
+    state: directory
+    owner: "{{ restic_user_res.uid | default(root) }}"
+    group: "{{ restic_user_res.group | default(root) }}"
+    mode: "0700"
 
 - name: Ensure either backup_paths or backup_stdin_command is populated
   when: restic_backup_paths|length > 0 and restic_backup_stdin_command and false
@@ -42,6 +59,14 @@
         state: present
       when: ansible_os_family not in ['RedHat', 'Debian']
 
+- name: Ensure restic password file is created and uptodate
+  copy:
+    dest: "{{ restic_password_file_path }}"
+    mode: "{{ restic_password_file_mode }}"
+    owner: "{{ restic_user_res.uid | default(root) }}"
+    group: "{{ restic_user_res.group | default(root) }}"
+    content: "{{ restic_repo_password }}"
+
 - name: Ensure systemd service file for '{{ restic_job_name }}' is templated
   template:
     dest: "/etc/systemd/system/{{ restic_systemd_unit_naming_scheme }}.service"

roles/restic/templates/restic.service.j2

@@ -8,7 +8,7 @@ WorkingDirectory={{ restic_systemd_working_directory }}
 SyslogIdentifier={{ restic_systemd_syslog_identifier }}
 
 Environment=RESTIC_REPOSITORY={{ restic_repo_url }}
-Environment=RESTIC_PASSWORD={{ restic_repo_password }}
+Environment=RESTIC_PASSWORD_FILE={{ restic_password_file_path }}
 {% for kv in restic_complete_environment | dict2items %}
 Environment={{ kv.key }}={{ kv.value }}
 {% endfor %}