matrix-docker-ansible-deploy/roles/custom/matrix-synapse/tasks/synapse/workers/setup_install.yml

---

- name: Determine current worker configs
  ansible.builtin.find:
    path: "{{ matrix_synapse_config_dir_path }}"
    patterns: "worker.*.yaml"
    use_regex: true
  register: matrix_synapse_workers_current_config_files

- ansible.builtin.set_fact:
    matrix_synapse_enabled_worker_names: "{{ matrix_synapse_workers_enabled_list | map(attribute='name') }}"

# This also deletes some things which we need. They will be recreated below.
- name: Ensure unnecessary worker configs are cleaned
  ansible.builtin.file:
    path: "{{ item.path }}"
    state: absent
  with_items: "{{ matrix_synapse_workers_current_config_files.files }}"
  when: "not ansible_check_mode and (item.path | basename | replace ('worker.', '') | replace('.yaml', '')) not in matrix_synapse_enabled_worker_names"

- name: Determine current worker systemd services
  ansible.builtin.find:
    path: "{{ devture_systemd_docker_base_systemd_path }}"
    patterns: "matrix-synapse-worker.*.service"
    use_regex: true
  register: matrix_synapse_workers_current_systemd_services

- name: Ensure unnecessary worker systemd services are stopped and disabled
  ansible.builtin.service:
    name: "{{ item.path | basename }}"
    state: stopped
    enabled: false
  with_items: "{{ matrix_synapse_workers_current_systemd_services.files }}"
  when: "not ansible_check_mode and (item.path | basename | replace('.service', '')) not in matrix_synapse_enabled_worker_names"

- name: Ensure unnecessary worker systemd services are cleaned
  ansible.builtin.file:
    path: "{{ item.path }}"
    state: absent
  with_items: "{{ matrix_synapse_workers_current_systemd_services.files }}"
  when: "not ansible_check_mode and (item.path | basename | replace('.service', '')) not in matrix_synapse_enabled_worker_names"

- name: Ensure creation of worker systemd service files and configuration files
  ansible.builtin.include_tasks: "{{ role_path }}/tasks/synapse/workers/util/setup_files_for_worker.yml"
  with_items: "{{ matrix_synapse_workers_enabled_list }}"
  loop_control:
    loop_var: matrix_synapse_worker_details
Add initial support for synapse workers · needs documentation; no checks yet for port clashes or typos in worker name · according to https://github.com/matrix-org/synapse/wiki/Workers-setup-with-nginx#results about 90% of requests go to the synchrotron endpoint · thus, the synchrotron worker is especially suited to be load-balanced · most of the other workers are documented to support only a single instance · https://github.com/matrix-org/synapse/blob/master/docs/workers.md 5 years ago			`---`

Stop/disable unnecessary worker services before deleting them 4 years ago			`- name: Determine current worker configs`
More ansible-lint fixes 2 years ago			`ansible.builtin.find:`
synapse role workers setup: make configs clean action remote compatible Many people probably didn't even know this - that ansible can be quite a bit picky about what it will be willing to work with remotely. Thanks @maxklenk ! 4 years ago			`path: "{{ matrix_synapse_config_dir_path }}"`
			`patterns: "worker.*.yaml"`
			`use_regex: true`
