Restore Overview

Limitations

If you are restoring a sharded cluster, you must restore all shards. The restore process fails if you try to restore a single shard in a sharded cluster.

Prerequisites

To perform automated restores:

• Install an MongoDB Agent installed on the source and all target hosts, and check that an MongoDB Agent on the target deployment can connect to all hosts in the target deployment.

• Configure Backup Admin and Automation Admin roles in Ops Manager.

• For sharded clusters running FCV 4.0 or earlier, enable checkpoints.

• Check that the target cluster's featureCompatibilityVersion is greater than or equal to the source cluster's featureCompatibilityVersion.

  Example

  Run the following command to retrieve the featureCompatibilityVersion of a given host:

  db.adminCommand( {
    getParameter: 1,
    featureCompatibilityVersion: 1
  } )

  To learn more, see setFeatureCompatibilityVersion.

• Review the following compatibility matrix for the supported source cluster each MongoDB version. The MongoDB version of each host in the target cluster must support the FCV of the snapshot of the source cluster.

  Source Cluster FCV	MongoDB 3.4	MongoDB 3.6	MongoDB 4.0	MongoDB 4.2	MongoDB 4.4	MongoDB 5.0	MongoDB 6.0
  3.2
  3.4
  3.6
  4.0
  4.2
  4.4
  5.0
  6.0

Restore to Different Project

You can choose to restore to a cluster of a different project:

• To restore to another Ops Manager project, you must have Automation Admin or Backup Admin roles for the target project.

• To restore to another MongoDB Atlas project, you must have Project Owner role for the target project.

Potential Causes for Automated Restore Failure

An automated restore can fail when certain storage settings of the backup's database and target database do not match:

• storage.engine

• storage.directoryPerDB

• storage.mmapv1.nsSize

• storage.mmapv1.smallFiles

• storage.wiredTiger.collectionConfig.blockCompressor

• storage.wiredTiger.engineConfig.directoryForIndexes

No method exists to check for mismatches before attempting a restore. If a restore attempt fails, Ops Manager displays any mismatched settings. If you still want to restore the backup's database, fix the settings in the target database that do not match backup's database, then retry the restore process for the backup's database.

An automated restore fails when you attempt to restore a single shard in a sharded cluster. If you are restoring a sharded cluster, you must restore all shards.

Restore Procedures

To perform an automated restore, see the procedure for the deployment you want to restore:

• Replica Set

• Sharded Cluster

Prerequisites

To perform manual restores, you must have the Backup Admin role in Ops Manager.

Restore File Format

Ops Manager provides each snapshot as an uncompressed (.tar) or compressed (.tar.gz) archive containing a complete copy of the data directory.

Choosing compressed snapshots results in faster delivery, but requires sufficient space on the target host for both the compressed snapshot and its extracted database files.

• For a replica set, Ops Manager provides one snapshot that you copy to each replica set member.

• For a sharded cluster, Ops Manager provides one snapshot for the config servers and one snapshot for each shard.

Manual Restore Procedures

To perform a manual restore, see:

• Restore a Single Database or Collection using Queryable Backup

• Restore a Replica Set

• Restore a Sharded Cluster

Restore Process Flows

You can restore from a completed shapshot or from a specific point in time. Use the following pages to learn about the manual restore process flows.