feat(synapse): add deployment method virtualenv

roles/synapse/README.md

@@ -20,18 +20,7 @@ The following variables need to be populated:
 
 - `docker`
 - `podman`
-- `virtualenv` - Python virtual env supervised with `systemd`
+- `venv` - Python virtual env supervised with `systemd`
 
 Set `synapse_deployment_method` to one of the supported deployment methods.
 The current default is `docker`.
-
-### `virtualenv` deployment method
-
-This deployment method installs a `systemd` service called `synapse.service` to
-control the homeserver process. The service depends on the `network.target` by
-default (see [`synapse_systemd_unit_after`](synapse/main/systemd.yml)), and
-uses the `default.target` as it's `WantedBy`
-(see [`synapse_systemd_install_wanted_by`](synapse/main/systemd.yml)).
-
-To only start synapse after, for example, services for redis and postgresql are up,
-set `synapse_systemd_unit_wants: [ "postgresql.service", "redis.service" ]`.

roles/synapse/defaults/main/main.yml

@@ -1,6 +1,6 @@
 ---
+
 synapse_user: synapse
-synapse_group: synapse
 synapse_version: "1.115.0"
 synapse_state: "present"
 synapse_deployment_method: "docker"

roles/synapse/defaults/main/systemd.yml

@@ -4,20 +4,5 @@ synapse_systemd_service_directory: /etc/systemd/system
 synapse_systemd_service_file: >-2
   {{ synapse_systemd_service_directory }}/{{ synapse_systemd_service_name }}
 
-synapse_systemd_service_state: >-2
-  {{ (synapse_state == 'present') | ternary('started', 'stopped') }}
 synapse_systemd_service_enabled: >-2
   {{ (synapse_state == 'present') | bool }}
-
-synapse_systemd_unit_description: "Synapse matrix homeserver"
-synapse_systemd_service_type: simple
-synapse_systemd_service_exec_start: >-2
-  {{ synapse_venv_path }}/bin/python \
-    -m synapse.app.homeserver \
-    --config-path={{ synapse_homeserver_config_file }}
-synapse_systemd_service_restart: always
-
-synapse_systemd_unit_after:
-  - "network.target"
-synapse_systemd_unit_wants: []
-synapse_systemd_install_wanted_by: "default.target"

roles/synapse/defaults/main/user.yml

@@ -1,21 +0,0 @@
----
-synapse_user_base_groups:
-  - "{{ synapse_run_group }}"
-synapse_user_groups: ~
-synapse_user_all_groups: >-2
-  {{ synapse_user_base_groups | default([], true)
-    + synapse_user_groups | default([], true) }}
-synapse_user_groups_append: "{{ synapse_user_all_groups | length > 0 }}"
-synapse_run_user: >-2
-  {{ synapse_user_info.name | default(synapse_user) }}
-synapse_run_group: >-2
-  {{ (synapse_user_info is defined and ('groups' in synapse_user_info))
-    | ternary(
-      (synapse_user_info.groups | default("") | split(",") | first),
-      synapse_group
-    )
-  }}
-synapse_run_user_id: >-2
-  {{ synapse_user_info.uid | default(synapse_user) }}
-synapse_run_group_id: >-2
-  {{ synapse_user_info.group | default(synapse_user) }}

roles/synapse/defaults/main/virtualenv.yml

@@ -1,11 +1,6 @@
 ---
-synapse_venv_package: "matrix-synapse[all]"
+synapse_venv_package:
+  - synapse
 synapse_venv_pip_dependencies:
   - pip
   - setuptools
-synapse_venv_package_full: >-2
-  {{ synapse_venv_package }}@{{ synapse_version }}
-
-synapse_venv_python_binary: >-2
-  {{ ansible_python_interpreter | default(omit, true) }}
-synapse_venv_extra_args: ~

roles/synapse/tasks/configure.yml

@@ -1,19 +1,12 @@
 ---
-- name: Ensure synapse group '{{ synapse_group }}' is {{ synapse_state }}
-  ansible.builtin.group:
-    name: "{{ synapse_group }}"
-    system: "{{ synapse_group_system | default(true, true) }}"
-    state: "{{ synapse_state }}"
-  register: synapse_group_info
-
 - name: Ensure synapse user '{{ synapse_user }}' is {{ synapse_state }}
   ansible.builtin.user:
     name: "{{ synapse_user }}"
     state: "{{ synapse_state }}"
     system: "{{ synapse_user_system | default(true, true) }}"
     create_home: "{{ synapse_user_create_home | default(false, true) }}"
-    groups: "{{ synapse_user_all_groups | default(omit, true) }}"
+    groups: "{{ synapse_user_groups | default(omit, true) }}"
-    append: "{{ synapse_user_groups_append | default(omit, true) }}"
+    append: "{{ (synapse_user_groups is defined) | ternary(true, omit) }}"
   register: synapse_user_info
 
 - name: Ensure directories for synapse are {{ synapse_state }}

roles/synapse/tasks/deploy-venv.yml

@@ -15,11 +15,14 @@
   ansible.builtin.pip:
     name: "{{ synapse_venv_pip_dependencies }}"
     virtualenv: "{{ synapse_venv_path }}"
-    virtualenv_python: "{{ synapse_venv_python_binary }}"
+    virtualenv_python: >-
-    extra_args: "{{ synapse_venv_extra_args | default(omit, true) }}"
+      {{ synapse_virtualenv_python_binary
+        | default(ansible_python_interpreter
+          | default(omit, true), true) }}
+    extra_args: "{{ synapse_venv_extra_args }}"
     state: "{{ synapse_state }}"
 
-- name: Ensure synapse pip package is {{ synapse_state }}
+- name: Ensure synapse is {{ synapse_state }}
   ansible.builtin.pip:
     name: "{{ synapse_venv_package }}"
     version: "{{ synapse_version }}"
@@ -40,7 +43,7 @@
 - name: Ensure systemd service is {{ synapse_state }}
   ansible.builtin.systemd:
     name: "{{ synapse_systemd_service_name }}"
-    state: "{{ synapse_systemd_service_state }}"
+    state: "{{ synapse_state }}"
 
 - name: Ensure systemd service is {{ synapse_systemd_service_enabled | ternary('enabled', 'disabled') }}
   ansible.builtin.systemd:

roles/synapse/templates/synapse.service.j2

@@ -1,22 +0,0 @@
-[Unit]
-Description="{{ synapse_systemd_unit_description }}"
-
-{% if synapse_systemd_unit_after | default([]) | length > 0 %}
-After={{ synapse_systemd_unit_after | join(' ') }}
-{% endif %}
-{% if synapse_systemd_unit_wants | default([]) | length > 0 %}
-Wants={{ synapse_systemd_unit_wants | join(' ') }}
-{% endif %}
-
-[Service]
-Type={{ synapse_systemd_service_type }}
-WorkingDirectory={{ synapse_venv_path }}
-ExecStart={{ synapse_systemd_service_exec_start }}
-
-User={{ synapse_run_user }}
-Group={{ synapse_run_group }}
-
-Restart={{ synapse_systemd_service_restart }}
-
-[Install]
-WantedBy={{ synapse_systemd_install_wanted_by }}

roles/synapse/vars/main.yml

@@ -6,7 +6,7 @@ synapse_states:
 synapse_deployment_methods:
   - docker
   - podman
-  - virtualenv
+  - venv
 
 synapse_required_variables:
   - synapse_domain