Install the MongoDB Agent to Only Monitor or Backup Deployments

Log in to the Cloud Manager.

Navigate to the MongoDB Agent Download page.

If you have a project with existing deployments, you can install the MongoDB Agent on your existing deployments:

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

   1. If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.

   2. If it's not already displayed, select your desired project from the Projects menu in the navigation bar.

   3. If the Deployment page is not already displayed, click Deployment in the sidebar.

      The Deployment page displays.

2. Click the Agents tab for your deployment.

   The Agents page displays.

3. Click Downloads & Settings.

4. From the Select Your Server's Operating System menu, click Amazon Linux - RPM.

Download the latest version of the MongoDB Agent.

From a system shell on the host that will run the MongoDB Agent, issue the following curl command to download the installer for 64-bit x86:

curl -OL https://cloud.mongodb.com/download/agent/automation/mongodb-mms-automation-agent-manager-latest.x86_64.rpm

Edit the MongoDB Agent configuration file.

In the directory where you installed the MongoDB Agent, open theautomation-agent.config file in your preferred text editor.

sudo vi /etc/mongodb-mms/automation-agent.config

Update the following configuration options:

Optional: Configure the MongoDB Agent to use a proxy server.

To configure the MongoDB Agent to connect to Cloud Manager via a proxy server, you must specify the server in the httpProxy environment variable.

In the directory where you installed the MongoDB Agent, open theautomation-agent.config file in your preferred text editor.

sudo vi /etc/mongodb-mms/automation-agent.config

Add the following configuration key:

Prepare the data directory.

The data directory stores MongoDB data and must be owned by the mongod user. For an existing MongoDB deployment, ensure the directory has the mongod user as owner. If no MongoDB deployment exists, create the directory and set the owner.

The following commands create a data directory and set the owner as the mongod user:

sudo mkdir /data; sudo chown mongod:mongod /data

Start the MongoDB Agent.

Issue the following command:

sudo service mongodb-mms-automation-agent start

Finish the installation of the MongoDB Agent.

In the Install Agent Instructions modal, click Done.

Repeat the installation procedure for each MongoDB host.

Log in to the Cloud Manager.

Navigate to the MongoDB Agent Download page.

If you have a project with existing deployments, you can install the MongoDB Agent on your existing deployments:

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

   1. If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.

   2. If it's not already displayed, select your desired project from the Projects menu in the navigation bar.

   3. If the Deployment page is not already displayed, click Deployment in the sidebar.

      The Deployment page displays.

2. Click the Agents tab for your deployment.

   The Agents page displays.

3. Click Downloads & Settings.

4. From the Select Your Server's Operating System menu, click RHEL/CentOS (7.X) Power (ppc64le) - RPM.

Download the latest version of the MongoDB Agent.

From a system shell on the host that will run the MongoDB Agent, issue the following curl command to download the installer for RHEL 7 for PowerPC:

curl -OL https://cloud.mongodb.com/download/agent/automation/mongodb-mms-automation-agent-manager-latest.ppc641e.rhel7.rpm

Edit the MongoDB Agent configuration file.

In the directory where you installed the MongoDB Agent, open theautomation-agent.config file in your preferred text editor.

sudo vi /etc/mongodb-mms/automation-agent.config

Update the following configuration options:

Optional: Configure the MongoDB Agent to use a proxy server.

To configure the MongoDB Agent to connect to Cloud Manager via a proxy server, you must specify the server in the httpProxy environment variable.

In the directory where you installed the MongoDB Agent, open theautomation-agent.config file in your preferred text editor.

sudo vi /etc/mongodb-mms/automation-agent.config

Add the following configuration key:

Prepare the data directory.

The data directory stores MongoDB data and must be owned by the mongod user. For an existing MongoDB deployment, ensure the directory has the mongod user as owner. If no MongoDB deployment exists, create the directory and set the owner.

The following commands create a data directory and set the owner as the mongod user:

sudo mkdir /data; sudo chown mongod:mongod /data

Start the MongoDB Agent.

