MongoDB Agent Prerequisites

On this page

Hardware Requirements

Set Host Network Access
Set Host Permissions

Cloud Manager will no longer support Automation, Backup, and Monitoring for MongoDB 3.6 and 4.0 after August 30th, 2024. Please upgrade your MongoDB deployment or migrate to Atlas.

OAuth 2.0 authentication for programmatic access to Cloud Manager is available as a Preview feature.: The feature and the corresponding documentation might change at any time during the Preview period. To use OAuth 2.0 authentication, create a service account to use in your requests to the Cloud Manager Public API.

This section describes the requirements for the hosts that run the MongoDB Agent.

Hosts that run MongoDB Agents must run on a 64-bit version of one of the following hardware architectures and operating systems. The following table lists the MongoDB Server versions that you can deploy with the MongoDB Agent on the associated platforms:

Architecture	Distro/OS	8.0	7.0	6.0	5.0	4.4	4.2
x86_64	RHEL/Oracle Linux 7 ¹
	RHEL/Rocky/Alma Linux/Oracle Linux 8 ¹
	RHEL/Rocky/Alma Linux/Oracle Linux 9 ¹
	Amazon Linux 2
	Amazon Linux 2023
	SUSE12
	SUSE15
	Debian 8
	Debian 9
	Debian 10
	Debian 11
	Debian 12
	Ubuntu 16.x
	Ubuntu 18.x
	Ubuntu 20.x
	Ubuntu 22.x ²
	Windows
ARM	RHEL 8
	RHEL 9
	Amazon Linux 2
	Amazon Linux 2023
	Ubuntu 20.x
	Ubuntu 22.x
PowerPC/ ppc64le	RHEL 7
	RHEL 8
zSeries/ 390x	RHEL 7
	RHEL 8

¹ MongoDB supports Oracle Linux running RHCK only. MongoDB doesn't support Oracle Linux running UEK.

² MongoDB Connector for BI isn't supported on Ubuntu 22.04.

Hardware Requirements

Use 64-bit Chip Architectures

The MongoDB Agent must run on 64-bit architectures.

Provide Sufficient CPU and RAM

MongoDB recommends a minimum of 2 CPU cores and 2 GB of RAM for MongoDB Agent hosts.

If you activate backup, all MongoDB Agent hosts require at least an additional 2 CPU cores and 3 GB of RAM beyond basic platform requirements. Each backup job that the MongoDB Agent runs further impacts host performance.

Set Host Network Access

The hosts that serve the MongoDB deployments must:

Have full network access to each other through their Fully Qualified Domain Names (FQDNs). Each host must reach each other host through the FQDN.
Permit Automation to start mongod on a random ephemeral port and connect to that port when restoring your deployment from a backup.

Find the FQDN for each host. Run the following command in Powershell:
```
net config workstation | findstr /C:"Full Computer name"
```
Download and install the Windows BIND tools.

Find the FQDN for each host. Run the following command in the shell:
```
hostname -f
```

Find the FQDN for each host. Run the following command in the shell:
```
hostname -f
```

Find the FQDN for each host. Run the following command in the shell:
```
hostname -f
```

Resolve each FQDN to a unique IP address. Run the following command in the shell to resolve the FQDN:
```
dig +short myip.opendns.com @resolver1.opendns.com
```
Set the Common Name or Subject Alternative Name value of any SSL certificates to the MongoDB host's FQDN.

The network configuration must allow each MongoDB Agent to make a direct connection to each MongoDB deployment listed on the Deployment page. Cloud Manager does not support port forwarding.

Disable Windows Firewall Stealth Mode

For best performance, Disable Windows Firewall stealth mode on the MongoDB hosts on which you installed the MongoDB Agent.

Set Host Permissions

On a Host that Already Runs MongoDB

If you install the MongoDB Agent on a host that is running a MongoDB process, the agent must have:

Permission to stop any MongoDB processes. The MongoDB Agent restarts the process using the Agent's own set of MongoDB binaries. If you installed MongoDB with a package manager, use the same package manager to install the MongoDB Agent. This gives the MongoDB Agent the same owner as MongoDB.
Read and Write permissions on the MongoDB data directory and log directory.

On a Host Before Installing MongoDB

If you deploy the MongoDB Agent to a host that doesn't have MongoDB installed, ensure the user that owns the MongoDB Agent has Read and Write permissions on the MongoDB data and log directories you plan to use.

Root Access

To install the MongoDB Agent using a deb package, log in as root or a user with sudo privileges.

To install the MongoDB Agent using a .rpm package, log in as root or a user with sudo privileges.

To install the MongoDB Agent using a .tar package, log in as root or a user with sudo privileges.

Acquire an Agent API Key

The MongoDB Agent requires one Agent API Key per project to communicate with the Cloud Manager.

If you do not have an existing Agent API Key for your Cloud Manager project, create one:

In MongoDB Cloud Manager, go to the Deployment page for your project.

If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
If it's not already displayed, select your desired project from the Projects menu in the navigation bar.
If the Deployment page is not already displayed, click Deployment in the sidebar.
The Deployment page displays.

Go to the Agents page.

Click the Agents tab for your deployment.

The Agents page displays.

Generate the API key.

Click Agent API Keys.
Click Generate.
Note
This button appears if both of the following criteria are true:
- The current user is the Project Owner.
- The project has no Agent API Keys other than the Original Group API Key with an exclamation next to it. This type of key exists in projects created before the new Agent API Key model. In the new model, you can create multiple Agent API Keys in a project, and any the project's MongoDB Agents can use any of the keys.
In the Generate Key modal, provide a description of the new Agent API Key in the Description box.
Click Generate.
Important
When you generate an Agent API Key, Cloud Manager displays it one time only. You must copy this key. Treat it like a password; store it in a secure place. Cloud Manager never displays the full key again.

Back

MongoDB Agent

Install