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
This commit is contained in:
@ -251,6 +251,44 @@ listeners:
|
||||
type: manhole
|
||||
{% endif %}
|
||||
|
||||
{% if matrix_synapse_workers_enabled %}
|
||||
# c.f. https://github.com/matrix-org/synapse/tree/master/docs/workers.md
|
||||
# TCP replication: streaming data from the master to the workers
|
||||
- port: {{ matrix_synapse_replication_tcp_port }}
|
||||
bind_addresses: ['0.0.0.0']
|
||||
type: replication
|
||||
|
||||
# HTTP replication: for the workers to send data to the main synapse process
|
||||
- port: {{ matrix_synapse_replication_http_port }}
|
||||
bind_addresses: ['0.0.0.0']
|
||||
type: http
|
||||
resources:
|
||||
- names: [replication]
|
||||
|
||||
# c.f. https://github.com/matrix-org/synapse/tree/master/contrib/systemd-with-workers/README.md
|
||||
worker_app: synapse.app.homeserver
|
||||
|
||||
# thx https://oznetnerd.com/2017/04/18/jinja2-selectattr-filter/
|
||||
# reduce the main worker's offerings to core homeserver business
|
||||
{% if matrix_synapse_workers_enabled_list|selectattr('worker', 'equalto', 'appservice')|list %}
|
||||
notify_appservices: false
|
||||
{% endif %}
|
||||
{% if matrix_synapse_workers_enabled_list|selectattr('worker', 'equalto', 'federation_sender')|list %}
|
||||
send_federation: false
|
||||
{% endif %}
|
||||
{% if matrix_synapse_workers_enabled_list|selectattr('worker', 'equalto', 'media_repository')|list %}
|
||||
enable_media_repo: false
|
||||
{% endif %}
|
||||
{% if matrix_synapse_workers_enabled_list|selectattr('worker', 'equalto', 'pusher')|list %}
|
||||
start_pushers: false
|
||||
{% endif %}
|
||||
{% if matrix_synapse_workers_enabled_list|selectattr('worker', 'equalto', 'user_dir')|list %}
|
||||
update_user_directory: false
|
||||
{% endif %}
|
||||
|
||||
# rather let systemd handle the forking
|
||||
daemonize: false
|
||||
{% endif %}
|
||||
|
||||
## Homeserver blocking ##
|
||||
|
||||
|
@ -0,0 +1,29 @@
|
||||
#jinja2: lstrip_blocks: "True"
|
||||
# c.f. https://github.com/matrix-org/synapse/pull/4662
|
||||
[Unit]
|
||||
Description=Synapse Matrix Worker
|
||||
After=matrix-synapse.service
|
||||
BindsTo=matrix-synapse.service
|
||||
|
||||
[Service]
|
||||
Type=simple
|
||||
|
||||
# Intentional delay, so that the homeserver (we likely depend on) can manage to start.
|
||||
ExecStartPre=/bin/sleep 5
|
||||
|
||||
# systemd ftw 🤦♂️
|
||||
# https://github.com/systemd/systemd/issues/14895#issuecomment-594123923
|
||||
ExecStart=/bin/sh -c "WORKER=%i; WORKER=$${WORKER%%:*}; \
|
||||
exec /usr/bin/docker exec \
|
||||
--user={{ matrix_user_uid }}:{{ matrix_user_gid }} \
|
||||
matrix-synapse \
|
||||
python -m synapse.app.$${WORKER} -c /data/homeserver.yaml -c /data/worker.%i.yaml"
|
||||
|
||||
ExecStop=/usr/bin/docker exec matrix-synapse pkill -f %i
|
||||
KillMode=process
|
||||
Restart=always
|
||||
RestartSec=10
|
||||
SyslogIdentifier=matrix-synapse-%i
|
||||
|
||||
[Install]
|
||||
WantedBy=matrix-synapse.service
|
29
roles/matrix-synapse/templates/synapse/worker.yaml.j2
Normal file
29
roles/matrix-synapse/templates/synapse/worker.yaml.j2
Normal file
@ -0,0 +1,29 @@
|
||||
#jinja2: lstrip_blocks: "True"
|
||||
worker_app: synapse.app.{{ item.worker }}
|
||||
|
||||
worker_replication_host: 127.0.0.1
|
||||
worker_replication_port: {{ matrix_synapse_replication_tcp_port }}
|
||||
worker_replication_http_port: {{ matrix_synapse_replication_http_port }}
|
||||
|
||||
{% if item.worker not in [ 'appservice', 'federation_sender', 'pusher' ] %}
|
||||
worker_listeners:
|
||||
- type: http
|
||||
port: {{ item.port }}
|
||||
resources:
|
||||
- names:
|
||||
{% if item.worker in [ 'synchrotron', 'client_reader', 'event_creator', 'frontend_proxy', 'user_dir' ] %}
|
||||
- client
|
||||
{% elif item.worker in [ 'federation_reader' ] %}
|
||||
- federation
|
||||
{% elif item.worker in [ 'media_repository' ] %}
|
||||
- media
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
|
||||
{% if item.worker == 'frontend_proxy' %}
|
||||
worker_main_http_uri: http://127.0.0.1:8008
|
||||
{% endif %}
|
||||
|
||||
worker_daemonize: false
|
||||
worker_pid_file: /matrix-run/{{ item.worker }}.port{{ item.port }}.pid
|
||||
worker_log_config: /data/{{ matrix_server_fqn_matrix }}.log.config
|
Reference in New Issue
Block a user