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

---

# A previous version of the worker setup used this.
# This is a temporary cleanup for people who ran that version.
- name: Ensure old matrix-synapse.service.wants directory is gone
  ansible.builtin.file:
    path: "{{ matrix_systemd_path }}/matrix-synapse.service.wants"
    state: absent

# Same. This was part of a previous version of the worker setup.
# No longer necessary.
- name: Ensure matrix-synapse-worker-write-pid script is removed
  ansible.builtin.file:
    path: "{{ matrix_local_bin_path }}/matrix-synapse-worker-write-pid"
    state: absent

- include_tasks: "{{ role_path }}/tasks/synapse/workers/setup_install.yml"
  when: "matrix_synapse_enabled|bool and matrix_synapse_workers_enabled|bool"

- include_tasks: "{{ role_path }}/tasks/synapse/workers/setup_uninstall.yml"
  when: "not matrix_synapse_workers_enabled|bool"
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 2020-04-10 21:44:53 +00:00			`---`

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 2021-01-25 10:14:46 +00:00			`# A previous version of the worker setup used this.`
			`# This is a temporary cleanup for people who ran that version.`
			`- name: Ensure old matrix-synapse.service.wants directory is gone`
Use fully-qualified module names for builtin Ansible modules Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1939 2022-07-18 07:39:08 +00:00			`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 2021-01-25 10:14:46 +00:00			`path: "{{ matrix_systemd_path }}/matrix-synapse.service.wants"`
			`state: absent`

			`# Same. This was part of a previous version of the worker setup.`
			`# No longer necessary.`
			`- name: Ensure matrix-synapse-worker-write-pid script is removed`
Use fully-qualified module names for builtin Ansible modules Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1939 2022-07-18 07:39:08 +00:00			`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 2021-01-25 10:14:46 +00:00			`path: "{{ matrix_local_bin_path }}/matrix-synapse-worker-write-pid"`
			`state: absent`

Relocate tasks related to Synapse workers 2021-02-15 08:42:20 +00:00			`- include_tasks: "{{ role_path }}/tasks/synapse/workers/setup_install.yml"`
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 2020-04-10 21:44:53 +00:00			`when: "matrix_synapse_enabled\|bool and matrix_synapse_workers_enabled\|bool"`

Relocate tasks related to Synapse workers 2021-02-15 08:42:20 +00:00			`- include_tasks: "{{ role_path }}/tasks/synapse/workers/setup_uninstall.yml"`
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 2020-04-10 21:44:53 +00:00			`when: "not matrix_synapse_workers_enabled\|bool"`