Rename some variables

roles/matrix-base/defaults/main.yml

@@ -1,16 +1,19 @@
-# The bare hostname which represents your identity.
-# This is something like "example.com".
+# The bare domain name which represents your Matrix identity.
+# Matrix user ids for your server will be of the form (`@user:<matrix-domain>`).
+#
 # Note: this playbook does not touch the server referenced here.
-hostname_identity: "{{ host_specific_hostname_identity|lower }}"
+# Installation happens on another server ("matrix.<matrix-domain>", see `matrix_server_fqn_matrix`).
+#
+# Example value: example.com
+matrix_domain: ~
 
-# This is where your data lives and what we set up here.
-# This and the Riot hostname (see below) are expected to be on the same server.
-hostname_matrix: "matrix.{{ hostname_identity }}"
+# This is where your data lives and what we set up.
+# This and the Riot FQN (see below) are expected to be on the same server.
+matrix_server_fqn_matrix: "matrix.{{ matrix_domain }}"
 
 # This is where you access the web UI from and what we set up here.
-# This and the Matrix hostname (see above) are expected to be on the same server.
-hostname_riot: "riot.{{ hostname_identity }}"
-
+# This and the Matrix FQN (see above) are expected to be on the same server.
+matrix_server_fqn_riot: "riot.{{ matrix_domain }}"
 
 matrix_user_username: "matrix"
 matrix_user_uid: 991
@@ -21,7 +24,7 @@ matrix_base_data_path_mode: "750"
 
 matrix_static_files_base_path: "{{ matrix_base_data_path }}/static-files"
 
-matrix_homeserver_url: "https://{{ hostname_matrix }}"
+matrix_homeserver_url: "https://{{ matrix_server_fqn_matrix }}"
 
 matrix_identity_server_url: ~
 
@@ -32,8 +35,8 @@ matrix_docker_network: "matrix"
 #
 # If you wish to rely on DNS SRV records only, you can disable this.
 # Using DNS SRV records implies that you'll be handling Matrix Federation API traffic (tcp/8448)
-# using certificates for the base domain (`hostname_identity`) and not for the
-# matrix domain (`hostname_matrix`).
+# using certificates for the base domain (`matrix_domain`) and not for the
+# matrix domain (`matrix_server_fqn_matrix`).
 matrix_well_known_matrix_server_enabled: true
 
 # Variables to Control which parts of our roles run.

roles/matrix-base/tasks/main.yml

@@ -1,3 +1,7 @@
+- import_tasks: "{{ role_path }}/tasks/sanity_check.yml"
+  tags:
+    - always
+
 - import_tasks: "{{ role_path }}/tasks/clean_up_old_files.yml"
   when: run_setup
   tags:
@@ -21,13 +25,9 @@
     - setup-synapse
     - setup-nginx-proxy
 
-- import_tasks: "{{ role_path }}/tasks/sanity_check.yml"
-  tags:
-    - always
-
 - import_tasks: "{{ role_path }}/tasks/self_check_dns.yml"
   delegate_to: 127.0.0.1
   become: false
   when: run_self_check
   tags:
-    - self-check
+    - self-check

roles/matrix-base/tasks/sanity_check.yml

@@ -15,15 +15,32 @@
     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: (Deprecation) Catch and report renamed settings
+  fail:
+    msg: >-
+      Your configuration contains a variable, which now has a different name.
+      Please change your configuration to rename the variable (`{{ item.old }}` -> `{{ item.new }}`).
+  when: "item.old in vars"
+  with_items:
+    - {'old': 'host_specific_hostname_identity', 'new': 'matrix_domain'}
+    - {'old': 'hostname_identity', 'new': 'matrix_domain'}
+    - {'old': 'hostname_matrix', 'new': 'matrix_server_fqn_matrix'}
+    - {'old': 'hostname_riot', 'new': 'matrix_server_fqn_riot'}
+
+- name: Fail if required variables are undefined
+  fail:
+    msg: "The `{{ item }}` variable must be defined and have a non-null value"
+  with_items:
+    - matrix_domain
+    - matrix_server_fqn_matrix
+    - matrix_server_fqn_riot
+  when: "item not in vars or vars[item] is none"
+
 - 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 }}"
+    - "{{ matrix_domain }}"
+    - "{{ matrix_server_fqn_matrix }}"
+    - "{{ matrix_server_fqn_riot }}"
+  when: "item != item|lower"

roles/matrix-base/tasks/self_check_dns.yml

@@ -4,16 +4,16 @@
   set_fact:
     dns_srv_record_checks:
       - service_and_protocol: "_matrix._tcp"
-        domain: "{{ (hostname_identity + '.') }}"
-        expected_target: "{{ (hostname_matrix + '.') }}"
+        domain: "{{ (matrix_domain + '.') }}"
+        expected_target: "{{ (matrix_server_fqn_matrix + '.') }}"
         expected_port: 8448
 
 - block:
     - set_fact:
         dns_srv_record_check_mxisd:
           service_and_protocol: "_matrix-identity._tcp"
-          domain: "{{ (hostname_identity + '.') }}"
-          expected_target: "{{ (hostname_matrix + '.') }}"
+          domain: "{{ (matrix_domain + '.') }}"
+          expected_target: "{{ (matrix_server_fqn_matrix + '.') }}"
           expected_port: 443
 
     - name: Determine domains that we require certificates for (mxisd)
@@ -25,4 +25,4 @@
   include_tasks: "{{ role_path }}/tasks/self_check_dns_srv.yml"
   with_items: "{{ dns_srv_record_checks }}"
   loop_control:
-    loop_var: dns_srv_record_check
+    loop_var: dns_srv_record_check

roles/matrix-base/templates/static-files/well-known/matrix-server.j2

@@ -1,3 +1,3 @@
 {
-	"m.server": "{{ hostname_matrix }}:8448"
+	"m.server": "{{ matrix_server_fqn_matrix }}:8448"
 }

roles/matrix-base/templates/usr-local-bin/matrix-remove-all.j2

@@ -5,7 +5,7 @@ if [ "$(id -u)" != "0" ]; then
 	exit 1
 fi
 
-echo "WARNING! You are about to remove everything the playbook installs for matrix.{{ host_specific_hostname_identity }}: matrix, docker images,..."
+echo "WARNING! You are about to remove everything the playbook installs for {{ matrix_server_fqn_matrix }}: matrix, docker images,..."
 echo -n "If you're sure you want to do this, type: 'Yes, I really want to remove everything!'"
 read sure