- Agents >
- Backup Agent >
- Install or Update the Backup Agent >
- Install or Update the Backup Agent through Automation
Install or Update the Backup Agent through Automation¶
On this page
The Backup Agent polls the primary MongoDB instance of every backup-enabled replica set and transmits the operations to the Ops Manager service.
The Backup Agent relies on the Ops Manager Monitoring Agent to populate the list of sharded clusters and replica sets eligible for backup. If the appropriate hosts are not added, or the Monitoring Agent is not being correctly run, the lists may be incomplete or out-of-date. If you have not already installed and configured the Monitoring Agent, please refer to the Install or Update the Monitoring Agent documentation.
Considerations¶
MongoDB Requirements¶
Ops Manager only supports backing up replica sets and sharded clusters, and does not support backing up standalone instances.
Ops Manager only supports backup for replica sets that run MongoDB 2.0 or later.
Ops Manager only supports backup for sharded clusters that run MongoDB 2.4.3 or later.
All backed up replica sets and config servers must be able to maintain
oplog entries, by default, for at least 3 hours over the last 24 hour
period. You can change the default window by adding the
mms.backup.minimumOplogWindowHours
setting to the
Custom tab on the Ops Manager Configuration page.
Running on Amazon EC2¶
If you run the Backup Agent on Amazon EC2, do not use the t1.micro
instance type, which has a CPU scheduling policy that does not
typically provide sufficient capacity to support a Backup Agent for a
production deployment. Use a larger instance type instead.
Backup Directory¶
After you install the Backup Agent, do not use the agent’s directory location for anything other than the agent itself. The Backup Agent periodically deletes the contents of its root directory.
Prerequisites¶
Automation Agent¶
The Automation Agent must be running on the server where you want to install the Backup Agent. To install the Automation Agent, see Automation Agent.
Monitoring Agent¶
Your deployment must have a running Monitoring Agent. To install the Monitoring Agent, see Monitoring Agent.
Backup Agent Host¶
Run the Backup Agent on a host that:
- Is separate from your MongoDB instances. This avoids system resource contention.
- Can connect to your MongoDB instances. Check network settings for connections between the agent and MongoDB hosts. For a list of needed ports, see open ports for agents.
- Has at least 2 CPU cores and 3 GB of RAM above platform requirements. With each backup job it runs, the Backup Agent further impacts host performance.
Firewall¶
If your MongoDB instances operate within a firewall, configure
your network infrastructure to
allow outbound connections from the Backup Agent to Ops Manager on
port 8080
if it is using HTTP or 8443
if it is using HTTPS.
Procedure¶
To install the agent, click Deployment, then Servers, then click a server’s ellipsis icon (…) and select Install Backup Agent.
To update the agent, click the link Ops Manager provides when your agent is out-of-date. When the agent needs updating, Ops Manager displays a warning on the Deployment page and provides a link to perform the update.
Next Steps¶
After you have successfully installed the Backup Agent, see Back up a Deployment to enable backup for a replica set.