Issue the following command:

sudo service mongodb-mms-automation-agent start

Finish the installation of the MongoDB Agent.

In the Install Agent Instructions modal, click Done.

Repeat the installation procedure for each MongoDB host.

Log in to the Cloud Manager.

Navigate to the MongoDB Agent Download page.

If you have a project with existing deployments, you can install the MongoDB Agent on your existing deployments:

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

   1. If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.

   2. If it's not already displayed, select your desired project from the Projects menu in the navigation bar.

   3. If the Deployment page is not already displayed, click Deployment in the sidebar.

      The Deployment page displays.

2. Click the Agents tab for your deployment.

   The Agents page displays.

3. Click Downloads & Settings.

4. From the Select Your Server's Operating System menu, click RHEL/CentOS (7.X) Power (ppc64le) - TAR.

Download the latest version of the MongoDB Agent.

From a system shell on the host that will run the MongoDB Agent, issue the following curl command to download the installer for RHEL 7 for PowerPC:

curl -OL https://cloud.mongodb.com/download/agent/automation/mongodb-mms-automation-agent-manager-latest.rhel7_ppc64le.tar.gz

Extract the MongoDB Agent.

You can install the MongoDB Agent in any directory. If you want to move the archive to another directory before extracting, you may do so.

To install the MongoDB Agent, extract the archive:

tar -xvzf mongodb-mms-automation-agent-<VERSION>.rhel7_ppc64le.tar.gz

Change to the extracted binary directory.

Change into the directory that was created after extracting the MongoDB Agent binary:

cd mongodb-mms-automation-agent-<VERSION>.rhel7_ppc64le

Edit the MongoDB Agent configuration file.

In the directory where you installed the MongoDB Agent, open thelocal.config file in your preferred text editor.

vi <install-path>/local.config

Update the following configuration options:

Optional: Configure the MongoDB Agent to use a proxy server.

To configure the MongoDB Agent to connect to Cloud Manager via a proxy server, you must specify the server in the httpProxy environment variable.

In the directory where you installed the MongoDB Agent, open thelocal.config file in your preferred text editor.

vi <install-path>/local.config

Add the following configuration key:

Optional: Create the binary, log, and data directories.

Create the following directories to store files that the MongoDB Agent needs.

Run the following commands to create the directories:

sudo mkdir -m 755 -p /var/lib/mongodb-mms-automation
sudo mkdir -m 755 -p /var/log/mongodb-mms-automation
sudo mkdir -m 755 -p /data

By default, the Agent binaries and Cloud Manager configuration backup file are located in /var/lib/mongodb-mms-automation. If you want to store these files in a different directory, follow these procedures:

To change the location of the Agent Binaries:

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

   1. If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.

   2. If it's not already displayed, select your desired project from the Projects menu in the navigation bar.

   3. If the Deployment page is not already displayed, click Deployment in the sidebar.

      The Deployment page displays.

2. Click the Agents tab for your deployment.

   The Agents page displays.

3. Change the path.

   1. Click Downloads & Settings.

   2. Below the Download Directory heading, click the pencil icon to the right of the path shown in Download Directory (Linux).

   3. Change the path to the new path you want.

   4. Click Save.

   5. Create the new directory you specified on each host that runs an Agent.

      sudo mkdir -m 755 -p /<newPath>

To change the location of the Agent configuration backup:

1. Open the Agent configuration file in your preferred text editor.

2. Change the mmsConfigBackup setting to the new path for the configuration backup file.

   mmsConfigBackup=/<newPath>/mms-cluster-config-backup.json

3. Save the Agent configuration file.

4. Move the configuration backup file to the new directory.

   sudo mv /var/lib/mongodb-mms-automation/mms-cluster-config-backup.json /<newPath>

Assign permissions to the system user that runs the MongoDB Agent.

Run the following commands:

# Create mongod user and group if they do not exist
if ! sudo /usr/bin/id -g mongod &>/dev/null; then
  sudo /usr/sbin/groupadd -r mongod
