Redis: slave -> replica (#2867) (#2868)

* Redis: slave -> replica

* Fallback for old Redis versions in CI.

(cherry picked from commit 2d1f5408d3)

Co-authored-by: Felix Fontein <felix@fontein.de>

changelogs/fragments/2867-redis-terminology.yml

@@ -0,0 +1,2 @@
+minor_changes:
+- "redis - allow to use the term ``replica`` instead of ``slave``, which has been the official Redis terminology since 2018 (https://github.com/ansible-collections/community.general/pull/2867)."

plugins/modules/database/misc/redis.py

@@ -10,17 +10,17 @@ __metaclass__ = type
 DOCUMENTATION = '''
 ---
 module: redis
-short_description: Various redis commands, slave and flush
+short_description: Various redis commands, replica and flush
 description:
    - Unified utility to interact with redis instances.
 options:
     command:
         description:
             - The selected redis command
-            - C(config) (new in 1.6), ensures a configuration setting on an instance.
+            - C(config) ensures a configuration setting on an instance.
             - C(flush) flushes all the instance or a specified db.
-            - C(slave) sets a redis instance in slave or master mode.
+            - C(replica) sets a redis instance in replica or master mode. (C(slave) is an alias for C(replica).)
-        choices: [ config, flush, slave ]
+        choices: [ config, flush, replica, slave ]
         type: str
     login_password:
         description:
@@ -38,18 +38,21 @@ options:
         type: int
     master_host:
         description:
-            - The host of the master instance [slave command]
+            - The host of the master instance [replica command]
         type: str
     master_port:
         description:
-            - The port of the master instance [slave command]
+            - The port of the master instance [replica command]
         type: int
-    slave_mode:
+    replica_mode:
         description:
-            - the mode of the redis instance [slave command]
+            - The mode of the redis instance [replica command]
-        default: slave
+            - C(slave) is an alias for C(replica).
-        choices: [ master, slave ]
+        default: replica
+        choices: [ master, replica, slave ]
         type: str
+        aliases:
+            - slave_mode
     db:
         description:
             - The database to flush (used in db mode) [flush command]
@@ -76,7 +79,7 @@ notes:
    - Requires the redis-py Python package on the remote host. You can
      install it with pip (pip install redis) or with a package manager.
      https://github.com/andymccurdy/redis-py
-   - If the redis master instance we are making slave of is password protected
+   - If the redis master instance we are making replica of is password protected
      this needs to be in the redis.conf in the masterauth variable
 
 seealso:
@@ -86,16 +89,16 @@ author: "Xabier Larrakoetxea (@slok)"
 '''
 
 EXAMPLES = '''
-- name: Set local redis instance to be slave of melee.island on port 6377
+- name: Set local redis instance to be a replica of melee.island on port 6377
   community.general.redis:
-    command: slave
+    command: replica
     master_host: melee.island
     master_port: 6377
 
-- name: Deactivate slave mode
+- name: Deactivate replica mode
   community.general.redis:
-    command: slave
+    command: replica
-    slave_mode: master
+    replica_mode: master
 
 - name: Flush all the redis db
   community.general.redis:
@@ -145,7 +148,7 @@ import re
 
 
 # Redis module specific support methods.
-def set_slave_mode(client, master_host, master_port):
+def set_replica_mode(client, master_host, master_port):
     try:
         return client.slaveof(master_host, master_port)
     except Exception:
@@ -174,13 +177,13 @@ def flush(client, db=None):
 def main():
     module = AnsibleModule(
         argument_spec=dict(
-            command=dict(type='str', choices=['config', 'flush', 'slave']),
+            command=dict(type='str', choices=['config', 'flush', 'replica', 'slave']),
             login_password=dict(type='str', no_log=True),
             login_host=dict(type='str', default='localhost'),
             login_port=dict(type='int', default=6379),
             master_host=dict(type='str'),
             master_port=dict(type='int'),
-            slave_mode=dict(type='str', default='slave', choices=['master', 'slave']),
+            replica_mode=dict(type='str', default='replica', choices=['master', 'replica', 'slave'], aliases=["slave_mode"]),
             db=dict(type='int'),
             flush_mode=dict(type='str', default='all', choices=['all', 'db']),
             name=dict(type='str'),
@@ -196,20 +199,24 @@ def main():
     login_host = module.params['login_host']
     login_port = module.params['login_port']
     command = module.params['command']
-
-    # Slave Command section -----------
     if command == "slave":
+        command = "replica"
+
+    # Replica Command section -----------
+    if command == "replica":
         master_host = module.params['master_host']
         master_port = module.params['master_port']
-        mode = module.params['slave_mode']
+        mode = module.params['replica_mode']
+        if mode == "slave":
+            mode = "replica"
 
         # Check if we have all the data
-        if mode == "slave":  # Only need data if we want to be slave
+        if mode == "replica":  # Only need data if we want to be replica
             if not master_host:
-                module.fail_json(msg='In slave mode master host must be provided')
+                module.fail_json(msg='In replica mode master host must be provided')
 
             if not master_port:
-                module.fail_json(msg='In slave mode master port must be provided')
+                module.fail_json(msg='In replica mode master port must be provided')
 
         # Connect and check
         r = redis.StrictRedis(host=login_host, port=login_port, password=login_password)
@@ -223,7 +230,7 @@ def main():
         if mode == "master" and info["role"] == "master":
             module.exit_json(changed=False, mode=mode)
 
-        elif mode == "slave" and info["role"] == "slave" and info["master_host"] == master_host and info["master_port"] == master_port:
+        elif mode == "replica" and info["role"] == "slave" and info["master_host"] == master_host and info["master_port"] == master_port:
             status = dict(
                 status=mode,
                 master_host=master_host,
@@ -234,9 +241,8 @@ def main():
             # Do the stuff
             # (Check Check_mode before commands so the commands aren't evaluated
             # if not necessary)
-            if mode == "slave":
+            if mode == "replica":
-                if module.check_mode or\
+                if module.check_mode or set_replica_mode(r, master_host, master_port):
-                   set_slave_mode(r, master_host, master_port):
                     info = r.info()
                     status = {
                         'status': mode,
@@ -245,7 +251,7 @@ def main():
                     }
                     module.exit_json(changed=True, mode=status)
                 else:
-                    module.fail_json(msg='Unable to set slave mode')
+                    module.fail_json(msg='Unable to set replica mode')
 
             else:
                 if module.check_mode or set_master_mode(r):

tests/integration/targets/redis_info/defaults/main.yml

@@ -1,4 +1,4 @@
 ---
 redis_password: PASS
 master_port: 6379
-slave_port: 6380
+replica_port: 6380

tests/integration/targets/redis_info/tasks/main.yml

@@ -33,9 +33,9 @@
     - result.info.tcp_port == master_port
     - result.info.role == 'master'
 
-- name: redis_info - connect to slave
+- name: redis_info - connect to replica
   community.general.redis_info:
-    login_port: "{{ slave_port }}"
+    login_port: "{{ replica_port }}"
     login_password: "{{ redis_password }}"
   register: result
 
@@ -43,5 +43,5 @@
     that:
     - result is not changed
     - result.info is defined
-    - result.info.tcp_port == slave_port
+    - result.info.tcp_port == replica_port
     - result.info.role == 'slave'

tests/integration/targets/setup_redis_replication/defaults/main.yml

@@ -22,14 +22,21 @@ redis_module: "{{ (ansible_python_version is version('2.7', '>=')) | ternary('re
 
 redis_password: PASS
 
+old_redis: >-
+  {{
+    (ansible_distribution == 'CentOS' and ansible_distribution_major_version|int <= 7) or
+    (ansible_distribution == 'Ubuntu' and ansible_distribution_major_version|int <= 18) or
+    (ansible_os_family == 'FreeBSD' and ansible_distribution_major_version|int <= 12)
+  }}
+
 # Master
 master_port: 6379
 master_conf: /etc/redis-master.conf
 master_datadir: /var/lib/redis-master
 master_logdir: /var/log/redis-master
 
-# Slave
+# Replica
-slave_port: 6380
+replica_port: 6380
-slave_conf: /etc/redis-slave.conf
+replica_conf: /etc/redis-replica.conf
-slave_datadir: /var/lib/redis-slave
+replica_datadir: /var/lib/redis-replica
-slave_logdir: /var/log/redis-slave
+replica_logdir: /var/log/redis-replica

tests/integration/targets/setup_redis_replication/handlers/main.yml

@@ -1,7 +1,7 @@
 - name: stop redis services
   shell: |
     kill -TERM $(cat /var/run/redis_{{ master_port }}.pid)
-    kill -TERM $(cat /var/run/redis_{{ slave_port }}.pid)
+    kill -TERM $(cat /var/run/redis_{{ replica_port }}.pid)
   listen: cleanup redis
 
 - name: remove redis packages
@@ -27,8 +27,8 @@
   - "{{ master_datadir }}"
   - "{{ master_logdir }}"
   - /var/run/redis_{{ master_port }}.pid
-  - "{{ slave_conf }}"
+  - "{{ replica_conf }}"
-  - "{{ slave_datadir }}"
+  - "{{ replica_datadir }}"
-  - "{{ slave_logdir }}"
+  - "{{ replica_logdir }}"
-  - /var/run/redis_{{ slave_port }}.pid
+  - /var/run/redis_{{ replica_port }}.pid
   listen: cleanup redis

tests/integration/targets/setup_redis_replication/tasks/setup_redis_cluster.yml

@@ -1,5 +1,5 @@
 # We run two servers listening different ports
-# to be able to check replication (one server for master, another for slave).
+# to be able to check replication (one server for master, another for replica).
 
 - name: Install redis server apt dependencies
   apt:
@@ -56,8 +56,8 @@
   loop:
   - "{{ master_datadir }}"
   - "{{ master_logdir }}"
-  - "{{ slave_datadir }}"
+  - "{{ replica_datadir }}"
-  - "{{ slave_logdir }}"
+  - "{{ replica_logdir }}"
 
 - name: Create redis configs
   copy:
@@ -75,16 +75,16 @@
     port: "{{ master_port }}"
     logdir: "{{ master_logdir }}"
     datadir: "{{ master_datadir }}"
-  - file: "{{ slave_conf }}"
+  - file: "{{ replica_conf }}"
-    port: "{{ slave_port }}"
+    port: "{{ replica_port }}"
-    logdir: "{{ slave_logdir }}"
+    logdir: "{{ replica_logdir }}"
-    datadir: "{{ slave_datadir }}"
+    datadir: "{{ replica_datadir }}"
 
 - name: Start redis master
   shell: "{{ redis_bin[ansible_distribution] }} {{ master_conf }}"
 
-- name: Start redis slave
+- name: Start redis replica
-  shell: "{{ redis_bin[ansible_distribution] }} {{ slave_conf }} --slaveof 127.0.0.1 {{ master_port }}"
+  shell: "{{ redis_bin[ansible_distribution] }} {{ replica_conf }} --{% if old_redis %}slaveof{% else %}replicaof{% endif %} 127.0.0.1 {{ master_port }}"
 
 - name: Wait for redis master to be started
   ansible.builtin.wait_for:
@@ -95,10 +95,10 @@
     connect_timeout: 5
     timeout: 30
 
-- name: Wait for redis slave to be started
+- name: Wait for redis replica to be started
   ansible.builtin.wait_for:
     host: 127.0.0.1
-    port: "{{ slave_port }}"
+    port: "{{ replica_port }}"
     state: started
     delay: 1
     connect_timeout: 5