[PR #10863/9d0150b2 backport][stable-11] [doc] update requirements for all consul modules/lookups (#10872)

[doc] update requirements for all consul modules/lookups (#10863)

* [doc] update requirements for consul_kv module

python-consul has been unmaintained for a while. It uses a legacy way of passing the Consul token when sending requests. This leads to warning messages in Consul log, and will eventually break communication. Using the maintained py-consul library ensures compatibility to newer Consul versions.

* [doc] replace all python-consul occurrences with py-consul

* [fix] tests and possible pip server errors

* [chore] remove referencce to python-consul in comment

---------


(cherry picked from commit 9d0150b2c3)

Co-authored-by: Sebastian Damm <SipSeb@users.noreply.github.com>
Co-authored-by: Sebastian Damm <sebastian.damm@pascom.net>

plugins/lookup/consul_kv.py

@@ -16,7 +16,7 @@ description:
     with simple rest commands.
   - C(curl -X PUT -d 'some-value' http://localhost:8500/v1/kv/ansible/somedata).
 requirements:
-  - 'python-consul python library U(https://python-consul.readthedocs.io/en/latest/#installation)'
+  - 'py-consul python library U(https://github.com/criteo/py-consul?tab=readme-ov-file#installation)'
 options:
   _raw:
     description: List of key(s) to retrieve.
@@ -131,7 +131,7 @@ class LookupModule(LookupBase):
 
         if not HAS_CONSUL:
             raise AnsibleError(
-                'python-consul is required for consul_kv lookup. see http://python-consul.readthedocs.org/en/latest/#installation')
+                'py-consul is required for consul_kv lookup. see https://github.com/criteo/py-consul?tab=readme-ov-file#installation')
 
         # get options
         self.set_options(direct=kwargs)

plugins/modules/consul.py

@@ -25,7 +25,7 @@ description:
     metadata so at that stage change management is to be added.
   - See U(http://consul.io) for more details.
 requirements:
-  - python-consul
+  - py-consul
   - requests
 author: "Steve Gargan (@sgargan)"
 extends_documentation_fragment:
@@ -549,7 +549,7 @@ class ConsulCheck(object):
 
 def test_dependencies(module):
     if not python_consul_installed:
-        module.fail_json(msg="python-consul required for this module. see https://python-consul.readthedocs.io/en/latest/#installation")
+        module.fail_json(msg="py-consul required for this module. see https://github.com/criteo/py-consul?tab=readme-ov-file#installation")
 
 
 def main():

plugins/modules/consul_kv.py

@@ -20,7 +20,7 @@ description:
     of the results.
   - See http://www.consul.io/docs/agent/http.html#kv for more details.
 requirements:
-  - python-consul
+  - py-consul
   - requests
 author:
   - Steve Gargan (@sgargan)
@@ -150,8 +150,8 @@ except ImportError:
 
 from ansible.module_utils.basic import AnsibleModule
 
-# Note: although the python-consul documentation implies that using a key with a value of `None` with `put` has a
-# special meaning (https://python-consul.readthedocs.io/en/latest/#consul-kv), if not set in the subsequently API call,
+# Note: although the py-consul implementation implies that using a key with a value of `None` with `put` has a special
+# meaning (https://github.com/criteo/py-consul/blob/master/consul/api/kv.py), if not set in the subsequently API call,
 # the value just defaults to an empty string (https://www.consul.io/api/kv.html#create-update-key)
 NOT_SET = None