matrix-docker-ansible-deploy/roles/custom/matrix-synapse/tasks/self_check_federation_api.yml

---

- name: Check Matrix Federation API
  ansible.builtin.uri:
    url: "{{ matrix_synapse_federation_api_url_endpoint_public }}"
    follow_redirects: none
    validate_certs: "{{ matrix_synapse_self_check_validate_certificates }}"
  register: result_matrix_synapse_federation_api
  ignore_errors: true
  check_mode: false
  when: matrix_synapse_enabled | bool

- name: Fail if Matrix Federation API not working
  ansible.builtin.fail:
    msg: "Failed checking Matrix Federation API is up at `{{ matrix_server_fqn_matrix }}` (checked endpoint: `{{ matrix_synapse_federation_api_url_endpoint_public }}`). Is Synapse running? Is port {{ matrix_federation_public_port }} open in your firewall? Full error: {{ result_matrix_synapse_federation_api }}"
  when: "matrix_synapse_enabled | bool and matrix_synapse_federation_enabled | bool and (result_matrix_synapse_federation_api.failed or 'json' not in result_matrix_synapse_federation_api)"

- name: Fail if Matrix Federation API unexpectedly enabled
  ansible.builtin.fail:
    msg: "Matrix Federation API is up at `{{ matrix_server_fqn_matrix }}` (checked endpoint: `{{ matrix_synapse_federation_api_url_endpoint_public }}`) despite being disabled."
  when: "matrix_synapse_enabled | bool and not matrix_synapse_federation_enabled | bool and not result_matrix_synapse_federation_api.failed"

- name: Report working Matrix Federation API
  ansible.builtin.debug:
    msg: "The Matrix Federation API at `{{ matrix_server_fqn_matrix }}` (checked endpoint: `{{ matrix_synapse_federation_api_url_endpoint_public }}`) is working"
  when: "matrix_synapse_enabled | bool and matrix_synapse_federation_enabled | bool"
Add self-check command 2018-10-21 09:58:25 +00:00			`---`

			`- name: Check Matrix Federation API`
Use fully-qualified module names for builtin Ansible modules Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1939 2022-07-18 07:39:08 +00:00			`ansible.builtin.uri:`
Make roles more independent of one another With this change, the following roles are now only dependent on the minimal `matrix-base` role: - `matrix-corporal` - `matrix-coturn` - `matrix-mailer` - `matrix-mxisd` - `matrix-postgres` - `matrix-riot-web` - `matrix-synapse` The `matrix-nginx-proxy` role still does too much and remains dependent on the others. Wiring up the various (now-independent) roles happens via a glue variables file (`group_vars/matrix-servers`). It's triggered for all hosts in the `matrix-servers` group. According to Ansible's rules of priority, we have the following chain of inclusion/overriding now: - role defaults (mostly empty or good for independent usage) - playbook glue variables (`group_vars/matrix-servers`) - inventory host variables (`inventory/host_vars/matrix.<your-domain>`) All roles default to enabling their main component (e.g. `matrix_mxisd_enabled: true`, `matrix_riot_web_enabled: true`). Reasoning: if a role is included in a playbook (especially separately, in another playbook), it should "work" by default. Our playbook disables some of those if they are not generally useful (e.g. `matrix_corporal_enabled: false`). 2019-01-16 16:05:48 +00:00			`url: "{{ matrix_synapse_federation_api_url_endpoint_public }}"`
uri.follow_redirects is now a string field 2020-01-22 21:33:20 +00:00			`follow_redirects: none`
Make self-check not validate self-signed certificates By default, `--tags=self-check` no longer validates certificates when `matrix_ssl_retrieval_method` is set to `self-signed`. Besides this default, people can also enable/disable validation using the individual role variables manually. Fixes #124 (Github Issue) 2019-03-22 07:39:17 +00:00			`validate_certs: "{{ matrix_synapse_self_check_validate_certificates }}"`
Make roles more independent of one another With this change, the following roles are now only dependent on the minimal `matrix-base` role: - `matrix-corporal` - `matrix-coturn` - `matrix-mailer` - `matrix-mxisd` - `matrix-postgres` - `matrix-riot-web` - `matrix-synapse` The `matrix-nginx-proxy` role still does too much and remains dependent on the others. Wiring up the various (now-independent) roles happens via a glue variables file (`group_vars/matrix-servers`). It's triggered for all hosts in the `matrix-servers` group. According to Ansible's rules of priority, we have the following chain of inclusion/overriding now: - role defaults (mostly empty or good for independent usage) - playbook glue variables (`group_vars/matrix-servers`) - inventory host variables (`inventory/host_vars/matrix.<your-domain>`) All roles default to enabling their main component (e.g. `matrix_mxisd_enabled: true`, `matrix_riot_web_enabled: true`). Reasoning: if a role is included in a playbook (especially separately, in another playbook), it should "work" by default. Our playbook disables some of those if they are not generally useful (e.g. `matrix_corporal_enabled: false`). 2019-01-16 16:05:48 +00:00			`register: result_matrix_synapse_federation_api`
Add self-check command 2018-10-21 09:58:25 +00:00			`ignore_errors: true`
fix: all praise the allmighty yamllinter 2022-02-05 20:32:54 +00:00			`check_mode: false`
More ansible-lint fixes 2022-07-18 08:22:05 +00:00			`when: matrix_synapse_enabled \| bool`
Add self-check command 2018-10-21 09:58:25 +00:00
			`- name: Fail if Matrix Federation API not working`
