Move roles/matrix* to roles/custom/matrix*

This paves the way for installing other roles into `roles/galaxy` using `ansible-galaxy`,
similar to how it's done in:

- https://github.com/spantaleev/gitea-docker-ansible-deploy
- https://github.com/spantaleev/nextcloud-docker-ansible-deploy

In the near future, we'll be removing a lot of the shared role code from here
and using upstream roles for it. Some of the core `matrix-*` roles have
already been extracted out into other reusable roles:

- https://github.com/devture/com.devture.ansible.role.postgres
- https://github.com/devture/com.devture.ansible.role.systemd_docker_base
- https://github.com/devture/com.devture.ansible.role.timesync
- https://github.com/devture/com.devture.ansible.role.vars_preserver
- https://github.com/devture/com.devture.ansible.role.playbook_runtime_messages
- https://github.com/devture/com.devture.ansible.role.playbook_help

We just need to migrate to those.

roles/custom/matrix-coturn/defaults/main.yml

@@ -0,0 +1,84 @@
+---
+# Project source code URL: https://github.com/coturn/coturn
+
+matrix_coturn_enabled: true
+
+matrix_coturn_container_image_self_build: false
+matrix_coturn_container_image_self_build_repo: "https://github.com/coturn/coturn"
+matrix_coturn_container_image_self_build_repo_version: "docker/{{ matrix_coturn_version }}"
+matrix_coturn_container_image_self_build_repo_dockerfile_path: "docker/coturn/alpine/Dockerfile"
+
+matrix_coturn_version: 4.6.0-r0
+matrix_coturn_docker_image: "{{ matrix_coturn_docker_image_name_prefix }}coturn/coturn:{{ matrix_coturn_version }}-alpine"
+matrix_coturn_docker_image_name_prefix: "{{ 'localhost/' if matrix_coturn_container_image_self_build else matrix_container_global_registry_prefix }}"
+matrix_coturn_docker_image_force_pull: "{{ matrix_coturn_docker_image.endswith(':latest') }}"
+
+# The Docker network that Coturn would be put into.
+#
+# Because Coturn relays traffic to unvalidated IP addresses,
+# using a dedicated network, isolated from other Docker (and local) services is preferrable.
+#
+# Setting up deny/allow rules with `matrix_coturn_allowed_peer_ips`/`matrix_coturn_denied_peer_ips` is also
+# possible for achieving such isolation, but is more complicated due to the dynamic nature of Docker networking.
+matrix_coturn_docker_network: "matrix-coturn"
+
+matrix_coturn_base_path: "{{ matrix_base_data_path }}/coturn"
+matrix_coturn_docker_src_files_path: "{{ matrix_coturn_base_path }}/docker-src"
+matrix_coturn_config_path: "{{ matrix_coturn_base_path }}/turnserver.conf"
+
+# List of systemd services that matrix-coturn.service depends on
+matrix_coturn_systemd_required_services_list: ['docker.service']
+
+# A list of additional "volumes" to mount in the container.
+# This list gets populated dynamically at runtime. You can provide a different default value,
+# if you wish to mount your own files into the container.
+# Contains definition objects like this: `{"src": "/outside", "dst": "/inside", "options": "rw|ro|slave|.."}
+matrix_coturn_container_additional_volumes: []
+
+# A list of extra arguments to pass to the container
+matrix_coturn_container_extra_arguments: []
+
+# Controls whether the Coturn container exposes its plain STUN port (tcp/3478 and udp/3478 in the container).
+#
+# Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:3478"), or empty string to not expose.
+matrix_coturn_container_stun_plain_host_bind_port: '3478'
+
+# Controls whether the Coturn container exposes its TLS STUN port (tcp/5349 and udp/5349 in the container).
+#
+# Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:5349"), or empty string to not expose.
+matrix_coturn_container_stun_tls_host_bind_port: '5349'
+
+# Controls whether the Coturn container exposes its TURN UDP port range and which interface to do it on.
+#
+# Takes an interface "<ip address>" (e.g. "127.0.0.1"), or empty string to listen on all interfaces.
+# Takes a null/none value (`~`) to prevent listening.
+#
+# The UDP port-range itself is specified using `matrix_coturn_turn_udp_min_port` and `matrix_coturn_turn_udp_max_port`.
+matrix_coturn_container_turn_range_listen_interface: ''
+
+# UDP port-range to use for TURN
+matrix_coturn_turn_udp_min_port: 49152
+matrix_coturn_turn_udp_max_port: 49172
+
+# A shared secret (between Synapse and Coturn) used for authentication.
+# You can put any string here, but generating a strong one is preferred (e.g. `pwgen -s 64 1`).
+matrix_coturn_turn_static_auth_secret: ""
+
+# The external IP address of the machine where Coturn is.
+matrix_coturn_turn_external_ip_address: ''
+matrix_coturn_turn_external_ip_addresses: ["{{ matrix_coturn_turn_external_ip_address }}"]
+
+matrix_coturn_allowed_peer_ips: []
+matrix_coturn_denied_peer_ips: []
+matrix_coturn_user_quota: null
+matrix_coturn_total_quota: null
+
+# To enable TLS, you need to provide paths to certificates.
+# Paths defined in `matrix_coturn_tls_cert_path` and `matrix_coturn_tls_key_path` are in-container paths.
+# Files on the host can be mounted into the container using `matrix_coturn_container_additional_volumes`.
+matrix_coturn_tls_enabled: false
+matrix_coturn_tls_cert_path: ~
+matrix_coturn_tls_key_path: ~
+
+matrix_coturn_tls_v1_enabled: false
+matrix_coturn_tls_v1_1_enabled: false