fi
# Create mongod user if they do not exist and assign
# them to the mongod group
if ! sudo /usr/bin/id mongod &>/dev/null; then
  sudo /usr/sbin/useradd -M -r -g mongod \
    -d /var/lib/mongo -s /bin/false \
    -c mongod mongod > /dev/null 2>&1
fi
# Grant the mongod:mongod user and group permissions
# to manage deployments.
sudo chown mongod:mongod /var/lib/mongod-mms-automation
sudo chown mongod:mongod /var/log/mongod-mms-automation
sudo chown mongod:mongod /data

Start the MongoDB Agent.

From the directory in which you installed the MongoDB Agent and as the system user you created in the last step, issue the following command:

nohup ./mongodb-mms-automation-agent \
  --config=local.config \
  >> /var/log/mongodb-mms-automation/automation-agent-fatal.log 2>&1 &

Finish the installation of the MongoDB Agent.

In the Install Agent Instructions modal, click Done.

Repeat the installation procedure for each MongoDB host.

Log in to the Cloud Manager.

Navigate to the MongoDB Agent Download page.

If you have a project with existing deployments, you can install the MongoDB Agent on your existing deployments:

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

   1. If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.

   2. If it's not already displayed, select your desired project from the Projects menu in the navigation bar.

   3. If the Deployment page is not already displayed, click Deployment in the sidebar.

      The Deployment page displays.

2. Click the Agents tab for your deployment.

   The Agents page displays.

3. Click Downloads & Settings.

4. From the Select Your Server's Operating System menu, click RHEL/CentOS (8.X/9.X), Amazon Linux 2, Amazon Linux 2023 - TAR (ARM).

Download the latest version of the MongoDB Agent.

From a system shell on the host that will run the MongoDB Agent, issue the following curl command to download the installer for RHEL 8.x/9.x or Amazon Linux 2 for ARM64:

curl -OL https://cloud.mongodb.com/download/agent/automation/mongodb-mms-automation-agent-manager-latest.aarch64.amzn2.rpm

Edit the MongoDB Agent configuration file.

In the directory where you installed the MongoDB Agent, open theautomation-agent.config file in your preferred text editor.

sudo vi /etc/mongodb-mms/automation-agent.config

Update the following configuration options:

Optional: Configure the MongoDB Agent to use a proxy server.

To configure the MongoDB Agent to connect to Cloud Manager via a proxy server, you must specify the server in the httpProxy environment variable.

In the directory where you installed the MongoDB Agent, open theautomation-agent.config file in your preferred text editor.

sudo vi /etc/mongodb-mms/automation-agent.config

Add the following configuration key:

Prepare the data directory.

The data directory stores MongoDB data and must be owned by the mongod user. For an existing MongoDB deployment, ensure the directory has the mongod user as owner. If no MongoDB deployment exists, create the directory and set the owner.

The following commands create a data directory and set the owner as the mongod user:

sudo mkdir /data; sudo chown mongod:mongod /data

Start the MongoDB Agent.

Issue the following command:

sudo service mongodb-mms-automation-agent start

Finish the installation of the MongoDB Agent.

In the Install Agent Instructions modal, click Done.

Repeat the installation procedure for each MongoDB host.

Log in to the Cloud Manager.

Navigate to the MongoDB Agent Download page.

If you have a project with existing deployments, you can install the MongoDB Agent on your existing deployments:

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

   1. If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.

   2. If it's not already displayed, select your desired project from the Projects menu in the navigation bar.

   3. If the Deployment page is not already displayed, click Deployment in the sidebar.

      The Deployment page displays.

2. Click the Agents tab for your deployment.

   The Agents page displays.

3. Click Downloads & Settings.

4. From the Select Your Server's Operating System menu, click RHEL/CentOS (8.X/9.X), Amazon Linux 2, Amazon Linux 2023 - TAR (ARM).

Download the latest version of the MongoDB Agent.

From a system shell on the host that will run the MongoDB Agent, issue the following curl command to download the installer for RHEL 8.x/9.x or Amazon Linux 2 for ARM64:

