feat(unifi_controller): add ansible role and playbook

galaxy.yml

@@ -1,13 +1,14 @@
 namespace: finallycoffee
 name: services
-version: "0.1.15"
+version: "0.2.0"
 readme: README.md
 authors:
 - transcaffeine <transcaffeine@finally.coffee>
 description: Various ansible roles useful for automating infrastructure
 dependencies:
-  "community.crypto": "^2.22.0"
-  "community.docker": "^4.0.0"
+  "community.general": "^11.0.0"
+  "community.crypto": "^3.0.3"
+  "community.docker": "^4.7.0"
   "containers.podman": "^1.16.0"
 license_file: LICENSE.md
 build_ignore:

playbooks/unifi_controller.yml

@@ -0,0 +1,7 @@
+---
+- name: Deploy unifi controller
+  hosts: "{{ unifi_controller_hosts | default('unifi_controller') }}"
+  become: "{{ unifi_controller_become | default(false) }}"
+  gather_facts: "{{ unifi_controller_gather_facts | default(false) }}"
+  roles:
+    - role: finallycoffee.services.unifi_controller

roles/authelia/defaults/main.yml

@@ -1,5 +1,5 @@
 ---
-authelia_version: "4.39.1"
+authelia_version: "4.39.8"
 authelia_user: authelia
 authelia_base_dir: /opt/authelia
 authelia_domain: authelia.example.org
@@ -15,7 +15,7 @@ authelia_notification_storage_file: "{{ authelia_data_dir }}/notifications.txt"
 authelia_user_storage_file: "{{ authelia_data_dir }}/user_database.yml"
 
 authelia_container_name: authelia
-authelia_container_image_server: docker.io
+authelia_container_image_server: ghcr.io
 authelia_container_image_namespace: authelia
 authelia_container_image_name: authelia
 authelia_container_image: >-2
@@ -92,7 +92,11 @@ authelia_config_webauthn_disable: true
 authelia_config_webauthn_timeout: 60s
 authelia_config_webauthn_display_name: "Authelia ({{ authelia_domain }})"
 authelia_config_webauthn_attestation_conveyance_preference: indirect
-authelia_config_webauthn_user_verification: preferred
+authelia_config_webauthn_user_verification: "preferred"
+authelia_config_webauthn_selection_criteria_user_verification: >-2
+  {{ authelia_config_webauthn_user_verification }}
+authelia_config_webauthn_selection_criteria_discoverability: "preferred"
+authelia_config_webauthn_selection_criteria_attachment: ""
 authelia_config_duo_api_hostname: ~
 authelia_config_duo_api_integration_key: ~
 authelia_config_duo_api_secret_key: ~
@@ -107,6 +111,8 @@ authelia_config_authentication_backend_password_reset_disable: false
 authelia_config_authentication_backend_password_reset_custom_url: ~
 authelia_config_authentication_backend_ldap_implementation: custom
 authelia_config_authentication_backend_ldap_url: ldap://127.0.0.1:389
+authelia_config_authentication_backend_ldap_address: >-2
+  {{ authelia_config_authentication_backend_ldap_url }}
 authelia_config_authentication_backend_ldap_timeout: 5s
 authelia_config_authentication_backend_ldap_start_tls: false
 authelia_config_authentication_backend_ldap_tls_skip_verify: false
@@ -157,6 +163,19 @@ authelia_config_session_inactivity: 5m
 authelia_config_session_remember_me_duration: 1M
 authelia_config_session_remember_me: >-2
   {{ authelia_config_session_remember_me_duration }}
+authelia_config_session_cookies:
+  - "{{ authelia_config_session_cookies_default }}"
+authelia_config_session_cookies_default_domain: >-2
+  {{ authelia_config_session_domain }}
+authelia_config_session_cookies_default_authelia_url: >-2
+  https://{{ authelia_config_session_cookies_default_domain }}
+authelia_config_session_cookies_default_default_redirection_url: >-2
+  {{ authelia_config_default_redirection_url }}
+authelia_config_session_cookies_default:
+  domain: "{{ authelia_config_session_cookies_default_domain }}"
+  authelia_url: "{{ authelia_config_session_cookies_default_authelia_url }}"
+  default_redirection_url: >-2
+    {{ authelia_config_session_cookies_default_default_redirection_url }}
 authelia_config_session_redis_host: "{{ authelia_redis_host }}"
 authelia_config_session_redis_port: "{{ authelia_redis_port }}"
 authelia_config_session_redis_username: "{{ authelia_redis_user }}"
@@ -193,7 +212,10 @@ authelia_config_notifier_smtp_disable_require_tls: false
 authelia_config_notifier_smtp_disable_html_emails: false
 authelia_config_notifier_smtp_tls_skip_verify: false
 authelia_config_notifier_smtp_tls_minimum_version: "{{ authelia_tls_minimum_version }}"
-#authelia_config_identity_provider_
+authelia_config_identity_validation_reset_password_jwt_secret: >-2
+  {{ authelia_config_jwt_secret }}
+authelia_config_identity_validation_reset_password_jwt_lifespan: "5 minutes"
+authelia_config_identity_validation_reset_password_jwt_algorithm: "HS256"
 
 authelia_database_type: ~
 authelia_database_host: ~

roles/authelia/vars/main.yml

@@ -25,7 +25,6 @@ authelia_container_base_labels:
 authelia_config: "{{ authelia_base_config | combine(authelia_extra_config, recursive=True) }}"
 authelia_top_level_config:
   theme: "{{ authelia_config_theme }}"
-  jwt_secret: "{{ authelia_config_jwt_secret }}"
   log: "{{ authelia_config_log }}"
   telemetry: "{{ authelia_config_telemetry }}"
   totp: "{{ authelia_config_totp }}"
@@ -39,12 +38,11 @@ authelia_top_level_config:
   regulation: "{{ authelia_config_regulation }}"
   storage: "{{ authelia_config_storage }}"
   notifier: "{{ authelia_config_notifier }}"
+  identity_validation: "{{ authelia_config_identity_validation }}"
 
 authelia_base_config: >-2
   {{
     authelia_top_level_config
-    | combine({"default_redirection_url": authelia_config_default_redirection_url}
-      if authelia_config_default_redirection_url | default(false, true) else {})
     | combine(({"server": authelia_config_server })
       | combine({"tls": authelia_config_server_tls}
         if authelia_config_server_tls_key | default(false, true) else {}))
@@ -99,7 +97,10 @@ authelia_config_webauthn:
   timeout: "{{ authelia_config_webauthn_timeout }}"
   display_name: "{{ authelia_config_webauthn_display_name }}"
   attestation_conveyance_preference: "{{ authelia_config_webauthn_attestation_conveyance_preference }}"
-  user_verification: "{{ authelia_config_webauthn_user_verification }}"
+  selection_criteria:
+    attachment: "{{ authelia_config_webauthn_selection_criteria_attachment }}"
+    discoverability: "{{ authelia_config_webauthn_selection_criteria_discoverability }}"
+    user_verification: "{{ authelia_config_webauthn_selection_criteria_user_verification }}"
 authelia_config_duo_api:
   hostname: "{{ authelia_config_duo_api_hostname }}"
   integration_key: "{{ authelia_config_duo_api_integration_key }}"
@@ -128,7 +129,7 @@ authelia_config_authentication_backend_password_reset:
   disable: "{{ authelia_config_authentication_backend_password_reset_disable }}"
 authelia_config_authentication_backend_ldap:
   implementation: "{{ authelia_config_authentication_backend_ldap_implementation }}"
-  url: "{{ authelia_config_authentication_backend_ldap_url }}"
+  address: "{{ authelia_config_authentication_backend_ldap_address }}"
   timeout: "{{ authelia_config_authentication_backend_ldap_timeout }}"
   start_tls: "{{ authelia_config_authentication_backend_ldap_start_tls }}"
   tls:
@@ -182,12 +183,12 @@ authelia_config_session: >-2
   }}
 authelia_config_session_base:
   name: "{{ authelia_config_session_name }}"