roles/custom/matrix-coturn/tasks/init.yml

@@ -0,0 +1,15 @@
+---
+# See https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/1070
+# and https://github.com/spantaleev/matrix-docker-ansible-deploy/commit/1ab507349c752042d26def3e95884f6df8886b74#commitcomment-51108407
+- name: Fail if trying to self-build on Ansible < 2.8
+  ansible.builtin.fail:
+    msg: "To self-build the coturn image, you should use Ansible 2.8 or higher. See docs/ansible.md"
+  when: "ansible_version.major == 2 and ansible_version.minor < 8 and matrix_coturn_container_image_self_build and matrix_coturn_enabled"
+
+- ansible.builtin.set_fact:
+    matrix_systemd_services_list: "{{ matrix_systemd_services_list + ['matrix-coturn.service'] }}"
+  when: matrix_coturn_enabled | bool
+
+- ansible.builtin.set_fact:
+    matrix_systemd_services_list: "{{ matrix_systemd_services_list + ['matrix-coturn-reload.timer'] }}"
+  when: "matrix_coturn_enabled | bool and matrix_coturn_tls_enabled | bool"

roles/custom/matrix-coturn/tasks/main.yml

@@ -0,0 +1,23 @@
+---
+
+- ansible.builtin.import_tasks: "{{ role_path }}/tasks/init.yml"
+  tags:
+    - always
+
+- ansible.builtin.import_tasks: "{{ role_path }}/tasks/validate_config.yml"
+  when: "run_setup | bool and matrix_coturn_enabled | bool"
+  tags:
+    - setup-all
+    - setup-coturn
+
+- ansible.builtin.import_tasks: "{{ role_path }}/tasks/setup_install.yml"
+  when: "run_setup | bool and matrix_coturn_enabled | bool"
+  tags:
+    - setup-all
+    - setup-coturn
+
+- ansible.builtin.import_tasks: "{{ role_path }}/tasks/setup_uninstall.yml"
+  when: "run_setup | bool and not matrix_coturn_enabled | bool"
+  tags:
+    - setup-all
+    - setup-coturn

roles/custom/matrix-coturn/tasks/setup_install.yml

