Fix This Page
Navigation
You were redirected from a different version of the documentation. Click here to go back.

Install the Automation Agent with deb Packages

Overview

Ops 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 Ops Manager to determine the goal configuration, deploy changes as needed, and report deployment status back to Ops Manager.

Use this procedures to install the Automation Agent on Ubuntu with deb packages. For Debian systems, use the Install the Automation Agent from an Archive procedure.

To install the Automation Agent to a server that has an existing MongoDB deployment that was not installed with a deb package, use the Install the Automation Agent from an Archive procedure.

Prerequisites

64-Bit Architecture

The Automation Agent can run only on a 64-bit architecture.

Server Networking Access

The servers that host the MongoDB deployments must:

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

    To find the FQDN for each server:

    • On Linux / Mac OS X servers, run hostname -f in the shell.
    • On Windows servers, run net config workstation | findstr /C:"Full Computer name" in PowerShell.
  • Resolve each FQDN to a unique IP address.

    Run the following domain internet groper (dig) shell command to find the server’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/

You must ensure that your network configuration (all interfaces and firewalls) allows each Automation Agent to connect to every MongoDB deployment listed on the Deployment page.

Ops 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.

Ubuntu 12.04

If you install the Automation Agent to an Ubuntu 12.04 machine, and you plan to deploy MongoDB instances that use LDAP authentication, then you must either:

Alternatively, you can use Ubuntu 14.04 or later.

Server Networking Access

The servers that host the MongoDB deployments must:

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

    To find the FQDN for each server:

    • On Linux / Mac OS X servers, run hostname -f in the shell.
    • On Windows servers, run net config workstation | findstr /C:"Full Computer name" in PowerShell.
  • Resolve each FQDN to a unique IP address.

    Run the following domain internet groper (dig) shell command to find the server’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/

You must ensure that your network configuration (all interfaces and firewalls) allows each Automation Agent to connect to every MongoDB deployment listed on the Deployment page.

Ops Manager does not support port forwarding.

Root Access

To install the Automation Agent using a deb package, you must have root access.

Procedures

This section includes procedures for both installing and updating the Automation Agent.

Install the Automation Agent with a deb Package

Installation Tip for Binding the Agent to a Group

You can also access install instructions in Ops 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 deb for the agent that works on your platform:

Note

Replace <OpsManagerHost:Port> with the hostname and port of your Ops Manager installation.

For Ubuntu 15.X, 16.X on x64 architecture:

curl -OL https://<OpsManagerHost:Port>/download/agent/automation/mongodb-mms-automation-agent-manager_latest_amd64.ubuntu1604.deb

For Ubuntu 16.X on PowerPC architecture (managing MongoDB 3.4 or later deployments only):

curl -OL https://<OpsManagerHost:Port>/download/agent/automation/mongodb-mms-automation-agent-manager_latest_ppc64e1.ubuntu1604.deb

For Ubuntu 12.X, 14.X on x64 architecture:

curl -OL https://<OpsManagerHost:Port>/download/agent/automation/mongodb-mms-automation-agent-manager_latest_amd64.deb
2

Install the Automation Agent Package.

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

For Ubuntu 15.X, 16.X on x64 architecture:

sudo dpkg -i mongodb-mms-automation-agent-manager_latest_amd64.ubuntu1604.deb

For Ubuntu 16.X on PowerPC architecture (managing MongoDB 3.4 or later deployments only):

sudo dpkg -i mongodb-mms-automation-agent-manager_latest_ppc64e1.ubuntu1604.deb

For Ubuntu 12.X, 14.X on x64 architecture:

sudo dpkg -i mongodb-mms-automation-agent-manager_latest_amd64.deb
3

Edit the automation-agent.config file.

In the directory where you installed the Automation Agent, edit the automation-agent.config file to either:

Open the file with an editor. For example:

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

Configure for a Specific Group

Update the following configuration keys:

  • For mmsGroupId, set to your GroupID.
  • For mmsApiKey, set to the group’s agent API key.
  • For mmsBaseUrl, set to the URL of the Ops Manager Application. Include the port number.
mmsGroupId=<Group ID>
mmsApiKey=<agent API key>
mmsBaseUrl=<application URL>

