Undo reuse of redis auth doc fragment

ansible-collections · Feb 23, 2022 · e205260 · e205260
1 parent 036ffb7
commit e205260
Show file tree

Hide file tree

Showing 7 changed files with 41 additions and 50 deletions.
diff --git a/plugins/doc_fragments/redis.py b/plugins/doc_fragments/redis.py
@@ -31,6 +31,11 @@ class ModuleDocFragment(object):
       - Specify the password to authenticate with.
       - Usually not used when target is localhost.
     type: str
+  tls:
+    description:
+      - Specify whether or not to use TLS for the connection.
+    type: bool
+    default: true
   validate_certs:
     description:
       - Specify whether or not to validate TLS certificates.

diff --git a/plugins/doc_fragments/redis_tls_false.py b/plugins/doc_fragments/redis_tls_false.py
diff --git a/plugins/doc_fragments/redis_tls_true.py b/plugins/doc_fragments/redis_tls_true.py
diff --git a/plugins/modules/database/misc/redis.py b/plugins/modules/database/misc/redis.py
@@ -22,15 +22,46 @@
             - C(replica) sets a redis instance in replica or master mode. (C(slave) is an alias for C(replica).)
         choices: [ config, flush, replica, slave ]
         type: str
+    login_password:
+        description:
+            - The password used to authenticate with (usually not used)
+        type: str
+    login_host:
+        description:
+            - The host running the database
+        default: localhost
+        type: str
+    login_port:
+        description:
+            - The port to connect to
+        default: 6379
+        type: int
     tls:
-      default: false
-      version_added: 4.6.0
+        description:
+            - Specify whether or not to use TLS for the connection.
+        type: bool
+        default: false
+        version_added: 4.6.0
     login_user:
-      version_added: 4.6.0
+        description:
+            - Specify the user to authenticate with.
+            - Requires L(redis,https://pypi.org/project/redis) >= 3.4.0.
+        type: str
+        version_added: 4.6.0
     validate_certs:
-      version_added: 4.6.0
+        description:
+            - Specify whether or not to validate TLS certificates.
+            - This should only be turned off for personally controlled sites or with
+              C(localhost) as target.
+        type: bool
+        default: true
+        version_added: 4.6.0
     ca_certs:
-      version_added: 4.6.0
+        description:
+            - Path to root certificates file. If not set and I(tls) is
+              set to C(true), certifi ca-certificates will be used.
+        type: str
+        version_added: 4.6.0
     master_host:
         description:
             - The host of the master instance [replica command]
@@ -70,10 +101,6 @@
               Units are case insensitive i.e. 1m = 1mb = 1M = 1MB.
         type: str
 
-extends_documentation_fragment:
-  - community.general.redis.documentation
-  - community.general.redis_tls_false.documentation
-
 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.

diff --git a/plugins/modules/database/misc/redis_data.py b/plugins/modules/database/misc/redis_data.py
@@ -58,7 +58,6 @@
 
 extends_documentation_fragment:
   - community.general.redis.documentation
-  - community.general.redis_tls_true.documentation
 
 seealso:
     - module: community.general.redis_data_incr

diff --git a/plugins/modules/database/misc/redis_data_incr.py b/plugins/modules/database/misc/redis_data_incr.py
@@ -41,7 +41,6 @@
 
 extends_documentation_fragment:
   - community.general.redis.documentation
-  - community.general.redis_tls_true.documentation
 
 notes:
    - For C(check_mode) to work, the specified I(redis_user) needs permission to

diff --git a/plugins/modules/database/misc/redis_data_info.py b/plugins/modules/database/misc/redis_data_info.py
@@ -24,7 +24,6 @@
 
 extends_documentation_fragment:
   - community.general.redis
-  - community.general.redis_tls_true.documentation
 
 seealso:
   - module: community.general.redis_data