@@ -0,0 +1,111 @@
+---
+
+# This is a cleanup/migration task. It can be removed some time in the future.
+- name: (Migration) Remove deprecated cronjob
+  ansible.builtin.file:
+    path: "{{ matrix_cron_path }}/matrix-coturn-ssl-reload"
+    state: absent
+
+- name: Ensure Matrix Coturn path exists
+  ansible.builtin.file:
+    path: "{{ item.path }}"
+    state: directory
+    mode: 0750
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+  with_items:
+    - {path: "{{ matrix_coturn_docker_src_files_path }}", when: "{{ matrix_coturn_container_image_self_build }}"}
+  when: "item.when | bool"
+
+- name: Ensure Coturn image is pulled
+  community.docker.docker_image:
+    name: "{{ matrix_coturn_docker_image }}"
+    source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
+    force_source: "{{ matrix_coturn_docker_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}"
+    force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_coturn_docker_image_force_pull }}"
+  when: "not matrix_coturn_container_image_self_build | bool"
+  register: result
+  retries: "{{ matrix_container_retries_count }}"
+  delay: "{{ matrix_container_retries_delay }}"
+  until: result is not failed
+
+- when: "matrix_coturn_container_image_self_build | bool"
+  block:
+    - name: Ensure Coturn repository is present on self-build
+      ansible.builtin.git:
+        repo: "{{ matrix_coturn_container_image_self_build_repo }}"
+        dest: "{{ matrix_coturn_docker_src_files_path }}"
+        version: "{{ matrix_coturn_container_image_self_build_repo_version }}"
+        force: "yes"
+      become: true
+      become_user: "{{ matrix_user_username }}"
+      register: matrix_coturn_git_pull_results
+
+    - name: Ensure Coturn Docker image is built
+      community.docker.docker_image:
+        name: "{{ matrix_coturn_docker_image }}"
+        source: build
+        force_source: "{{ matrix_coturn_git_pull_results.changed if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}"
+        force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_coturn_git_pull_results.changed }}"
+        build:
+          dockerfile: "{{ matrix_coturn_container_image_self_build_repo_dockerfile_path }}"
+          path: "{{ matrix_coturn_docker_src_files_path }}"
+          pull: true
+
+- name: Ensure Coturn configuration path exists
+  ansible.builtin.file:
+    path: "{{ matrix_coturn_base_path }}"
+    state: directory
+    mode: 0750
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+
+- name: Ensure turnserver.conf installed
+  ansible.builtin.template:
+    src: "{{ role_path }}/templates/turnserver.conf.j2"
+    dest: "{{ matrix_coturn_config_path }}"
+    mode: 0644
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+
+- name: Ensure Coturn network is created in Docker
+  community.docker.docker_network:
+    name: "{{ matrix_coturn_docker_network }}"
+    driver: bridge
+
+- name: Ensure matrix-coturn.service installed
+  ansible.builtin.template:
+    src: "{{ role_path }}/templates/systemd/matrix-coturn.service.j2"
+    dest: "{{ matrix_systemd_path }}/matrix-coturn.service"
+    mode: 0644
+  register: matrix_coturn_systemd_service_change_results
+
+# This may be unnecessary when more long-lived certificates are used.
+# We optimize for the common use-case though (short-lived Let's Encrypt certificates).
+# Reloading doesn't hurt anyway, so there's no need to make this more flexible.
+- name: Ensure reloading systemd units installed, if necessary
+  ansible.builtin.template:
+    src: "{{ role_path }}/templates/systemd/{{ item }}.j2"
+    dest: "{{ matrix_systemd_path }}/{{ item }}"
+    mode: 0644
+  register: "matrix_coturn_systemd_service_change_results"
+  when: "matrix_coturn_tls_enabled | bool"
+  with_items:
+    - matrix-coturn-reload.service
+    - matrix-coturn-reload.timer
+
+# A similar task exists in `setup_uninstall.yml`
+- name: Ensure reloading systemd units uninstalled, if unnecessary
+  ansible.builtin.file:
+    path: "{{ item }}"
+    state: absent
+  register: "matrix_coturn_systemd_service_change_results"
+  when: "not matrix_coturn_tls_enabled | bool"
+  with_items:
+    - matrix-coturn-reload.service
+    - matrix-coturn-reload.timer
+
+- name: Ensure systemd reloaded if systemd units changed
+  ansible.builtin.service:
+    daemon_reload: true
+  when: "matrix_coturn_systemd_service_change_results.changed"

