Docs Menu
Docs Home
/
MongoDB Cloud Manager
/ /

Back up a Deployment

On this page

  • Considerations
  • Prerequisites
  • Procedure

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.

Cloud Manager builds snapshots using the latest patch release of MongoDB.

Example

Consider a deployment where the current MongoDB version is 4.0.20.

If you back up a database running MongoDB 4.0.15, Cloud Manager creates the snapshot using MongoDB 4.0.20, the current version. Cloud Manager displays that snapshot as MongoDB 4.0.20 in the console.

MongoDB guarantees all patch release versions to be compatible. You can use the snapshots built with 4.0.20 to restore to your 4.0.15 instances, if needed.

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.

A Replica Set must:

  • Be monitored by Cloud Manager.

  • Run MongoDB Enterprise with an FCV of 4.2 or later.

  • Have an active primary node.

  • Have one node with WiredTiger set as its storage engine.

  • Be monitored by Cloud Manager.

  • Run MongoDB version 2.6 to 4.0.

  • Have an active primary node.

A Sharded Cluster must:

  • Be monitored by Cloud Manager.

  • Run MongoDB Enterprise with an FCV of 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.

All FCV 4.2 and later databases must fulfill the appropriate backup considerations.

The MongoDB version must meet the minimum compatibility.

Decide how to back up the data and what data to back up.

You can back up your entire MongoDB deployment.

1

If you have not yet enabled Cloud 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

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

3

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 Username/Password or LDAP authentication, the username used to authenticate the MongoDB Agent with the MongoDB deployment.

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.

See Configure MongoDB Agent to Use TLS.

4

You can choose to back up all databases and collections in your MongoDB deployment or specific ones.

1

If you have not yet enabled Cloud 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

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

3
Menu
Possible Values
Default Value
Sync source
  • Any secondary (Cloud 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.

    If you select this option, Cloud Manager limits backups to deployments with fewer than 100,000 files. Files includes collections and indexes.

See the considerations in Storage Engines.

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

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 Username/Password or LDAP authentication, the username used to authenticate the MongoDB Agent with the MongoDB deployment.

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.

See Configure MongoDB Agent to Use TLS.

5

Back

Backup Preparations

Next

Manage Backups