summary refs log tree commit diff
diff options
context:
space:
mode:
authorOlivier Wilkinson (reivilibre) <oliverw@matrix.org>2023-12-06 15:14:41 +0000
committerOlivier Wilkinson (reivilibre) <oliverw@matrix.org>2024-01-10 12:14:50 +0000
commit259a808dc2c63dc37f363ab6123ab1dc95936ca0 (patch)
treec0d86a4def0409cc41e7b55157f24ea6658af4a9
parentAdd a --generate-only option (diff)
downloadsynapse-259a808dc2c63dc37f363ab6123ab1dc95936ca0.tar.xz
Docstring on WorkerTemplate
-rwxr-xr-xdocker/configure_workers_and_start.py8
1 files changed, 8 insertions, 0 deletions
diff --git a/docker/configure_workers_and_start.py b/docker/configure_workers_and_start.py
index f936a71cc3..89b77d44fd 100755
--- a/docker/configure_workers_and_start.py
+++ b/docker/configure_workers_and_start.py
@@ -89,6 +89,14 @@ MARKER_FILE_PATH = "/conf/workers_have_been_configured"
 
 @dataclass
 class WorkerTemplate:
+    """
+    A definition of individual settings for a specific worker type.
+    A worker name can be fed into the template in order to generate a config.
+
+    These worker templates can be merged with `merge_worker_template_configs`
+    in order for a single worker to be made from multiple templates.
+    """
+
     listener_resources: Set[str] = field(default_factory=set)
     endpoint_patterns: Set[str] = field(default_factory=set)
     # (worker_name) -> {config}