-  domain: "{{ authelia_config_session_domain }}"
   same_site: "{{ authelia_config_session_same_site }}"
   secret: "{{ authelia_config_session_secret }}"
   expiration: "{{ authelia_config_session_expiration }}" 
   inactivity: "{{ authelia_config_session_inactivity }}"
   remember_me: "{{ authelia_config_session_remember_me }}"
+  cookies: "{{ authelia_config_session_cookies }}"
 authelia_config_session_redis: >-2
   {{
     {
@@ -274,3 +275,9 @@ authelia_config_notifier_smtp:
   tls:
     skip_verify: "{{ authelia_config_notifier_smtp_tls_skip_verify }}"
     minimum_version: "{{ authelia_config_notifier_smtp_tls_minimum_version }}"
+authelia_config_identity_validation:
+  reset_password: "{{ authelia_config_identity_validation_reset_password }}"
+authelia_config_identity_validation_reset_password:
+  jwt_secret: "{{ authelia_config_identity_validation_reset_password_jwt_secret }}"
+  jwt_lifespan: "{{ authelia_config_identity_validation_reset_password_jwt_lifespan }}"
+  jwt_algorithm: "{{ authelia_config_identity_validation_reset_password_jwt_algorithm }}"

roles/ghost/defaults/main.yml

@@ -1,6 +1,6 @@
 ---
 ghost_domain: ~
-ghost_version: "5.117.0"
+ghost_version: "6.0.5"
 ghost_user: ghost
 ghost_user_group: ghost
 ghost_base_path: /opt/ghost

roles/gitea/defaults/main.yml

@@ -1,5 +1,5 @@
 ---
-gitea_version: "1.23.7"
+gitea_version: "1.24.5"
 gitea_user: git
 gitea_run_user: "{{ gitea_user }}"
 gitea_base_path: "/opt/gitea"

roles/keycloak/defaults/main.yml

@@ -1,5 +1,5 @@
 ---
-keycloak_version: "26.2.2"
+keycloak_version: "26.3.3"
 keycloak_container_name: keycloak
 
 keycloak_container_image_upstream_registry: quay.io

roles/phpldapadmin/defaults/main/main.yml

@@ -1,5 +1,5 @@
 ---
-phpldapadmin_version: "2.1.2"
+phpldapadmin_version: "2.3.0"
 
 phpldapadmin_state: present
 phpldapadmin_deployment_method: docker

roles/snipe_it/defaults/main/container.yml

@@ -1,6 +1,6 @@
 ---
 snipe_it_container_image_registry: docker.io
-snipe_it_container_image_namespace: snipe
+snipe_it_container_image_namespace: 'snipe'
 snipe_it_container_image_name: 'snipe-it'
 snipe_it_container_image_tag: ~
 snipe_it_container_image_flavour: alpine

roles/snipe_it/defaults/main/main.yml

@@ -1,6 +1,6 @@
 ---
 snipe_it_user: snipeit
-snipe_it_version: "8.0.4"
+snipe_it_version: "8.3.1"
 snipe_it_domain: ~
 snipe_it_state: present
 snipe_it_deployment_method: docker

roles/unifi_controller/README.md

@@ -0,0 +1,16 @@
+# `finallycoffee.services.unifi_controller` ansible role
+
+Deploy [`jacobalberty/unifi-docker`](https://github.com/jacobalberty/unifi-docker)
+using either `docker` or `podman` (configure using
+`unifi_controller_deployment_method`).
+
+## Configuration
+
+Change the default bind IP of `::` by setting
+`unifi_controller_bind_ip`. By default, the ports
+`1900/udp` (SSDP), `3478/udp` (STUN), `10001/udp`,
+`8080/tcp` (HTTP), `8443/tcp` (HTTPS) and `6789/tcp`
+are exposed.
+
+For more information on which ports are needed when, see
+[Unifi's required ports reference](https://help.ui.com/hc/en-us/articles/218506997-Required-Ports-Reference).

roles/unifi_controller/defaults/main/container.yml

@@ -0,0 +1,41 @@
+---
+unifi_controller_container_name: "unifi-controller"
+unifi_controller_container_image_registry: "docker.io"
+unifi_controller_container_image_namespace: "jacobalberty"
+unifi_controller_container_image_repository: "unifi"
+unifi_controller_container_image_tag: ~
+unifi_controller_container_image_name: >-2
+  {{ [
+    unifi_controller_container_image_registry | default([]),
+    unifi_controller_container_image_namespace | default([]),
+    unifi_controller_container_image_repository
+  ] | flatten | join('/') }}
+unifi_controller_container_image: >-2
+  {{ [
+    unifi_controller_container_image_name,
+    unifi_controller_container_image_tag | default('v' + unifi_controller_version, true)
+  ] | join(':') }}
+unifi_controller_container_image_source: "pull"
+unifi_controller_container_image_force_source: >-2
+  {{ unifi_controller_container_image_tag | default(false, true) | bool }}
+unifi_controller_container_image_pull: >-2
+  {{ unifi_controller_container_image_source == 'pull' }}
+unifi_controller_container_image_force_pull: >-2
+  {{ unifi_controller_container_image_pull and unifi_controller_container_image_force_source }}
+unifi_controller_container_ports:
+  - "{{ unifi_controller_bind_ip }}:8080:8080/tcp" # HTTP: device + app communication
+  - "{{ unifi_controller_bind_ip }}:8443:8443/tcp" # HTTPS: app web page + API
+  - "{{ unifi_controller_bind_ip }}:1900:1900/udp" # SSDP: layer 2 discovery
+  - "{{ unifi_controller_bind_ip }}:3478:3478/udp" # STUN: device adoption and communication
+  - "{{ unifi_controller_bind_ip }}:10001:10001/udp" # device discovery (during adoption)
+unifi_controller_container_user: >-2
+  {{ unifi_controller_run_uid }}:{{ unifi_controller_run_gid }}
+unifi_controller_container_restart_policy: "on-failure"
+unifi_controller_container_default_volumes:
+  - "{{ unifi_controller_base_path }}:/unifi:rw"
+unifi_controller_container_volumes: []
+unifi_controller_container_merged_volumes: >-2
+  {{ unifi_controller_container_default_volumes | default([])
+  + unifi_controller_container_volumes | default([]) }}
+unifi_controller_container_state: >-2
+  {{ (unifi_controller_state == 'present') | ternary('started', 'absent') }}

roles/unifi_controller/defaults/main/main.yml

@@ -0,0 +1,9 @@
+---
+unifi_controller_version: "9.4.19"
+unifi_controller_base_path: "/var/lib/unifi-controller"
+unifi_controller_log_path: "{{ unifi_controller_base_path }}/log"
+unifi_controller_data_path: "{{ unifi_controller_base_path }}/data"
+unifi_controller_bind_ip: "::"
+
+unifi_controller_state: "present"
+unifi_controller_deployment_method: "docker"

roles/unifi_controller/defaults/main/user.yml

@@ -0,0 +1,8 @@
+---
+unifi_controller_user: unifi
+unifi_controller_user_create_home: false
+unifi_controller_user_system: true
+unifi_controller_run_uid: >-2
+  {{ unifi_controller_user_info.uid | default(unifi_controller_user) }}
+unifi_controller_run_gid: >-2
+  {{ unifi_controller_user_info.group | default(unifi_controller_user) }}

roles/unifi_controller/meta/main.yml

@@ -0,0 +1,11 @@
+---
+allow_duplicates: true
+dependencies: []
+galaxy_info:
+  role_name: unifi_controller
+  description: Ansible role to deploy unifi (network) controller in a container
+  galaxy_tags:
+    - unifi
+    - unifi_controller
+    - docker
+    - podman

roles/unifi_controller/tasks/deploy-docker.yml

@@ -0,0 +1,17 @@
+---
+- name: Ensure container image '{{ unifi_controller_container_image }}' is {{ unifi_controller_state }}
+  community.docker.docker_image:
+    name: "{{ unifi_controller_container_image }}"
+    state: "{{ unifi_controller_state }}"
+    source: "{{ unifi_controller_container_image_source }}"
+    force_source: "{{ unifi_controller_container_image_force_source }}"
+
+- name: Ensure container '{{ unifi_controller_container_name }}' is {{ unifi_controller_container_state }}
+  community.docker.docker_container:
+    name: "{{ unifi_controller_container_name }}"
+    image: "{{ unifi_controller_container_image }}"
+    user: "{{ unifi_controller_container_user }}"
+    ports: "{{ unifi_controller_container_ports }}"
+    volumes: "{{ unifi_controller_container_merged_volumes }}"
+    restart_policy: "{{ unifi_controller_container_restart_policy }}"
+    state: "{{ unifi_controller_container_state }}"

roles/unifi_controller/tasks/deploy-podman.yml

@@ -0,0 +1,17 @@
+---
+- name: Ensure container image '{{ unifi_controller_container_image }}' is {{ unifi_controller_state }}
+  containers.podman.podman_image:
+    name: "{{ unifi_controller_container_image }}"
+    state: "{{ unifi_controller_state }}"
+    pull: "{{ unifi_controller_container_image_pull }}"
+    force: "{{ unifi_controller_container_image_force_pull }}"
+
+- name: Ensure container '{{ unifi_controller_container_name }}' is {{ unifi_controller_container_state }}
+  containers.podman.podman_container:
+    name: "{{ unifi_controller_container_name }}"
+    image: "{{ unifi_controller_container_image }}"
+    user: "{{ unifi_controller_container_user }}"
+    ports: "{{ unifi_controller_container_ports }}"
+    volumes: "{{ unifi_controller_container_merged_volumes }}"
+    restart_policy: "{{ unifi_controller_container_restart_policy }}"
+    state: "{{ unifi_controller_container_state }}"

roles/unifi_controller/tasks/main.yml

@@ -0,0 +1,18 @@
+---
+- name: Ensure unifi controller run user '{{ unifi_controller_user }}' is {{ unifi_controller_state }}
+  ansible.builtin.user:
+    name: "{{ unifi_controller_user }}"
+    state: "{{ unifi_controller_state }}"
+  register: unifi_controller_user_info
+
+- name: Ensure unifi controller base path '{{ unifi_controller_base_path }}' is {{ unifi_controller_state }}
+  ansible.builtin.file:
+    path: "{{ unifi_controller_base_path }}"
+    state: "{{ (unifi_controller_state == 'present') | ternary('directory', 'absent') }}"
+    owner: "{{ unifi_controller_run_uid }}"
+    group: "{{ unifi_controller_run_gid }}"
+    mode: "0755"
+
+- name: Deploy unifi controller with {{ unifi_controller_deployment_method }}
+  ansible.builtin.include_tasks:
+    file: "deploy-{{ unifi_controller_deployment_method }}.yml"

roles/unifi_controller/vars/main.yml

@@ -0,0 +1,7 @@
+---
+unifi_controller_states:
+  - "present"
+  - "absent"
+unifi_controller_deployment_methods:
+  - "docker"
+  - "podman"

roles/vaultwarden/defaults/main/main.yml

@@ -1,6 +1,6 @@
 ---
 vaultwarden_user: vaultwarden
-vaultwarden_version: "1.33.2"
+vaultwarden_version: "1.34.3"
 
 vaultwarden_config_file: "/etc/vaultwarden/config.json"
 vaultwarden_config_directory: "{{ vaultwarden_config_file | dirname }}"

roles/vouch_proxy/defaults/main.yml

@@ -1,6 +1,6 @@
 ---
 vouch_proxy_user: vouch-proxy
-vouch_proxy_version: "0.41.0"
+vouch_proxy_version: "0.45.0"
 vouch_proxy_base_path: /opt/vouch-proxy
 vouch_proxy_config_path: "{{ vouch_proxy_base_path }}/config"
 vouch_proxy_config_file: "{{ vouch_proxy_config_path }}/config.yaml"