Files
matrix-docker-ansible-deploy/roles/custom/matrix-bridge-mx-puppet-steam/tasks/setup_install.yml
T
Slavi Pantaleev e5b8de8c2b Heal git checkout ownership in all roles cloning repositories on the server
6b4b7647e fixed this for synapse-usage-exporter only. A checkout owned by
a different user makes the git task fail from then on, either with a
permission error or with git's dubious-ownership protection, until
someone removes the directory on the host by hand. It gets into that
state when the matrix user's uid changes (a server migration or a restore
onto a differently numbered user), when an earlier clone ran as another
user, or when someone runs git as root inside the checkout.

Every other role cloning a repository onto the server was open to the
same failure, so ensure the checkout's ownership recursively before
updating it at the remaining 54 sites.

The three matrix-synapse ext clones also gain force=yes. They were the
only on-server clones without it, which left a checkout that an
interrupted run had half-written wedged, instead of repaired on the next
run.

matrix-matrixto used to clone as root into a directory that nothing ever
chowned, unlike every other role. It now becomes the matrix user too.

The Element Web and SchildiChat Web theme checkouts live on the Ansible
controller, where correcting ownership is not ours to do, so they merely
mark the checkout as a safe directory for git.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-07-31 19:01:52 +03:00

169 lines
7.9 KiB
YAML

