From dcdc43b6aace15aab228dabc5880c406b741a7d7 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Sun, 7 Jan 2024 11:56:25 +0200 Subject: [PATCH] Move matrix-bridge-appservice-irc to its own container network --- group_vars/matrix_servers | 28 ++++++++++++------- .../defaults/main.yml | 11 +++++++- .../tasks/setup_install.yml | 5 ++++ .../tasks/validate_config.yml | 3 +- .../systemd/matrix-appservice-irc.service.j2 | 16 ++++++++--- 5 files changed, 47 insertions(+), 16 deletions(-) diff --git a/group_vars/matrix_servers b/group_vars/matrix_servers index 661fae217..c062d515b 100755 --- a/group_vars/matrix_servers +++ b/group_vars/matrix_servers @@ -635,6 +635,13 @@ matrix_appservice_slack_database_password: "{{ '%s' | format(matrix_homeserver_g # We don't enable bridges by default. matrix_appservice_irc_enabled: false +matrix_appservice_irc_systemd_required_services_list_auto: | + {{ + matrix_addons_homeserver_systemd_services_list + + + ([devture_postgres_identifier ~ '.service'] if (devture_postgres_enabled and matrix_appservice_irc_database_hostname == devture_postgres_connection_hostname) else []) + }} + matrix_appservice_irc_container_image_self_build: "{{ matrix_architecture != 'amd64' }}" # Normally, matrix-nginx-proxy is enabled and nginx can reach matrix-appservice-irc over the container network. @@ -642,19 +649,21 @@ matrix_appservice_irc_container_image_self_build: "{{ matrix_architecture != 'am # matrix-appservice-irc's client-server port to the local host. matrix_appservice_irc_container_http_host_bind_port: "{{ (matrix_playbook_service_host_bind_interface_prefix ~ '9999') if matrix_playbook_service_host_bind_interface_prefix else '' }}" +matrix_appservice_irc_container_network: "{{ matrix_addons_container_network }}" + +matrix_appservice_irc_container_additional_networks_auto: |- + {{ + ( + ([] if matrix_addons_homeserver_container_network == '' else [matrix_addons_homeserver_container_network]) + + + ([devture_postgres_container_network] if (devture_postgres_enabled and matrix_appservice_irc_database_hostname == devture_postgres_connection_hostname and matrix_appservice_irc_container_network != devture_postgres_container_network) else []) + ) | unique + }} + # The IRC bridge docs say that if homeserver presence is disabled, it's better to also disable # IRC bridge presence, for performance reasons. matrix_appservice_irc_homeserver_enablePresence: "{{ matrix_synapse_presence_enabled }}" -matrix_appservice_irc_systemd_required_services_list: | - {{ - ['docker.service'] - + - ['matrix-' + matrix_homeserver_implementation + '.service'] - + - (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else []) - }} - matrix_appservice_irc_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'irc.as.token', rounds=655555) | to_uuid }}" matrix_appservice_irc_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'irc.hs.token', rounds=655555) | to_uuid }}" @@ -663,7 +672,6 @@ matrix_appservice_irc_database_engine: "{{ 'postgres' if devture_postgres_enable matrix_appservice_irc_database_hostname: "{{ devture_postgres_connection_hostname if devture_postgres_enabled else '' }}" matrix_appservice_irc_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'as.irc.db', rounds=655555) | to_uuid }}" - ###################################################################### # # /matrix-bridge-appservice-irc diff --git a/roles/custom/matrix-bridge-appservice-irc/defaults/main.yml b/roles/custom/matrix-bridge-appservice-irc/defaults/main.yml index 3dda9b756..9db6fae2b 100644 --- a/roles/custom/matrix-bridge-appservice-irc/defaults/main.yml +++ b/roles/custom/matrix-bridge-appservice-irc/defaults/main.yml @@ -367,11 +367,20 @@ matrix_appservice_irc_ircService_servers: [] # noqa var-naming # Takes an ":" or "" value (e.g. "127.0.0.1:9999"), or empty string to not expose. matrix_appservice_irc_container_http_host_bind_port: '' +matrix_appservice_irc_container_network: "" + +matrix_appservice_irc_container_additional_networks: "{{ matrix_appservice_irc_container_additional_networks_auto + matrix_appservice_irc_container_additional_networks_custom }}" +matrix_appservice_irc_container_additional_networks_auto: [] +matrix_appservice_irc_container_additional_networks_custom: [] + # A list of extra arguments to pass to the container matrix_appservice_irc_container_extra_arguments: [] # List of systemd services that matrix-appservice-irc.service depends on. -matrix_appservice_irc_systemd_required_services_list: ['docker.service'] +matrix_appservice_irc_systemd_required_services_list: "{{ matrix_appservice_irc_systemd_required_services_list_default + matrix_appservice_irc_systemd_required_services_list_auto + matrix_appservice_irc_systemd_required_services_list_custom }}" +matrix_appservice_irc_systemd_required_services_list_default: ['docker.service'] +matrix_appservice_irc_systemd_required_services_list_auto: [] +matrix_appservice_irc_systemd_required_services_list_custom: [] # List of systemd services that matrix-appservice-irc.service wants matrix_appservice_irc_systemd_wanted_services_list: [] diff --git a/roles/custom/matrix-bridge-appservice-irc/tasks/setup_install.yml b/roles/custom/matrix-bridge-appservice-irc/tasks/setup_install.yml index 69a9aa4c8..e175cf2a5 100644 --- a/roles/custom/matrix-bridge-appservice-irc/tasks/setup_install.yml +++ b/roles/custom/matrix-bridge-appservice-irc/tasks/setup_install.yml @@ -188,6 +188,11 @@ owner: "{{ matrix_user_username }}" group: "{{ matrix_user_groupname }}" +- name: Ensure matrix-appservice-irc container network is created + community.general.docker_network: + name: "{{ matrix_appservice_irc_container_network }}" + driver: bridge + - name: Ensure matrix-appservice-irc.service installed ansible.builtin.template: src: "{{ role_path }}/templates/systemd/matrix-appservice-irc.service.j2" diff --git a/roles/custom/matrix-bridge-appservice-irc/tasks/validate_config.yml b/roles/custom/matrix-bridge-appservice-irc/tasks/validate_config.yml index 0c4c6c29d..b73740a61 100644 --- a/roles/custom/matrix-bridge-appservice-irc/tasks/validate_config.yml +++ b/roles/custom/matrix-bridge-appservice-irc/tasks/validate_config.yml @@ -1,6 +1,6 @@ --- -- name: Fail if required settings not defined +- name: Fail if required appservice-irc settings not defined ansible.builtin.fail: msg: >- You need to define a required configuration setting (`{{ item.name }}`). @@ -9,6 +9,7 @@ - {'name': 'matrix_appservice_irc_appservice_token', when: true} - {'name': 'matrix_appservice_irc_homeserver_token', when: true} - {'name': 'matrix_appservice_irc_database_hostname', when: "{{ matrix_appservice_irc_database_engine == 'postgres' }}"} + - {'name': 'matrix_appservice_irc_container_network', when: true} # Our base configuration (`matrix_appservice_irc_configuration_yaml`) is not enough to # let the playbook run without errors. diff --git a/roles/custom/matrix-bridge-appservice-irc/templates/systemd/matrix-appservice-irc.service.j2 b/roles/custom/matrix-bridge-appservice-irc/templates/systemd/matrix-appservice-irc.service.j2 index 93678338e..bfb7b44b5 100644 --- a/roles/custom/matrix-bridge-appservice-irc/templates/systemd/matrix-appservice-irc.service.j2 +++ b/roles/custom/matrix-bridge-appservice-irc/templates/systemd/matrix-appservice-irc.service.j2 @@ -19,16 +19,18 @@ ExecStartPre=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_s # Intentional delay, so that the homeserver (we likely depend on) can manage to start. ExecStartPre={{ matrix_host_command_sleep }} 5 -ExecStart={{ devture_systemd_docker_base_host_command_docker }} run --rm --name matrix-appservice-irc \ +ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} create \ + --rm \ + --name=matrix-appservice-irc \ --log-driver=none \ --user={{ matrix_user_uid }}:{{ matrix_user_gid }} \ --cap-drop=ALL \ - --network={{ matrix_docker_network }} \ + --network={{ matrix_appservice_irc_container_network }} \ {% if matrix_appservice_irc_container_http_host_bind_port %} -p {{ matrix_appservice_irc_container_http_host_bind_port }}:9999 \ {% endif %} - -v {{ matrix_appservice_irc_config_path }}:/config:z \ - -v {{ matrix_appservice_irc_data_path }}:/data:z \ + --mount type=bind,src={{ matrix_appservice_irc_config_path }},dst=/config \ + --mount type=bind,src={{ matrix_appservice_irc_data_path }},dst=/data \ {% for arg in matrix_appservice_irc_container_extra_arguments %} {{ arg }} \ {% endfor %} @@ -36,6 +38,12 @@ ExecStart={{ devture_systemd_docker_base_host_command_docker }} run --rm --name {{ matrix_appservice_irc_docker_image }} \ -c 'node app.js -c /config/config.yaml -f /config/registration.yaml -p 9999' +{% for network in matrix_appservice_irc_container_additional_networks %} +ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} network connect {{ network }} matrix-appservice-irc +{% endfor %} + +ExecStart={{ devture_systemd_docker_base_host_command_docker }} start --attach matrix-appservice-irc + ExecStop=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} stop --time={{ devture_systemd_docker_base_container_stop_grace_time_seconds }} matrix-appservice-irc 2>/dev/null || true' ExecStop=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} rm matrix-appservice-irc 2>/dev/null || true' Restart=always