roles/custom/matrix-coturn/tasks/setup_uninstall.yml

@@ -0,0 +1,47 @@
+---
+
+- name: Check existence of matrix-coturn service
+  ansible.builtin.stat:
+    path: "{{ matrix_systemd_path }}/matrix-coturn.service"
+  register: matrix_coturn_service_stat
+  when: "not matrix_coturn_enabled | bool"
+
+- name: Ensure matrix-coturn is stopped
+  ansible.builtin.service:
+    name: matrix-coturn
+    state: stopped
+    enabled: false
+    daemon_reload: true
+  when: "matrix_coturn_service_stat.stat.exists | bool"
+
+- name: Ensure matrix-coturn-reload.timer is stopped
+  ansible.builtin.service:
+    name: matrix-coturn
+    state: stopped
+    enabled: false
+    daemon_reload: true
+  failed_when: false
+  when: "matrix_coturn_service_stat.stat.exists | bool"
+
+- name: Ensure systemd units don't exist
+  ansible.builtin.file:
+    path: "{{ matrix_systemd_path }}/{{ item }}"
+    state: absent
+  register: matrix_coturn_systemd_unit_uninstallation_result
+  with_items:
+    - matrix-coturn.service
+    - matrix-coturn-reload.service
+    - matrix-coturn-reload.timer
+
+- name: Ensure systemd reloaded after unit removal
+  ansible.builtin.service:
+    daemon_reload: true
+  when: "matrix_coturn_systemd_unit_uninstallation_result.changed | bool"
+
+- name: Ensure Matrix coturn paths don't exist
+  ansible.builtin.file:
+    path: "{{ matrix_coturn_base_path }}"
+    state: absent
+
+# Intentionally not removing the Docker image when uninstalling.
+# We can't be sure it had been pulled by us in the first place.

roles/custom/matrix-coturn/tasks/validate_config.yml

@@ -0,0 +1,9 @@
+---
+
+- name: Fail if required Coturn settings not defined
+  ansible.builtin.fail:
+    msg: >-
+      You need to define a required configuration setting (`{{ item }}`) for using Coturn.
+  when: "vars[item] == ''"
+  with_items:
+    - "matrix_coturn_turn_static_auth_secret"

roles/custom/matrix-coturn/templates/systemd/matrix-coturn-reload.service.j2

@@ -0,0 +1,6 @@
+[Unit]
+Description=Reloads matrix-coturn so that new SSL certificates can kick in
+
+[Service]
+Type=oneshot
+ExecStart={{ matrix_host_command_systemctl }} reload matrix-coturn.service

roles/custom/matrix-coturn/templates/systemd/matrix-coturn-reload.timer.j2

@@ -0,0 +1,10 @@
+[Unit]
+Description=Reloads matrix-coturn periodically so that new SSL certificates can kick in
+
+[Timer]
+Unit=matrix-coturn-reload.service
+OnCalendar=*-*-* 06:30:00
+RandomizedDelaySec=1h
+
+[Install]
+WantedBy=timers.target

roles/custom/matrix-coturn/templates/systemd/matrix-coturn.service.j2

