Replace `matrix_dynamic_dns` with `ddclient`

Signed-off-by: Suguru Hirahara <did🔑z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5>

CHANGELOG.md

@@ -1,5 +1,13 @@
 # 2026-02-08
 
+## (BC Break) Dynamic DNS role has been relocated and variable names need adjustments
+
+The role for Dynamic DNS has been relocated to the [mother-of-all-self-hosting](https://github.com/mother-of-all-self-hosting) organization.
+
+Along with the relocation, the `matrix_dynamic_dns_` prefix on its variable names has been renamed to `ddclient_`, so you need to adjust your `vars.yml` configuration.
+
+As always, the playbook would let you know about this and point out any variables you may have missed.
+
 ## ma1sd has been removed from the playbook
 
 [ma1sd](./docs/configuring-playbook-ma1sd.md) has been removed from the playbook, as it has been unmaintained for a long time.

docs/configuring-playbook-dynamic-dns.md

@@ -21,9 +21,9 @@ You'll need to authenticate with your DNS provider somehow, in most cases this i
 To enable dynamic DNS, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
 
 ```yaml
-matrix_dynamic_dns_enabled: true
+ddclient_enabled: true
 
-matrix_dynamic_dns_domain_configurations:
+ddclient_domain_configurations:
   - provider: example.net
     protocol: dyndn2
     username: YOUR_USERNAME_HERE
@@ -31,7 +31,7 @@ matrix_dynamic_dns_domain_configurations:
     domain: "{{ matrix_domain }}"
 ```
 
-Keep in mind that certain providers may require a different configuration of the `matrix_dynamic_dns_domain_configurations` variable, for provider specific examples see the [upstream documentation](https://github.com/ddclient/ddclient/blob/main/ddclient.conf.in).
+Keep in mind that certain providers may require a different configuration of the `ddclient_domain_configurations` variable, for provider specific examples see the [upstream documentation](https://github.com/ddclient/ddclient/blob/main/ddclient.conf.in).
 
 ### Extending the configuration
 

group_vars/matrix_servers

@@ -368,7 +368,7 @@ devture_systemd_service_manager_services_list_auto: |
     +
     ([{'name': 'matrix-dimension.service', 'priority': 4000, 'groups': ['matrix', 'integration-managers', 'dimension']}] if matrix_dimension_enabled else [])
     +
-    ([{'name': 'matrix-dynamic-dns.service', 'priority': 5000, 'groups': ['matrix', 'dynamic-dns']}] if matrix_dynamic_dns_enabled else [])
+    ([{'name': 'matrix-dynamic-dns.service', 'priority': 5000, 'groups': ['matrix', 'dynamic-dns']}] if ddclient_enabled else [])
     +
     ([{'name': (etherpad_identifier + '.service'), 'priority': 4000, 'groups': ['matrix', 'etherpad']}] if etherpad_enabled else [])
     +
@@ -3348,11 +3348,11 @@ etherpad_database_postgres_password: "{{ '%s' | format(matrix_homeserver_generic
 #
 ######################################################################
 
-matrix_dynamic_dns_enabled: false
+ddclient_enabled: false
 
-matrix_dynamic_dns_docker_image_registry_prefix_upstream: "{{ matrix_container_global_registry_prefix_override if matrix_container_global_registry_prefix_override else matrix_dynamic_dns_docker_image_registry_prefix_upstream_default }}"
+ddclient_docker_image_registry_prefix_upstream: "{{ matrix_container_global_registry_prefix_override if matrix_container_global_registry_prefix_override else ddclient_docker_image_registry_prefix_upstream_default }}"
 
-matrix_dynamic_dns_container_network: matrix-dynamic-dns
+ddclient_container_network: matrix-dynamic-dns
 
 ######################################################################
 #

i18n/translation-templates/docs/configuring-playbook-dynamic-dns.pot

@@ -45,7 +45,7 @@ msgid "To enable dynamic DNS, add the following configuration to your `inventory
 msgstr ""
 
 #: ../../../docs/configuring-playbook-dynamic-dns.md:34
-msgid "Keep in mind that certain providers may require a different configuration of the `matrix_dynamic_dns_domain_configurations` variable, for provider specific examples see the [upstream documentation](https://github.com/ddclient/ddclient/blob/main/ddclient.conf.in)."
+msgid "Keep in mind that certain providers may require a different configuration of the `ddclient_domain_configurations` variable, for provider specific examples see the [upstream documentation](https://github.com/ddclient/ddclient/blob/main/ddclient.conf.in)."
 msgstr ""
 
 #: ../../../docs/configuring-playbook-dynamic-dns.md:36

roles/custom/matrix-dynamic-dns/defaults/main.yml

@@ -12,68 +12,68 @@
 # Project source code URL: https://github.com/linuxserver/docker-ddclient
 
 # Whether dynamic dns is enabled
-matrix_dynamic_dns_enabled: true
+ddclient_enabled: true
 
 # The dynamic dns daemon interval
-matrix_dynamic_dns_daemon_interval: '300'
+ddclient_daemon_interval: '300'
 
 # renovate: datasource=docker depName=linuxserver/ddclient versioning=semver
-matrix_dynamic_dns_version: 4.0.0
+ddclient_version: 4.0.0
 
 # The docker container to use when in mode
-matrix_dynamic_dns_docker_image: "{{ matrix_dynamic_dns_docker_image_registry_prefix }}linuxserver/ddclient:{{ matrix_dynamic_dns_version }}"
+ddclient_docker_image: "{{ ddclient_docker_image_registry_prefix }}linuxserver/ddclient:{{ ddclient_version }}"
 
-matrix_dynamic_dns_docker_image_registry_prefix: "{{ 'localhost/' if matrix_dynamic_dns_container_image_self_build else matrix_dynamic_dns_docker_image_registry_prefix_upstream }}"
-matrix_dynamic_dns_docker_image_registry_prefix_upstream: "{{ matrix_dynamic_dns_docker_image_registry_prefix_upstream_default }}"
-matrix_dynamic_dns_docker_image_registry_prefix_upstream_default: docker.io/
+ddclient_docker_image_registry_prefix: "{{ 'localhost/' if ddclient_container_image_self_build else ddclient_docker_image_registry_prefix_upstream }}"
+ddclient_docker_image_registry_prefix_upstream: "{{ ddclient_docker_image_registry_prefix_upstream_default }}"
+ddclient_docker_image_registry_prefix_upstream_default: docker.io/
 
 # The image to force pull
-matrix_dynamic_dns_docker_image_force_pull: "{{ matrix_dynamic_dns_docker_image.endswith(':latest') }}"
+ddclient_docker_image_force_pull: "{{ ddclient_docker_image.endswith(':latest') }}"
 
-matrix_dynamic_dns_container_network: ''
+ddclient_container_network: ''
 
-matrix_dynamic_dns_container_additional_networks: "{{ matrix_dynamic_dns_container_additional_networks_auto + matrix_dynamic_dns_container_additional_networks_custom }}"
-matrix_dynamic_dns_container_additional_networks_auto: []
-matrix_dynamic_dns_container_additional_networks_custom: []
+ddclient_container_additional_networks: "{{ ddclient_container_additional_networks_auto + ddclient_container_additional_networks_custom }}"
+ddclient_container_additional_networks_auto: []
+ddclient_container_additional_networks_custom: []
 
 # List of extra arguments to pass to the container mode
-matrix_dynamic_dns_container_extra_arguments: []
+ddclient_container_extra_arguments: []
 
 # List of wanted services when running in mode
-matrix_dynamic_dns_systemd_wanted_services_list: []
+ddclient_systemd_wanted_services_list: []
 
 # List of required services when running in mode
-matrix_dynamic_dns_systemd_required_services_list: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}"
+ddclient_systemd_required_services_list: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}"
 
 # Build the container from source when running in mode
-matrix_dynamic_dns_container_image_self_build: false
-matrix_dynamic_dns_container_image_self_build_repo: "https://github.com/linuxserver/docker-ddclient.git"
-matrix_dynamic_dns_container_image_self_build_repo_branch: "{{ matrix_dynamic_dns_version }}"
+ddclient_container_image_self_build: false
+ddclient_container_image_self_build_repo: "https://github.com/linuxserver/docker-ddclient.git"
+ddclient_container_image_self_build_repo_branch: "{{ ddclient_version }}"
 
 # Config paths
-matrix_dynamic_dns_base_path: "{{ matrix_base_data_path }}/dynamic-dns"
-matrix_dynamic_dns_config_path: "{{ matrix_dynamic_dns_base_path }}/config"
-matrix_dynamic_dns_docker_src_files_path: "{{ matrix_dynamic_dns_base_path }}/docker-src"
+ddclient_base_path: "{{ matrix_base_data_path }}/dynamic-dns"
+ddclient_config_path: "{{ ddclient_base_path }}/config"
+ddclient_docker_src_files_path: "{{ ddclient_base_path }}/docker-src"
 
 # Config options
-matrix_dynamic_dns_use: "web"
+ddclient_use: "web"
 
 # The endpoint to use to determine your external IP
-matrix_dynamic_dns_web: "https://cloudflare.com/cdn-cgi/trace"
+ddclient_web: "https://cloudflare.com/cdn-cgi/trace"
 
 # The field to extract the IP from
-# If your endpoint defined in `matrix_dynamic_dns_web` doesn't need this, just set it to ""
-matrix_dynamic_dns_web_skip: "ip="
+# If your endpoint defined in `ddclient_web` doesn't need this, just set it to ""
+ddclient_web_skip: "ip="
 
-matrix_dynamic_dns_additional_configuration_blocks: []
+ddclient_additional_configuration_blocks: []
 
 # Holds the configurations (the domains to update DNS for, the providers they use, etc.)
 #
 # Example:
-# matrix_dynamic_dns_domain_configurations:
+# ddclient_domain_configurations:
 #   - provider: domains.google.com
 #     protocol: dyndn2
 #     username: XXXXXXXXXXXXXXXX
 #     password: XXXXXXXXXXXXXXXX
 #     domain: "{{ matrix_domain }}"
-matrix_dynamic_dns_domain_configurations: []
+ddclient_domain_configurations: []

roles/custom/matrix-dynamic-dns/tasks/main.yml

@@ -12,15 +12,15 @@
     - install-all
     - install-dynamic-dns
   block:
-    - when: matrix_dynamic_dns_enabled | bool
+    - when: ddclient_enabled | bool
       ansible.builtin.include_tasks: "{{ role_path }}/tasks/validate_config.yml"
 
-    - when: matrix_dynamic_dns_enabled | bool
+    - when: ddclient_enabled | bool
       ansible.builtin.include_tasks: "{{ role_path }}/tasks/setup_install.yml"
 
 - tags:
     - setup-all
     - setup-dynamic-dns
   block:
-    - when: not matrix_dynamic_dns_enabled | bool
+    - when: not ddclient_enabled | bool
       ansible.builtin.include_tasks: "{{ role_path }}/tasks/setup_uninstall.yml"

roles/custom/matrix-dynamic-dns/tasks/setup_install.yml

@@ -11,11 +11,11 @@
 
 - name: Ensure Dynamic DNS image is pulled
   community.docker.docker_image:
-    name: "{{ matrix_dynamic_dns_docker_image }}"
+    name: "{{ ddclient_docker_image }}"
     source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
-    force_source: "{{ matrix_dynamic_dns_docker_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}"
-    force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_dynamic_dns_docker_image_force_pull }}"
-  when: matrix_dynamic_dns_enabled | bool and not matrix_dynamic_dns_container_image_self_build
+    force_source: "{{ ddclient_docker_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}"
+    force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else ddclient_docker_image_force_pull }}"
+  when: ddclient_enabled | bool and not ddclient_container_image_self_build
   register: result
   retries: "{{ devture_playbook_help_container_retries_count }}"
   delay: "{{ devture_playbook_help_container_retries_delay }}"
@@ -29,38 +29,38 @@
     owner: "{{ matrix_user_name }}"
     group: "{{ matrix_group_name }}"
   with_items:
-    - {path: "{{ matrix_dynamic_dns_base_path }}", when: true}
-    - {path: "{{ matrix_dynamic_dns_config_path }}", when: true}
-    - {path: "{{ matrix_dynamic_dns_docker_src_files_path }}", when: "{{ matrix_dynamic_dns_container_image_self_build }}"}
-  when: matrix_dynamic_dns_enabled | bool and item.when | bool
+    - {path: "{{ ddclient_base_path }}", when: true}
+    - {path: "{{ ddclient_config_path }}", when: true}
+    - {path: "{{ ddclient_docker_src_files_path }}", when: "{{ ddclient_container_image_self_build }}"}
+  when: ddclient_enabled | bool and item.when | bool
 
 - name: Ensure Dynamic DNS repository is present on self build
   ansible.builtin.git:
-    repo: "{{ matrix_dynamic_dns_container_image_self_build_repo }}"
-    version: "{{ matrix_dynamic_dns_container_image_self_build_repo_branch }}"
-    dest: "{{ matrix_dynamic_dns_docker_src_files_path }}"
+    repo: "{{ ddclient_container_image_self_build_repo }}"
+    version: "{{ ddclient_container_image_self_build_repo_branch }}"
+    dest: "{{ ddclient_docker_src_files_path }}"
     force: "yes"
   become: true
   become_user: "{{ matrix_user_name }}"
-  register: matrix_dynamic_dns_git_pull_results
-  when: "matrix_dynamic_dns_enabled | bool and matrix_dynamic_dns_container_image_self_build | bool"
+  register: ddclient_git_pull_results
+  when: "ddclient_enabled | bool and ddclient_container_image_self_build | bool"
 
 - name: Ensure Dynamic DNS Docker image is built
   community.docker.docker_image:
-    name: "{{ matrix_dynamic_dns_docker_image }}"
+    name: "{{ ddclient_docker_image }}"
     source: build
-    force_source: "{{ matrix_dynamic_dns_git_pull_results.changed if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}"
-    force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_dynamic_dns_git_pull_results.changed }}"
+    force_source: "{{ ddclient_git_pull_results.changed if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}"
+    force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else ddclient_git_pull_results.changed }}"
     build:
       dockerfile: Dockerfile
-      path: "{{ matrix_dynamic_dns_docker_src_files_path }}"
+      path: "{{ ddclient_docker_src_files_path }}"
       pull: true
-  when: "matrix_dynamic_dns_enabled | bool and matrix_dynamic_dns_container_image_self_build | bool"
+  when: "ddclient_enabled | bool and ddclient_container_image_self_build | bool"
 
 - name: Ensure Dynamic DNS ddclient.conf installed
   ansible.builtin.template:
     src: "{{ role_path }}/templates/ddclient.conf.j2"
-    dest: "{{ matrix_dynamic_dns_config_path }}/ddclient.conf"
+    dest: "{{ ddclient_config_path }}/ddclient.conf"
     mode: 0644
     owner: "{{ matrix_user_name }}"
     group: "{{ matrix_group_name }}"
@@ -68,7 +68,7 @@
 - name: Ensure matrix-dynamic-dns container network is created
   community.general.docker_network:
     enable_ipv6: "{{ devture_systemd_docker_base_ipv6_enabled }}"
-    name: "{{ matrix_dynamic_dns_container_network }}"
+    name: "{{ ddclient_container_network }}"
     driver: bridge
     driver_options: "{{ devture_systemd_docker_base_container_networks_driver_options }}"
 

roles/custom/matrix-dynamic-dns/tasks/setup_uninstall.yml

@@ -9,9 +9,9 @@
 - name: Check existence of matrix-dynamic-dns service
   ansible.builtin.stat:
     path: "{{ devture_systemd_docker_base_systemd_path }}/matrix-dynamic-dns.service"
-  register: matrix_dynamic_dns_service_stat
+  register: ddclient_service_stat
 
-- when: matrix_dynamic_dns_service_stat.stat.exists | bool
+- when: ddclient_service_stat.stat.exists | bool
   block:
     - name: Ensure matrix-dynamic-dns is stopped
       ansible.builtin.service:

