Install MongoDB Enterprise Edition on Red Hat or CentOS
On this page
Note
MongoDB Atlas
MongoDB Atlas is a hosted MongoDB service option in the cloud which requires no installation overhead and offers a free tier to get started.
Overview
Use this tutorial to install MongoDB 5.0 Enterprise Edition on
Red Hat Enterprise Linux, CentOS Linux, or Oracle Linux [1]
using the yum
package manager.
MongoDB Enterprise Edition is available on select platforms and contains support for several features related to security and monitoring.
MongoDB Version
This tutorial installs MongoDB 5.0 Enterprise Edition. To install a different version of MongoDB Enterprise, use the version drop-down menu in the upper-left corner of this page to select the documentation for that version.
Considerations
Platform Support
Note
EOL Notice
MongoDB 5.0 Enterprise Edition supports the following 64-bit versions of Red Hat Enterprise Linux (RHEL), CentOS Linux, Oracle Linux [1], Rocky Linux, and AlmaLinux [2] on x86_64 architecture:
RHEL / CentOS / Oracle / Rocky / Alma 8
RHEL / CentOS / Oracle 7
MongoDB only supports the 64-bit versions of these platforms.
MongoDB 5.0 Enterprise Edition on RHEL / CentOS / Oracle / Rocky / Alma Linux also supports the ARM64 architecture on select platforms.
See Platform Support for more information.
[1] | (1, 2) MongoDB only supports Oracle Linux running the Red Hat Compatible Kernel (RHCK). MongoDB does not support the Unbreakable Enterprise Kernel (UEK). |
[2] | MongoDB on-premises products released for RHEL version 8.0+ are compatible with and supported on Rocky Linux version 8.0+ and AlmaLinux version 8.0+, contingent upon those distributions meeting their obligation to deliver full RHEL compatibility. |
Production Notes
Before deploying MongoDB in a production environment, consider the Production Notes for Self-Managed Deployments document which offers performance considerations and configuration recommendations for production MongoDB deployments.
Install MongoDB Enterprise Edition
Follow these steps to install MongoDB Enterprise Edition using the
yum
package manager.
Configure the Repository
Create an
/etc/yum.repos.d/mongodb-enterprise-5.0.repo
file so
that you can install MongoDB Enterprise directly using yum
:
[mongodb-enterprise-5.0] name=MongoDB Enterprise Repository baseurl=https://repo.mongodb.com/yum/redhat/8/mongodb-enterprise/5.0/$basearch/ gpgcheck=1 enabled=1 gpgkey=https://pgp.mongodb.com/server-5.0.asc
[mongodb-enterprise-5.0] name=MongoDB Enterprise Repository baseurl=https://repo.mongodb.com/yum/redhat/7/mongodb-enterprise/5.0/$basearch/ gpgcheck=1 enabled=1 gpgkey=https://pgp.mongodb.com/server-5.0.asc
Note
If you have a mongodb-enterprise.repo
file
in this directory from a previous installation of MongoDB, you
should remove it. Use the mongodb-enterprise-5.0.repo
file above to install MongoDB 5.0.
You can also download the .rpm
files directly from the
MongoDB repository.
Downloads are organized by Red Hat / CentOS
version (e.g. 9
), then MongoDB
release version
(e.g. 5.0
), then architecture (e.g. x86_64
).
Prior to MongoDB 5.0, odd-numbered MongoDB release versions, such as
4.3
, were development releases. Beginning with MongoDB 5.1,
MongoDB has quarterly rapid releases. For more information on the
differences between rapid and long-term support releases, see
MongoDB Versioning.
Install MongoDB Enterprise Server
To install the latest stable version of MongoDB Enterprise 5.0, issue the following command:
sudo yum install -y mongodb-enterprise
To install a specific release, you must specify each component package individually along with the version number, as in the following example:
sudo yum install -y mongodb-enterprise-5.0.29 mongodb-enterprise-database-5.0.29 mongodb-enterprise-server-5.0.29 mongodb-enterprise-shell-5.0.29 mongodb-enterprise-mongos-5.0.29 mongodb-enterprise-tools-5.0.29
Note
Although you can specify any available version of MongoDB
Enterprise, yum
upgrades the packages when a newer
version becomes available. To prevent unintended upgrades,
pin the package by adding the following exclude
directive
to your /etc/yum.conf
file:
exclude=mongodb-enterprise,mongodb-enterprise-database,mongodb-enterprise-server,mongodb-enterprise-shell,mongodb-enterprise-mongos,mongodb-enterprise-tools
Run MongoDB Enterprise Edition
Prerequisites
ulimit
Most Unix-like operating systems limit the system resources that a
process may use. These limits may negatively impact MongoDB operation,
and should be adjusted. See UNIX ulimit
Settings for Self-Managed Deployments for the recommended
settings for your platform.
Note
If the ulimit
value for number of open files is under 64000
, MongoDB
generates a startup warning.
Directory Paths
To Use Default Directories
By default, MongoDB runs using the mongod
user account and
uses the following default directories:
/var/lib/mongo
(the data directory)/var/log/mongodb
(the log directory)
The package manager creates the default directories during
installation. The owner and group name are mongod
.
To Use Non-Default Directories
To use a data directory and/or log directory other than the default directories:
Create the new directory or directories.
Edit the configuration file
/etc/mongod.conf
and modify the following fields accordingly:storage.dbPath
to specify a new data directory path (e.g./some/data/directory
)systemLog.path
to specify a new log file path (e.g./some/log/directory/mongod.log
)
Ensure that the user running MongoDB has access to the directory or directories:
sudo chown -R mongod:mongod <directory> If you change the user that runs the MongoDB process, you must give the new user access to these directories.
Configure SELinux if enforced. See Configure SELinux.
Configure SELinux
Important
If SELinux is in enforcing
mode, you must customize your SELinux
policy for MongoDB by making the following two policy adjustments:
Permit Access to cgroup
The current SELinux Policy does not allow the MongoDB process to
access /sys/fs/cgroup
, which is required to determine
the available memory on your system. If you intend to run SELinux in
enforcing
mode, you will need to make the following adjustment
to your SELinux policy:
Ensure your system has the
checkpolicy
package installed:sudo yum install checkpolicy Create a custom policy file
mongodb_cgroup_memory.te
:cat > mongodb_cgroup_memory.te <<EOF module mongodb_cgroup_memory 1.0; require { type cgroup_t; type mongod_t; class dir search; class file { getattr open read }; } #============= mongod_t ============== allow mongod_t cgroup_t:dir search; allow mongod_t cgroup_t:file { getattr open read }; EOF Once created, compile and load the custom policy module by running these three commands:
checkmodule -M -m -o mongodb_cgroup_memory.mod mongodb_cgroup_memory.te semodule_package -o mongodb_cgroup_memory.pp -m mongodb_cgroup_memory.mod sudo semodule -i mongodb_cgroup_memory.pp
The MongoDB process is now able to access the correct files with
SELinux set to enforcing
.
Permit Access to netstat
for FTDC
The current SELinux Policy does not allow the MongoDB process to open
and read /proc/net/netstat
, which is required for
Full Time Diagnostic Data Capture (FTDC).
If you intend to run SELinux in
enforcing
mode, you will need to make the following adjustment
to your SELinux policy:
Ensure your system has the
checkpolicy
package installed:sudo yum install checkpolicy Create a custom policy file
mongodb_proc_net.te
:cat > mongodb_proc_net.te <<EOF module mongodb_proc_net 1.0; require { type cgroup_t; type configfs_t; type file_type; type mongod_t; type proc_net_t; type sysctl_fs_t; type var_lib_nfs_t; class dir { search getattr }; class file { getattr open read }; } #============= mongod_t ============== allow mongod_t cgroup_t:dir { search getattr } ; allow mongod_t cgroup_t:file { getattr open read }; allow mongod_t configfs_t:dir getattr; allow mongod_t file_type:dir { getattr search }; allow mongod_t file_type:file getattr; allow mongod_t proc_net_t:file { open read }; allow mongod_t sysctl_fs_t:dir search; allow mongod_t var_lib_nfs_t:dir search; EOF Once created, compile and load the custom policy module by running these three commands:
checkmodule -M -m -o mongodb_proc_net.mod mongodb_proc_net.te semodule_package -o mongodb_proc_net.pp -m mongodb_proc_net.mod sudo semodule -i mongodb_proc_net.pp
Important
In addition to the above, you will also need to further customize
your SELinux policy in the following two cases if SELinux is in
enforcing
mode:
You are using a custom directory path instead of using the default
dbPath
,systemLog.path
, orpidFilePath
in RHEL 7.0 or later, and/orYou are using a custom port instead of using the default MongoDB ports.
Using a Custom MongoDB Directory Path
Update the SELinux policy to allow the
mongod
service to use the new directory:sudo semanage fcontext -a -t <type> </some/MongoDB/directory.*> where specify one of the following types as appropriate:
mongod_var_lib_t
for data directorymongod_log_t
for log file directorymongod_var_run_t
for pid file directory
Note
Be sure to include the
.*
at the end of the directory.Update the SELinux user policy for the new directory:
sudo chcon -Rv -u system_u -t <type> </some/MongoDB/directory> where specify one of the following types as appropriate:
mongod_var_lib_t
for data directorymongod_log_t
for log directorymongod_var_run_t
for pid file directory
Apply the updated SELinux policies to the directory:
sudo restorecon -R -v </some/MongoDB/directory>
For example:
Tip
Be sure to include the .*
at the end of the directory for the
semanage fcontext
operations.
If using a non-default MongoDB data path of
/mongodb/data
:sudo semanage fcontext -a -t mongod_var_lib_t '/mongodb/data.*' sudo chcon -Rv -u system_u -t mongod_var_lib_t '/mongodb/data' sudo restorecon -R -v '/mongodb/data' If using a non-default MongoDB log directory of
/mongodb/log
(e.g. if the log file path is/mongodb/log/mongod.log
):sudo semanage fcontext -a -t mongod_log_t '/mongodb/log.*' sudo chcon -Rv -u system_u -t mongod_log_t '/mongodb/log' sudo restorecon -R -v '/mongodb/log'
Using a Custom MongoDB Port
sudo semanage port -a -t mongod_port_t -p tcp <portnumber>
Note
You might need to restart mongod
for the custom port
to be recognized.
Procedure
Follow these steps to run MongoDB Enterprise Edition on your system. These instructions assume that you are using the default settings.
Init System
To run and manage your mongod
process, you will be using
your operating system's built-in init system. Recent versions of
Linux tend to use systemd (which uses the systemctl
command),
while older versions of Linux tend to use System V init (which uses
the service
command).
If you are unsure which init system your platform uses, run the following command:
ps --no-headers -o comm 1
Then select the appropriate tab below based on the result:
systemd
- select the systemd (systemctl) tab below.init
- select the System V Init (service) tab below.
Start MongoDB.
You can start the mongod
process by issuing the
following command:
sudo systemctl start mongod
If you receive an error similar to the following when starting
mongod
:
Failed to start mongod.service: Unit mongod.service not found.
Run the following command first:
sudo systemctl daemon-reload
Then run the start command above again.
Verify that MongoDB has started successfully.
You can verify that the mongod
process has started
successfully by issuing the following command:
sudo systemctl status mongod
You can optionally ensure that MongoDB will start following a system reboot by issuing the following command:
sudo systemctl enable mongod
Stop MongoDB.
As needed, you can stop the mongod
process by issuing the
following command:
sudo systemctl stop mongod
Restart MongoDB.
You can restart the mongod
process by issuing the following
command:
sudo systemctl restart mongod
You can follow the state of the process for errors or important messages
by watching the output in the /var/log/mongodb/mongod.log
file.
Begin using MongoDB.
Start a mongosh
session on the same host machine as the
mongod
. You can run mongosh
without any command-line options to connect to a
mongod
that is running on your localhost with default
port 27017.
mongosh
For more information on connecting using mongosh
,
such as to connect to a mongod
instance running
on a different host and/or port, see the
mongosh documentation.
To help you start using MongoDB, MongoDB provides Getting Started Guides in various driver editions. For the driver documentation, see Start Developing with MongoDB.
Start MongoDB.
You can start the mongod
process by issuing the following
command:
sudo service mongod start
Verify that MongoDB has started successfully
You can verify that the mongod
process has started
successfully by checking the contents of the log file at
/var/log/mongodb/mongod.log
for a line reading
[initandlisten] waiting for connections on port <port>
where <port>
is the port configured in /etc/mongod.conf
, 27017
by default.
You can optionally ensure that MongoDB will start following a system reboot by issuing the following command:
sudo chkconfig mongod on
Stop MongoDB.
As needed, you can stop the mongod
process by issuing the
following command:
sudo service mongod stop
Restart MongoDB.
You can restart the mongod
process by issuing the following
command:
sudo service mongod restart
You can follow the state of the process for errors or important messages
by watching the output in the /var/log/mongodb/mongod.log
file.
Begin using MongoDB.
Start a mongosh
session on the same host machine as the
mongod
. You can run mongosh
without any command-line options to connect to a
mongod
that is running on your localhost with default
port 27017.
mongosh
For more information on connecting using mongosh
,
such as to connect to a mongod
instance running
on a different host and/or port, see the
mongosh documentation.
To help you start using MongoDB, MongoDB provides Getting Started Guides in various driver editions. For the driver documentation, see Start Developing with MongoDB.
Uninstall MongoDB
To completely remove MongoDB from a system, you must remove the MongoDB applications themselves, the configuration files, and any directories containing data and logs. The following section guides you through the necessary steps.
Warning
This process will completely remove MongoDB, its configuration, and all databases. This process is not reversible, so ensure that all of your configuration and data is backed up before proceeding.
Stop MongoDB.
Stop the mongod
process by issuing the following command:
sudo service mongod stop
Additional Information
Localhost Binding by Default
By default, MongoDB launches with bindIp
set to
127.0.0.1
, which binds to the localhost network interface. This
means that the mongod
can only accept connections from
clients that are running on the same machine. Remote clients will not be
able to connect to the mongod
, and the mongod
will
not be able to initialize a replica set unless this value is set
to a valid network interface which is accessible from the remote clients.
This value can be configured either:
Warning
Before binding to a non-localhost (e.g. publicly accessible) IP address, ensure you have secured your cluster from unauthorized access. For a complete list of security recommendations, see Security Checklist for Self-Managed Deployments. At minimum, consider enabling authentication and hardening network infrastructure.
For more information on configuring bindIp
, see
IP Binding in Self-Managed Deployments.
MongoDB Enterprise Edition Packages
MongoDB Enterprise Edition is available from its own dedicated repository, and contains the following officially-supported packages:
Package Name | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
mongodb-enterprise | A metapackage that automatically installs the component
packages listed below. | ||||||||||
mongodb-enterprise-database | A
| ||||||||||
mongodb-mongosh | Contains the MongoDB Shell ( mongosh ). | ||||||||||
mongodb-enterprise-tools | A
|