matrix-docker-ansible-deploy/roles/matrix-base/tasks/sanity_check.yml

---

- set_fact:
    matrix_ansible_outdated_fail_msg: "You are running on Ansible {{ ansible_version.string }}, which is not supported. See our guide about Ansible: https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/master/docs/ansible.md"

- name: Fail if running on Ansible < 2.4
  fail:
    msg: "{{ matrix_ansible_outdated_fail_msg }}"
  when: "ansible_version.major <= 2 and ansible_version.minor < 4"

# Ansible 2.5.0 and 2.5.1 are known to have a bug with `include_tasks` + `with_items`.
# The bug has been fixed in Ansible 2.5.2.
- name: Fail if running on Ansible 2.5.x (lower than 2.5.2)
  fail:
    msg: "{{ matrix_ansible_outdated_fail_msg }}"
  when: "ansible_version.major == 2 and ansible_version.minor == 5 and ansible_version.revision < 2"

# This sanity check is only used to detect uppercase when people override these specific variables.
#
# If people set `host_specific_hostname_identity` without overriding other variables (the general use-case),
# we take care to lower-case it automatically and it won't cause trouble anyway.
- name: Fail if uppercase domain used
  fail:
    msg: "Detected that you're using an uppercase domain name - `{{ item }}`. This will cause trouble. Please use all-lowercase!"
  when: "item != item|lower"
  with_items:
    - "{{ hostname_identity }}"
    - "{{ hostname_matrix }}"
    - "{{ hostname_riot }}"
Move setup sanity checks to a central place 2018-12-23 19:14:01 +02:00			`---`

Add Ansible guide and Ansible version checks After having multiple people report issues with retrieving SSL certificates, we've finally discovered the culprit to be Ansible 2.5.1 (default and latest version on Ubuntu 18.04 LTS). As silly as it is, certain distributions ("LTS" even) are 13 bugfix versions of Ansible behind. From now on, we try to auto-detect buggy Ansible versions and tell the user. We also provide some tips for how to upgrade Ansible or run it from inside a Docker container. My testing shows that Ansible 2.4.0 and 2.4.6 are OK. All other intermediate 2.4.x versions haven't been tested, but we trust they're OK too. From the 2.5.x releases, only 2.5.0 and 2.5.1 seem to be affected. Ansible 2.5.2 corrects the problem with `include_tasks` + `with_items`. 2019-01-03 16:15:47 +02:00			`- set_fact:`
			`matrix_ansible_outdated_fail_msg: "You are running on Ansible {{ ansible_version.string }}, which is not supported. See our guide about Ansible: https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/master/docs/ansible.md"`

			`- name: Fail if running on Ansible < 2.4`
			`fail:`
			`msg: "{{ matrix_ansible_outdated_fail_msg }}"`
			`when: "ansible_version.major <= 2 and ansible_version.minor < 4"`

			# Ansible 2.5.0 and 2.5.1 are known to have a bug with `include_tasks` + `with_items`.
			`# The bug has been fixed in Ansible 2.5.2.`
			`- name: Fail if running on Ansible 2.5.x (lower than 2.5.2)`
			`fail:`
			`msg: "{{ matrix_ansible_outdated_fail_msg }}"`
			`when: "ansible_version.major == 2 and ansible_version.minor == 5 and ansible_version.revision < 2"`

Lowercase host_specific_hostname_identity to prevent troubles If uppercase is used, certain tools (like certbot) would cause trouble. They would retrieve a certificate for the lowercased domain name, but we'd try to use it from an uppercase-named directory, which will fail. Besides certbot, we may experience other trouble too. (it hasn't been investigated how far the breakage goes). To fix it all, we lowercase `host_specific_hostname_identity` by default, which takes care of the general use-case (people only setting that and relying on us to build the other domain names - `hostname_matrix` and `hostname_riot`). For others, who decide to override these other variables directly (and who may work around us and introduce uppercase there directly), we also have the sanity-check tool warn if uppercase is detected in any of the final domains. 2018-12-23 19:20:53 +02:00			`# This sanity check is only used to detect uppercase when people override these specific variables.`
			`#`
			# If people set `host_specific_hostname_identity` without overriding other variables (the general use-case),
			`# we take care to lower-case it automatically and it won't cause trouble anyway.`
			`- name: Fail if uppercase domain used`
			`fail:`
			msg: "Detected that you're using an uppercase domain name - `{{ item }}`. This will cause trouble. Please use all-lowercase!"
			`when: "item != item\|lower"`
			`with_items:`
			`- "{{ hostname_identity }}"`
			`- "{{ hostname_matrix }}"`
Add Ansible guide and Ansible version checks After having multiple people report issues with retrieving SSL certificates, we've finally discovered the culprit to be Ansible 2.5.1 (default and latest version on Ubuntu 18.04 LTS). As silly as it is, certain distributions ("LTS" even) are 13 bugfix versions of Ansible behind. From now on, we try to auto-detect buggy Ansible versions and tell the user. We also provide some tips for how to upgrade Ansible or run it from inside a Docker container. My testing shows that Ansible 2.4.0 and 2.4.6 are OK. All other intermediate 2.4.x versions haven't been tested, but we trust they're OK too. From the 2.5.x releases, only 2.5.0 and 2.5.1 seem to be affected. Ansible 2.5.2 corrects the problem with `include_tasks` + `with_items`. 2019-01-03 16:15:47 +02:00			`- "{{ hostname_riot }}"`