- Reference >
- Automation Agent >
- Install the Automation Agent >
- Install the Automation Agent on OS X
Install the Automation Agent on OS X¶
On this page
Overview¶
The Automation Agent runs on every host that runs a monitored MongoDB deployment. The agent provides the interface for starting and managing deployments. If you run MongoDB on hardware that you provision, you must install the Automation Agent manually on each server. If you run MongoDB through the Ops Manager integration with Amazon Web Services (AWS), Ops Manager automatically deploys the Automation Agents every time you provision an new EC2 instance.
Automation Agents can run only on 64-bit architectures.
Prerequisites¶
Before installing the agent, review the Automation Checklist for considerations and prerequisites specific to the agent.
Procedure¶
This section includes procedures for both installing and updating the Automation Agent.
Install the Automation Agent on OS X¶
Download the latest version of the Automation Agent archive.¶
On a system shell, issue a command that resembles the
following. Replace osx_x86_64
with your platform, as needed:
Install the Automation Agent.¶
To install the agent, extract the archive. For example:
The Automation Agent is installed.
Edit the local.config
file to include your Group ID and Ops Manager API key.¶
In the directory where you installed the Automation Agent, edit the
local.config
file.
- For
mmsGroupId
, enter your GroupID as the value. - For
mmsApiKey
, enter your API key.
Create Automation Directory¶
Create the directories /var/lib/mongodb-mms-automation
,
/var/log/mongodb-mms-automation
and /data
and ensure
that the user running the agent owns the directories.
Start the Automation Agent.¶
Issue the following command:
Update the Automation Agent on OS X¶
Stop any currently running Automation Agents.¶
Issue the following command:
Download the latest version of the Automation Agent archive.¶
On a system shell, issue a command that resembles the
following. Replace osx_x86_64
with your platform, as needed:
Install the Automation Agent.¶
To install the agent, extract the archive. For example:
The Automation Agent is installed.
Edit the local.config
file to include your Group ID and Ops Manager API key.¶
In the directory where you installed the Automation Agent, edit the
local.config
file.
- For
mmsGroupId
, enter your GroupID as the value. - For
mmsApiKey
, enter your API key.
Create Automation Directory¶
Create the directories /var/lib/mongodb-mms-automation
,
/var/log/mongodb-mms-automation
and /data
and ensure
that the user running the agent owns the directories.
Start the Automation Agent.¶
Issue the following command: