306 lines
11 KiB
Python
Executable File
306 lines
11 KiB
Python
Executable File
#!/usr/bin/env python
|
|
# 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 Collection, Dict, Iterable, List, Sequence, Tuple
|
|
|
|
from jinja2 import Environment, FileSystemLoader
|
|
from signedjson.key import generate_signing_key, write_signing_keys
|
|
|
|
from synapse.util.stringutils import random_string
|
|
|
|
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?
|
|
)
|
|
|
|
# TODO These are probably all wrong
|
|
|
|
# ^/_matrix/client/(api/v1|r0|v3|unstable)/sendToDevice/ ?
|
|
# ^/_matrix/client/(api/v1|r0|v3|unstable)/.*/tags
|
|
# ^/_matrix/client/(api/v1|r0|v3|unstable)/.*/account_data ?
|
|
# ^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/receipt
|
|
# ^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/read_markers ?
|
|
# ^/_matrix/client/(api/v1|r0|v3|unstable)/presence/ ?
|
|
|
|
WORKER_ROUTES: Dict[str, Tuple[str, ...]] = {
|
|
"main": (),
|
|
"synchrotron": (
|
|
"^/_matrix/client/(v2_alpha|r0|v3)/sync$",
|
|
"^/_matrix/client/(api/v1|v2_alpha|r0|v3)/events$",
|
|
"^/_matrix/client/(api/v1|r0|v3)/initialSync$",
|
|
"^/_matrix/client/(api/v1|r0|v3)/rooms/[^/]+/initialSync$",
|
|
),
|
|
"federation_inbound": ("^/_matrix/federation/v1/send/",),
|
|
"federation_reader": (
|
|
"^/_matrix/federation/v1/event/",
|
|
"^/_matrix/federation/v1/state/",
|
|
"^/_matrix/federation/v1/state_ids/",
|
|
"^/_matrix/federation/v1/backfill/",
|
|
"^/_matrix/federation/v1/get_missing_events/",
|
|
"^/_matrix/federation/v1/publicRooms",
|
|
"^/_matrix/federation/v1/query/",
|
|
"^/_matrix/federation/v1/make_join/",
|
|
"^/_matrix/federation/v1/make_leave/",
|
|
"^/_matrix/federation/v1/send_join/",
|
|
"^/_matrix/federation/v2/send_join/",
|
|
"^/_matrix/federation/v1/send_leave/",
|
|
"^/_matrix/federation/v2/send_leave/",
|
|
"^/_matrix/federation/v1/invite/",
|
|
"^/_matrix/federation/v2/invite/",
|
|
"^/_matrix/federation/v1/query_auth/",
|
|
"^/_matrix/federation/v1/event_auth/",
|
|
"^/_matrix/federation/v1/exchange_third_party_invite/",
|
|
"^/_matrix/federation/v1/user/devices/",
|
|
"^/_matrix/federation/v1/get_groups_publicised$",
|
|
"^/_matrix/key/v2/query",
|
|
"^/_matrix/federation/(v1|unstable/org.matrix.msc2946)/hierarchy/",
|
|
),
|
|
"federation_sender": (),
|
|
"typing": ("^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/typing",),
|
|
"appservice": (),
|
|
"client_reader": (
|
|
"^/_matrix/client/(api/v1|r0|v3|unstable)/createRoom$",
|
|
"^/_matrix/client/(api/v1|r0|v3|unstable)/publicRooms$",
|
|
"^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/joined_members$",
|
|
"^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/context/.*$",
|
|
"^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/members$",
|
|
"^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/state$",
|
|
"^/_matrix/client/(v1|unstable/org.matrix.msc2946)/rooms/.*/hierarchy$",
|
|
"^/_matrix/client/unstable/im.nheko.summary/rooms/.*/summary$",
|
|
"^/_matrix/client/(r0|v3|unstable)/account/3pid$",
|
|
"^/_matrix/client/(r0|v3|unstable)/devices$",
|
|
"^/_matrix/client/versions$",
|
|
"^/_matrix/client/(api/v1|r0|v3|unstable)/voip/turnServer$",
|
|
"^/_matrix/client/(r0|v3|unstable)/joined_groups$",
|
|
"^/_matrix/client/(r0|v3|unstable)/publicised_groups$",
|
|
"^/_matrix/client/(r0|v3|unstable)/publicised_groups/",
|
|
"^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/event/",
|
|
"^/_matrix/client/(api/v1|r0|v3|unstable)/joined_rooms$",
|
|
"^/_matrix/client/(api/v1|r0|v3|unstable)/search$",
|
|
"^/_matrix/client/(r0|v3|unstable)/keys/query$",
|
|
"^/_matrix/client/(r0|v3|unstable)/keys/changes$",
|
|
"^/_matrix/client/(r0|v3|unstable)/keys/claim$",
|
|
"^/_matrix/client/(r0|v3|unstable)/room_keys/",
|
|
#
|
|
"^/_matrix/client/(api/v1|r0|v3|unstable)/login$",
|
|
"^/_matrix/client/(r0|v3|unstable)/register$",
|
|
"^/_matrix/client/v1/register/m.login.registration_token/validity$",
|
|
"^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/redact",
|
|
"^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/send",
|
|
"^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/state/",
|
|
"^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/(join|invite|leave|ban|unban|kick)$",
|
|
"^/_matrix/client/(api/v1|r0|v3|unstable)/join/",
|
|
"^/_matrix/client/(api/v1|r0|v3|unstable)/profile/",
|
|
"^/_matrix/client/(r0|v3|unstable)/sendToDevice/",
|
|
"^/_matrix/client/(r0|v3|unstable)/.*/tags",
|
|
"^/_matrix/client/(r0|v3|unstable)/.*/account_data",
|
|
"^/_matrix/client/(api/v1|r0|v3|unstable)/presence/",
|
|
"^/_matrix/client/(r0|v3|unstable)/rooms/.*/receipt",
|
|
"^/_matrix/client/(r0|v3|unstable)/rooms/.*/read_markers",
|
|
"^/_matrix/client/(r0|v3|unstable)/.*/tags",
|
|
"^/_matrix/client/(r0|v3|unstable)/.*/account_data",
|
|
"^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/messages$",
|
|
"^/_matrix/client/(api/v1|r0|v3|unstable)/login/sso/redirect",
|
|
"^/_synapse/client/pick_idp$",
|
|
"^/_synapse/client/pick_username",
|
|
"^/_synapse/client/new_user_consent$",
|
|
"^/_synapse/client/sso_register$",
|
|
"^/_synapse/client/oidc/callback$",
|
|
"^/_synapse/client/saml2/authn_response$",
|
|
"^/_matrix/client/(api/v1|r0|v3|unstable)/login/cas/ticket$",
|
|
),
|
|
"event_creator": (),
|
|
"event_persister": (),
|
|
"media_repository": (
|
|
"^/_synapse/admin/v1/purge_media_cache$",
|
|
"^/_synapse/admin/v1/room/.*/media.*$",
|
|
"^/_synapse/admin/v1/user/.*/media.*$",
|
|
"^/_synapse/admin/v1/media/.*$",
|
|
"^/_synapse/admin/v1/quarantine_media/.*$",
|
|
"^/_synapse/admin/v1/users/.*/media$",
|
|
),
|
|
"pusher": (),
|
|
"user_dir": ("^/_matrix/client/(api/v1|r0|v3|unstable)/user_directory/search$",),
|
|
"background_worker": (),
|
|
"receipts_account_data": (),
|
|
}
|
|
|
|
|
|
@dataclasses.dataclass
|
|
class Worker:
|
|
name: str
|
|
kind: str
|
|
index: int
|
|
ip: str
|
|
|
|
|
|
def worker_num_to_ip(num: int) -> str:
|
|
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(1, worker_type_count + 1):
|
|
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, server_name: str
|
|
) -> None:
|
|
if target_path.exists():
|
|
print("Target path already exists. Won't overwrite.")
|
|
return
|
|
target_path.mkdir()
|
|
|
|
# Generate a signing key
|
|
key_id = "a_" + random_string(4)
|
|
key = (generate_signing_key(key_id),)
|
|
with open(target_path.joinpath("signing.key"), "w") as fout:
|
|
write_signing_keys(fout, key)
|
|
|
|
macaroon_secret_key = random_string(32)
|
|
|
|
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")
|
|
rp_template = env.get_template("Caddyfile.j2")
|
|
|
|
worker_dir = target_path.joinpath("workers")
|
|
worker_dir.mkdir()
|
|
worker_logging_dir = target_path.joinpath("workers.logging")
|
|
worker_logging_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:
|
|
log_config_path = worker_logging_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)
|
|
|
|
# if worker.name == "main":
|
|
# Main can't use a worker file.
|
|
# continue
|
|
|
|
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)
|
|
|
|
hs_config_path = target_path.joinpath("homeserver.yaml")
|
|
hs_config = hs_template.render(
|
|
all_workers=all_workers,
|
|
workers_by_name=workers_by_name,
|
|
worker_dir=worker_dir,
|
|
logs_dir=logs_dir,
|
|
server_name=server_name,
|
|
macaroon_secret_key=macaroon_secret_key,
|
|
)
|
|
with open(hs_config_path, "w") as fout:
|
|
fout.write(hs_config)
|
|
|
|
caddy_config_path = target_path.joinpath("Caddyfile")
|
|
caddy_config = rp_template.render(
|
|
server_name=server_name,
|
|
port=8447,
|
|
http_ip=worker_num_to_ip(1),
|
|
routing=build_routes_template_var(all_workers),
|
|
main_server=f"{worker_num_to_ip(1)}:8080",
|
|
)
|
|
with open(caddy_config_path, "w") as fout:
|
|
fout.write(caddy_config)
|
|
|
|
|
|
def build_routes_template_var(
|
|
all_workers: List[Worker],
|
|
) -> Sequence[Tuple[str, Collection[str], List[str]]]:
|
|
route_groups = {}
|
|
for worker in all_workers:
|
|
if worker.kind not in route_groups:
|
|
if WORKER_ROUTES[worker.kind]:
|
|
route_groups[worker.kind] = worker.kind, WORKER_ROUTES[worker.kind], []
|
|
else:
|
|
continue
|
|
|
|
_, _routes, server_endpoints = route_groups[worker.kind]
|
|
|
|
server_endpoints.append(f"{worker.ip}:8080")
|
|
|
|
return tuple(route_groups.values())
|
|
|
|
|
|
def main(target_path: Path, server_name: str) -> None:
|
|
generate(DESIRED_WORKERS, target_path, server_name)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
target_path = Path(sys.argv[1])
|
|
server_name = sys.argv[2]
|
|
main(target_path, server_name)
|