Move roles/matrix* to roles/custom/matrix*
This paves the way for installing other roles into `roles/galaxy` using `ansible-galaxy`, similar to how it's done in: - https://github.com/spantaleev/gitea-docker-ansible-deploy - https://github.com/spantaleev/nextcloud-docker-ansible-deploy In the near future, we'll be removing a lot of the shared role code from here and using upstream roles for it. Some of the core `matrix-*` roles have already been extracted out into other reusable roles: - https://github.com/devture/com.devture.ansible.role.postgres - https://github.com/devture/com.devture.ansible.role.systemd_docker_base - https://github.com/devture/com.devture.ansible.role.timesync - https://github.com/devture/com.devture.ansible.role.vars_preserver - https://github.com/devture/com.devture.ansible.role.playbook_runtime_messages - https://github.com/devture/com.devture.ansible.role.playbook_help We just need to migrate to those.
This commit is contained in:
		@@ -0,0 +1,65 @@
 | 
			
		||||
---
 | 
			
		||||
# The tasks below run before `validate_config.yml`.
 | 
			
		||||
# To avoid failing with a cryptic error message, we'll do validation here.
 | 
			
		||||
#
 | 
			
		||||
# This check is mostly relevant to people who explicitly define `matrix_synapse_workers_enabled_list`
 | 
			
		||||
# (Synapse Workers users from the earlier days of this PR - https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/456).
 | 
			
		||||
#
 | 
			
		||||
# In the future, it should be possible to remove this check.
 | 
			
		||||
# Our own code which dynamically builds `matrix_synapse_workers_enabled_list` does things right.
 | 
			
		||||
- name: Fail if required property not defined for worker
 | 
			
		||||
  ansible.builtin.fail:
 | 
			
		||||
    msg: "Synapse workers (like {{ matrix_synapse_worker_details | to_json }}) need to define a `{{ item }}` property"
 | 
			
		||||
  with_items:
 | 
			
		||||
    - id
 | 
			
		||||
    - name
 | 
			
		||||
    - type
 | 
			
		||||
    - app
 | 
			
		||||
    - port
 | 
			
		||||
    - webserving
 | 
			
		||||
  when: "item not in matrix_synapse_worker_details"
 | 
			
		||||
 | 
			
		||||
# Names are used for container names and systemd services.
 | 
			
		||||
# Routing happens based on container names, so Synapse processes that try to route to workers with underscores in the name will complain. Example:
 | 
			
		||||
# > InvalidCodepoint Codepoint U+005F at position 46 of 'matrix-synapse-worker-stream-writer-3-account_data' not allowed
 | 
			
		||||
- name: Fail if worker name includes underscore
 | 
			
		||||
  ansible.builtin.fail:
 | 
			
		||||
    msg: "Unrecognized Synapse worker `name`: `{{ matrix_synapse_worker_details.name }}`. It must not include underscores"
 | 
			
		||||
  when: "'_' in matrix_synapse_worker_details.name"
 | 
			
		||||
 | 
			
		||||
- name: Fail if worker type unknown
 | 
			
		||||
  ansible.builtin.fail:
 | 
			
		||||
    msg: "Unrecognized Synapse worker `type`: `{{ matrix_synapse_worker_details.type }}`. Supported types are: {{ matrix_synapse_known_worker_types | join(', ') }}"
 | 
			
		||||
  when: "matrix_synapse_worker_details.type not in matrix_synapse_known_worker_types"
 | 
			
		||||
 | 
			
		||||
- name: Fail if worker app unknown
 | 
			
		||||
  ansible.builtin.fail:
 | 
			
		||||
    msg: "Unrecognized Synapse worker `app`: `{{ matrix_synapse_worker_details.app }}`. Supported types are: {{ matrix_synapse_workers_avail_list | join(', ') }}"
 | 
			
		||||
  when: "matrix_synapse_worker_details.app not in matrix_synapse_workers_avail_list"
 | 
			
		||||
 | 
			
		||||