roles/custom/matrix-dynamic-dns/tasks/validate_config.yml

@@ -8,15 +8,15 @@
 - name: Fail if no matrix-dynamic-dns configurations specified
   ansible.builtin.fail:
     msg: >-
-      You need to define at least one configuration in `matrix_dynamic_dns_domain_configurations` for using matrix-dynamic-dns.
-  when: "matrix_dynamic_dns_domain_configurations | length == 0"
+      You need to define at least one configuration in `ddclient_domain_configurations` for using matrix-dynamic-dns.
+  when: "ddclient_domain_configurations | length == 0"
 
 - name: Fail if required matrix-dynamic-dns settings not defined in configuration blocks
   ansible.builtin.fail:
     msg: >-
-      One of the configurations in matrix_dynamic_dns_domain_configurations is missing a required key (domain, protocol).
+      One of the configurations in ddclient_domain_configurations is missing a required key (domain, protocol).
   when: "'domain' not in configuration or 'protocol' not in configuration"
-  with_items: "{{ matrix_dynamic_dns_domain_configurations }}"
+  with_items: "{{ ddclient_domain_configurations }}"
   loop_control:
     loop_var: configuration
 
@@ -26,7 +26,7 @@
       You need to define a required configuration setting (`{{ item.name }}`).
   when: "item.when | bool and lookup('vars', item.name, default='') | string | length == 0"
   with_items:
-    - {'name': 'matrix_dynamic_dns_container_network', when: true}
+    - {'name': 'ddclient_container_network', when: true}
 
 - name: (Deprecation) Catch and report renamed matrix-dynamic-dns variables
   ansible.builtin.fail:
@@ -34,4 +34,4 @@
       The variable `{{ item.old }}` is deprecated. Please use `{{ item.new }}` instead.
   when: "lookup('ansible.builtin.varnames', ('^' + item.old + '$'), wantlist=True) | length > 0"
   with_items:
-    - {'old': 'matrix_dynamic_dns_container_image_name_prefix', 'new': 'matrix_dynamic_dns_docker_image_registry_prefix'}
+    - {'old': 'ddclient_container_image_name_prefix', 'new': 'ddclient_docker_image_registry_prefix'}

roles/custom/matrix-dynamic-dns/templates/ddclient.conf.j2

@@ -5,21 +5,21 @@ SPDX-FileCopyrightText: 2022 Slavi Pantaleev
 SPDX-License-Identifier: AGPL-3.0-or-later
 #}
 
-daemon={{ matrix_dynamic_dns_daemon_interval }}
+daemon={{ ddclient_daemon_interval }}
 syslog=no
 pid=/var/run/ddclient/ddclient.pid
 ssl=yes
-use={{ matrix_dynamic_dns_use }}
-web='{{ matrix_dynamic_dns_web }}'
-{% if matrix_dynamic_dns_web_skip %}
-web-skip='{{ matrix_dynamic_dns_web_skip }}'
+use={{ ddclient_use }}
+web='{{ ddclient_web }}'
+{% if ddclient_web_skip %}
+web-skip='{{ ddclient_web_skip }}'
 {% endif %}
 
