Navigation
This version of the documentation is archived and no longer supported. To learn how to upgrade your version of MongoDB Ops Manager, refer to the upgrade documentation.
You were redirected from a different version of the documentation. Click here to go back.

Back up a Deployment

Overview

You can choose to back up all databases and collections on the deployment or specific ones.

Important

Only sharded clusters or replica sets can be backed up. To back up a standalone mongod process, you must first convert it to a single-member replica set.

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 group must be unique. Failure to have unique names for the deployment items will result in broken backup snapshots.

Prerequisites

  • For a Replica Set:
    • Ops Manager must be monitoring the deployment.
    • It must run MongoDB version 2.2.0 or later.
    • It must have an active primary node.
  • For a Sharded Cluster:
    • Ops Manager must be monitoring the deployment, including at least one mongos in the cluster.
    • It must run MongoDB version 2.4.3 or later.
    • All config servers must be running. The config server mongod processes must be started with either the --configsvr command line option or the { "clusterRole": "configsvr" } setting in the mongod configuration file.
    • The balancing round must be able to complete in less than one hour.
  • The MongoDB version and Ops Manager version must meet the compatibility requirements.
  • Decide how to back up the data and what data to back up. See the Backup Preparations.

Procedure

1

Click Backup.

If you have not yet enabled Ops Manager Backup, click Begin Setup and complete the wizard. This results in a completed backup setup, so you can skip the rest of this procedure.

2

Start backing up the process.

From the list of processes, navigate to the Status column for the process you want to back up and click Start.

3

In the Start Backup sidebar, configure the backup source and storage engine.

Menu Possible Values Default Value
Sync source
  • Any secondary (Ops Manager chooses)
  • Any specific secondary
  • The primary node

any secondary

Using a secondary is preferred because it minimizes performance impact on the primary.

Storage Engine
  • MongoDB Memory Mapped Files or
  • WiredTiger

See the considerations in Storage Engines.

Same storage engine as the primary node of the database being backed up.

If the storage engine is WiredTiger, you can enable encryption. To enable encryption, select Enable Encryption. Select only if you have set up KMIP server for your backups and configured the group to use KMIP.

4

If the deployment is not under Automation and requires authentication, specify the authentication mechanism and credentials.

Specify the following, as appropriate:

Auth Mechanism

The authentication mechanism the host uses.

The options are:

DB Username

For Username/Password or LDAP authentication, the username used to authenticate the Backup Agent to the MongoDB deployment.

See Configure Backup Agent for MONGODB-CR or Configure Backup Agent for LDAP Authentication.

DB Password For Username/Password or LDAP authentication, the password used to authenticate the Backup Agent to the MongoDB deployment.
Allows SSL for connections

If checked, the Backup Agent uses SSL to connect to MongoDB.

See Configure Backup Agent for SSL.

5

To filter which namespaces get backed up, click Advanced Settings.

To exclude databases and collections from this backup:

  1. Click Blacklist.
  2. Enter the first database and collection in the text box. For collections, enter the full namespace: <database>.<collection>.
  3. To exclude additional databases or collections, click the Add another link then repeat the previous step.

To include only certain databases and collections for this backup:

  1. Click Whitelist.
  2. Enter the first database and collection in the text box. For collections, enter the full namespace: <database>.<collection>.
  3. To include additional databases or collections, click the Add another link then repeat the previous step.
6

Click Start.