Atlas lets you restore data from a scheduled or on-demand Cloud Backup, including snapshots from different projects or organizations. The following sections describe restoring from a snapshot without Encryption at Rest using Customer Key Management. To restore from a snapshot using Encryption at Rest using Customer Key Management, see Restore from a Snapshot Using Encryption at Rest.
Note
You can only perform cross-organization restores through the Atlas UI.
Restore Considerations
In addition to the prerequisites, consider the following requirements and limitations when restoring from a scheduled or on-demand Cloud Backup.
If the
DefaultRWConcernvalue on the source snapshot differs from theDefaultRWConcernvalue on the target cluster, Atlas overrides the value on the source snapshot with the value on the target cluster. If there is no value configured for theDefaultRWConcernon the target cluster, Atlas keeps the value ofDefaultRWConcernfrom the snapshot without explicit configuration. This may differ from the default value for that MongoDB version.
This feature is not available for
M0clusters.For
M10+dedicated clusters, Atlas restores MongoDB Search index definitions from a Cloud Backup snapshot. Atlas doesn't restore search index data, so themongotprocesses perform initial syncs for all restored search index definitions. If you've defined large search indexes on your cluster, you might experience delays during snapshot restorations.Note
When you restore the data from the snapshot, the MongoDB Search index definitions from the snapshot replace any existing MongoDB Search index definitions.
Sharded Clusters
If you are restoring from a sharded cluster, the source and target clusters must have the same number of shards.
The source and target clusters must use the same type of config server. Config servers can be either config shards or dedicated config servers.
Atlas can't restore a sharded cluster snapshot to a replica set.
Flex Clusters
Atlas can't restore snapshots from Flex clusters, dedicated clusters, or Cloud Manager to a Flex cluster.
A Flex cluster allows you to have only two snapshots. If you require having more snapshots, upgrade your cluster to a dedicated cluster.
Recommendations to Optimize Restore Times
To optimize performance and reduce the amount of time it takes to restore, follow these principles where applicable:
Select a target cluster that isn't global or multi-cloud.
Select a multi-region cluster only if copies of the snapshot you plan to restore exist in every region of that cluster.
Select a target cluster that belongs to the same cloud provider region as the snapshot.
Select a cluster tier with the same storage capacity as the capacity of the original volume used by the source cluster.
If the target cluster runs on AWS with configured IOPS, select the configured IOPS to fall within the configured range.
Select a cluster that is not configured to use NVMe storage. NVMe storage degrades restore performance.
Fallback Snapshots
If a scheduled snapshot fails for any reason, Atlas attempts to repeat the snapshot process. If necessary, you may use the resulting fallback snapshot to restore the cluster. This isn't recommended: fallback snapshots use a different process from regular snapshots. They may contain inconsistent data.
Fallback snapshots are marked in the UI with a warning icon, and a warning message appears in the restore modal window if the restore uses a fallback snapshot.
Warning
Restoring your cluster from a fallback snapshot may result in inconsistent data across your cluster, and should be considered an option of last resort.
Required Access
To watch a backup restore job until it completes, you must have
Project Read Only access or higher to the project.
To start a restore job, you must have
Project Backup Manager or Project Owner access
to the project.
Procedure
Atlas deletes all existing data on the target cluster prior to the restore. The target cluster is unavailable for the duration of the restore. As part of the restore, Atlas also restores any indexes.
Restore a Cluster
To start a restore job for your project and cluster using the Atlas CLI, run the following command:
atlas backups restores start <automated|download|pointInTime> [options]
To watch for a specific restore job to complete using the Atlas CLI, run the following command:
atlas backups restores watch <restoreJobId> [options]
To learn more about the syntax and parameters for the previous commands, see the Atlas CLI documentation for atlas backups restores start and atlas backups restores watch.
The Atlas Administration API provides different endpoints for restoring
M10+ clusters and Flex clusters.
Restore One Snapshot of One Cluster Flex Clusters Restore Jobs
Restore a Cluster
In Atlas, go to the Backup details for your project.
If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.
If it's not already displayed, select your project from the Projects menu in the navigation bar.
In the sidebar, click Backup under the Database heading.
The Backup details display.
Click the cluster link.
Select the snapshot to restore and click Restore.
In the Actions column, expand the Actions menu, and click Restore for the snapshot that you want to restore.
In the modal window, select the target project and the target cluster from the dropdown menu. If the target cluster is part of a different project or organization than your source cluster, you can enter the name of and select the target project from the dropdown menu.
Follow the prompt and click Restore.
Restart your application and ensure it uses the new target cluster.