- when: "matrix_synapse_worker_details.type == 'stream_writer'"
 | 
			
		||||
  block:
 | 
			
		||||
    - name: Fail if stream_writer_stream not defined for stream_writer worker
 | 
			
		||||
      ansible.builtin.fail:
 | 
			
		||||
        msg: >-
 | 
			
		||||
          Synapse stream_writer workers (such as {{ item }}) need to define a valid `stream_writer_stream` property
 | 
			
		||||
          (not `{{ matrix_synapse_worker_details.stream_writer_stream | default('undefined') }}`).
 | 
			
		||||
          Supported types are: {{ matrix_synapse_workers_known_stream_writer_stream_types | join(', ') }}
 | 
			
		||||
      when: "'stream_writer_stream' not in matrix_synapse_worker_details or matrix_synapse_worker_details.stream_writer_stream not in matrix_synapse_workers_known_stream_writer_stream_types"
 | 
			
		||||
 | 
			
		||||
    - name: Fail if replication_port not defined for stream_writer worker
 | 
			
		||||
      ansible.builtin.fail:
 | 
			
		||||
        msg: "Synapse background workers of type stream_writer (such as {{ item }}) need to define a valid `replication_port` property"
 | 
			
		||||
      when: "'replication_port' not in matrix_synapse_worker_details"
 | 
			
		||||
 | 
			
		||||
- ansible.builtin.set_fact:
 | 
			
		||||
    matrix_systemd_services_list: "{{ matrix_systemd_services_list + [matrix_synapse_worker_details.name + '.service'] }}"
 | 
			
		||||
 | 
			
		||||
- ansible.builtin.set_fact:
 | 
			
		||||
    matrix_synapse_webserving_workers_systemd_services_list: "{{ matrix_synapse_webserving_workers_systemd_services_list + [matrix_synapse_worker_details.name + '.service'] }}"
 | 
			
		||||
  when: matrix_synapse_worker_details.webserving | bool
 | 
			
		||||
 | 
			
		||||
# Inject stream writers into the instance map.
 | 
			
		||||
- ansible.builtin.set_fact:
 | 
			
		||||
    matrix_synapse_instance_map: "{{ matrix_synapse_instance_map | combine({matrix_synapse_worker_details.name: {'host': matrix_synapse_worker_details.name, 'port': matrix_synapse_worker_details.replication_port}}) }}"
 | 
			
		||||
  when: matrix_synapse_worker_details.type in matrix_synapse_known_instance_map_eligible_worker_types
 | 
			
		||||
@@ -0,0 +1,20 @@
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
- ansible.builtin.set_fact:
 | 
			
		||||
    matrix_synapse_worker_systemd_service_name: "{{ matrix_synapse_worker_details.name }}"
 | 
			
		||||
    matrix_synapse_worker_container_name: "{{ matrix_synapse_worker_details.name }}"
 | 
			
		||||
    matrix_synapse_worker_config_file_name: "worker.{{ matrix_synapse_worker_details.name }}.yaml"
 | 
			
		||||
 | 
			
		||||
- name: Ensure configuration exists for {{ matrix_synapse_worker_systemd_service_name }}
 | 
			
		||||
  ansible.builtin.template:
 | 
			
		||||
    src: "{{ role_path }}/templates/synapse/worker.yaml.j2"
 | 
			
		||||
    dest: "{{ matrix_synapse_config_dir_path }}/{{ matrix_synapse_worker_config_file_name }}"
 | 
			
		||||
    mode: 0644
 | 
			
		||||
    owner: "{{ matrix_user_username }}"
 | 
			
		||||
    group: "{{ matrix_user_groupname }}"
 | 
			
		||||
 | 
			
		||||
- name: Ensure systemd service exists for {{ matrix_synapse_worker_systemd_service_name }}
 | 
			
		||||
  ansible.builtin.template:
 | 
			
		||||
    src: "{{ role_path }}/templates/synapse/systemd/matrix-synapse-worker.service.j2"
 | 
			
		||||
    dest: "{{ matrix_systemd_path }}/{{ matrix_synapse_worker_systemd_service_name }}.service"
 | 
			
		||||
    mode: 0644
 | 
			
		||||
		Reference in New Issue
	
	Block a user