Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the docs to mention that minimum pymongo version is 4 and fix links #656

Merged
merged 1 commit into from
Jun 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/mongodb_module.template.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@
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
'''
Expand Down
2 changes: 1 addition & 1 deletion plugins/cache/mongodb.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions plugins/lookup/mongodb.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)
'''
Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/mongodb_balancer.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
'''
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/mongodb_index.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/mongodb_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/mongodb_maintenance.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
'''
Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/mongodb_oplog.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
'''
Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/mongodb_parameter.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)"
'''
Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/mongodb_replicaset.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
'''
Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/mongodb_role.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/mongodb_schema.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/mongodb_shard.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 ]
'''

Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/mongodb_shard_tag.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
'''
Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/mongodb_shard_zone.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
'''
Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/mongodb_shutdown.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
'''
Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/mongodb_status.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
'''
Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/mongodb_stepdown.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
'''
Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/mongodb_user.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading