Rename keepalived_notification_emails variable

Signed-off-by: Norman Ziegner <[email protected]>

Author: Normo

molecule/keepalived/molecule.yml

@@ -35,9 +35,10 @@ provisioner:
             - "172.17.0.3"
             - "172.17.0.4"
           keepalived_virtual_ip_address: "172.17.0.20"
-          keepalived_notification_email:
-            - "root@localhost"
-            - "[email protected]"
+          keepalived_notification_email: "[email protected]"
+          # keepalived_notification_emails:
+          #   - "root@localhost"
+          #   - "[email protected]"
 verifier:
   name: "ansible"
 scenario:

roles/keepalived/README.md

@@ -156,7 +156,7 @@ keepalived_pid_file_path: "/run/keepalived/keepalived.pid"
 List of email accounts that will receive notification mails:
 
 ```yaml
-keepalived_notification_email:
+keepalived_notification_emails:
   - 'root@localhost'
 ```
 

roles/keepalived/defaults/main.yml

@@ -45,7 +45,7 @@ keepalived_pid_file_path: "/run/keepalived/keepalived.pid"
 
 
 # Configure email accounts that will receive notification mails
-keepalived_notification_email: ["root@localhost"]
+keepalived_notification_emails: ["root@localhost"]
 # Configure notification sender
 keepalived_notification_email_from: "keepalived@localhost"
 # Configure SMTP Server

roles/keepalived/tasks/main.yml

@@ -13,6 +13,20 @@
     fail_msg: "Some mandatory variables are not set."
     success_msg: "All mandatory variables are set."
 
+- name: "Variable keepalived_notification_email is deprecated"
+  when: "keepalived_notification_email | default('') | length > 0"
+  block:
+
+    - name: "Set keepalived_notification_emails variable"
+      ansible.builtin.set_fact:
+        keepalived_notification_emails: ["{{ keepalived_notification_email }}"]
+
+    - name: "Show deprecation warning"
+      ansible.builtin.debug:
+        msg:
+          - "The variable keepalived_notification_email is deprecated and will be removed in the next major release."
+          - "Please use list variable 'keepalived_notification_emails' instead."
+
 - name: "Install dependencies for Keepalived."
   become: true
   ansible.builtin.package:

roles/keepalived/templates/keepalived.conf.j2

@@ -11,9 +11,9 @@ global_defs {
 {% if keepalived_set_script_security_flag %}
     enable_script_security
 {% endif %}
-{% if keepalived_notification_email | default([]) | length > 0 %}
+{% if keepalived_notification_emails | default([]) | length > 0 %}
     notification_email {
-{% for email in keepalived_notification_email %}
+{% for email in keepalived_notification_emails %}
         {{ email }}
 {% endfor %}
     }