This role installs the MongoDB Community edition server metapackage, mongodb-org, via the OS's package manager. It currently defaults to installing the latest release from version 7, you can install a newer major version by setting mongodb_version: 8.0.12, see 'Tested Platforms and Versions' section for a compatibility matrix.
See Example Playbooks for working examples. This role does not configure the server, it uses the default configuration values and minimal recommended ulimit settings. Its recommended to configure the server for production use, for details see: https://www.mongodb.com/docs/manual/administration/production-notes/
You can install this role with the Ansible Galaxy CLI:
ansible-galaxy install trfore.mongodb_installYou can also include it in a requirements.yml file and install it with ansible-galaxy install -r requirements.yml, using the format:
---
roles:
- trfore.mongodb_install- CentOS Stream 9
- Debian 12
- Ubuntu 22.04 & 24.04
- CentOS Stream 9
- Debian 11 & 12
- Ubuntu 22.04
- CentOS Stream 9
- Debian 11
- Ubuntu 22.04
- CentOS Stream 8
- Debian 10 & 11
- Ubuntu 20.04
- CentOS Stream 8
- Debian 10
- Ubuntu 20.04
ansible-core>=2.17.0
-
community.general.yum_versionlock(for CentOS & RHEL target host) -
community.mongodbrequired whenmongodb_security_authorization: enable, see detail belowansible-galaxy collection install community.general community.mongodb
Common variables are listed below, along with default values (see defaults/main.yml):
| Variable | Default | Description | Required |
|---|---|---|---|
| mongodb_version | 7.0.22 |
MongoDB Community stable releases v4.4, v5, v6, v7, v8 |
No |
| mongodb_version_maj | Automatic | Extracts major value from mongodb_version |
Automatic |
| mongodb_version_maj_minor | Automatic | Extracts major and minor values from mongodb_version |
Automatic |
| mongodb_transparent_hugepages_optimization | false |
Disable Transparent HugePages (THP) for MongoDB ≤ 7 or enable Transparent HugePages (THP) for MongoDB ≥ 8 | No |
| mongodb_security_authorization | disabled |
MongoDB authorization setting in mongod.conf, e.g. enabled or disabled |
No |
| hostname | `` | Set the hostname for the MongoDB server (useful for some monitoring tools). | No |
defaults/main.yml:
| Variable | Default | Description | Required |
|---|---|---|---|
| mongodb_gpg_key | URL | MongoDB GPG Key | No |
| mongodb_pkg_hold | true |
Boolean, true to hold package version |
No |
| mongodb_pkg_hold_list | MongoDB Packages | List of MongoDB packages installed from mongodb-org, v4.4 to v7 |
No |
Set these to automatically create users during provisioning. If mongodb_security_authorization is set to enabled, the users will be created after mongod starts (see defaults/main.yml).
| Variable | Default | Description | Required |
|---|---|---|---|
| disable_logging_for_auth | false |
Boolean, suppress auth info in Ansible output (e.g., passwords) | No |
| mongodb_user_admin_name | UserAdmin |
Administrative user name | No |
| mongodb_user_admin_password | passw01d |
Administrative user password | No |
| mongodb_root_admin_name | RootAdmin |
Root user name | No |
| mongodb_root_admin_password | passw01d |
Root user password | No |
| mongodb_root_backup_name | BackupUser |
Backup user name | No |
| mongodb_root_backup_password | passw01d |
Backup user password | No |
defaults/main.yml:
| Variable | Default | Description | Required |
|---|---|---|---|
| mongodb_systemd_unit_limit_nofile | 64000 |
File descriptor limit | No |
| mongodb_systemd_unit_limit_nproc | 64000 |
Process count limit | No |
vars/debian.yml:
| Variable | Default | Description | Required |
|---|---|---|---|
| mongodb_path_db | /var/lib/mongodb |
PATH, MongoDB database folder | No |
| mongodb_path_log | /var/log/mongodb |
PATH, MongoDB log folder | No |
| mongodb_dependencies | ["libcurl4","openssl","liblzma5"] |
Required packages for MongoDB | No |
| mongodb_pkg_hold_list | MongoDB Packages | List of MongoDB packages installed from mongodb-org |
No |
vars/redhat.yml and vars/redhat_mongo_v{4-8}.yml:
| Variable | Default | Description | Required |
|---|---|---|---|
| mongodb_path_db | /var/lib/mongo |
PATH, MongoDB database folder | No |
| mongodb_path_log | /var/log/mongodb |
PATH, MongoDB log folder | No |
| mongodb_dependencies | ["openssl","xz-libs"] |
Required packages for MongoDB | No |
| mongodb_pkg_hold_list | MongoDB Packages | List of MongoDB packages installed from mongodb-org |
No |
- Package install via distribution's package manager.
- hosts: servers
become: true
roles:
- name: Install MongoDB
role: trfore.mongodb_install- hosts: servers
become: true
vars:
mongodb_version: "8.0.12"
roles:
- name: Install MongoDB
role: trfore.mongodb_install- With authorization, user creation, and THP settings
- hosts: servers
become: true
vars:
hostname: "mongodb-test"
mongodb_version: "8.0.12"
mongodb_net_bindip: "127.0.22.1"
mongodb_net_port: "27017"
mongodb_user_admin_name: main-admin
mongodb_user_admin_password: "mainpassw01d"
mongodb_root_admin_name: root-admin
mongodb_root_admin_password: "rootpassw01d"
mongodb_root_backup_name: backup-user
mongodb_root_backup_password: "backuppassw01d"
mongodb_security_authorization: "enabled"
disable_logging_for_auth: true
mongodb_systemd_unit_limit_nofile: 64000
mongodb_systemd_unit_limit_nproc: 64000
# In MongoDB 8.0 and later, ensure that THP is enabled before mongod starts by creating a service file for your platform's initialization system. If you are using MongoDB 7.0 or earlier, disable THP.
mongodb_transparent_hugepages_optimization: true
# Example of how to add a custom configuration to the mongod.conf file (experimental)
mongodb_config:
processManagement:
fork: false
systemLog:
verbosity: 0
roles:
- name: Install MongoDB
role: trfore.mongodb_installThis Ansible role is MIT.
MongoDB Community is Server Side Public License software from MongoDB, Inc. For additional information see: https://www.mongodb.com/licensing/server-side-public-license
- trfore - original author and maintainer
Special thanks to all those who have contributed to the project! Interested in adding a feature or fixing a bug? Checkout the contributing guide.
| Github | Ansible Galaxy |
|---|---|
| ansible-role-jsvc | trfore.jsvc |
| ansible-role-mongodb-install | trfore.mongodb_install |
| ansible-role-omada-install | trfore.omada_install |
- https://www.mongodb.com/docs/manual/release-notes/
- https://www.mongodb.com/download-center/community/releases
- https://www.mongodb.com/docs/manual/administration/install-on-linux/
- https://www.mongodb.com/docs/manual/administration/production-notes/
- https://www.mongodb.com/docs/manual/reference/configuration-options/
- https://www.mongodb.com/docs/manual/reference/ulimit/
- MongoDB Docs: Disabling Transparent Hugepages (THP) for MongoDB 7 or Earlier
- MongoDB Docs: Enabling Transparent Hugepages (THP) for MongoDB 8