Back up a Deployment
On this page
You can back up your MongoDB deployment.
Important
Only sharded clusters or replica sets can be backed up. To back up a standalone mongod process, you must convert it to a single-member replica set.
Prerequisites
Unique Names for Deployment Items
Ensure your deployment items have unique names before creating backups.
Important
Replica set, sharded cluster, and shard names within the same project must be unique. Failure to have unique names for the deployments will result in broken backup snapshots.
Replica Set Requirements
A Replica Set must:
Be monitored by Ops Manager.
Run MongoDB Enterprise with FCV 4.2 or later.
Have an active primary node.
Have one node with WiredTiger set as its storage engine.
Sharded Cluster Requirements
A Sharded Cluster must:
Be monitored by Ops Manager.
Run MongoDB Enterprise with FCV 4.2 or later on all nodes including the config server.
Have an active primary node of each shard and the config server.
Have one node per shard or config server with WiredTiger set as its storage engine.
MongoDB Compatibility
All databases must fulfill the appropriate backup considerations.
MongoDB Compatibility
The MongoDB version and Ops Manager version must meet the compatibility requirements.
Data Protection Plan
Procedure
Note
We recommend that you review the amount of data that you are backing up to the blockstore. If the amount of data that you back up negatively affects the performance of the blockstore or if you can't meet your RTO requirements with a single blockstore, distribute the workload across multiple blockstores to balance the backup operations. You can even configure a single blockstore per shard to meet your scaling needs.
You can create additional blockstores any time and configure your backup jobs to use the blockstores manually:
To learn more about allocating specific blockstores to a project, see Manage Backup Resources.
To learn more about configuring shard backups to use specific blockstores, see Manual Blockstore Maintenance.
Set Authentication Mechanisms.
If Automation doesn't manage your deployment and your deployment requires authentication, specify the authentication mechanism and credentials.
Specify the following, as appropriate:
Auth Mechanism | The authentication mechanism that the MongoDB host uses. MongoDB Community options include:
MongoDB Enterprise options also include: |
DB Username | For See Configure MongoDB Agent for Authentication or Configure MongoDB Agent for LDAP. |
DB Password | For Username/Password or LDAP authentication, the
password used to authenticate the MongoDB Agent with the MongoDB
deployment. |
Allows TLS for connections | If checked, Backup uses TLS to connect to MongoDB. |
(Conditional) Assign Deployment Regions for Regional Backup.
If you want to enable Regional Backup for your replica set or sharded cluster, assign deployment regions. For a sharded cluster, you must assign a deployment region for every sharded cluster member, including every shard and config server.
To start a single or multi-region backup:
Select Turn on Multi-Region Backups checkbox.
Select the deployment region from the dropdown.
If you want to set the same deployment region for every member of the sharded cluster, click Set. Alternatively, select a different region from the dropdown for each sharded cluster member.