From cbc192771114c6a0434b6b9b6896685bc9d66caf Mon Sep 17 00:00:00 2001
From: Suguru Hirahara <acioustick@noreply.codeberg.org>
Date: Wed, 5 Mar 2025 13:19:25 +0900
Subject: [PATCH] Update validate_config.yml for migration: add a hint to
 update Ansible roles

This commit adds the hint to fetch Ansible roles which have been replaced, as it is pretty easy to overlook necessity of doing so, especially if you had not enabled (and disabled thereafter) roles, whose variable names has been changed.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
---
 .../tasks/validate_config.yml                 | 25 +++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/roles/custom/matrix_playbook_migration/tasks/validate_config.yml b/roles/custom/matrix_playbook_migration/tasks/validate_config.yml
index ecb36f762..5476ed382 100644
--- a/roles/custom/matrix_playbook_migration/tasks/validate_config.yml
+++ b/roles/custom/matrix_playbook_migration/tasks/validate_config.yml
@@ -84,6 +84,8 @@
 
       Please change your configuration (vars.yml) to rename all `matrix_postgres`-prefixed variables (`matrix_postgres_*` -> `postgres_*`).
 
+      After changing it, please do not forget to fetch the Ansible role.
+
       The following variables in your configuration need to be renamed: {{ vars | dict2items | selectattr('key', 'match', 'matrix_postgres_.*') | map(attribute='key') | join(', ') }}
   when: "vars | dict2items | selectattr('key', 'match', 'matrix_postgres_.*') | list | items2dict"
 
@@ -95,6 +97,8 @@
 
       Please change your configuration (vars.yml) to rename all `matrix_mailer`-prefixed variables (`matrix_mailer_*` -> `exim_relay_*`).
 
+      After changing it, please do not forget to fetch the Ansible role.
+
       The following variables in your configuration need to be renamed: {{ vars | dict2items | selectattr('key', 'match', 'matrix_mailer_.*') | map(attribute='key') | join(', ') }}
   when: "vars | dict2items | selectattr('key', 'match', 'matrix_mailer_.*') | list | items2dict"
 
@@ -110,6 +114,7 @@
           The matrix-prometheus-node-exporter role that used to be part of this playbook has been replaced by https://github.com/mother-of-all-self-hosting/ansible-role-prometheus-node-exporter.
           The new role is compatible with the old one, but uses different names for its variables.
           Please change your configuration (vars.yml) to rename all variables (`matrix_prometheus_node_exporter_` -> `prometheus_node_exporter_`).
+          After changing it, please do not forget to fetch the Ansible role.
           We found usage of the following variables: {{ matrix_playbook_migration_matrix_prometheus_node_exporter_migration_vars.keys() | join(', ') }}
       when: "matrix_playbook_migration_matrix_prometheus_node_exporter_migration_vars | length > 0"
 
@@ -125,6 +130,7 @@
           The matrix-prometheus-postgres-exporter role that used to be part of this playbook has been replaced by https://github.com/mother-of-all-self-hosting/ansible-role-prometheus-postgres-exporter.
           The new role is compatible with the old one, but uses different names for its variables.
           Please change your configuration (vars.yml) to rename all variables (`matrix_prometheus_postgres_exporter_` -> `prometheus_postgres_exporter_`).
+          After changing it, please do not forget to fetch the Ansible role.
           We found usage of the following variables: {{ matrix_playbook_migration_matrix_prometheus_postgres_exporter_migration_vars.keys() | join(', ') }}
       when: "matrix_playbook_migration_matrix_prometheus_postgres_exporter_migration_vars | length > 0"
 
@@ -140,6 +146,7 @@
           The matrix-backup-borg role that used to be part of this playbook has been replaced by https://github.com/mother-of-all-self-hosting/ansible-role-backup_borg.
           The new role is compatible with the old one, but uses different names for its variables.
           Please change your configuration (vars.yml) to rename all variables (`matrix_backup_borg_` -> `backup_borg_`).
