From bac05327d618d6fb76ac88789d5fbb36d1fc98d9 Mon Sep 17 00:00:00 2001 From: Gert van den Berg Date: Thu, 27 Jun 2024 09:32:22 +0200 Subject: [PATCH] Update documentation to remove broken links and refer to the correct minimum pymongo version --- docs/mongodb_module.template.py | 4 ++-- plugins/cache/mongodb.py | 2 +- plugins/lookup/mongodb.py | 4 ++-- plugins/modules/mongodb_balancer.py | 4 ++-- plugins/modules/mongodb_index.py | 2 +- plugins/modules/mongodb_info.py | 2 +- plugins/modules/mongodb_maintenance.py | 4 ++-- plugins/modules/mongodb_oplog.py | 4 ++-- plugins/modules/mongodb_parameter.py | 4 ++-- plugins/modules/mongodb_replicaset.py | 4 ++-- plugins/modules/mongodb_role.py | 4 ++-- plugins/modules/mongodb_schema.py | 2 +- plugins/modules/mongodb_shard.py | 2 +- plugins/modules/mongodb_shard_tag.py | 4 ++-- plugins/modules/mongodb_shard_zone.py | 4 ++-- plugins/modules/mongodb_shutdown.py | 4 ++-- plugins/modules/mongodb_status.py | 4 ++-- plugins/modules/mongodb_stepdown.py | 4 ++-- plugins/modules/mongodb_user.py | 4 ++-- 19 files changed, 33 insertions(+), 33 deletions(-) diff --git a/docs/mongodb_module.template.py b/docs/mongodb_module.template.py index b38f8a688..252ac7be2 100644 --- a/docs/mongodb_module.template.py +++ b/docs/mongodb_module.template.py @@ -25,8 +25,8 @@ default: notes: -- Requires the pymongo Python package on the remote host, version 2.4.2+. This - can be installed using pip or the OS package manager. @see U(http://api.mongodb.org/python/current/installation.html) +- Requires the pymongo Python package on the remote host, version 4+. This + can be installed using pip or the OS package manager. @see U(https://www.mongodb.com/docs/languages/python/pymongo-driver/current/get-started/download-and-install/) requirements: - pymongo ''' diff --git a/plugins/cache/mongodb.py b/plugins/cache/mongodb.py index 0fa7a2cd8..03afaefb5 100644 --- a/plugins/cache/mongodb.py +++ b/plugins/cache/mongodb.py @@ -129,7 +129,7 @@ def _manage_indexes(self, collection): def _collection(self): ''' This is a context manager for opening and closing mongo connections as needed. This exists as to not create a global - connection, due to pymongo not being fork safe (http://api.mongodb.com/python/current/faq.html#is-pymongo-fork-safe) + connection, due to pymongo not being fork safe (https://www.mongodb.com/docs/languages/python/pymongo-driver/current/faq/#is-pymongo-fork-safe-) ''' mongo = pymongo.MongoClient(self._connection) try: diff --git a/plugins/lookup/mongodb.py b/plugins/lookup/mongodb.py index b49c3f334..8c6cf42d7 100644 --- a/plugins/lookup/mongodb.py +++ b/plugins/lookup/mongodb.py @@ -73,11 +73,11 @@ description: - Extra connection parameters that to be sent to pymongo.MongoClient - Check the example to see how to connect to mongo using an SSL certificate. - - "All possible parameters are here: U(https://api.mongodb.com/python/current/api/pymongo/mongo_client.html#pymongo.mongo_client.MongoClient)" + - "All possible parameters are here: U(https://pymongo.readthedocs.io/en/stable/api/pymongo/mongo_client.html#pymongo.mongo_client.MongoClient)" type: dict default: {} notes: - - "Please check https://api.mongodb.org/python/current/api/pymongo/collection.html?highlight=find#pymongo.collection.Collection.find for more details." + - "Please check https://pymongo.readthedocs.io/en/stable/api/pymongo/collection.html#pymongo.collection.Collection.find for more details." requirements: - pymongo >= 2.4 (python library) ''' diff --git a/plugins/modules/mongodb_balancer.py b/plugins/modules/mongodb_balancer.py index 77ce37ed0..f30da1c38 100644 --- a/plugins/modules/mongodb_balancer.py +++ b/plugins/modules/mongodb_balancer.py @@ -65,8 +65,8 @@ type: raw required: false notes: - - Requires the pymongo Python package on the remote host, version 2.4.2+. This - can be installed using pip or the OS package manager. @see U(http://api.mongodb.org/python/current/installation.html) + - Requires the pymongo Python package on the remote host, version 4+. This + can be installed using pip or the OS package manager. @see U(https://www.mongodb.com/docs/languages/python/pymongo-driver/current/get-started/download-and-install/) requirements: - pymongo ''' diff --git a/plugins/modules/mongodb_index.py b/plugins/modules/mongodb_index.py index ee69c093b..c3ad98d24 100644 --- a/plugins/modules/mongodb_index.py +++ b/plugins/modules/mongodb_index.py @@ -39,7 +39,7 @@ - Replica set to connect to (automatically connects to primary for writes). type: str notes: - - Requires the pymongo Python package on the remote host, version 2.4.2+. + - Requires the pymongo Python package on the remote host, version 4+. requirements: - pymongo diff --git a/plugins/modules/mongodb_info.py b/plugins/modules/mongodb_info.py index 3341c870b..44f818171 100644 --- a/plugins/modules/mongodb_info.py +++ b/plugins/modules/mongodb_info.py @@ -38,7 +38,7 @@ elements: str notes: - - Requires the pymongo Python package on the remote host, version 2.4.2+. + - Requires the pymongo Python package on the remote host, version 4+. requirements: - pymongo diff --git a/plugins/modules/mongodb_maintenance.py b/plugins/modules/mongodb_maintenance.py index d470040ce..f31616d90 100644 --- a/plugins/modules/mongodb_maintenance.py +++ b/plugins/modules/mongodb_maintenance.py @@ -29,8 +29,8 @@ type: bool default: false notes: - - Requires the pymongo Python package on the remote host, version 2.4.2+. This - can be installed using pip or the OS package manager. @see U(http://api.mongodb.org/python/current/installation.html) + - Requires the pymongo Python package on the remote host, version 4+. This + can be installed using pip or the OS package manager. @see U(https://www.mongodb.com/docs/languages/python/pymongo-driver/current/get-started/download-and-install/) requirements: - pymongo ''' diff --git a/plugins/modules/mongodb_oplog.py b/plugins/modules/mongodb_oplog.py index 5735f0ddf..78e49805c 100644 --- a/plugins/modules/mongodb_oplog.py +++ b/plugins/modules/mongodb_oplog.py @@ -38,8 +38,8 @@ default: false required: false notes: - - Requires the pymongo Python package on the remote host, version 2.4.2+. This - can be installed using pip or the OS package manager. @see U(http://api.mongodb.org/python/current/installation.html) + - Requires the pymongo Python package on the remote host, version 4+. This + can be installed using pip or the OS package manager. @see U(https://www.mongodb.com/docs/languages/python/pymongo-driver/current/get-started/download-and-install/) requirements: - pymongo ''' diff --git a/plugins/modules/mongodb_parameter.py b/plugins/modules/mongodb_parameter.py index d167cf646..b96f2f369 100644 --- a/plugins/modules/mongodb_parameter.py +++ b/plugins/modules/mongodb_parameter.py @@ -46,9 +46,9 @@ choices: [int, str] notes: - - Requires the pymongo Python package on the remote host, version 2.4.2+. + - Requires the pymongo Python package on the remote host, version 4+. - This can be installed using pip or the OS package manager. - - See also U(http://api.mongodb.org/python/current/installation.html) + - See also U(https://www.mongodb.com/docs/languages/python/pymongo-driver/current/get-started/download-and-install/) requirements: [ "pymongo" ] author: "Loic Blot (@nerzhul)" ''' diff --git a/plugins/modules/mongodb_replicaset.py b/plugins/modules/mongodb_replicaset.py index d6cdaae26..0d9a98660 100644 --- a/plugins/modules/mongodb_replicaset.py +++ b/plugins/modules/mongodb_replicaset.py @@ -111,8 +111,8 @@ - hello default: hello notes: -- Requires the pymongo Python package on the remote host, version 2.4.2+. This - can be installed using pip or the OS package manager. @see U(http://api.mongodb.org/python/current/installation.html) +- Requires the pymongo Python package on the remote host, version 4+. This + can be installed using pip or the OS package manager. @see U(https://www.mongodb.com/docs/languages/python/pymongo-driver/current/get-started/download-and-install/) requirements: - pymongo ''' diff --git a/plugins/modules/mongodb_role.py b/plugins/modules/mongodb_role.py index 23f653c32..a3ef1d76b 100644 --- a/plugins/modules/mongodb_role.py +++ b/plugins/modules/mongodb_role.py @@ -79,9 +79,9 @@ default: false type: bool notes: - - Requires the pymongo Python package on the remote host, version 2.4.2+. This + - Requires the pymongo Python package on the remote host, version 4+. This can be installed using pip or the OS package manager. Newer mongo server versions require newer - pymongo versions. @see http://api.mongodb.org/python/current/installation.html + pymongo versions. @see https://www.mongodb.com/docs/languages/python/pymongo-driver/current/compatibility/ requirements: - "pymongo" author: diff --git a/plugins/modules/mongodb_schema.py b/plugins/modules/mongodb_schema.py index 4443c0c82..0263fa56a 100644 --- a/plugins/modules/mongodb_schema.py +++ b/plugins/modules/mongodb_schema.py @@ -84,7 +84,7 @@ default: false notes: - - Requires the pymongo Python package on the remote host, version 2.4.2+. + - Requires the pymongo Python package on the remote host, version 4+. requirements: - pymongo diff --git a/plugins/modules/mongodb_shard.py b/plugins/modules/mongodb_shard.py index bc37f59db..35d2b33a1 100644 --- a/plugins/modules/mongodb_shard.py +++ b/plugins/modules/mongodb_shard.py @@ -54,7 +54,7 @@ - "present" notes: - - Requires the pymongo Python package on the remote host, version 2.4.2+. + - Requires the pymongo Python package on the remote host, version 4+. requirements: [ pymongo ] ''' diff --git a/plugins/modules/mongodb_shard_tag.py b/plugins/modules/mongodb_shard_tag.py index c6b1a1339..0dade13de 100644 --- a/plugins/modules/mongodb_shard_tag.py +++ b/plugins/modules/mongodb_shard_tag.py @@ -49,8 +49,8 @@ type: str default: "mongos" notes: - - Requires the pymongo Python package on the remote host, version 2.4.2+. This - can be installed using pip or the OS package manager. @see U(http://api.mongodb.org/python/current/installation.html) + - Requires the pymongo Python package on the remote host, version 4+. This + can be installed using pip or the OS package manager. @see U(https://www.mongodb.com/docs/languages/python/pymongo-driver/current/get-started/download-and-install/) requirements: - pymongo ''' diff --git a/plugins/modules/mongodb_shard_zone.py b/plugins/modules/mongodb_shard_zone.py index 1d1c68fde..374fbcdde 100644 --- a/plugins/modules/mongodb_shard_zone.py +++ b/plugins/modules/mongodb_shard_zone.py @@ -54,8 +54,8 @@ type: str default: "mongos" notes: - - Requires the pymongo Python package on the remote host, version 2.4.2+. This - can be installed using pip or the OS package manager. @see U(http://api.mongodb.org/python/current/installation.html) + - Requires the pymongo Python package on the remote host, version 4+. This + can be installed using pip or the OS package manager. @see U(https://www.mongodb.com/docs/languages/python/pymongo-driver/current/get-started/download-and-install/) requirements: - pymongo ''' diff --git a/plugins/modules/mongodb_shutdown.py b/plugins/modules/mongodb_shutdown.py index 60e3f027b..e2ecd6e1a 100644 --- a/plugins/modules/mongodb_shutdown.py +++ b/plugins/modules/mongodb_shutdown.py @@ -33,8 +33,8 @@ type: int default: 10 notes: -- Requires the pymongo Python package on the remote host, version 2.4.2+. This - can be installed using pip or the OS package manager. @see U(http://api.mongodb.org/python/current/installation.html) +- Requires the pymongo Python package on the remote host, version 4+. This + can be installed using pip or the OS package manager. @see U(https://www.mongodb.com/docs/languages/python/pymongo-driver/current/get-started/download-and-install/) requirements: - pymongo ''' diff --git a/plugins/modules/mongodb_status.py b/plugins/modules/mongodb_status.py index 4b7a208db..badd35886 100644 --- a/plugins/modules/mongodb_status.py +++ b/plugins/modules/mongodb_status.py @@ -57,8 +57,8 @@ - minimal default: default notes: -- Requires the pymongo Python package on the remote host, version 2.4.2+. This - can be installed using pip or the OS package manager. @see U(http://api.mongodb.org/python/current/installation.html) +- Requires the pymongo Python package on the remote host, version 4+. This + can be installed using pip or the OS package manager. @see U(https://www.mongodb.com/docs/languages/python/pymongo-driver/current/get-started/download-and-install/) requirements: - pymongo ''' diff --git a/plugins/modules/mongodb_stepdown.py b/plugins/modules/mongodb_stepdown.py index cd0580e7a..79200ebc3 100644 --- a/plugins/modules/mongodb_stepdown.py +++ b/plugins/modules/mongodb_stepdown.py @@ -52,8 +52,8 @@ type: bool default: false notes: - - Requires the pymongo Python package on the remote host, version 2.4.2+. This - can be installed using pip or the OS package manager. @see U(http://api.mongodb.org/python/current/installation.html) + - Requires the pymongo Python package on the remote host, version 4+. This + can be installed using pip or the OS package manager. @see U(https://www.mongodb.com/docs/languages/python/pymongo-driver/current/get-started/download-and-install/) requirements: - pymongo ''' diff --git a/plugins/modules/mongodb_user.py b/plugins/modules/mongodb_user.py index fee4c48c1..37845399d 100644 --- a/plugins/modules/mongodb_user.py +++ b/plugins/modules/mongodb_user.py @@ -79,9 +79,9 @@ - If this file is present (and C(login_user) is not defined), then skip this task. notes: - - Requires the pymongo Python package on the remote host, version 2.4.2+. This + - Requires the pymongo Python package on the remote host, version 4+. This can be installed using pip or the OS package manager. Newer mongo server versions require newer - pymongo versions. @see http://api.mongodb.org/python/current/installation.html + pymongo versions. @see https://www.mongodb.com/docs/languages/python/pymongo-driver/current/compatibility/ requirements: - "pymongo" author: