Files
matrix-docker-ansible-deploy/roles/custom/matrix-bridge-mx-puppet-groupme/defaults/main.yml
T
Slavi PantaleevandClaude Opus 5.5 bff3f54d53 Harden pre-start container cleanup against name-release races
Containers are created with `--rm`, so Docker removes them asynchronously after they stop.
The pre-start `docker rm` returns immediately while that removal is still in progress
(its error is suppressed), and the following `docker create --name` can fail with
"The container name ... is already in use".

This is easy to hit since systemd_service_manager switched its default restart mode to `all-at-once`:
many containers stop and start at the same time and Docker falls behind on removals.
The playbook then fails at "Restart systemd services needing restart at once",
even though the services recover on their own (`Restart=always`) a little later.

The external roles (MASH, devture) were hardened against this in 2026-03
(see mother-of-all-self-hosting/ansible-role-valkey@0ba79c0), but the roles in `roles/custom` never were.
This ports the same bounded cleanup loop to them: stop, force-remove,
and wait until Docker releases the name, failing explicitly after a timeout.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
2026-10-16 19:04:04 +03:00

176 lines
10 KiB
YAML

# SPDX-FileCopyrightText: 2021 - 2025 Slavi Pantaleev
# SPDX-FileCopyrightText: 2021 Ahmad Haghighi
# SPDX-FileCopyrightText: 2021 Cody Neiman
# SPDX-FileCopyrightText: 2021 MDAD project contributors
# SPDX-FileCopyrightText: 2022 Cody Wyatt Neiman
# SPDX-FileCopyrightText: 2022 Marko Weltzer
# SPDX-FileCopyrightText: 2022 Nikita Chernyi
# SPDX-FileCopyrightText: 2024 Suguru Hirahara
#
# SPDX-License-Identifier: AGPL-3.0-or-later
---
# Mx Puppet GroupMe is a Matrix <-> GroupMe bridge
# Project source code URL: https://gitlab.com/xangelix-pub/matrix/mx-puppet-groupme
matrix_bridge_mx_puppet_groupme_enabled: true
matrix_bridge_mx_puppet_groupme_container_image_self_build: false
matrix_bridge_mx_puppet_groupme_container_image_self_build_repo: "https://gitlab.com/xangelix-pub/matrix/mx-puppet-groupme"
matrix_bridge_mx_puppet_groupme_container_image_self_build_repo_version: "{{ 'main' if matrix_bridge_mx_puppet_groupme_version == 'latest' else matrix_bridge_mx_puppet_groupme_version }}"
# Controls whether the mx-puppet-groupme container exposes its HTTP port (tcp/8437 in the container).
#
# Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:8437"), or empty string to not expose.
matrix_bridge_mx_puppet_groupme_container_http_host_bind_port: ''
matrix_bridge_mx_puppet_groupme_version: 533cccc8
matrix_bridge_mx_puppet_groupme_container_image: "{{ matrix_bridge_mx_puppet_groupme_container_image_registry_prefix }}xangelix-pub/matrix/mx-puppet-groupme:{{ matrix_bridge_mx_puppet_groupme_version }}"
matrix_bridge_mx_puppet_groupme_container_image_registry_prefix: "{{ 'localhost/' if matrix_bridge_mx_puppet_groupme_container_image_self_build else matrix_bridge_mx_puppet_groupme_container_image_registry_prefix_upstream }}"
matrix_bridge_mx_puppet_groupme_container_image_registry_prefix_upstream: "{{ matrix_bridge_mx_puppet_groupme_container_image_registry_prefix_upstream_default }}"
matrix_bridge_mx_puppet_groupme_container_image_registry_prefix_upstream_default: "registry.gitlab.com/"
matrix_bridge_mx_puppet_groupme_base_path: "{{ matrix_base_data_path }}/mx-puppet-groupme"
matrix_bridge_mx_puppet_groupme_config_path: "{{ matrix_bridge_mx_puppet_groupme_base_path }}/config"
matrix_bridge_mx_puppet_groupme_data_path: "{{ matrix_bridge_mx_puppet_groupme_base_path }}/data"
matrix_bridge_mx_puppet_groupme_container_src_files_path: "{{ matrix_bridge_mx_puppet_groupme_base_path }}/docker-src"
matrix_bridge_mx_puppet_groupme_appservice_port: "8437"
matrix_bridge_mx_puppet_groupme_homeserver_address: ""
matrix_bridge_mx_puppet_groupme_homeserver_domain: '{{ matrix_domain }}'
matrix_bridge_mx_puppet_groupme_appservice_address: 'http://matrix-mx-puppet-groupme:{{ matrix_bridge_mx_puppet_groupme_appservice_port }}'
# "@alice:example.com" to allow a specific user
# "@.*:example.com" to allow users on a specific homeserver
# "@.*" to allow anyone
matrix_bridge_mx_puppet_groupme_provisioning_whitelist:
- "@.*:{{ matrix_domain | regex_escape }}"
# Leave empty to disable blacklist
# "@bob:example.com" to disallow a specific user
# "@.*:example.com" to disallow users on a specific homeserver
matrix_bridge_mx_puppet_groupme_provisioning_blacklist: []
matrix_bridge_mx_puppet_groupme_container_network: ""
matrix_bridge_mx_puppet_groupme_container_additional_networks: "{{ matrix_bridge_mx_puppet_groupme_container_additional_networks_auto + matrix_bridge_mx_puppet_groupme_container_additional_networks_custom }}"
matrix_bridge_mx_puppet_groupme_container_additional_networks_auto: []
matrix_bridge_mx_puppet_groupme_container_additional_networks_custom: []
# A list of extra arguments to pass to the container
matrix_bridge_mx_puppet_groupme_container_extra_arguments: []
# Controls how long the pre-start cleanup should wait for stale container-name release
# before failing startup explicitly.
matrix_bridge_mx_puppet_groupme_container_cleanup_timeout_seconds: "{{ devture_systemd_docker_base_container_cleanup_timeout_seconds }}"
# Controls the delay between pre-start cleanup retries.
matrix_bridge_mx_puppet_groupme_container_cleanup_retry_delay_seconds: "{{ devture_systemd_docker_base_container_cleanup_retry_delay_seconds }}"
# Shell command used in the systemd pre-start phase to deterministically remove a stale
# container and wait until Docker releases its name.
matrix_bridge_mx_puppet_groupme_container_cleanup_command: |
i=0;
while [ "$i" -lt {{ matrix_bridge_mx_puppet_groupme_container_cleanup_timeout_seconds }} ]; do
{{ devture_systemd_docker_base_host_command_docker }} stop -t {{ devture_systemd_docker_base_container_stop_grace_time_seconds }} matrix-mx-puppet-groupme >/dev/null 2>&1 || true;
{{ devture_systemd_docker_base_host_command_docker }} rm -f matrix-mx-puppet-groupme >/dev/null 2>&1 || true;
if {{ devture_systemd_docker_base_host_command_docker }} container inspect matrix-mx-puppet-groupme >/dev/null 2>&1; then
i=$((i + 1));
sleep {{ matrix_bridge_mx_puppet_groupme_container_cleanup_retry_delay_seconds }};
continue;
fi;
if {{ devture_systemd_docker_base_host_command_docker }} info >/dev/null 2>&1; then
exit 0;
fi;
echo "Failed to query Docker daemon while cleaning up matrix-mx-puppet-groupme" >&2;
exit 1;
done;
echo "Failed to remove stale container matrix-mx-puppet-groupme after {{ matrix_bridge_mx_puppet_groupme_container_cleanup_timeout_seconds }} attempts" >&2;
exit 1
# List of systemd services that matrix-puppet-groupme.service depends on.
matrix_bridge_mx_puppet_groupme_systemd_required_services_list: "{{ matrix_bridge_mx_puppet_groupme_systemd_required_services_list_default + matrix_bridge_mx_puppet_groupme_systemd_required_services_list_auto + matrix_bridge_mx_puppet_groupme_systemd_required_services_list_custom }}"
matrix_bridge_mx_puppet_groupme_systemd_required_services_list_default: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}"
matrix_bridge_mx_puppet_groupme_systemd_required_services_list_auto: []
matrix_bridge_mx_puppet_groupme_systemd_required_services_list_custom: []
# List of systemd services that matrix-puppet-groupme.service wants
matrix_bridge_mx_puppet_groupme_systemd_wanted_services_list: []
matrix_bridge_mx_puppet_groupme_appservice_token: ''
matrix_bridge_mx_puppet_groupme_homeserver_token: ''
# Can be set to enable automatic double-puppeting via Shared Secret Auth (https://github.com/devture/matrix-synapse-shared-secret-auth).
matrix_bridge_mx_puppet_groupme_login_shared_secret: ''
matrix_bridge_mx_puppet_groupme_presence_enabled: true
matrix_bridge_mx_puppet_groupme_presence_interval: 5000
matrix_bridge_mx_puppet_groupme_database_engine: sqlite
matrix_bridge_mx_puppet_groupme_sqlite_database_path_local: "{{ matrix_bridge_mx_puppet_groupme_data_path }}/database.db"
matrix_bridge_mx_puppet_groupme_sqlite_database_path_in_container: "/data/database.db"
matrix_bridge_mx_puppet_groupme_database_username: matrix_mx_puppet_groupme
matrix_bridge_mx_puppet_groupme_database_password: ~
matrix_bridge_mx_puppet_groupme_database_hostname: ''
matrix_bridge_mx_puppet_groupme_database_port: 5432
matrix_bridge_mx_puppet_groupme_database_name: matrix_mx_puppet_groupme
matrix_bridge_mx_puppet_groupme_database_sslmode: disable
matrix_bridge_mx_puppet_groupme_database_connection_string: 'postgresql://{{ matrix_bridge_mx_puppet_groupme_database_username }}:{{ matrix_bridge_mx_puppet_groupme_database_password }}@{{ matrix_bridge_mx_puppet_groupme_database_hostname }}:{{ matrix_bridge_mx_puppet_groupme_database_port }}/{{ matrix_bridge_mx_puppet_groupme_database_name }}?sslmode={{ matrix_bridge_mx_puppet_groupme_database_sslmode }}'
# Default configuration template which covers the generic use case.
# You can customize it by controlling the various variables inside it.
#
# For a more advanced customization, you can extend the default (see `matrix_bridge_mx_puppet_groupme_configuration_extension_yaml`)
# or completely replace this variable with your own template.
matrix_bridge_mx_puppet_groupme_configuration_yaml: "{{ lookup('template', 'templates/config.yaml.j2') }}"
matrix_bridge_mx_puppet_groupme_configuration_extension_yaml: |
# Your custom YAML configuration goes here.
# This configuration extends the default starting configuration (`matrix_bridge_mx_puppet_groupme_configuration_yaml`).
#
# You can override individual variables from the default configuration, or introduce new ones.
#
# If you need something more special, you can take full control by
# completely redefining `matrix_bridge_mx_puppet_groupme_configuration_yaml`.
matrix_bridge_mx_puppet_groupme_configuration_extension: "{{ matrix_bridge_mx_puppet_groupme_configuration_extension_yaml | from_yaml if matrix_bridge_mx_puppet_groupme_configuration_extension_yaml | from_yaml is mapping else {} }}"
# Holds the final configuration (a combination of the default and its extension).
# You most likely don't need to touch this variable. Instead, see `matrix_bridge_mx_puppet_groupme_configuration_yaml`.
matrix_bridge_mx_puppet_groupme_configuration: "{{ matrix_bridge_mx_puppet_groupme_configuration_yaml | from_yaml | combine(matrix_bridge_mx_puppet_groupme_configuration_extension, recursive=True) }}"
matrix_bridge_mx_puppet_groupme_registration_yaml: |
as_token: "{{ matrix_bridge_mx_puppet_groupme_appservice_token }}"
hs_token: "{{ matrix_bridge_mx_puppet_groupme_homeserver_token }}"
id: groupme-puppet
namespaces:
users:
- exclusive: true
regex: '@_groupmepuppet_.*:{{ matrix_bridge_mx_puppet_groupme_homeserver_domain | regex_escape }}'
rooms: []
aliases:
- exclusive: true
regex: '#_groupmepuppet_.*:{{ matrix_bridge_mx_puppet_groupme_homeserver_domain | regex_escape }}'
protocols: []
rate_limited: false
sender_localpart: _groupmepuppet_bot
url: {{ matrix_bridge_mx_puppet_groupme_appservice_address }}
de.sorunome.msc2409.push_ephemeral: true
receive_ephemeral: true
matrix_bridge_mx_puppet_groupme_registration: "{{ matrix_bridge_mx_puppet_groupme_registration_yaml | from_yaml }}"
# matrix_bridge_mx_puppet_groupme_restart_necessary controls whether the service
# will be restarted (when true) or merely started (when false) by the
# systemd service manager role (when conditional restart is enabled).
#
# This value is automatically computed during installation based on whether
# any configuration files, the systemd service file, or the container image changed.
# The default of `false` means "no restart needed" — appropriate when the role's
# installation tasks haven't run (e.g., due to --tags skipping them).
matrix_bridge_mx_puppet_groupme_restart_necessary: false