# SPDX-FileCopyrightText: 2020 - 2024 Slavi Pantaleev
# SPDX-FileCopyrightText: 2020 Hugues Morisset
# SPDX-FileCopyrightText: 2020 Panagiotis Vasilopoulos
# SPDX-FileCopyrightText: 2020 Stuart Mumford
# SPDX-FileCopyrightText: 2022 Jim Myhrberg
# SPDX-FileCopyrightText: 2022 Marko Weltzer
# SPDX-FileCopyrightText: 2022 Nikita Chernyi
# SPDX-FileCopyrightText: 2022 Sebastian Gumprich
# SPDX-FileCopyrightText: 2024 David Mehren
#
# SPDX-License-Identifier: AGPL-3.0-or-later
---
- name: Ensure MX Puppet Steam paths exist
ansible.builtin.file:
path: "{{ item.path }}"
state: directory
mode: '0750'
owner: "{{ matrix_user_name }}"
group: "{{ matrix_group_name }}"
with_items:
- {path: "{{ matrix_bridge_mx_puppet_steam_base_path }}", when: true}
- {path: "{{ matrix_bridge_mx_puppet_steam_config_path }}", when: true}
- {path: "{{ matrix_bridge_mx_puppet_steam_data_path }}", when: true}
- {path: "{{ matrix_bridge_mx_puppet_steam_container_src_files_path }}", when: "{{ matrix_bridge_mx_puppet_steam_container_image_self_build }}"}
when: matrix_bridge_mx_puppet_steam_enabled | bool and item.when | bool
- name: Check if an old database file already exists
ansible.builtin.stat:
path: "{{ matrix_bridge_mx_puppet_steam_base_path }}/database.db"
register: matrix_bridge_mx_puppet_steam_stat_database
- name: (Data relocation) Ensure matrix-mx-puppet-steam.service is stopped
ansible.builtin.service:
name: matrix-mx-puppet-steam
state: stopped
enabled: false
daemon_reload: true
failed_when: false
when: "matrix_bridge_mx_puppet_steam_stat_database.stat.exists"
- name: (Data relocation) Move mx-puppet-steam database file to ./data directory
ansible.builtin.command:
cmd: "mv {{ matrix_bridge_mx_puppet_steam_base_path }}/database.db {{ matrix_bridge_mx_puppet_steam_data_path }}/database.db"
creates: "{{ matrix_bridge_mx_puppet_steam_data_path }}/database.db"
removes: "{{ matrix_bridge_mx_puppet_steam_base_path }}/database.db"
when: "matrix_bridge_mx_puppet_steam_stat_database.stat.exists"
- ansible.builtin.set_fact:
matrix_bridge_mx_puppet_steam_migration_requires_restart: false
- when: "matrix_bridge_mx_puppet_steam_database_engine == 'postgres'"
block:
- name: Check if an SQLite database already exists
ansible.builtin.stat:
path: "{{ matrix_bridge_mx_puppet_steam_sqlite_database_path_local }}"
register: matrix_bridge_mx_puppet_steam_sqlite_database_path_local_stat_result
- when: "matrix_bridge_mx_puppet_steam_sqlite_database_path_local_stat_result.stat.exists | bool"
block:
- ansible.builtin.include_role:
name: galaxy/postgres
tasks_from: migrate_db_to_postgres
vars:
postgres_db_migration_request:
src: "{{ matrix_bridge_mx_puppet_steam_sqlite_database_path_local }}"
dst: "{{ matrix_bridge_mx_puppet_steam_database_connection_string }}"
caller: "{{ role_path | basename }}"
engine_variable_name: 'matrix_bridge_mx_puppet_steam_database_engine'
engine_old: 'sqlite'
systemd_services_to_stop: ['matrix-mx-puppet-steam.service']
- ansible.builtin.set_fact:
matrix_bridge_mx_puppet_steam_migration_requires_restart: true
- name: Ensure MX Puppet Steam image is pulled
community.docker.docker_image_pull:
name: "{{ matrix_bridge_mx_puppet_steam_container_image }}"
pull: always
when: matrix_bridge_mx_puppet_steam_enabled | bool and not matrix_bridge_mx_puppet_steam_container_image_self_build
register: matrix_bridge_mx_puppet_steam_container_image_pull_result
retries: "{{ devture_playbook_help_container_retries_count }}"
delay: "{{ devture_playbook_help_container_retries_delay }}"
until: matrix_bridge_mx_puppet_steam_container_image_pull_result is not failed
# A checkout owned by a different user (a uid change, an earlier clone by another user, etc.) would make the git task below fail on ownership or permissions.
- name: Ensure MX Puppet Steam repository ownership is correct on self build
ansible.builtin.file:
path: "{{ matrix_bridge_mx_puppet_steam_container_src_files_path }}"
state: directory
owner: "{{ matrix_user_name }}"
group: "{{ matrix_group_name }}"
recurse: true
when: "matrix_bridge_mx_puppet_steam_enabled | bool and matrix_bridge_mx_puppet_steam_container_image_self_build"
- name: Ensure MX Puppet Steam repository is present on self build
ansible.builtin.git:
repo: "{{ matrix_bridge_mx_puppet_steam_container_image_self_build_repo }}"
version: "{{ matrix_bridge_mx_puppet_steam_container_image_self_build_repo_version }}"
dest: "{{ matrix_bridge_mx_puppet_steam_container_src_files_path }}"
force: "yes"
become: true
become_user: "{{ matrix_user_name }}"
register: matrix_bridge_mx_puppet_steam_git_pull_results
when: "matrix_bridge_mx_puppet_steam_enabled | bool and matrix_bridge_mx_puppet_steam_container_image_self_build"
- name: Ensure MX Puppet Steam Docker image is built
community.docker.docker_image_build:
name: "{{ matrix_bridge_mx_puppet_steam_container_image }}"
dockerfile: Dockerfile
path: "{{ matrix_bridge_mx_puppet_steam_container_src_files_path }}"
pull: true
rebuild: "{{ 'always' if matrix_bridge_mx_puppet_steam_git_pull_results.changed | bool else 'never' }}"
when: "matrix_bridge_mx_puppet_steam_enabled | bool and matrix_bridge_mx_puppet_steam_container_image_self_build"
register: matrix_bridge_mx_puppet_steam_container_image_build_result
- name: Ensure mx-puppet-steam config.yaml installed
ansible.builtin.copy:
content: "{{ matrix_bridge_mx_puppet_steam_configuration | to_nice_yaml(indent=2, width=999999) }}"
dest: "{{ matrix_bridge_mx_puppet_steam_config_path }}/config.yaml"
mode: '0644'
owner: "{{ matrix_user_name }}"
group: "{{ matrix_group_name }}"
register: matrix_bridge_mx_puppet_steam_config_result
- name: Ensure mx-puppet-steam steam-registration.yaml installed
ansible.builtin.copy:
content: "{{ matrix_bridge_mx_puppet_steam_registration | to_nice_yaml(indent=2, width=999999) }}"
dest: "{{ matrix_bridge_mx_puppet_steam_config_path }}/registration.yaml"
mode: '0644'
owner: "{{ matrix_user_name }}"
group: "{{ matrix_group_name }}"
register: matrix_bridge_mx_puppet_steam_registration_result
- name: Ensure mx-puppet-steam container network is created
when: matrix_bridge_mx_puppet_steam_container_network != 'host'
community.general.docker_network:
enable_ipv6: "{{ devture_systemd_docker_base_ipv6_enabled }}"
name: "{{ matrix_bridge_mx_puppet_steam_container_network }}"
driver: bridge
driver_options: "{{ devture_systemd_docker_base_container_networks_driver_options }}"
- name: Ensure matrix-mx-puppet-steam.service installed
ansible.builtin.template:
src: "{{ role_path }}/templates/systemd/matrix-mx-puppet-steam.service.j2"
dest: "/etc/systemd/system/matrix-mx-puppet-steam.service"
mode: '0644'
register: matrix_bridge_mx_puppet_steam_systemd_service_result
- name: Determine whether matrix-mx-puppet-steam needs a restart
ansible.builtin.set_fact:
matrix_bridge_mx_puppet_steam_restart_necessary: >-
{{
matrix_bridge_mx_puppet_steam_migration_requires_restart | default(false)
or matrix_bridge_mx_puppet_steam_config_result.changed | default(false)
or matrix_bridge_mx_puppet_steam_registration_result.changed | default(false)
or matrix_bridge_mx_puppet_steam_systemd_service_result.changed | default(false)
or matrix_bridge_mx_puppet_steam_container_image_pull_result.changed | default(false)
or matrix_bridge_mx_puppet_steam_container_image_build_result.changed | default(false)
}}
- name: Ensure matrix-mx-puppet-steam.service restarted, if necessary
ansible.builtin.service:
name: "matrix-mx-puppet-steam.service"
state: restarted
daemon_reload: true
when: "matrix_bridge_mx_puppet_steam_migration_requires_restart | bool"