Make roles more independent of one another

With this change, the following roles are now only dependent
on the minimal `matrix-base` role:
- `matrix-corporal`
- `matrix-coturn`
- `matrix-mailer`
- `matrix-mxisd`
- `matrix-postgres`
- `matrix-riot-web`
- `matrix-synapse`

The `matrix-nginx-proxy` role still does too much and remains
dependent on the others.

Wiring up the various (now-independent) roles happens
via a glue variables file (`group_vars/matrix-servers`).
It's triggered for all hosts in the `matrix-servers` group.

According to Ansible's rules of priority, we have the following
chain of inclusion/overriding now:
- role defaults (mostly empty or good for independent usage)
- playbook glue variables (`group_vars/matrix-servers`)
- inventory host variables (`inventory/host_vars/matrix.<your-domain>`)

All roles default to enabling their main component
(e.g. `matrix_mxisd_enabled: true`, `matrix_riot_web_enabled: true`).
Reasoning: if a role is included in a playbook (especially separately,
in another playbook), it should "work" by default.

Our playbook disables some of those if they are not generally useful
(e.g. `matrix_corporal_enabled: false`).

roles/matrix-postgres/tasks/import_postgres.yml

@@ -2,6 +2,11 @@
 
 # Pre-checks
 
+- name: Fail if Postgres not enabled
+  fail:
+    msg: "Postgres via the matrix-postgres role is not enabled (`matrix_postgres_enabled`). Cannot import."
+  when: "not matrix_postgres_enabled"
+
 - name: Fail if playbook called incorrectly
   fail:
     msg: "The `server_path_postgres_dump` variable needs to be provided to this playbook, via --extra-vars"

roles/matrix-postgres/tasks/import_sqlite_db.yml

@@ -2,6 +2,11 @@
 
 # Pre-checks
 
+- name: Fail if Postgres not enabled
+  fail:
+    msg: "Postgres via the matrix-postgres role is not enabled (`matrix_postgres_enabled`). Cannot import."
+  when: "not matrix_postgres_enabled"
+
 - name: Fail if playbook called incorrectly
   fail:
     msg: "The `server_path_homeserver_db` variable needs to be provided to this playbook, via --extra-vars"

roles/matrix-postgres/tasks/init.yml

@@ -1,3 +1,3 @@
 - set_fact:
     matrix_systemd_services_list: "{{ matrix_systemd_services_list + ['matrix-postgres'] }}"
-  when: "not matrix_postgres_use_external"
+  when: matrix_postgres_enabled

roles/matrix-postgres/tasks/main.yml

@@ -2,11 +2,17 @@
   tags:
     - always
 
+- import_tasks: "{{ role_path }}/tasks/validate_config.yml"
+  when: "run_setup and matrix_postgres_enabled"
+  tags:
+    - setup-all
+    - setup-postgres
+
 - import_tasks: "{{ role_path }}/tasks/setup_postgres.yml"
   when: run_setup
   tags:
-    - setup-postgres
     - setup-all
+    - setup-postgres
 
 - import_tasks: "{{ role_path }}/tasks/import_postgres.yml"
   when: run_import_postgres

roles/matrix-postgres/tasks/setup_postgres.yml

@@ -5,8 +5,10 @@
 #
 
 - import_tasks: "{{ role_path }}/tasks/migrate_postgres_data_directory.yml"
+  when: matrix_postgres_enabled
 
 - import_tasks: "{{ role_path }}/tasks/util/detect_existing_postgres_version.yml"
+  when: matrix_postgres_enabled
 
 # If we have found an existing version (installed from before), we use its corresponding Docker image.
 # If not, we install using the latest Postgres.
@@ -14,16 +16,18 @@
 # Upgrading is supposed to be performed separately and explicitly (see `upgrade_postgres.yml`).
 - set_fact:
     matrix_postgres_docker_image_to_use: "{{ matrix_postgres_docker_image_latest if matrix_postgres_detected_version_corresponding_docker_image == '' else matrix_postgres_detected_version_corresponding_docker_image }}"
+  when: matrix_postgres_enabled
 
 - name: Warn if on an old version of Postgres
   debug:
     msg: "NOTE: Your setup is on an old Postgres version ({{ matrix_postgres_docker_image_to_use }}), while {{ matrix_postgres_docker_image_latest }} is supported. You can upgrade using --tags=upgrade-postgres"
-  when: "matrix_postgres_docker_image_to_use != matrix_postgres_docker_image_latest"
+  when: "matrix_postgres_enabled and matrix_postgres_docker_image_to_use != matrix_postgres_docker_image_latest"
 
 # Even if we don't run the internal server, we still need this for running the CLI
 - name: Ensure postgres Docker image is pulled
   docker_image:
     name: "{{ matrix_postgres_docker_image_to_use }}"
+  when: matrix_postgres_enabled
 
 # We always create these directories, even if an external Postgres is used,
 # because we store environment variable files there.
@@ -37,6 +41,7 @@
   with_items:
     - "{{ matrix_postgres_base_path }}"
     - "{{ matrix_postgres_data_path }}"
+  when: matrix_postgres_enabled
 
 - name: Ensure Postgres environment variables file created
   template:
@@ -46,18 +51,21 @@
   with_items:
     - "env-postgres-psql"
     - "env-postgres-server"
+  when: matrix_postgres_enabled
 
 - name: Ensure matrix-postgres-cli script created
   template:
     src: "{{ role_path }}/templates/usr-local-bin/matrix-postgres-cli.j2"
     dest: "/usr/local/bin/matrix-postgres-cli"
     mode: 0750
+  when: matrix_postgres_enabled
 
 - name: Ensure matrix-make-user-admin script created
   template:
     src: "{{ role_path }}/templates/usr-local-bin/matrix-make-user-admin.j2"
     dest: "/usr/local/bin/matrix-make-user-admin"
     mode: 0750
+  when: matrix_postgres_enabled
 
 #
 # Tasks related to setting up an internal postgres server
@@ -68,7 +76,7 @@
     src: "{{ role_path }}/templates/systemd/matrix-postgres.service.j2"
     dest: "/etc/systemd/system/matrix-postgres.service"
     mode: 0644
-  when: "not matrix_postgres_use_external"
+  when: matrix_postgres_enabled
 
 #
 # Tasks related to getting rid of the internal postgres server (if it was previously enabled)
@@ -78,29 +86,29 @@
   stat:
     path: "/etc/systemd/system/matrix-postgres.service"
   register: matrix_postgres_service_stat
-  when: matrix_postgres_use_external
+  when: "not matrix_postgres_enabled"
 
 - name: Ensure matrix-postgres is stopped
   service:
     name: matrix-postgres
     state: stopped
     daemon_reload: yes
-  when: "matrix_postgres_use_external and matrix_postgres_service_stat.stat.exists"
+  when: "not matrix_postgres_enabled and matrix_postgres_service_stat.stat.exists"
 
 - name: Ensure matrix-postgres.service doesn't exist
   file:
     path: "/etc/systemd/system/matrix-postgres.service"
     state: absent
-  when: "matrix_postgres_use_external and matrix_postgres_service_stat.stat.exists"
+  when: "not matrix_postgres_enabled and matrix_postgres_service_stat.stat.exists"
 
 - name: Check existence of matrix-postgres local data path
   stat:
     path: "{{ matrix_postgres_data_path }}"
   register: matrix_postgres_data_path_stat
-  when: matrix_postgres_use_external
+  when: "not matrix_postgres_enabled"
 
 # We just want to notify the user. Deleting data is too destructive.
 - name: Notify if matrix-postgres local data remains
   debug:
-    msg: "Note: You are not using a local PostgreSQL database, but some old data remains from before in {{ matrix_postgres_data_path }}. Feel free to delete it."
-  when: "matrix_postgres_use_external and matrix_postgres_data_path_stat.stat.exists"
+    msg: "Note: You are not using a local PostgreSQL database, but some old data remains from before in `{{ matrix_postgres_data_path }}`. Feel free to delete it."
+  when: "not matrix_postgres_enabled and matrix_postgres_data_path_stat.stat.exists"

roles/matrix-postgres/tasks/upgrade_postgres.yml

@@ -22,8 +22,8 @@
 
 - name: Fail, if trying to upgrade external Postgres database
   fail:
-    msg: "Your configuration indicates that you're using an external Postgres database. Refusing to try and upgrade that."
-  when: "matrix_postgres_use_external"
+    msg: "Your configuration indicates that you're not using Postgres from this role. There is nothing to upgrade."
+  when: "not matrix_postgres_enabled"
 
 - name: Check Postgres auto-upgrade backup data directory
   stat:

roles/matrix-postgres/tasks/validate_config.yml

@@ -0,0 +1,22 @@
+---
+
+- name: (Deprecation) Warn about matrix_postgres_use_external usage
+  fail:
+    msg: >
+      The `matrix_postgres_use_external` variable defined in your configuration is not used by this playbook anymore!
+      You'll need to adapt to the new way of using an external Postgres server.
+      It's a combination of `matrix_postgres_enabled: false` and specifying Postgres connection
+      details in a few `matrix_synapse_database_` variables.
+      See the "Using an external PostgreSQL server (optional)" documentation page.
+  when: "'matrix_postgres_use_external' in vars"
+
+- name: Fail if required Postgres settings not defined
+  fail:
+    msg: >
+      You need to define a required configuration setting (`{{ item }}`) for using mxisd.
+  when: "vars[item] == ''"
+  with_items:
+    - "matrix_postgres_connection_hostname"
+    - "matrix_postgres_connection_username"
+    - "matrix_postgres_connection_password"
+    - "matrix_postgres_db_name"