Navigation

Install MongoDB Enterprise Edition on Amazon Linux

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 4.2 Enterprise Edition on Amazon Linux using the yum package manager.

MongoDB Enterprise Edition is available on select platforms and contains support for several features related to security and monitoring.

Verify Linux Distribution

You can verify which Linux distribution you are running by running the following command on the command-line:

grep ^NAME  /etc/*release

The result should be Amazon Linux or Amazon Linux AMI. If using a different Linux distribution, please see the install instructions for your platform.

MongoDB Version

This tutorial installs MongoDB 4.2 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

MongoDB 4.2 Enterprise Edition supports the following 64-bit Amazon Linux releases on x86_64 architecture:

  • Amazon Linux 2
  • Amazon Linux (2013.03 or later)

MongoDB only supports the 64-bit versions of these platforms.

See Supported Platforms for more information.

Production Notes

Before deploying MongoDB in a production environment, consider the Production Notes 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. Select the tab for your version of Amazon Linux:

1

Configure repository.

Create an /etc/yum.repos.d/mongodb-enterprise-4.2.repo file so that you can install MongoDB enterprise directly using yum:

[mongodb-enterprise-4.2]
name=MongoDB Enterprise Repository
baseurl=https://repo.mongodb.com/yum/amazon/2/mongodb-enterprise/4.2/$basearch/
gpgcheck=1
enabled=1
gpgkey=https://www.mongodb.org/static/pgp/server-4.2.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-4.2.repo file above to install MongoDB 4.2.

You can also download the .rpm files directly from the MongoDB repository. Downloads are organized by Amazon Linux version (e.g. 2), then MongoDB release version (e.g. 4.2), then architecture (e.g. x86_64). Odd-numbered MongoDB release versions, such as 4.3, are development versions and are unsuitable for production deployment.

2

Install the MongoDB Enterprise packages.

Install MongoDB Enterprise 4.2.

Issue the following command:

sudo yum install -y mongodb-enterprise

Install a specific release of 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-4.2.8 mongodb-enterprise-server-4.2.8 mongodb-enterprise-shell-4.2.8 mongodb-enterprise-mongos-4.2.8 mongodb-enterprise-tools-4.2.8

If you only install mongodb-enterprise=4.2.8 and do not include the component packages, the latest version of each MongoDB package will be installed regardless of what version you specified.

Pin a specific version of MongoDB Enterprise.

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-server,mongodb-enterprise-shell,mongodb-enterprise-mongos,mongodb-enterprise-tools
1

Configure repository.

Create an /etc/yum.repos.d/mongodb-enterprise-4.2.repo file so that you can install MongoDB enterprise directly using yum:

[mongodb-enterprise-4.2]
name=MongoDB Enterprise Repository
baseurl=https://repo.mongodb.com/yum/amazon/2013.03/mongodb-enterprise/4.2/$basearch/
gpgcheck=1
enabled=1
gpgkey=https://www.mongodb.org/static/pgp/server-4.2.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-4.2.repo file above to install MongoDB 4.2.

You can also download the .rpm files directly from the MongoDB repository. Downloads are organized by Amazon Linux version (e.g. 2013.03), then MongoDB release version (e.g. 4.2), then architecture (e.g. x86_64). Odd-numbered MongoDB release versions, such as 4.3, are development versions and are unsuitable for production deployment.

2

Install the MongoDB Enterprise packages.

Install MongoDB Enterprise 4.2.

Issue the following command:

sudo yum install -y mongodb-enterprise

Install a specific release of 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-4.2.8 mongodb-enterprise-server-4.2.8 mongodb-enterprise-shell-4.2.8 mongodb-enterprise-mongos-4.2.8 mongodb-enterprise-tools-4.2.8

If you only install mongodb-enterprise=4.2.8 and do not include the component packages, the latest version of each MongoDB package will be installed regardless of what version you specified.

Pin a specific version of MongoDB Enterprise.

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-server,mongodb-enterprise-shell,mongodb-enterprise-mongos,mongodb-enterprise-tools

Run MongoDB Enterprise Edition

ulimit Considerations
Most Unix-like operating systems limit the system resources that a session may use. These limits may negatively impact MongoDB operation. See UNIX ulimit Settings for more information.
Directories

By default, MongoDB instance stores:

  • its data files in /var/lib/mongo
  • its log files in /var/log/mongodb

If you installed via the package manager, these default directories are created during the installation.

If you installed manually by downloading the tarballs, you can create the directories using mkdir -p <directory> or sudo mkdir -p <directory> depending on the user that will run MongoDB. (See your linux man pages for information on mkdir and sudo.)

By default, MongoDB runs using the mongod user account. If you change the user that runs the MongoDB process, you must also modify the permission to the /var/lib/mongo and /var/log/mongodb directories to give this user access to these directories.

To specify a different log file directory and data file directory, edit the systemLog.path and storage.dbPath settings in the /etc/mongod.conf. Ensure that the user running MongoDB has access to these directories.

Procedure

Follow these steps to run MongoDB Enterprise Edition. 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.

1

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.

2

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
3

Stop MongoDB.

As needed, you can stop the mongod process by issuing the following command:

sudo systemctl stop mongod
4

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.

5

Begin using MongoDB.

Start a mongo shell on the same host machine as the mongod. You can run the mongo shell without any command-line options to connect to a mongod that is running on your localhost with default port 27017:

mongo

For more information on connecting using the mongo shell, such as to connect to a mongod instance running on a different host and/or port, see The mongo Shell.

To help you start using MongoDB, MongoDB provides Getting Started Guides in various driver editions. See Getting Started for the available editions.

1

Start MongoDB.

You can start the mongod process by issuing the following command:

sudo service mongod start
2

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
3

Stop MongoDB.

As needed, you can stop the mongod process by issuing the following command:

sudo service mongod stop
4

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.

5

Begin using MongoDB.

Start a mongo shell on the same host machine as the mongod. You can run the mongo shell without any command-line options to connect to a mongod that is running on your localhost with default port 27017:

mongo

For more information on connecting using the mongo shell, such as to connect to a mongod instance running on a different host and/or port, see The mongo Shell.

To help you start using MongoDB, MongoDB provides Getting Started Guides in various driver editions. See Getting Started for the available editions.

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.

1

Stop MongoDB.

Stop the mongod process by issuing the following command:

sudo service mongod stop
2

Remove Packages.

Remove any MongoDB packages that you had previously installed.

sudo yum erase $(sudo rpm -qa | grep mongodb-enterprise)
3

Remove Data Directories.

Remove MongoDB databases and log files.

sudo rm -r /var/log/mongodb
sudo rm -r /var/lib/mongo

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.

This value can be configured either:

  • in the MongoDB configuration file with bindIp, or
  • via the command-line argument --bind_ip

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. At minimum, consider enabling authentication and hardening network infrastructure.

For more information on configuring bindIp, see IP Binding.

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-server Contains the mongod daemon and associated configuration and init scripts.
mongodb-enterprise-mongos Contains the mongos daemon.
mongodb-enterprise-shell Contains the mongo shell.
mongodb-enterprise-cryptd Contains the mongocryptd binary
mongodb-enterprise-tools

Contains the following MongoDB tools: