STASH

scripts-dev/workers_setup.py

@@ -0,0 +1,134 @@
+# Copyright 2022 The Matrix.org Foundation C.I.C.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+import dataclasses
+import sys
+from os.path import dirname
+from pathlib import Path
+from typing import List, Tuple, Iterable
+
+from jinja2 import Environment, FileSystemLoader
+
+DESIRED_WORKERS = (
+    ("main", 1),
+    ("synchrotron", 2),
+    ("federation_inbound", 2),
+    ("federation_reader", 2),
+    ("federation_sender", 2),
+    ("typing", 1),
+    ("appservice", 1),
+    ("client_reader", 2),
+    ("event_creator", 2),
+    ("event_persister", 2),
+    ("media_repository", 1),
+    ("pusher", 2),
+    ("user_dir", 1),
+    ("background_worker", 1),
+    # TODO ("encryption", 1),  # ??
+    ("receipts_account_data", 1)
+    # TODO frontend_proxy?
+)
+
+
+@dataclasses.dataclass
+class Worker:
+    name: str
+    kind: str
+    index: int
+    ip: str
+
+
+def worker_num_to_ip(num: int):
+    return f"127.0.57.{num}"
+
+
+def make_workers(workers: Iterable[Tuple[str, int]]) -> List[Worker]:
+    result = []
+    worker_overall_num = 0
+    for worker_type, worker_type_count in workers:
+        for worker_idx in range(worker_type_count):
+            worker_overall_num += 1
+            if worker_type == "main":
+                worker_name = "main"
+            else:
+                worker_name = f"{worker_type}{worker_idx}"
+
+            result.append(Worker(
+                worker_name, worker_type, worker_idx, worker_num_to_ip(worker_overall_num)
+            ))
+
+    return result
+
+
+def generate(worker_counts: Tuple[Tuple[str, int], ...], target_path: Path):
+    if target_path.exists():
+        print("Target path already exists. Won't overwrite.")
+        return
+    target_path.mkdir()
+
+    env = Environment(loader=FileSystemLoader(dirname(__file__) + "/workers_setup"))
+    hs_template = env.get_template("homeserver.yaml.j2")
+    worker_template = env.get_template("worker.yaml.j2")
+    logging_template = env.get_template("logging.yaml.j2")
+
+    worker_dir = target_path.joinpath("workers")
+    worker_dir.mkdir()
+    worker_dir = worker_dir.resolve()
+
+    logs_dir = target_path.joinpath("logs")
+    logs_dir.mkdir()
+    logs_dir = logs_dir.resolve()
+
+    all_workers = make_workers(worker_counts)
+    workers_by_name = {worker.name: worker for worker in all_workers}
+
+    for worker in all_workers:
+        worker_config_path = worker_dir.joinpath(f"{worker.name}.yaml")
+        worker_config = worker_template.render(
+            worker=worker,
+            worker_dir=worker_dir,
+            logs_dir=logs_dir,
+            all_workers=all_workers,
+            workers_by_name=workers_by_name
+        )
+        with open(worker_config_path, "w") as fout:
+            fout.write(worker_config)
+
+        log_config_path = worker_dir.joinpath(f"{worker.name}.logging.yaml")
+        log_config = logging_template.render(
+            worker=worker,
+            worker_dir=worker_dir,
+            logs_dir=logs_dir,
+            all_workers=all_workers,
+            workers_by_name=workers_by_name
+        )
+        with open(log_config_path, "w") as fout:
+            fout.write(log_config)
+
+    hs_config_path = target_path.joinpath("homeserver.yaml")
+    hs_config = hs_template.render(
+        all_workers=all_workers,
+        worker_dir=worker_dir,
+        logs_dir=logs_dir
+    )
+    with open(hs_config_path, "w") as fout:
+        fout.write(hs_config)
+
+
+def main(target_path: Path):
+    generate(DESIRED_WORKERS, target_path)
+
+
+if __name__ == '__main__':
+    target_path = Path(sys.argv[1])
+    main(target_path)

scripts-dev/workers_setup/homeserver.yaml.j2

@@ -0,0 +1,42 @@
+
+instance_map:
+{% for worker in all_workers %}
+  {{ worker.name }}:
+    host: {{ worker.ip }}
+    port: 9090
+{% endfor %}
+
+
stream_writers:
+  events:
+{% for worker in all_workers %}
+{% if worker.kind == "event_persister" %}
+    - {{ worker.name }}
+{% endif %}
+
+  typing:
+{% for worker in all_workers %}
+{% if worker.kind == "typing" %}
+    - {{ worker.name }}
+{% endif %}
+
+
+start_pushers: false
+
+pusher_instances:
+{% if worker.kind == "pusher" %}
+    - {{ worker.name }}
+{% endif %}
+
+notify_appservices: False
+
+federation_sender_instances:
+{% if worker.kind == "federation_sender" %}
+    - {{ worker.name }}
+{% endif %}
+
+enable_media_repo: False
+
+media_instance_running_background_jobs: "media1"
+
+update_user_directory: False
+

scripts-dev/workers_setup/logging.yaml.j2

@@ -0,0 +1,32 @@
+
+version: 1
+
+formatters:
+    precise:
+        format: '%(asctime)s - %(name)s - %(lineno)d - %(levelname)s - %(request)s - %(message)s'
+
+filters:
+    context:
+        (): synapse.util.logcontext.LoggingContextFilter
+        request: ""
+
+handlers:
+    console:
+        class: logging.FileHandler
+        formatter: precise
+        filters: [context]
+        encoding: 'UTF-8'
+        filename: '{{ logs_dir }}/{{ worker.name }}.log'
+
+loggers:
+    synapse:
+        level: DEBUG
+
+    synapse.storage.SQL:
+        # beware: increasing this to DEBUG will make synapse log sensitive
+        # information such as access tokens.
+        level: INFO
+
+root:
+    level: WARNING
+    handlers: [console]

scripts-dev/workers_setup/worker.yaml.j2

@@ -0,0 +1,26 @@
+{# TODO worker apps! #}
+{% if worker.kind == "main" %}
+worker_app: synapse.app.homeserver
+{% else %}
+worker_app: synapse.app.generic_worker
+worker_name: {{ worker_name }}
+
# The replication listener on the main synapse process.
+worker_replication_host: {{ worker_ip }}
+worker_replication_http_port: 9090
+
worker_listeners:
+  - type: http
+    port: 8080
+    resources:
+    - names:
+    - client
+    - federation
+{% if worker.kind == "media" %}
+    - media
+{% endif %}
+
+worker_log_config: '{{ workers_dir }}/{{ worker_name }}.logging.yaml'
+worker_pid_file: '{{ logs_dir }}/{{ worker_name }}.pid'
+{% endif %}
+
+{% set main_worker = workers_by_name.main %}
+worker_main_http_uri: http://{{ main_worker.ip }}:8080