mirror of
https://mau.dev/maunium/synapse.git
synced 2024-10-31 19:59:01 +01:00
Modernize configure_workers_and_start.py bootstrapping script for Dockerfile-workers. (#14294)
This commit is contained in:
parent
0cf48f2d5f
commit
e9cbddc8e7
2 changed files with 15 additions and 15 deletions
1
changelog.d/14294.docker
Normal file
1
changelog.d/14294.docker
Normal file
|
@ -0,0 +1 @@
|
||||||
|
Remove references to legacy worker types in the multi-worker Dockerfile.
|
|
@ -20,7 +20,7 @@
|
||||||
# * SYNAPSE_SERVER_NAME: The desired server_name of the homeserver.
|
# * SYNAPSE_SERVER_NAME: The desired server_name of the homeserver.
|
||||||
# * SYNAPSE_REPORT_STATS: Whether to report stats.
|
# * SYNAPSE_REPORT_STATS: Whether to report stats.
|
||||||
# * SYNAPSE_WORKER_TYPES: A comma separated list of worker names as specified in WORKER_CONFIG
|
# * SYNAPSE_WORKER_TYPES: A comma separated list of worker names as specified in WORKER_CONFIG
|
||||||
# below. Leave empty for no workers, or set to '*' for all possible workers.
|
# below. Leave empty for no workers.
|
||||||
# * SYNAPSE_AS_REGISTRATION_DIR: If specified, a directory in which .yaml and .yml files
|
# * SYNAPSE_AS_REGISTRATION_DIR: If specified, a directory in which .yaml and .yml files
|
||||||
# will be treated as Application Service registration files.
|
# will be treated as Application Service registration files.
|
||||||
# * SYNAPSE_TLS_CERT: Path to a TLS certificate in PEM format.
|
# * SYNAPSE_TLS_CERT: Path to a TLS certificate in PEM format.
|
||||||
|
@ -58,10 +58,10 @@ MAIN_PROCESS_HTTP_LISTENER_PORT = 8080
|
||||||
# have to attach by instance_map to the master process and have client endpoints.
|
# have to attach by instance_map to the master process and have client endpoints.
|
||||||
WORKERS_CONFIG: Dict[str, Dict[str, Any]] = {
|
WORKERS_CONFIG: Dict[str, Dict[str, Any]] = {
|
||||||
"pusher": {
|
"pusher": {
|
||||||
"app": "synapse.app.pusher",
|
"app": "synapse.app.generic_worker",
|
||||||
"listener_resources": [],
|
"listener_resources": [],
|
||||||
"endpoint_patterns": [],
|
"endpoint_patterns": [],
|
||||||
"shared_extra_conf": {"start_pushers": False},
|
"shared_extra_conf": {},
|
||||||
"worker_extra_conf": "",
|
"worker_extra_conf": "",
|
||||||
},
|
},
|
||||||
"user_dir": {
|
"user_dir": {
|
||||||
|
@ -84,7 +84,11 @@ WORKERS_CONFIG: Dict[str, Dict[str, Any]] = {
|
||||||
"^/_synapse/admin/v1/media/.*$",
|
"^/_synapse/admin/v1/media/.*$",
|
||||||
"^/_synapse/admin/v1/quarantine_media/.*$",
|
"^/_synapse/admin/v1/quarantine_media/.*$",
|
||||||
],
|
],
|
||||||
"shared_extra_conf": {"enable_media_repo": False},
|
# The first configured media worker will run the media background jobs
|
||||||
|
"shared_extra_conf": {
|
||||||
|
"enable_media_repo": False,
|
||||||
|
"media_instance_running_background_jobs": "media_repository1",
|
||||||
|
},
|
||||||
"worker_extra_conf": "enable_media_repo: true",
|
"worker_extra_conf": "enable_media_repo: true",
|
||||||
},
|
},
|
||||||
"appservice": {
|
"appservice": {
|
||||||
|
@ -95,10 +99,10 @@ WORKERS_CONFIG: Dict[str, Dict[str, Any]] = {
|
||||||
"worker_extra_conf": "",
|
"worker_extra_conf": "",
|
||||||
},
|
},
|
||||||
"federation_sender": {
|
"federation_sender": {
|
||||||
"app": "synapse.app.federation_sender",
|
"app": "synapse.app.generic_worker",
|
||||||
"listener_resources": [],
|
"listener_resources": [],
|
||||||
"endpoint_patterns": [],
|
"endpoint_patterns": [],
|
||||||
"shared_extra_conf": {"send_federation": False},
|
"shared_extra_conf": {},
|
||||||
"worker_extra_conf": "",
|
"worker_extra_conf": "",
|
||||||
},
|
},
|
||||||
"synchrotron": {
|
"synchrotron": {
|
||||||
|
@ -205,7 +209,7 @@ WORKERS_CONFIG: Dict[str, Dict[str, Any]] = {
|
||||||
"worker_extra_conf": "",
|
"worker_extra_conf": "",
|
||||||
},
|
},
|
||||||
"frontend_proxy": {
|
"frontend_proxy": {
|
||||||
"app": "synapse.app.frontend_proxy",
|
"app": "synapse.app.generic_worker",
|
||||||
"listener_resources": ["client", "replication"],
|
"listener_resources": ["client", "replication"],
|
||||||
"endpoint_patterns": ["^/_matrix/client/(api/v1|r0|v3|unstable)/keys/upload"],
|
"endpoint_patterns": ["^/_matrix/client/(api/v1|r0|v3|unstable)/keys/upload"],
|
||||||
"shared_extra_conf": {},
|
"shared_extra_conf": {},
|
||||||
|
@ -326,7 +330,7 @@ def add_worker_roles_to_shared_config(
|
||||||
worker_port: int,
|
worker_port: int,
|
||||||
) -> None:
|
) -> None:
|
||||||
"""Given a dictionary representing a config file shared across all workers,
|
"""Given a dictionary representing a config file shared across all workers,
|
||||||
append sharded worker information to it for the current worker_type instance.
|
append appropriate worker information to it for the current worker_type instance.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
shared_config: The config dict that all worker instances share (after being converted to YAML)
|
shared_config: The config dict that all worker instances share (after being converted to YAML)
|
||||||
|
@ -359,7 +363,7 @@ def add_worker_roles_to_shared_config(
|
||||||
|
|
||||||
elif worker_type in ["account_data", "presence", "receipts", "to_device", "typing"]:
|
elif worker_type in ["account_data", "presence", "receipts", "to_device", "typing"]:
|
||||||
# Update the list of stream writers
|
# Update the list of stream writers
|
||||||
# It's convienent that the name of the worker type is the same as the event stream
|
# It's convenient that the name of the worker type is the same as the stream to write
|
||||||
shared_config.setdefault("stream_writers", {}).setdefault(
|
shared_config.setdefault("stream_writers", {}).setdefault(
|
||||||
worker_type, []
|
worker_type, []
|
||||||
).append(worker_name)
|
).append(worker_name)
|
||||||
|
@ -371,10 +375,6 @@ def add_worker_roles_to_shared_config(
|
||||||
"port": worker_port,
|
"port": worker_port,
|
||||||
}
|
}
|
||||||
|
|
||||||
elif worker_type == "media_repository":
|
|
||||||
# The first configured media worker will run the media background jobs
|
|
||||||
shared_config.setdefault("media_instance_running_background_jobs", worker_name)
|
|
||||||
|
|
||||||
|
|
||||||
def generate_base_homeserver_config() -> None:
|
def generate_base_homeserver_config() -> None:
|
||||||
"""Starts Synapse and generates a basic homeserver config, which will later be
|
"""Starts Synapse and generates a basic homeserver config, which will later be
|
||||||
|
@ -483,8 +483,7 @@ def generate_worker_files(
|
||||||
if worker_config:
|
if worker_config:
|
||||||
worker_config = worker_config.copy()
|
worker_config = worker_config.copy()
|
||||||
else:
|
else:
|
||||||
log(worker_type + " is an unknown worker type! It will be ignored")
|
error(worker_type + " is an unknown worker type! Please fix!")
|
||||||
continue
|
|
||||||
|
|
||||||
new_worker_count = worker_type_counter.setdefault(worker_type, 0) + 1
|
new_worker_count = worker_type_counter.setdefault(worker_type, 0) + 1
|
||||||
worker_type_counter[worker_type] = new_worker_count
|
worker_type_counter[worker_type] = new_worker_count
|
||||||
|
|
Loading…
Reference in a new issue