curl -OL https://cloud.mongodb.com/download/agent/automation/mongodb-mms-automation-agent-manager-latest.amzn2_aarch64.tar.gz

Extract the MongoDB Agent.

You can install the MongoDB Agent in any directory. If you want to move the archive to another directory before extracting, you may do so.

To install the MongoDB Agent, extract the archive:

tar -xvzf mongodb-mms-automation-agent-<VERSION>.amzn2_aarch64.tar.gz

Change to the extracted binary directory.

Change into the directory that was created after extracting the MongoDB Agent binary:

cd mongodb-mms-automation-agent-<VERSION>.amzn2_aarch64

Edit the MongoDB Agent configuration file.

In the directory where you installed the MongoDB Agent, open thelocal.config file in your preferred text editor.

vi <install-path>/local.config

Update the following configuration options:

Optional: Configure the MongoDB Agent to use a proxy server.

To configure the MongoDB Agent to connect to Cloud Manager via a proxy server, you must specify the server in the httpProxy environment variable.

In the directory where you installed the MongoDB Agent, open thelocal.config file in your preferred text editor.

vi <install-path>/local.config

Add the following configuration key:

Optional: Create the binary, log, and data directories.

Create the following directories to store files that the MongoDB Agent needs.

Run the following commands to create the directories:

sudo mkdir -m 755 -p /var/lib/mongodb-mms-automation
sudo mkdir -m 755 -p /var/log/mongodb-mms-automation
sudo mkdir -m 755 -p /data

By default, the Agent binaries and Cloud Manager configuration backup file are located in /var/lib/mongodb-mms-automation. If you want to store these files in a different directory, follow these procedures:

To change the location of the Agent Binaries:

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

   1. If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.

   2. If it's not already displayed, select your desired project from the Projects menu in the navigation bar.

   3. If the Deployment page is not already displayed, click Deployment in the sidebar.

      The Deployment page displays.

2. Click the Agents tab for your deployment.

   The Agents page displays.

3. Change the path.

   1. Click Downloads & Settings.

   2. Below the Download Directory heading, click the pencil icon to the right of the path shown in Download Directory (Linux).

   3. Change the path to the new path you want.

   4. Click Save.

   5. Create the new directory you specified on each host that runs an Agent.

      sudo mkdir -m 755 -p /<newPath>

To change the location of the Agent configuration backup:

1. Open the Agent configuration file in your preferred text editor.

2. Change the mmsConfigBackup setting to the new path for the configuration backup file.

   mmsConfigBackup=/<newPath>/mms-cluster-config-backup.json

3. Save the Agent configuration file.

4. Move the configuration backup file to the new directory.

   sudo mv /var/lib/mongodb-mms-automation/mms-cluster-config-backup.json /<newPath>

Assign permissions to the system user that runs the MongoDB Agent.

Run the following commands:

# Create mongod user and group if they do not exist
if ! sudo /usr/bin/id -g mongod &>/dev/null; then
  sudo /usr/sbin/groupadd -r mongod
fi
# Create mongod user if they do not exist and assign
# them to the mongod group
if ! sudo /usr/bin/id mongod &>/dev/null; then
  sudo /usr/sbin/useradd -M -r -g mongod \
    -d /var/lib/mongo -s /bin/false \
    -c mongod mongod > /dev/null 2>&1
fi
# Grant the mongod:mongod user and group permissions
# to manage deployments.
sudo chown mongod:mongod /var/lib/mongod-mms-automation
sudo chown mongod:mongod /var/log/mongod-mms-automation
sudo chown mongod:mongod /data

Start the MongoDB Agent.

From the directory in which you installed the MongoDB Agent and as the system user you created in the last step, issue the following command:

nohup ./mongodb-mms-automation-agent \
  --config=local.config \
  >> /var/log/mongodb-mms-automation/automation-agent-fatal.log 2>&1 &

Finish the installation of the MongoDB Agent.

In the Install Agent Instructions modal, click Done.

Repeat the installation procedure for each MongoDB host.