-{% for matrix_dynamic_dns_additional_configuration in matrix_dynamic_dns_additional_configuration_blocks %}
-{{ matrix_dynamic_dns_additional_configuration }}
+{% for ddclient_additional_configuration in ddclient_additional_configuration_blocks %}
+{{ ddclient_additional_configuration }}
 {% endfor %}
 
-{% for dynamic_dns_domain_configuration in matrix_dynamic_dns_domain_configurations %}
+{% for dynamic_dns_domain_configuration in ddclient_domain_configurations %}
 protocol={{ dynamic_dns_domain_configuration.protocol }}
 
 {% if 'apikey' in dynamic_dns_domain_configuration %}

roles/custom/matrix-dynamic-dns/templates/systemd/matrix-dynamic-dns.service.j2

@@ -1,11 +1,11 @@
 #jinja2: lstrip_blocks: True
 [Unit]
 Description=Matrix Dynamic DNS
-{% for service in matrix_dynamic_dns_systemd_required_services_list %}
+{% for service in ddclient_systemd_required_services_list %}
 Requires={{ service }}
 After={{ service }}
 {% endfor %}
-{% for service in matrix_dynamic_dns_systemd_wanted_services_list %}
+{% for service in ddclient_systemd_wanted_services_list %}
 Wants={{ service }}
 {% endfor %}
 DefaultDependencies=no
@@ -20,17 +20,17 @@ ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} create \
 			--rm \
 			--name=matrix-dynamic-dns \
 			--log-driver=none \
-			--network={{ matrix_dynamic_dns_container_network }} \
+			--network={{ ddclient_container_network }} \
   			-e PUID={{ matrix_user_uid }} \
   			-e PGID={{ matrix_user_gid }} \
-			--mount type=bind,src={{ matrix_dynamic_dns_config_path }},dst=/config \
-			{% for arg in matrix_dynamic_dns_container_extra_arguments %}
+			--mount type=bind,src={{ ddclient_config_path }},dst=/config \
+			{% for arg in ddclient_container_extra_arguments %}
 			{{ arg }} \
 			{% endfor %}
-			{{ matrix_dynamic_dns_docker_image }}
+			{{ ddclient_docker_image }}
 
 
-{% for network in matrix_dynamic_dns_container_additional_networks %}
+{% for network in ddclient_container_additional_networks %}
 ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} network connect {{ network }} matrix-dynamic-dns
 {% endfor %}
 

roles/custom/matrix_playbook_migration/tasks/validate_config.yml

@@ -590,6 +590,19 @@
       The following variables in your configuration need to be renamed: {{ lookup('ansible.builtin.varnames', '^matrix_client_cinny_.+', wantlist=True) | join(', ') }}
   when: "lookup('ansible.builtin.varnames', '^matrix_client_cinny_.+', wantlist=True) | length > 0"
 
+- name: (Deprecation) Catch and report matrix-dynamic-dns variables
+  ansible.builtin.fail:
+    msg: |-
+      The matrix-dynamic-dns role in the playbook now lives under the MASH organization (https://github.com/mother-of-all-self-hosting/ansible-role-ddclient).
+      The new role is pretty much the same, but uses differently named variables.
+
+      Please rename all `matrix_dynamic_dns_`-prefixed variables (`matrix_dynamic_dns_*` -> `ddclient_*`) on your configuration file (vars.yml).
+
+      After renaming them, please do not forget to fetch the Ansible role. See docs/maintenance-upgrading-services.md for details about how to do so.
+
+      The following variables in your configuration need to be renamed: {{ lookup('ansible.builtin.varnames', '^matrix_dynamic_dns_.+', wantlist=True) | join(', ') }}
+  when: "lookup('ansible.builtin.varnames', '^matrix_dynamic_dns_.+', wantlist=True) | length > 0"
+
 - name: (Deprecation) Catch and report mautrix-facebook variables
   ansible.builtin.fail:
     msg: |-