From 3c099541a7342715d493f20161326371beed5e78 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Mon, 8 Jan 2024 17:34:38 +0200 Subject: [PATCH] Move matrix-bridge-mx-puppet-slack to its own container network and add native Traefik support --- group_vars/matrix_servers | 34 ++++++++++--- .../defaults/main.yml | 51 +++++++++++++++++-- .../tasks/inject_into_nginx_proxy.yml | 44 ---------------- .../tasks/main.yml | 9 ---- .../tasks/setup_install.yml | 15 ++++++ .../tasks/validate_config.yml | 13 +++++ .../templates/config.yaml.j2 | 10 ++-- .../templates/labels.j2 | 26 ++++++++++ .../systemd/matrix-mx-puppet-slack.service.j2 | 17 +++++-- 9 files changed, 146 insertions(+), 73 deletions(-) delete mode 100644 roles/custom/matrix-bridge-mx-puppet-slack/tasks/inject_into_nginx_proxy.yml create mode 100644 roles/custom/matrix-bridge-mx-puppet-slack/templates/labels.j2 diff --git a/group_vars/matrix_servers b/group_vars/matrix_servers index b53cbd850..abea74997 100755 --- a/group_vars/matrix_servers +++ b/group_vars/matrix_servers @@ -1733,19 +1733,35 @@ matrix_hookshot_urlprefix: "{{ 'https' if matrix_playbook_ssl_enabled else 'http # We don't enable bridges by default. matrix_mx_puppet_slack_enabled: false -matrix_mx_puppet_slack_container_image_self_build: "{{ matrix_architecture != 'amd64' }}" +matrix_mx_puppet_slack_hostname: "{{ matrix_server_fqn_matrix }}" -matrix_mx_puppet_slack_systemd_required_services_list: | +matrix_mx_puppet_slack_systemd_required_services_list_auto: | {{ - ['docker.service'] - + - ['matrix-' + matrix_homeserver_implementation + '.service'] - + - ([devture_postgres_identifier ~ '.service'] if devture_postgres_enabled else []) + matrix_addons_homeserver_systemd_services_list + - (['matrix-nginx-proxy.service'] if matrix_nginx_proxy_enabled else []) + ([devture_postgres_identifier ~ '.service'] if (devture_postgres_enabled and matrix_mx_puppet_slack_database_hostname == devture_postgres_connection_hostname) else []) }} +matrix_mx_puppet_slack_container_image_self_build: "{{ matrix_architecture != 'amd64' }}" + +matrix_mx_puppet_slack_container_network: "{{ matrix_addons_container_network }}" + +matrix_mx_puppet_slack_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_mx_puppet_slack_database_hostname == devture_postgres_connection_hostname and matrix_mx_puppet_slack_container_network != devture_postgres_container_network) else []) + + + ([matrix_playbook_reverse_proxyable_services_additional_network] if (matrix_playbook_reverse_proxyable_services_additional_network and matrix_mx_puppet_slack_container_labels_traefik_enabled) else []) + ) | unique + }} + +matrix_mx_puppet_slack_container_labels_traefik_enabled: "{{ matrix_playbook_reverse_proxy_type in ['playbook-managed-traefik', 'other-traefik-container'] }}" +matrix_mx_puppet_slack_container_labels_traefik_docker_network: "{{ matrix_playbook_reverse_proxyable_services_additional_network }}" +matrix_mx_puppet_slack_container_labels_traefik_entrypoints: "{{ devture_traefik_entrypoint_primary }}" +matrix_mx_puppet_slack_container_labels_traefik_tls_certResolver: "{{ devture_traefik_certResolver_primary }}" + matrix_mx_puppet_slack_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mxslk.as.tok', rounds=655555) | to_uuid }}" matrix_mx_puppet_slack_homeserver_address: "{{ matrix_addons_homeserver_client_api_url }}" @@ -1753,6 +1769,8 @@ matrix_mx_puppet_slack_homeserver_token: "{{ '%s' | format(matrix_homeserver_gen matrix_mx_puppet_slack_login_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret if matrix_synapse_ext_password_provider_shared_secret_auth_enabled else '' }}" +matrix_mx_puppet_slack_presence_enabled: "{{ matrix_homeserver_implementation != 'synapse' or matrix_synapse_presence_enabled }}" + # Postgres is the default, except if not using internal Postgres server matrix_mx_puppet_slack_database_engine: "{{ 'postgres' if devture_postgres_enabled else 'sqlite' }}" matrix_mx_puppet_slack_database_hostname: "{{ devture_postgres_connection_hostname if devture_postgres_enabled else '' }}" diff --git a/roles/custom/matrix-bridge-mx-puppet-slack/defaults/main.yml b/roles/custom/matrix-bridge-mx-puppet-slack/defaults/main.yml index fe1f20cb1..e684876c4 100644 --- a/roles/custom/matrix-bridge-mx-puppet-slack/defaults/main.yml +++ b/roles/custom/matrix-bridge-mx-puppet-slack/defaults/main.yml @@ -4,6 +4,10 @@ matrix_mx_puppet_slack_enabled: true +matrix_mx_puppet_slack_scheme: https +matrix_mx_puppet_slack_hostname: '' +matrix_mx_puppet_slack_path_prefix: /slack/oauth + matrix_mx_puppet_slack_oauth_client_id: '' matrix_mx_puppet_slack_oauth_client_secret: '' @@ -34,8 +38,9 @@ matrix_mx_puppet_slack_homeserver_address: "" matrix_mx_puppet_slack_homeserver_domain: '{{ matrix_domain }}' matrix_mx_puppet_slack_appservice_address: 'http://matrix-mx-puppet-slack:{{ matrix_mx_puppet_slack_appservice_port }}' -matrix_mx_puppet_slack_redirect_path: '/slack/oauth' -matrix_mx_puppet_slack_redirect_uri: 'https://{{ matrix_server_fqn_matrix }}{{ matrix_mx_puppet_slack_redirect_path }}' +matrix_mx_puppet_slack_oauth_enabled: true +matrix_mx_puppet_slack_oauth_redirect_path: "{{ matrix_mx_puppet_slack_path_prefix }}" +matrix_mx_puppet_slack_oauth_redirect_uri: '{{ matrix_mx_puppet_slack_scheme }}://{{ matrix_mx_puppet_slack_hostname }}{{ matrix_mx_puppet_slack_oauth_redirect_path }}' # "@user:server.com" to allow specific user # "@.*:yourserver.com" to allow users on a specific homeserver @@ -48,11 +53,48 @@ matrix_mx_puppet_slack_provisioning_whitelist: # "@.*:yourserver.com" disallow users on a specific homeserver matrix_mx_puppet_slack_provisioning_blacklist: [] +matrix_mx_puppet_slack_container_network: "" + +matrix_mx_puppet_slack_container_additional_networks: "{{ matrix_mx_puppet_slack_container_additional_networks_auto + matrix_mx_puppet_slack_container_additional_networks_custom }}" +matrix_mx_puppet_slack_container_additional_networks_auto: [] +matrix_mx_puppet_slack_container_additional_networks_custom: [] + +# matrix_mx_puppet_slack_container_labels_traefik_enabled controls whether labels to assist a Traefik reverse-proxy will be attached to the container. +# See `../templates/labels.j2` for details. +# +# To inject your own other container labels, see `matrix_mx_puppet_slack_container_labels_additional_labels`. +matrix_mx_puppet_slack_container_labels_traefik_enabled: true +matrix_mx_puppet_slack_container_labels_traefik_docker_network: "{{ matrix_mx_puppet_slack_container_network }}" +matrix_mx_puppet_slack_container_labels_traefik_entrypoints: web-secure +matrix_mx_puppet_slack_container_labels_traefik_tls_certResolver: default # noqa var-naming + +# Controls whether labels will be added that expose mx-puppet-slack's public endpoint +matrix_mx_puppet_slack_container_labels_public_endpoint_enabled: true +matrix_mx_puppet_slack_container_labels_public_endpoint_hostname: "{{ matrix_mx_puppet_slack_hostname }}" +matrix_mx_puppet_slack_container_labels_public_endpoint_path_prefix: "{{ matrix_mx_puppet_slack_path_prefix }}" +matrix_mx_puppet_slack_container_labels_public_endpoint_traefik_rule: "Host(`{{ matrix_mx_puppet_slack_container_labels_public_endpoint_hostname }}`) && PathPrefix(`{{ matrix_mx_puppet_slack_container_labels_public_endpoint_path_prefix }}`)" +matrix_mx_puppet_slack_container_labels_public_endpoint_traefik_priority: 0 +matrix_mx_puppet_slack_container_labels_public_endpoint_traefik_entrypoints: "{{ matrix_mx_puppet_slack_container_labels_traefik_entrypoints }}" +matrix_mx_puppet_slack_container_labels_public_endpoint_traefik_tls: "{{ matrix_mx_puppet_slack_container_labels_public_endpoint_traefik_entrypoints != 'web' }}" +matrix_mx_puppet_slack_container_labels_public_endpoint_traefik_tls_certResolver: "{{ matrix_mx_puppet_slack_container_labels_traefik_tls_certResolver }}" # noqa var-naming + +# matrix_mx_puppet_slack_container_labels_additional_labels contains a multiline string with additional labels to add to the container label file. +# See `../templates/labels.j2` for details. +# +# Example: +# matrix_mx_puppet_slack_container_labels_additional_labels: | +# my.label=1 +# another.label="here" +matrix_mx_puppet_slack_container_labels_additional_labels: '' + # A list of extra arguments to pass to the container matrix_mx_puppet_slack_container_extra_arguments: [] # List of systemd services that matrix-puppet-slack.service depends on. -matrix_mx_puppet_slack_systemd_required_services_list: ['docker.service'] +matrix_mx_puppet_slack_systemd_required_services_list: "{{ matrix_mx_puppet_slack_systemd_required_services_list_default + matrix_mx_puppet_slack_systemd_required_services_list_auto + matrix_mx_puppet_slack_systemd_required_services_list_custom }}" +matrix_mx_puppet_slack_systemd_required_services_list_default: ['docker.service'] +matrix_mx_puppet_slack_systemd_required_services_list_auto: [] +matrix_mx_puppet_slack_systemd_required_services_list_custom: [] # List of systemd services that matrix-puppet-slack.service wants matrix_mx_puppet_slack_systemd_wanted_services_list: [] @@ -63,6 +105,9 @@ matrix_mx_puppet_slack_homeserver_token: '' # Can be set to enable automatic double-puppeting via Shared Secret Auth (https://github.com/devture/matrix-synapse-shared-secret-auth). matrix_mx_puppet_slack_login_shared_secret: '' +matrix_mx_puppet_slack_presence_enabled: true +matrix_mx_puppet_slack_presence_interval: 5000 + # Database configuration, role uses 'sqlite' per default but playbook sets up postgres by default matrix_mx_puppet_slack_database_engine: sqlite diff --git a/roles/custom/matrix-bridge-mx-puppet-slack/tasks/inject_into_nginx_proxy.yml b/roles/custom/matrix-bridge-mx-puppet-slack/tasks/inject_into_nginx_proxy.yml deleted file mode 100644 index c4e82a5b5..000000000 --- a/roles/custom/matrix-bridge-mx-puppet-slack/tasks/inject_into_nginx_proxy.yml +++ /dev/null @@ -1,44 +0,0 @@ ---- - -- name: Fail if matrix-nginx-proxy role already executed - ansible.builtin.fail: - msg: >- - Trying to append Slack Appservice's reverse-proxying configuration to matrix-nginx-proxy, - but it's pointless since the matrix-nginx-proxy role had already executed. - To fix this, please change the order of roles in your playbook, - so that the matrix-nginx-proxy role would run after the matrix-mx-puppet-slack role. - when: matrix_nginx_proxy_role_executed | default(False) | bool - -- name: Generate Matrix MX Puppet Slack proxying configuration for matrix-nginx-proxy - ansible.builtin.set_fact: - matrix_mx_puppet_slack_matrix_nginx_proxy_configuration: | - location {{ matrix_mx_puppet_slack_redirect_path }} { - {% if matrix_nginx_proxy_enabled | default(False) %} - {# Use the embedded DNS resolver in Docker containers to discover the service #} - resolver 127.0.0.11 valid=5s; - set $backend "{{ matrix_mx_puppet_slack_appservice_address }}"; - proxy_pass $backend; - {% else %} - {# Generic configuration for use outside of our container setup #} - proxy_pass http://127.0.0.1:{{ matrix_mx_puppet_slack_appservice_port }}; - {% endif %} - } - -- name: Register Slack Appservice proxying configuration with matrix-nginx-proxy - ansible.builtin.set_fact: - matrix_nginx_proxy_proxy_matrix_additional_server_configuration_blocks: | - {{ - matrix_nginx_proxy_proxy_matrix_additional_server_configuration_blocks | default([]) - + - [matrix_mx_puppet_slack_matrix_nginx_proxy_configuration] - }} - -- name: Warn about reverse-proxying if matrix-nginx-proxy not used - ansible.builtin.debug: - msg: >- - NOTE: You've enabled the Matrix Slack bridge but are not using the matrix-nginx-proxy - reverse proxy. - Please make sure that you're proxying the `{{ matrix_mx_puppet_slack_redirect_path }}` - URL endpoint to the matrix-mx-puppet-slack container. - You can expose the container's port using the `matrix_appservice_slack_container_http_host_bind_port` variable. - when: "not matrix_nginx_proxy_enabled | default(False) | bool" diff --git a/roles/custom/matrix-bridge-mx-puppet-slack/tasks/main.yml b/roles/custom/matrix-bridge-mx-puppet-slack/tasks/main.yml index 63e074050..d5d3d421e 100644 --- a/roles/custom/matrix-bridge-mx-puppet-slack/tasks/main.yml +++ b/roles/custom/matrix-bridge-mx-puppet-slack/tasks/main.yml @@ -1,14 +1,5 @@ --- -- tags: - - setup-all - - setup-nginx-proxy - - install-all - - install-nginx-proxy - block: - - when: matrix_mx_puppet_slack_enabled | bool - ansible.builtin.include_tasks: "{{ role_path }}/tasks/inject_into_nginx_proxy.yml" - - tags: - setup-all - setup-mx-puppet-slack diff --git a/roles/custom/matrix-bridge-mx-puppet-slack/tasks/setup_install.yml b/roles/custom/matrix-bridge-mx-puppet-slack/tasks/setup_install.yml index bba2d25c6..10480a7b6 100644 --- a/roles/custom/matrix-bridge-mx-puppet-slack/tasks/setup_install.yml +++ b/roles/custom/matrix-bridge-mx-puppet-slack/tasks/setup_install.yml @@ -113,6 +113,21 @@ owner: "{{ matrix_user_username }}" group: "{{ matrix_user_groupname }}" +- name: Ensure mx-puppet-slack support files installed + ansible.builtin.template: + src: "{{ role_path }}/templates/{{ item }}.j2" + dest: "{{ matrix_mx_puppet_slack_base_path }}/{{ item }}" + mode: 0640 + owner: "{{ matrix_user_username }}" + group: "{{ matrix_user_groupname }}" + with_items: + - labels + +- name: Ensure mx-puppet-slack container network is created + community.general.docker_network: + name: "{{ matrix_mx_puppet_slack_container_network }}" + driver: bridge + - name: Ensure matrix-mx-puppet-slack.service installed ansible.builtin.template: src: "{{ role_path }}/templates/systemd/matrix-mx-puppet-slack.service.j2" diff --git a/roles/custom/matrix-bridge-mx-puppet-slack/tasks/validate_config.yml b/roles/custom/matrix-bridge-mx-puppet-slack/tasks/validate_config.yml index 57abe4239..dbc1d0025 100644 --- a/roles/custom/matrix-bridge-mx-puppet-slack/tasks/validate_config.yml +++ b/roles/custom/matrix-bridge-mx-puppet-slack/tasks/validate_config.yml @@ -6,7 +6,20 @@ You need to define a required configuration setting (`{{ item.name }}`). when: "item.when | bool and vars[item.name] == ''" with_items: + - {'name': 'matrix_mx_puppet_slack_hostname', when: true} + - {'name': 'matrix_mx_puppet_slack_path_prefix', when: true} - {'name': 'matrix_mx_puppet_slack_appservice_token', when: true} - {'name': 'matrix_mx_puppet_slack_homeserver_address', when: true} - {'name': 'matrix_mx_puppet_slack_homeserver_token', when: true} - {'name': 'matrix_mx_puppet_slack_database_hostname', when: "{{ matrix_mx_puppet_slack_database_engine == 'postgres' }}"} + - {'name': 'matrix_mx_puppet_slack_container_network', when: true} + +- name: (Deprecation) Catch and report renamed mx-puppet-slack settings + ansible.builtin.fail: + msg: >- + Your configuration contains a variable, which now has a different name. + Please change your configuration to rename the variable (`{{ item.old }}` -> `{{ item.new }}`). + when: "item.old in vars" + with_items: + - {'old': 'matrix_mx_puppet_slack_redirect_path', 'new': 'matrix_mx_puppet_slack_oauth_redirect_path, but setting matrix_mx_puppet_slack_path_prefix is better'} + - {'old': 'matrix_mx_puppet_slack_redirect_uri', 'new': ' 0 %} +traefik.http.routers.matrix-mx-puppet-slack-public.priority={{ matrix_mx_puppet_slack_container_labels_public_endpoint_traefik_priority }} +{% endif %} +traefik.http.routers.matrix-mx-puppet-slack-public.service=matrix-mx-puppet-slack +traefik.http.routers.matrix-mx-puppet-slack-public.entrypoints={{ matrix_mx_puppet_slack_container_labels_public_endpoint_traefik_entrypoints }} +traefik.http.routers.matrix-mx-puppet-slack-public.tls={{ matrix_mx_puppet_slack_container_labels_public_endpoint_traefik_tls | to_json }} +{% if matrix_mx_puppet_slack_container_labels_public_endpoint_traefik_tls %} +traefik.http.routers.matrix-mx-puppet-slack-public.tls.certResolver={{ matrix_mx_puppet_slack_container_labels_public_endpoint_traefik_tls_certResolver }} +{% endif %} +traefik.http.services.matrix-mx-puppet-slack.loadbalancer.server.port={{ matrix_mx_puppet_slack_appservice_address }} +{% endif %} + + +{% endif %} + +{{ matrix_mx_puppet_slack_container_labels_additional_labels }} diff --git a/roles/custom/matrix-bridge-mx-puppet-slack/templates/systemd/matrix-mx-puppet-slack.service.j2 b/roles/custom/matrix-bridge-mx-puppet-slack/templates/systemd/matrix-mx-puppet-slack.service.j2 index f26154d04..d7c108fd9 100644 --- a/roles/custom/matrix-bridge-mx-puppet-slack/templates/systemd/matrix-mx-puppet-slack.service.j2 +++ b/roles/custom/matrix-bridge-mx-puppet-slack/templates/systemd/matrix-mx-puppet-slack.service.j2 @@ -19,23 +19,32 @@ 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-mx-puppet-slack \ +ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} create \ + --rm \ + --name=matrix-mx-puppet-slack \ --log-driver=none \ --user={{ matrix_user_uid }}:{{ matrix_user_gid }} \ --cap-drop=ALL \ - --network={{ matrix_docker_network }} \ + --network={{ matrix_mx_puppet_slack_container_network }} \ {% if matrix_mx_puppet_slack_container_http_host_bind_port %} -p {{ matrix_mx_puppet_slack_container_http_host_bind_port }}:{{ matrix_mx_puppet_slack_appservice_port }} \ {% endif %} -e CONFIG_PATH=/config/config.yaml \ -e REGISTRATION_PATH=/config/registration.yaml \ - -v {{ matrix_mx_puppet_slack_config_path }}:/config:z \ - -v {{ matrix_mx_puppet_slack_data_path }}:/data:z \ + --mount type=bind,src={{ matrix_mx_puppet_slack_config_path }},dst=/config \ + --mount type=bind,src={{ matrix_mx_puppet_slack_data_path }},dst=/data \ + --label-file={{ matrix_mx_puppet_slack_base_path }}/labels \ {% for arg in matrix_mx_puppet_slack_container_extra_arguments %} {{ arg }} \ {% endfor %} {{ matrix_mx_puppet_slack_docker_image }} +{% for network in matrix_mx_puppet_slack_container_additional_networks %} +ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} network connect {{ network }} matrix-mx-puppet-slack +{% endfor %} + +ExecStart={{ devture_systemd_docker_base_host_command_docker }} start --attach matrix-mx-puppet-slack + 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-mx-puppet-slack 2>/dev/null || true' ExecStop=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} rm matrix-mx-puppet-slack 2>/dev/null || true' Restart=always