Run Synapse workers in their own containers This switches the `docker exec` method of spawning Synapse workers inside the `matrix-synapse` container with dedicated containers for each worker. We also have dedicated systemd services for each worker, so this are now: - more consistent with everything else (we don't use systemd instantiated services anywhere) - we don't need the "parse systemd instance name into worker name + port" part - we don't need to keep track of PIDs manually - we don't need jq (less depenendencies) - workers dying would be restarted by systemd correctly, like any other service - `docker ps` shows each worker separately and we can observe resource usage 4 years ago			`register: matrix_synapse_workers_current_config_files`
synapse role workers setup: make configs clean action remote compatible Many people probably didn't even know this - that ansible can be quite a bit picky about what it will be willing to work with remotely. Thanks @maxklenk ! 4 years ago
Fix ansible-lint-reported errors 2 years ago			`- ansible.builtin.set_fact:`
Do not delete and re-create Synapse worker configs needlessly We had checks to avoid stopping/deleting systemd services for workers that used to exist and will continue to exist, but we were deleting config files for workers each time.. Only to recreate them again later. This lead to: - too many misleading "changed" tasks - too much unnecessary work - potential failures during playbook execution possibly leaving the system in a bad state (no worker config files) 2 years ago			`matrix_synapse_enabled_worker_names: "{{ matrix_synapse_workers_enabled_list \| map(attribute='name') }}"`

Stop/disable unnecessary worker services before deleting them 4 years ago			`# This also deletes some things which we need. They will be recreated below.`
Do not delete and re-create Synapse worker configs needlessly We had checks to avoid stopping/deleting systemd services for workers that used to exist and will continue to exist, but we were deleting config files for workers each time.. Only to recreate them again later. This lead to: - too many misleading "changed" tasks - too much unnecessary work - potential failures during playbook execution possibly leaving the system in a bad state (no worker config files) 2 years ago			`- name: Ensure unnecessary worker configs are cleaned`
Use fully-qualified module names for builtin Ansible modules Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1939 2 years ago			`ansible.builtin.file:`
synapse role workers setup: make configs clean action remote compatible Many people probably didn't even know this - that ansible can be quite a bit picky about what it will be willing to work with remotely. Thanks @maxklenk ! 4 years ago			`path: "{{ item.path }}"`
synapse workers: polishing, cleansing and installation of jq dependency 4 years ago			`state: absent`
Run Synapse workers in their own containers This switches the `docker exec` method of spawning Synapse workers inside the `matrix-synapse` container with dedicated containers for each worker. We also have dedicated systemd services for each worker, so this are now: - more consistent with everything else (we don't use systemd instantiated services anywhere) - we don't need the "parse systemd instance name into worker name + port" part - we don't need to keep track of PIDs manually - we don't need jq (less depenendencies) - workers dying would be restarted by systemd correctly, like any other service - `docker ps` shows each worker separately and we can observe resource usage 4 years ago			`with_items: "{{ matrix_synapse_workers_current_config_files.files }}"`
Do not delete and re-create Synapse worker configs needlessly We had checks to avoid stopping/deleting systemd services for workers that used to exist and will continue to exist, but we were deleting config files for workers each time.. Only to recreate them again later. This lead to: - too many misleading "changed" tasks - too much unnecessary work - potential failures during playbook execution possibly leaving the system in a bad state (no worker config files) 2 years ago			`when: "not ansible_check_mode and (item.path \| basename \| replace ('worker.', '') \| replace('.yaml', '')) not in matrix_synapse_enabled_worker_names"`
synapse workers: polishing, cleansing and installation of jq dependency 4 years ago
Stop/disable unnecessary worker services before deleting them 4 years ago			`- name: Determine current worker systemd services`
More ansible-lint fixes 2 years ago			`ansible.builtin.find:`
matrix_systemd_path -> devture_systemd_docker_base_systemd_path (via com.devture.ansible.role.systemd_docker_base) 2 years ago			`path: "{{ devture_systemd_docker_base_systemd_path }}"`
Run Synapse workers in their own containers This switches the `docker exec` method of spawning Synapse workers inside the `matrix-synapse` container with dedicated containers for each worker. We also have dedicated systemd services for each worker, so this are now: - more consistent with everything else (we don't use systemd instantiated services anywhere) - we don't need the "parse systemd instance name into worker name + port" part - we don't need to keep track of PIDs manually - we don't need jq (less depenendencies) - workers dying would be restarted by systemd correctly, like any other service - `docker ps` shows each worker separately and we can observe resource usage 4 years ago			`patterns: "matrix-synapse-worker.*.service"`
			`use_regex: true`
			`register: matrix_synapse_workers_current_systemd_services`
synapse workers: polishing, cleansing and installation of jq dependency 4 years ago
Stop/disable unnecessary worker services before deleting them 4 years ago			`- name: Ensure unnecessary worker systemd services are stopped and disabled`
Use fully-qualified module names for builtin Ansible modules Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1939 2 years ago			`ansible.builtin.service:`
More ansible-lint fixes 2 years ago			`name: "{{ item.path \| basename }}"`
Stop/disable unnecessary worker services before deleting them 4 years ago			`state: stopped`
			`enabled: false`
			`with_items: "{{ matrix_synapse_workers_current_systemd_services.files }}"`
Do not delete and re-create Synapse worker configs needlessly We had checks to avoid stopping/deleting systemd services for workers that used to exist and will continue to exist, but we were deleting config files for workers each time.. Only to recreate them again later. This lead to: - too many misleading "changed" tasks - too much unnecessary work - potential failures during playbook execution possibly leaving the system in a bad state (no worker config files) 2 years ago			`when: "not ansible_check_mode and (item.path \| basename \| replace('.service', '')) not in matrix_synapse_enabled_worker_names"`
Stop/disable unnecessary worker services before deleting them 4 years ago
			`- name: Ensure unnecessary worker systemd services are cleaned`
Use fully-qualified module names for builtin Ansible modules Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1939 2 years ago			`ansible.builtin.file:`
Run Synapse workers in their own containers This switches the `docker exec` method of spawning Synapse workers inside the `matrix-synapse` container with dedicated containers for each worker. We also have dedicated systemd services for each worker, so this are now: - more consistent with everything else (we don't use systemd instantiated services anywhere) - we don't need the "parse systemd instance name into worker name + port" part - we don't need to keep track of PIDs manually - we don't need jq (less depenendencies) - workers dying would be restarted by systemd correctly, like any other service - `docker ps` shows each worker separately and we can observe resource usage 4 years ago			`path: "{{ item.path }}"`
			`state: absent`
			`with_items: "{{ matrix_synapse_workers_current_systemd_services.files }}"`
Do not delete and re-create Synapse worker configs needlessly We had checks to avoid stopping/deleting systemd services for workers that used to exist and will continue to exist, but we were deleting config files for workers each time.. Only to recreate them again later. This lead to: - too many misleading "changed" tasks - too much unnecessary work - potential failures during playbook execution possibly leaving the system in a bad state (no worker config files) 2 years ago			`when: "not ansible_check_mode and (item.path \| basename \| replace('.service', '')) not in matrix_synapse_enabled_worker_names"`
synapse workers: polishing, cleansing and installation of jq dependency 4 years ago
Run Synapse workers in their own containers This switches the `docker exec` method of spawning Synapse workers inside the `matrix-synapse` container with dedicated containers for each worker. We also have dedicated systemd services for each worker, so this are now: - more consistent with everything else (we don't use systemd instantiated services anywhere) - we don't need the "parse systemd instance name into worker name + port" part - we don't need to keep track of PIDs manually - we don't need jq (less depenendencies) - workers dying would be restarted by systemd correctly, like any other service - `docker ps` shows each worker separately and we can observe resource usage 4 years ago			`- name: Ensure creation of worker systemd service files and configuration files`
More ansible-lint fixes 2 years ago			`ansible.builtin.include_tasks: "{{ role_path }}/tasks/synapse/workers/util/setup_files_for_worker.yml"`
Run Synapse workers in their own containers This switches the `docker exec` method of spawning Synapse workers inside the `matrix-synapse` container with dedicated containers for each worker. We also have dedicated systemd services for each worker, so this are now: - more consistent with everything else (we don't use systemd instantiated services anywhere) - we don't need the "parse systemd instance name into worker name + port" part - we don't need to keep track of PIDs manually - we don't need jq (less depenendencies) - workers dying would be restarted by systemd correctly, like any other service - `docker ps` shows each worker separately and we can observe resource usage 4 years ago			`with_items: "{{ matrix_synapse_workers_enabled_list }}"`
			`loop_control:`
			`loop_var: matrix_synapse_worker_details`