Add support for synapse-s3-storage-provider

roles/matrix-synapse/tasks/ext/s3-storage-provider/init.yml

@@ -0,0 +1,5 @@
+---
+
+- ansible.builtin.set_fact:
+    matrix_systemd_services_list: "{{ matrix_systemd_services_list + ['matrix-synapse-s3-storage-provider-migrate.timer'] }}"
+  when: matrix_synapse_ext_synapse_s3_storage_provider_enabled | bool

roles/matrix-synapse/tasks/ext/s3-storage-provider/setup.yml

@@ -0,0 +1,10 @@
+---
+
+- ansible.builtin.import_tasks: "{{ role_path }}/tasks/ext/s3-storage-provider/validate_config.yml"
+  when: matrix_synapse_ext_synapse_s3_storage_provider_enabled | bool
+
+- ansible.builtin.import_tasks: "{{ role_path }}/tasks/ext/s3-storage-provider/setup_install.yml"
+  when: matrix_synapse_ext_synapse_s3_storage_provider_enabled | bool
+
+- ansible.builtin.import_tasks: "{{ role_path }}/tasks/ext/s3-storage-provider/setup_uninstall.yml"
+  when: not matrix_synapse_ext_synapse_s3_storage_provider_enabled | bool

roles/matrix-synapse/tasks/ext/s3-storage-provider/setup_install.yml

@@ -0,0 +1,54 @@
+---
+
+# We install this into Synapse by making `matrix_synapse_ext_synapse_s3_storage_provider_enabled` influence other variables:
+# - `matrix_synapse_media_storage_providers` (via `matrix_synapse_media_storage_providers_auto`)
+# - `matrix_synapse_container_image_customizations_enabled`
+# - `matrix_synapse_container_image_customizations_s3_storage_provider_installation_enabled`
+#
+# Below are additional tasks for setting up various helper scripts, etc.
+
+- name: Ensure s3-storage-provider env file installed
+  ansible.builtin.template:
+    src: "{{ role_path }}/templates/synapse/ext/s3-storage-provider/env.j2"
+    dest: "{{ matrix_synapse_ext_s3_storage_provider_path }}/env"
+    mode: 0640
+
+- name: Ensure s3-storage-provider data path exists
+  ansible.builtin.file:
+    path: "{{ matrix_synapse_ext_s3_storage_provider_path }}/data"
+    state: directory
+    mode: 0750
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+
+- name: Ensure s3-storage-provider database.yaml file installed
+  ansible.builtin.template:
+    src: "{{ role_path }}/templates/synapse/ext/s3-storage-provider/database.yaml.j2"
+    dest: "{{ matrix_synapse_ext_s3_storage_provider_path }}/data/database.yaml"
+    mode: 0640
+
+- name: Ensure s3-storage-provider scripts installed
+  ansible.builtin.template:
+    src: "{{ role_path }}/templates/synapse/ext/s3-storage-provider/usr-local-bin/{{ item }}.j2"
+    dest: "{{ matrix_local_bin_path }}/{{ item }}"
+    mode: 0750
+  with_items:
+    - matrix-synapse-s3-storage-provider-shell
+    - matrix-synapse-s3-storage-provider-migrate
+
+- name: Ensure matrix-synapse-s3-storage-provider-migrate.service and timer are installed
+  ansible.builtin.template:
+    src: "{{ role_path }}/templates/systemd/.j2"
+    src: "{{ role_path }}/templates/synapse/ext/s3-storage-provider/systemd/{{ item }}.j2"
+    dest: "{{ matrix_systemd_path }}/{{ item }}"
+    mode: 0640
+  with_items:
+    - matrix-synapse-s3-storage-provider-migrate.service
+    - matrix-synapse-s3-storage-provider-migrate.timer
+  register: matrix_synapse_s3_storage_provider_systemd_service_result
+
+- name: Ensure systemd reloaded after matrix-synapse-s3-storage-provider-migrate.service installation
+  ansible.builtin.service:
+    daemon_reload: true
+  when: matrix_synapse_s3_storage_provider_systemd_service_result.changed | bool
+

roles/matrix-synapse/tasks/ext/s3-storage-provider/setup_uninstall.yml

@@ -0,0 +1,24 @@
+---
+
+- name: Ensure matrix-synapse-s3-storage-provider-migrate.service and timer don't exist
+  ansible.builtin.file:
+    path: "{{ matrix_systemd_path }}/{{ item }}"
+    state: absent
+  with_items:
+    - matrix-synapse-s3-storage-provider-migrate.timer
+    - matrix-synapse-s3-storage-provider-migrate.service
+  register: matrix_synapse_s3_storage_provider_migrate_sevice_removal
+
+- name: Ensure systemd reloaded after matrix-synapse-s3-storage-provider-migrate.service removal
+  ansible.builtin.service:
+    daemon_reload: true
+  when: matrix_synapse_s3_storage_provider_migrate_sevice_removal.changed | bool
+
+- name: Ensure s3-storage-provider files don't exist
+  ansible.builtin.file:
+    path: "{{ item }}"
+    state: absent
+  with_items:
+    - "{{ matrix_local_bin_path }}/matrix-synapse-s3-storage-provider-shell"
+    - "{{ matrix_local_bin_path }}/matrix-synapse-s3-storage-provider-migrate"
+    - "{{ matrix_synapse_ext_s3_storage_provider_path }}"

roles/matrix-synapse/tasks/ext/s3-storage-provider/validate_config.yml

@@ -0,0 +1,18 @@
+---
+
+- name: Fail if required s3-storage-provider settings not defined
+  ansible.builtin.fail:
+    msg: >-
+      You need to define a required configuration setting (`{{ item }}`) for using s3-storage-provider.
+  when: "vars[item] == ''"
+  with_items:
+    - "matrix_synapse_ext_synapse_s3_storage_provider_config_bucket"
+    - "matrix_synapse_ext_synapse_s3_storage_provider_config_region_name"
+    - "matrix_synapse_ext_synapse_s3_storage_provider_config_access_key_id"
+    - "matrix_synapse_ext_synapse_s3_storage_provider_config_secret_access_key"
+
+- name: Fail if required matrix_synapse_ext_synapse_s3_storage_provider_config_endpoint_url looks invalid
+  ansible.builtin.fail:
+    msg: >-
+      `matrix_synapse_ext_synapse_s3_storage_provider_config_endpoint_url` needs to look like a URL (`http://` or `https://` prefix).
+  when: "matrix_synapse_ext_synapse_s3_storage_provider_config_endpoint_url != '' and not matrix_synapse_ext_synapse_s3_storage_provider_config_endpoint_url.startswith('http')"

roles/matrix-synapse/tasks/ext/setup.yml

@@ -11,3 +11,5 @@
 - ansible.builtin.import_tasks: "{{ role_path }}/tasks/ext/synapse-simple-antispam/setup.yml"
 
 - ansible.builtin.import_tasks: "{{ role_path }}/tasks/ext/mjolnir-antispam/setup.yml"
+
+- ansible.builtin.import_tasks: "{{ role_path }}/tasks/ext/s3-storage-provider/setup.yml"