Use fully-qualified module names for builtin Ansible modules Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1939 2022-07-18 07:39:08 +00:00			`ansible.builtin.fail:`
Make Matrix federation port configurable Fixes #523 (Github Issue). 2020-06-09 05:29:03 +00:00			msg: "Failed checking Matrix Federation API is up at `{{ matrix_server_fqn_matrix }}` (checked endpoint: `{{ matrix_synapse_federation_api_url_endpoint_public }}`). Is Synapse running? Is port {{ matrix_federation_public_port }} open in your firewall? Full error: {{ result_matrix_synapse_federation_api }}"
More ansible-lint fixes 2022-07-18 08:22:05 +00:00			`when: "matrix_synapse_enabled \| bool and matrix_synapse_federation_enabled \| bool and (result_matrix_synapse_federation_api.failed or 'json' not in result_matrix_synapse_federation_api)"`
Make federation self-check conditional on matrix_synapse_federation_enabled 2019-03-14 05:23:35 +00:00
			`- name: Fail if Matrix Federation API unexpectedly enabled`
Use fully-qualified module names for builtin Ansible modules Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1939 2022-07-18 07:39:08 +00:00			`ansible.builtin.fail:`
fix: all praise the allmighty yamllinter 2022-02-05 20:32:54 +00:00			msg: "Matrix Federation API is up at `{{ matrix_server_fqn_matrix }}` (checked endpoint: `{{ matrix_synapse_federation_api_url_endpoint_public }}`) despite being disabled."
More ansible-lint fixes 2022-07-18 08:22:05 +00:00			`when: "matrix_synapse_enabled \| bool and not matrix_synapse_federation_enabled \| bool and not result_matrix_synapse_federation_api.failed"`
Add self-check command 2018-10-21 09:58:25 +00:00
			`- name: Report working Matrix Federation API`
Use fully-qualified module names for builtin Ansible modules Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1939 2022-07-18 07:39:08 +00:00			`ansible.builtin.debug:`
Rename some variables 2019-02-28 09:51:09 +00:00			msg: "The Matrix Federation API at `{{ matrix_server_fqn_matrix }}` (checked endpoint: `{{ matrix_synapse_federation_api_url_endpoint_public }}`) is working"
More ansible-lint fixes 2022-07-18 08:22:05 +00:00			`when: "matrix_synapse_enabled \| bool and matrix_synapse_federation_enabled \| bool"`