diff options
Diffstat (limited to 'ansible_collections/community/mongodb/README.md')
| -rw-r--r-- | ansible_collections/community/mongodb/README.md | 33 |
1 files changed, 16 insertions, 17 deletions
diff --git a/ansible_collections/community/mongodb/README.md b/ansible_collections/community/mongodb/README.md index cd86c4322..caadf1e93 100644 --- a/ansible_collections/community/mongodb/README.md +++ b/ansible_collections/community/mongodb/README.md @@ -1,10 +1,8 @@ # MongoDB Version and PyMongoDB Version Compatibility -- This collection is tested against the most recent two minor MongoDB releases, currently 5.0.X and 6.0.X. -- ~This collection is tested against PyMongo version 3.12.X and latest.~ PyMongo 3.12.X dropped on 11.04.2023. Now PyMongo latest only. -- This collection will not run against any MongoDB version lower than 4.0. You can set *strict_compatibility* to false to override this behaviour but don't expect 100% success. It might be a better approach to use an older release of this collection (1.3.4 or earlier) if you're using an old MongoDB version (3.6 or earlier). +- This collection is tested against the most recent two minor MongoDB releases, currently 6.0.X and 7.0.X. +- PyMongo 3.12.X dropped on 11.04.2023. Now PyMongo latest only. - Compatibility may be maintained for older software versions but is not guaranteed. Please upgrade your PyMongo driver version if you encounter difficulties with older versions. -- ~Support for PyMongo versions less than 4.X will be dropped in the future.~ [Drop support for pymongo < 4.0?](https://github.com/ansible-collections/community.mongodb/issues/457) - Support for Pymongo < 4.0 now dropped from collection version 1.5.0 # Mongodb Collection |Category|Status| @@ -12,10 +10,6 @@ |Github CI|| |Codecov|[](https://codecov.io/gh/ansible-collections/community.mongodb)| |CI Roles|| -|AutomatingMongoDBWithAnsible|[](https://github.com/rhysmeister/AutomatingMongoDBWithAnsible/actions/workflows/CI-basic.yml)| -|AutomatingMongoDBWithAnsible|[](https://github.com/rhysmeister/AutomatingMongoDBWithAnsible/actions/workflows/CI-etc.yml)| -|AutomatingMongoDBWithAnsible|[](https://github.com/rhysmeister/AutomatingMongoDBWithAnsible/actions/workflows/CI-resync.yml)| -|AutomatingMongoDBWithAnsible|[](https://github.com/rhysmeister/AutomatingMongoDBWithAnsible/actions/workflows/CI-upgrade-downgrade.yml)| |Latest Build|| This collection called `mongodb` aims at providing all Ansible modules allowing to interact with MongoDB. @@ -58,7 +52,6 @@ These modules are for any MongoDB cluster (standalone, replicaset, or sharded): - `community.mongodb.mongodb_index`: Creates or drops indexes on MongoDB collections. - `community.mongodb.mongodb_info`: Gather information about MongoDB instance. -- `community.mongodb.mongodb_monitoring`: Manages the [free monitoring](https://docs.mongodb.com/manual/administration/free-monitoring/) feature. - `community.mongodb.mongodb_oplog`: [Resizes](https://docs.mongodb.com/manual/tutorial/change-oplog-size) the MongoDB oplog (MongoDB 3.6+ only). - `community.mongodb.mongodb_parameter`: Change an administrative parameter on a MongoDB server. - `community.mongodb.mongodb_role`: Manage [MongoDB Roles](https://www.mongodb.com/docs/upcoming/tutorial/manage-users-and-roles/). @@ -81,6 +74,12 @@ These modules are only useful for sharded MongoDB clusters: - `community.mongodb.mongodb_shard_tag`: Manage Shard Tags. - `community.mongodb.mongodb_shard_zone`: Manage Shard Zones. +These modules are only useful for MongoDB Atlas clusters: + +- `community.mongodb.mongodb_atlas_cluster`: Manage MongoDB clusters in Atlas. +- `community.mongodb.mongodb_atlas_ldap_user`: Manage LDAP users in Atlas. +- `community.mongodb.mongodb_atlas_user`: Manage users in Atlas. +- `community.mongodb.mongodb_atlas_whitelist`: Manage IP whitelists in Atlas. ## community.mongodb Role Tags @@ -111,6 +110,14 @@ These tags apply to the specific roles as indicated. |mongodb_auth|admin_user|Tasks that work with the MongoDB Administrator user.| |mongodb_auth|app_user|Tasks that work with MongoDB app users.| +## Usage Examples + +The following links provide various examples for how the community.mongodb roles and modules can be used in real projects. + +* https://github.com/rhysmeister/AutomatingMongoDBWithAnsible (no longer maintained) +* https://github.com/superset1/Ansible_role_mongodb +* https://github.com/ansible-collections/community.mongodb/tree/master/roles/ROLENAME/molecule (replace ROLENAME, some full examples that we use in our testing) + ## Running the integration and unit tests * Requirements @@ -133,14 +140,6 @@ mkdir -p git/ansible_collections/community cd git/ansible_collections/community ``` -# Usage Examples - -The following links provide various exampels for how the community.mongodb roles and modules can be used in real projects. - -* https://github.com/rhysmeister/AutomatingMongoDBWithAnsible (no longer maintained) -* https://github.com/superset1/Ansible_role_mongodb -* https://github.com/ansible-collections/community.mongodb/tree/master/roles/ROLENAME/molecule (replace ROLENAME, some full examples that we use in our testing) - * Clone the required projects. ```bash |