2022-09-15 04:05:25 +00:00
---
# The tasks below run before `validate_config.yml`.
# To avoid failing with a cryptic error message, we'll do validation here.
#
# This check is mostly relevant to people who explicitly define `matrix_synapse_workers_enabled_list`
# (Synapse Workers users from the earlier days of this PR - https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/456).
#
# In the future, it should be possible to remove this check.
# Our own code which dynamically builds `matrix_synapse_workers_enabled_list` does things right.
- name : Fail if required property not defined for worker
ansible.builtin.fail :
msg : "Synapse workers (like {{ matrix_synapse_worker_details | to_json }}) need to define a `{{ item }}` property"
with_items :
- id
- name
- type
- app
- port
- webserving
when : "item not in matrix_synapse_worker_details"
# Names are used for container names and systemd services.
# Routing happens based on container names, so Synapse processes that try to route to workers with underscores in the name will complain. Example:
# > InvalidCodepoint Codepoint U+005F at position 46 of 'matrix-synapse-worker-stream-writer-3-account_data' not allowed
- name : Fail if worker name includes underscore
ansible.builtin.fail :
msg : "Unrecognized Synapse worker `name`: `{{ matrix_synapse_worker_details.name }}`. It must not include underscores"
when : "'_' in matrix_synapse_worker_details.name"
- name : Fail if worker type unknown
ansible.builtin.fail :
msg : "Unrecognized Synapse worker `type`: `{{ matrix_synapse_worker_details.type }}`. Supported types are: {{ matrix_synapse_known_worker_types | join(', ') }}"
when : "matrix_synapse_worker_details.type not in matrix_synapse_known_worker_types"
- name : Fail if worker app unknown
ansible.builtin.fail :
msg : "Unrecognized Synapse worker `app`: `{{ matrix_synapse_worker_details.app }}`. Supported types are: {{ matrix_synapse_workers_avail_list | join(', ') }}"
when : "matrix_synapse_worker_details.app not in matrix_synapse_workers_avail_list"
2022-09-27 08:38:33 +00:00
- when : "matrix_synapse_worker_details.type == 'stream_writer'"
block :
2022-09-15 04:05:25 +00:00
- name : Fail if stream_writer_stream not defined for stream_writer worker
ansible.builtin.fail :
msg : >-
Synapse stream_writer workers (such as {{ item }}) need to define a valid `stream_writer_stream` property
2022-09-18 09:21:09 +00:00
(not `{{ matrix_synapse_worker_details.stream_writer_stream | default('undefined') }}`).
2022-09-15 04:05:25 +00:00
Supported types are : {{ matrix_synapse_workers_known_stream_writer_stream_types | join(', ') }}
when : "'stream_writer_stream' not in matrix_synapse_worker_details or matrix_synapse_worker_details.stream_writer_stream not in matrix_synapse_workers_known_stream_writer_stream_types"
- name : Fail if replication_port not defined for stream_writer worker
ansible.builtin.fail :
msg : "Synapse background workers of type stream_writer (such as {{ item }}) need to define a valid `replication_port` property"
when : "'replication_port' not in matrix_synapse_worker_details"
- ansible.builtin.set_fact :
2022-11-23 09:45:25 +00:00
devture_systemd_service_manager_services_list_auto : "{{ devture_systemd_service_manager_services_list_auto + [{'name': (matrix_synapse_worker_details.name + '.service'), 'priority': 1100, 'groups': ['matrix', 'homeservers', 'synapse']}] }}"
2022-09-15 04:05:25 +00:00
- ansible.builtin.set_fact :
matrix_synapse_webserving_workers_systemd_services_list : "{{ matrix_synapse_webserving_workers_systemd_services_list + [matrix_synapse_worker_details.name + '.service'] }}"
when : matrix_synapse_worker_details.webserving | bool
2022-09-15 07:00:57 +00:00
# Inject stream writers into the instance map.
2022-09-15 04:05:25 +00:00
- ansible.builtin.set_fact :
matrix_synapse_instance_map : "{{ matrix_synapse_instance_map | combine({matrix_synapse_worker_details.name: {'host': matrix_synapse_worker_details.name, 'port': matrix_synapse_worker_details.replication_port}}) }}"
when : matrix_synapse_worker_details.type in matrix_synapse_known_instance_map_eligible_worker_types
2022-11-08 15:39:56 +00:00
# Inject pusher instances.
- ansible.builtin.set_fact :
matrix_synapse_federation_pusher_instances : "{{ matrix_synapse_federation_pusher_instances + [matrix_synapse_worker_details.name] }}"
when : matrix_synapse_worker_details.type == 'pusher'