@@ -0,0 +1,58 @@
+#jinja2: lstrip_blocks: "True"
+[Unit]
+Description=Matrix Coturn server
+{% for service in matrix_coturn_systemd_required_services_list %}
+Requires={{ service }}
+After={{ service }}
+{% endfor %}
+DefaultDependencies=no
+
+[Service]
+Type=simple
+Environment="HOME={{ matrix_systemd_unit_home_path }}"
+ExecStartPre=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-coturn 2>/dev/null || true'
+ExecStartPre=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-coturn 2>/dev/null || true'
+
+ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-coturn \
+			--log-driver=none \
+			--user={{ matrix_user_uid }}:{{ matrix_user_gid }} \
+			--cap-drop=ALL \
+			--cap-add=NET_BIND_SERVICE \
+			--entrypoint=turnserver \
+			--read-only \
+			--tmpfs=/var/tmp:rw,noexec,nosuid,size=100m \
+			--network={{ matrix_coturn_docker_network }} \
+			{% if matrix_coturn_container_stun_plain_host_bind_port != '' %}
+			-p {{ matrix_coturn_container_stun_plain_host_bind_port }}:3478 \
+			-p {{ matrix_coturn_container_stun_plain_host_bind_port }}:3478/udp \
+			{% endif %}
+			{% if matrix_coturn_container_stun_tls_host_bind_port != '' %}
+			-p {{ matrix_coturn_container_stun_tls_host_bind_port }}:5349 \
+			-p {{ matrix_coturn_container_stun_tls_host_bind_port }}:5349/udp \
+			{% endif %}
+			{% if matrix_coturn_container_turn_range_listen_interface is not none %}
+			-p {{ matrix_coturn_container_turn_range_listen_interface }}{{ ':' if matrix_coturn_container_turn_range_listen_interface else '' }}{{ matrix_coturn_turn_udp_min_port }}-{{ matrix_coturn_turn_udp_max_port }}:{{ matrix_coturn_turn_udp_min_port }}-{{ matrix_coturn_turn_udp_max_port }}/udp \
+			{% endif %}
+			--mount type=bind,src={{ matrix_coturn_config_path }},dst=/turnserver.conf,ro \
+			{% for volume in matrix_coturn_container_additional_volumes %}
+			-v {{ volume.src }}:{{ volume.dst }}:{{ volume.options }} \
+			{% endfor %}
+			{% for arg in matrix_coturn_container_extra_arguments %}
+			{{ arg }} \
+			{% endfor %}
+			{{ matrix_coturn_docker_image }} \
+			-c /turnserver.conf
+
+ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-coturn 2>/dev/null || true'
+ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-coturn 2>/dev/null || true'
+
+# This only reloads certificates (not other configuration).
+# See: https://github.com/coturn/coturn/pull/236
+ExecReload={{ matrix_host_command_docker }} exec matrix-coturn kill -USR2 1
+
+Restart=always
+RestartSec=30
+SyslogIdentifier=matrix-coturn
+
+[Install]
+WantedBy=multi-user.target

roles/custom/matrix-coturn/templates/turnserver.conf.j2

@@ -0,0 +1,47 @@
+#jinja2: lstrip_blocks: "True"
+use-auth-secret
+static-auth-secret={{ matrix_coturn_turn_static_auth_secret }}
+realm=turn.{{ matrix_server_fqn_matrix }}
+
+min-port={{ matrix_coturn_turn_udp_min_port }}
+max-port={{ matrix_coturn_turn_udp_max_port }}
+{% for ip in matrix_coturn_turn_external_ip_addresses|select('ne', '') %}
+external-ip={{ ip }}
+{% endfor %}
+
+log-file=stdout
+pidfile=/var/tmp/turnserver.pid
+userdb=/var/tmp/turnserver.db
+
+no-cli
+
+{% if matrix_coturn_tls_enabled %}
+cert={{ matrix_coturn_tls_cert_path }}
+pkey={{ matrix_coturn_tls_key_path }}
+{% if not matrix_coturn_tls_v1_enabled %}
+no-tlsv1
+{% endif %}
+{% if not matrix_coturn_tls_v1_1_enabled %}
+no-tlsv1_1
+{% endif %}
+{% else %}
+no-tls
+no-dtls
+{% endif %}
+
+prod
+no-tcp-relay
+
+{% if matrix_coturn_user_quota != None %}
+user-quota={{ matrix_coturn_user_quota }}
+{% endif %}
+{% if matrix_coturn_total_quota != None %}
+total-quota={{ matrix_coturn_total_quota }}
+{% endif %}
+
+{% for ip_range in matrix_coturn_denied_peer_ips %}
+denied-peer-ip={{ ip_range }}
+{% endfor %}
+{% for ip_range in matrix_coturn_allowed_peer_ips %}
+allowed-peer-ip={{ ip_range }}
+{% endfor %}