Do not configure the server pool settings: serverPoolKey, serverPoolPropertiesFile, serverPoolStateFile.

Configure for a Server Pool

Update the following configuration keys:

  • For mmsBaseUrl, set to the URL of the Ops Manager Application. Include the port number.

  • For serverPoolKey, set to the Server Pool Key.

    To find the server pool key, in the Admin menu, go to Server Pool view and click on the Agent Configuration tab.

  • For serverPoolPropertiesFile, set to the full filepath of a file that contains server properties. Ensure the Automation Agent can read the file.

    The properties file contains key/value pairs of the form <property>=<value>. The Ops Manager Administrator decides on both the property names and values.

    Note

    Ensure that the properties file contains the desired property names and values before starting the Automation Agent on the server.

    Once the server is registered with the pool, changes to the properties file do not take effect until the server is first removed and the Automation Agent restarted.

  • For serverPoolStateFile, set to the full filepath of the file to be used by the Automation Agent.

    Ensure that the directory path to the file exists and the agent has read and write access to the directory. The file itself need not exist; however, if it does exist, the agent must have read and write access to the file.

mmsBaseUrl=<application URL>
serverPoolKey=somekeyabc123
serverPoolPropertiesFile=<path to server properties file>
serverPoolStateFile=<path to server state file>

Do not configure the group settings: mmsGroupId and mmsApiKey.

4

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

To configure the agent to connect to Ops Manager via a proxy server, you must specify the server in the httpProxy environment variable. In the /etc/mongodb-mms/automation-agent.config file, set the httpProxy value to the URL of to your proxy server:

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

Prepare the data directory.

The data directory stores MongoDB data. For an existing MongoDB deployment, ensure that the directory is owned by the mongodb user. If no MongoDB deployment exists, create the directory and set the owner.

sudo mkdir /data
sudo chown mongodb:mongodb /data
6

Start the Automation Agent.

Issue the following command:

For Ubuntu 15.X or later:

sudo systemctl start mongodb-mms-automation-agent.service

For Ubuntu 12.X, 14.X:

sudo start mongodb-mms-automation-agent

Update the Automation Agent with a deb Package

Important

The preferred way to update the Automation Agent is through the Ops Manager UI. If an Automation Agent is out of date, Ops Manager displays a warning on the Deployment page and provides a link to perform the update automatically.

If you use this procedure, you do not need to stop the agent. The update package automatically stops, unpacks, and then restarts the agent.

1

Download the latest version of the Automation Agent archive.

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

Note

Replace <OpsManagerHost:Port> with the hostname and port of your Ops Manager installation.

For Ubuntu 15.X, 16.X on x64 architecture:

curl -OL https://<OpsManagerHost:Port>/download/agent/automation/mongodb-mms-automation-agent-manager_latest_amd64.ubuntu1604.deb

For Ubuntu 16.X on PowerPC architecture (managing MongoDB 3.4 or later deployments only):

curl -OL https://<OpsManagerHost:Port>/download/agent/automation/mongodb-mms-automation-agent-manager_latest_ppc64e1.ubuntu1604.deb

For Ubuntu 12.X, 14.X on x64 architecture:

curl -OL https://<OpsManagerHost:Port>/download/agent/automation/mongodb-mms-automation-agent-manager_latest_amd64.deb
2

Install the Automation Agent Package.

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

For Ubuntu 15.X, 16.X on x64 architecture:

sudo dpkg -i mongodb-mms-automation-agent-manager_latest_amd64.ubuntu1604.deb

For Ubuntu 16.X on PowerPC architecture (managing MongoDB 3.4 or later deployments only):

sudo dpkg -i mongodb-mms-automation-agent-manager_latest_ppc64e1.ubuntu1604.deb

For Ubuntu 12.X, 14.X on x64 architecture:

sudo dpkg -i mongodb-mms-automation-agent-manager_latest_amd64.deb
3

Prepare the data directory.

The data directory stores MongoDB data. For an existing MongoDB deployment, ensure that the directory is owned by the mongodb user. If no MongoDB deployment exists, create the directory and set the owner.

sudo mkdir /data
sudo chown mongodb:mongodb /data