From 259a808dc2c63dc37f363ab6123ab1dc95936ca0 Mon Sep 17 00:00:00 2001 From: "Olivier Wilkinson (reivilibre)" Date: Wed, 6 Dec 2023 15:14:41 +0000 Subject: [PATCH] Docstring on WorkerTemplate --- docker/configure_workers_and_start.py | 8 ++++++++ 1 file changed, 8 insertions(+) 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}