Navigation

Install the Automation Agent from an Archive

Overview

Cloud Manager Automation relies on an Automation Agent, which must be installed on every server that runs a monitored MongoDB deployment. The Automation Agents periodically poll Cloud Manager to determine the goal configuration, deploy changes as needed, and report deployment status back to Cloud Manager.

This procedure installs the Automation Agent on a Linux server using an tar.gz archive file.

Automation Agents can run only on 64-bit architectures.

Prerequisites

Server Networking Access

The hosts that serve the MongoDB deployments must:

  • Have full networking access to each other through their fully qualified domain names (FQDNs). Each host must be able to reach every other host through the FQDN.

    To find the FQDN for each host:

    • On Linux / macOS hosts, run the following command in the Terminal:

      hostname -f
      
    • On Windows hosts, run the following command in Powershell:

      net config workstation | findstr /C:"Full Computer name"
      
  • Resolve each FQDN to a unique IP address.

    Run the following domain internet groper (dig) shell command to find the host’s IP address.

    dig +short myip.opendns.com @resolver1.opendns.com
    

    Note

    dig is available for Microsoft Windows. Download and install the BIND tools from http://www.isc.org/downloads/

  • 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 Automation Agent to make a direct connection to every MongoDB deployment listed on the Deployment page. Cloud Manager does not support port forwarding.

Installing to a Server that Already Runs MongoDB

If you install the Automation Agent to a server that is already running a MongoDB process, the agent must have:

  • Permission to stop the MongoDB process. The Automation Agent will restart the process using the agent’s own set of MongoDB binaries. If you had installed MongoDB with a package manager, use the same package manager to install the Automation Agent. This gives the agent the same owner as MongoDB.
  • Read and Write permissions on the MongoDB data directory and log directory.
  • Permission to stop, start, and update any existing Monitoring and Backup Agents.

Installing to a Server Before Installing MongoDB

If you deploy the Automation Agent to a server that does not have MongoDB installed, ensure the user that owns the Automation Agent has Read and Write permissions on the MongoDB data and log directories you plan to use.

Install the Automation Agent from an Archive

Installation Tip for Binding the Agent to a Project

You can also access install instructions in Cloud Manager, including commands you can copy and paste: click Deployment, then Agents, then Downloads & Settings.

1

Download the latest version of the Automation Agent archive.

On a system shell, issue a curl command to download the archive for the agent that works on your platform:

For RHEL / CentOS (7.x) and SUSE 12 on x64 architecture:

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

For RHEL / CentOS (7.x) on PowerPC architecture (managing MongoDB 3.4 or later deployments only):

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

For all other Linux distributions:

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

Install the Automation Agent.

To install the agent that works on your platform, issue the appropriate command to extract the archive:

tar -xf mongodb-mms-automation-agent-latest.*.tar.gz

The Automation Agent is installed.

3

Generate an agent API key or retrieve an existing agent API key for your Cloud Manager project.

  1. Click + Generate Key.

Note

The button appears only if the current user is the project owner and the project either has no Agent API keys or just the Original Group API key. An Original Group API key exists only in projects created prior to the new Agent API Key model. The new model allows a project to have more than one key and permits any of the project’s agents to use any of the keys. For more information, see Manage Agent API Keys. If you do not see the + Generate Key button and do not remember your existing agent api key, you can generate a key on the Agent API Keys tab. To navigate to the tab, select Deployment view, then click the Agents tab and then the Agent API Keys tab.

  1. Enter your password and click Verify.
  2. Click + Generate Key again.

Important

When you generate an Agent API key, Cloud Manager displays it one time only. You must copy it and store it in a secure place. Cloud Manager will never display the full key again.

4

Edit the local.config file to include your Project ID and agent API key.

In the directory where you installed the Automation Agent, edit the local.config file.

  • For mmsGroupId, enter your ProjectID as the value.
  • For mmsApiKey, enter the project’s agent API key.
mmsGroupId=<Project ID>
mmsApiKey=<agent API key>
5

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

To configure the agent to connect to Cloud Manager via a proxy server, you must specify the server in the httpProxy environment variable. In the <install-directory>/local.config file, set the httpProxy value to the URL of to your proxy server:

httpProxy="http://proxy.example.com:9000"
6

Create the automation and data directories.

Create the directories for the Automation Agent:

Component Default Directory
Automation Agent binaries /var/lib/mongodb-mms-automation
Automation Agent logs /var/log/mongodb-mms-automation
MongoDB databases created by the Automation Agent /data

The system user that runs the Automation Agent should own these 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

Using a Different Path than /var/lib

By default, the Automation 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 Automation Agent Binaries:

  1. Click Deployment; Agents; and then Downloads & Settings.

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

  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 Automation Agent.

    sudo mkdir -m 755 -p /<newPath>
    

    Important

    Make sure the system user that runs the Automation Agent can write to this new directory.

To change the location of the Automation Agent configuration backup:

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

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

  3. Save the Automation 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>
    
7

Start the Automation Agent.

From the directory in which you installed the Automation Agent, issue the following command:

nohup ./mongodb-mms-automation-agent >> automation-agent.log 2>&1 &

Update the Automation Agent from an Archive

Important

If any Automation Agent for any deployment is out of date, Cloud Manager displays a warning on the Deployment page.

1

Stop any currently running Automation Agents.

Issue the following command:

pkill -f mongodb-mms-automation-agent
2

Download the latest version of the Automation Agent archive.

On a system shell, issue a curl command to download the archive for the agent that works on your platform:

For RHEL / CentOS (7.x) and SUSE 12 on x64 architecture:

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

For RHEL / CentOS (7.x) on PowerPC architecture (managing MongoDB 3.4 or later deployments only):

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

For all other Linux distributions:

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

Install the Automation Agent.

To install the agent that works on your platform, issue the appropriate command to extract the archive:

tar -xf mongodb-mms-automation-agent-latest.*.tar.gz

The Automation Agent is installed.

4

Edit the local.config file to include your Project ID and agent API key.

In the directory where you installed the Automation Agent, edit the local.config file.

  • For mmsGroupId, enter your ProjectID as the value.
  • For mmsApiKey, enter the project’s agent API key.
mmsGroupId=<Project ID>
mmsApiKey=<agent API key>
5

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

To configure the agent to connect to Cloud Manager via a proxy server, you must specify the server in the httpProxy environment variable. In the <install-directory>/local.config file, set the httpProxy value to the URL of to your proxy server:

httpProxy="http://proxy.example.com:9000"
6

Create the automation and data directories.

Create the directories for the Automation Agent:

Component Default Directory
Automation Agent binaries /var/lib/mongodb-mms-automation
Automation Agent logs /var/log/mongodb-mms-automation
MongoDB databases created by the Automation Agent /data

The system user that runs the Automation Agent should own these 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

Using a Different Path than /var/lib

By default, the Automation 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 Automation Agent Binaries:

  1. Click Deployment; Agents; and then Downloads & Settings.

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

  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 Automation Agent.

    sudo mkdir -m 755 -p /<newPath>
    

    Important

    Make sure the system user that runs the Automation Agent can write to this new directory.

To change the location of the Automation Agent configuration backup:

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

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

  3. Save the Automation 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>
    
7

Start the Automation Agent.

From the directory in which you installed the Automation Agent, issue the following command:

nohup ./mongodb-mms-automation-agent >> automation-agent.log 2>&1 &