From 809e2f8889de00f437d96ed52a7b538f7880d010 Mon Sep 17 00:00:00 2001
From: Tobias Huste <t.huste@hzdr.de>
Date: Thu, 23 Jan 2025 08:52:39 +0100
Subject: [PATCH 1/2] Rename elasticsearch_url variable

The variable is not prefixed with the role name. In order to prevent
name clashes it is renamed to zammad_elasticsearch_url.
---
 roles/zammad/README.md         |  2 +-
 roles/zammad/defaults/main.yml |  2 +-
 roles/zammad/handlers/main.yml |  2 +-
 roles/zammad/tasks/install.yml | 12 ++++++++++++
 4 files changed, 15 insertions(+), 3 deletions(-)

diff --git a/roles/zammad/README.md b/roles/zammad/README.md
index 83c066b6..1d03e3ae 100644
--- a/roles/zammad/README.md
+++ b/roles/zammad/README.md
@@ -119,7 +119,7 @@ configuring multiple domains or the redirection of outdated domains to the
 most recent one.
 
 ```yaml
-elasticsearch_url: "http://localhost:9200"
+zammad_elasticsearch_url: "http://localhost:9200"
 ```
 
 Elasticsearch server address.
diff --git a/roles/zammad/defaults/main.yml b/roles/zammad/defaults/main.yml
index 3280b659..80bcc8d4 100644
--- a/roles/zammad/defaults/main.yml
+++ b/roles/zammad/defaults/main.yml
@@ -15,5 +15,5 @@ zammad_ssl_key_path: "/etc/ssl/private/zammad_key.pem"
 zammad_nginx_additional_server_configs: []
 zammad_nginx_server_tokens: "off"
 
-elasticsearch_url: "http://localhost:9200"
+zammad_elasticsearch_url: "http://localhost:9200"
 ...
diff --git a/roles/zammad/handlers/main.yml b/roles/zammad/handlers/main.yml
index 0b363106..14e721b0 100644
--- a/roles/zammad/handlers/main.yml
+++ b/roles/zammad/handlers/main.yml
@@ -11,7 +11,7 @@
 
 - name: "Set Elasticsearch server address"
   ansible.builtin.command: >-
-    zammad run rails r "Setting.set('es_url', '{{ elasticsearch_url | quote }}')"
+    zammad run rails r "Setting.set('es_url', '{{ zammad_elasticsearch_url | quote }}')"
   changed_when: true
 
 - name: "Build search index"
diff --git a/roles/zammad/tasks/install.yml b/roles/zammad/tasks/install.yml
index c3b38862..d2f8d5c0 100644
--- a/roles/zammad/tasks/install.yml
+++ b/roles/zammad/tasks/install.yml
@@ -5,6 +5,18 @@
 
 ---
 
+- name: "Variable elasticsearch_url is deprecated"
+  ansible.builtin.debug:
+    msg:
+      - "The variable elasticsearch_url is deprecated and will be removed in the next major release."
+      - "Please use zammad_elasticsearch_url instead"
+  when: "elasticsearch_url is defined and elasticsearch_url | length > 0"
+
+- name: "Set variable zammad_elasticsearch_url for backwards compatibility"
+  ansible.builtin.set_fact:
+    zammad_elasticsearch_url: "{{ elasticsearch_url }}"
+  when: "elasticsearch_url is defined and elasticsearch_url | length > 0"
+
 - name: "Configure Zammad repository for Centos-like"
   when: "ansible_distribution | lower == 'centos'"
   block:

From 63297a2db127fc4216d25f11aafe815690ae14f8 Mon Sep 17 00:00:00 2001
From: Tobias Huste <t.huste@hzdr.de>
Date: Thu, 23 Jan 2025 09:00:22 +0100
Subject: [PATCH 2/2] Test deprecation message

---
 roles/zammad/defaults/main.yml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/roles/zammad/defaults/main.yml b/roles/zammad/defaults/main.yml
index 80bcc8d4..3280b659 100644
--- a/roles/zammad/defaults/main.yml
+++ b/roles/zammad/defaults/main.yml
@@ -15,5 +15,5 @@ zammad_ssl_key_path: "/etc/ssl/private/zammad_key.pem"
 zammad_nginx_additional_server_configs: []
 zammad_nginx_server_tokens: "off"
 
-zammad_elasticsearch_url: "http://localhost:9200"
+elasticsearch_url: "http://localhost:9200"
 ...