+          After changing it, please do not forget to fetch the Ansible role.
           We found usage of the following variables: {{ matrix_playbook_migration_backup_borg_migration_vars.keys() | join(', ') }}
       when: "matrix_playbook_migration_backup_borg_migration_vars | length > 0"
 
@@ -155,6 +162,7 @@
           The matrix-grafana role that used to be part of this playbook has been replaced by https://github.com/mother-of-all-self-hosting/ansible-role-grafana.
           The new role is compatible with the old one, but uses different names for its variables.
           Please change your configuration (vars.yml) to rename all variables (`matrix_grafana_` -> `grafana_`).
+          After changing it, please do not forget to fetch the Ansible role.
           We found usage of the following variables: {{ matrix_playbook_migration_grafana_migration_vars.keys() | join(', ') }}
       when: "matrix_playbook_migration_grafana_migration_vars | length > 0"
 
@@ -170,6 +178,7 @@
           The matrix-ntfy role that used to be part of this playbook has been replaced by https://github.com/mother-of-all-self-hosting/ansible-role-ntfy.
           The new role is compatible with the old one, but uses different names for its variables.
           Please change your configuration (vars.yml) to rename all variables (`matrix_ntfy_` -> `ntfy_`).
+          After changing it, please do not forget to fetch the Ansible role.
           We found usage of the following variables: {{ matrix_playbook_migration_ntfy_migration_vars.keys() | join(', ') }}
       when: "matrix_playbook_migration_ntfy_migration_vars | length > 0"
 
@@ -185,6 +194,7 @@
           The matrix-redis role that used to be part of this playbook has been replaced by https://github.com/mother-of-all-self-hosting/ansible-role-redis.
           The new role is compatible with the old one, but uses different names for its variables.
           Please change your configuration (vars.yml) to rename all variables (`matrix_redis_` -> `redis_`).
+          After changing it, please do not forget to fetch the Ansible role.
           We found usage of the following variables: {{ matrix_playbook_migration_redis_migration_vars.keys() | join(', ') }}
       when: "matrix_playbook_migration_redis_migration_vars | length > 0"
 
@@ -199,6 +209,7 @@
         msg: >-
           The Redis role that used to be part of this playbook has been superseded by https://github.com/mother-of-all-self-hosting/ansible-role-valkey.
           Please change your configuration (vars.yml) to rename all variables (`redis_` -> `valkey_`).
+          After changing it, please do not forget to fetch the Ansible role.
           We found usage of the following variables: {{ matrix_playbook_migration_redis_migration_vars.keys() | join(', ') }}
       when: "matrix_playbook_migration_redis_migration_vars | length > 0"
 
@@ -213,6 +224,7 @@
         msg: >-
           The KeyDB role that used to be part of this playbook has been superseded by https://github.com/mother-of-all-self-hosting/ansible-role-valkey.
           Please change your configuration (vars.yml) to rename all variables (`keydb_` -> `valkey_`).
+          After changing it, please do not forget to fetch the Ansible role.
           We found usage of the following variables: {{ matrix_playbook_migration_keydb_migration_vars.keys() | join(', ') }}
       when: "matrix_playbook_migration_keydb_migration_vars | length > 0"
 
@@ -228,6 +240,7 @@
           The matrix-etherpad role that used to be part of this playbook has been replaced by https://github.com/mother-of-all-self-hosting/ansible-role-etherpad.
           The new role is compatible with the old one, but uses different names for its variables.
           Please change your configuration (vars.yml) to rename all variables (`matrix_etherpad_` -> `etherpad_`).
+          After changing it, please do not forget to fetch the Ansible role.
           We found usage of the following variables: {{ matrix_playbook_migration_etherpad_migration_vars.keys() | join(', ') }}
       when: "matrix_playbook_migration_etherpad_migration_vars | length > 0"
 
@@ -243,6 +256,7 @@
           The matrix-aux role that used to be part of this playbook has been replaced by https://github.com/mother-of-all-self-hosting/ansible-role-aux.
           The new role is compatible with the old one, but uses different names for its variables.
           Please change your configuration (vars.yml) to rename all variables (`matrix_aux_` -> `aux_`).
+          After changing it, please do not forget to fetch the Ansible role.
           We found usage of the following variables: {{ matrix_playbook_migration_aux_migration_vars.keys() | join(', ') }}
       when: "matrix_playbook_migration_aux_migration_vars | length > 0"
 
@@ -258,6 +272,7 @@
           The matrix-jitsi role that used to be part of this playbook has been replaced by https://github.com/mother-of-all-self-hosting/ansible-role-jitsi.
           The new role is compatible with the old one, but uses different names for its variables.
           Please change your configuration (vars.yml) to rename all variables (`matrix_jitsi_` -> `jitsi_`).
+          After changing it, please do not forget to fetch the Ansible role.
           We found usage of the following variables: {{ matrix_playbook_migration_jitsi_migration_vars.keys() | join(', ') }}
       when: "matrix_playbook_migration_jitsi_migration_vars | length > 0"
 
@@ -423,6 +438,8 @@
 
       Please change your configuration (vars.yml) to rename all `devture_postgres_backup_`-prefixed variables (`devture_postgres_backup_*` -> `postgres_backup_*`).
 
+      After changing it, please do not forget to fetch the Ansible role.
+
       The following variables in your configuration need to be renamed: {{ vars | dict2items | selectattr('key', 'match', 'devture_postgres_backup_.*') | map(attribute='key') | join(', ') }}
   when: "vars | dict2items | selectattr('key', 'match', 'devture_postgres_backup_.*') | list | items2dict"
 
@@ -434,6 +451,8 @@
 
       Please change your configuration (vars.yml) to rename all `devture_postgres_`-prefixed variables (`devture_postgres_*` -> `postgres_*`).
 
+      After changing it, please do not forget to fetch the Ansible role.
+
       The following variables in your configuration need to be renamed: {{ vars | dict2items | selectattr('key', 'match', 'devture_postgres_.*') | map(attribute='key') | join(', ') }}
   when: "vars | dict2items | selectattr('key', 'match', 'devture_postgres_.*') | list | items2dict"
 
@@ -445,6 +464,8 @@
 
       Please change your configuration (vars.yml) to rename all `devture_traefik_certs_dumper_`-prefixed variables (`devture_traefik_certs_dumper_*` -> `traefik_certs_dumper_*`).
 
+      After changing it, please do not forget to fetch the Ansible role.
+
       The following variables in your configuration need to be renamed: {{ vars | dict2items | selectattr('key', 'match', 'devture_traefik_certs_dumper_.*') | map(attribute='key') | join(', ') }}
   when: "vars | dict2items | selectattr('key', 'match', 'devture_traefik_certs_dumper_.*') | list | items2dict"
 
@@ -456,6 +477,8 @@
 
       Please change your configuration (vars.yml) to rename all `devture_traefik_`-prefixed variables (`devture_traefik_*` -> `traefik_*`).
 
+      After changing it, please do not forget to fetch the Ansible role.
+
       The following variables in your configuration need to be renamed: {{ vars | dict2items | selectattr('key', 'match', 'devture_traefik_.*') | map(attribute='key') | join(', ') }}
   when: "vars | dict2items | selectattr('key', 'match', 'devture_traefik_.*') | list | items2dict"
 
@@ -467,6 +490,8 @@
 
       Please change your configuration (vars.yml) to rename all `devture_container_socket_proxy_`-prefixed variables (`devture_container_socket_proxy_*` -> `container_socket_proxy_*`).
 
+      After changing it, please do not forget to fetch the Ansible role.
+
       The following variables in your configuration need to be renamed: {{ vars | dict2items | selectattr('key', 'match', 'devture_container_socket_proxy_.*') | map(attribute='key') | join(', ') }}
   when: "vars | dict2items | selectattr('key', 'match', 'devture_container_socket_proxy_.*') | list | items2dict"