Migrate an mLab MongoDB Cluster to Atlas
MongoDB Atlas is a cloud service for running, monitoring, and maintaining MongoDB Deployments, including the provisioning of dedicated servers for MongoDB instances.
The following procedure migrates a MongoDB cluster hosted on mLab to Atlas. Because the procedure uses the Atlas Live Migration tool, the procedure only requires downtime while updating your applications to connect to the Atlas cluster.
The Atlas Live Migration tool requires that the source cluster runs MongoDB 3.0 or later. See Live Import Upgrade Path for more information.
Important: This procedure only applies to Dedicated mLab clusters. Shared or Sandbox mLab clusters are missing command and operational capabilities that the Live Migration tool requires to function.
Configure the Source mLab Cluster for Migration
Log into your mLab account and click on the MongoDB cluster you want to migrate. Keep this page open, as you will need the information presented on it for use with this procedure.
Create an Administrative User for Migration
To create an administrative user:
- Select the source MongoDB cluster in the mLab user interface.
- From the Databases view, click the
- Click Users.
- Click Add admin user. Take note of the username and password you assign. This user may be read-only.
- Click Create to create the user.
Whitelist the Atlas Migration Servers
- From the cluster view, click Networking.
- Click Add IP address range rule(s).
Add the following IP addresses:
- Click Apply security changes. When prompted, click Yes to confirm.
Configure the Destination Atlas Cluster for Migration
Log into your Atlas account and click Clusters in the left-hand navigation panel. Ensure you are in your preferred Atlas group by checking the Group dropdown in the top-left corner of the Atlas UI.
If you have not yet created an Atlas cluster as the destination for the migration procedure, create one now.
When selecting a destination cluster, consider the following:
The live migration process may not be able to keep up with a source cluster whose write workload is greater than what can be transferred and applied to the destination cluster. You may need to scale the destination cluster up to an instance with more processing power, bandwidth, or disk IO.
The destination Atlas cluster must be a replica set. You can scale the cluster to a sharded cluster after migration.
You cannot select an M0 (Free Tier) cluster as the destination for live migration.
The destination cluster should be empty, excluding data on the
localdatabases, to prevent namespace collisions. A namespace is the full path to a collection in
<database>.<collection>format. For example, if both the source and the destination cluster contain data in the
foo.barnamespace, the procedure will fail.
Configure MongoDB Users
The Atlas Live Migration tool does not migrate user and role data. You must configure the necessary MongoDB users, such that your applications have the same level of data and operational access as provided on the mLab cluster.
Whitelist Applications That Must Connect to the Cluster
Atlas defaults to blocking all incoming connections not on the IP whitelist. The Live Migration tool automatically adds a temporary whitelist entry for the source mLab cluster. You must whitelist any other applications or services that need to connect to the Atlas cluster.
VPC Peering (AWS Only)
The Atlas Live Migration tool does not leverage any VPC peering connections configured for the destination cluster. If you require that the live migration procedure leverage a VPC peering connection, please contact MongoDB Support.
Configure your Application Server for Migration
Ensure your applications meet the following requirements before starting the migration process:
The application server must have support for TLS/SSL to connect to an Atlas cluster.
If the application server uses a MongoDB driver to connect and perform operations on the MongoDB cluster, you must update to a driver version that is recommended for the MongoDB version of the destination cluster. See the driver compatibility table for complete documentation.
If the application server uses a MongoDB component, such as the mongo shell, to connect and perform operations on the MongoDB cluster, you must update these components to match the MongoDB version of the destination cluster. Download the appropriate version of the MongoDB server package. The server package includes the
mongoshell and other components such as mongodump and mongorestore.
Migrate an mLab Cluster to Atlas
Important: The Live Migration tool requires a period of downtime where you cut over your applications to the Atlas cluster. Atlas provides a 72-hour extendable cutover period during which you can schedule the downtime.
Step 1: Open the Live Migration Configuration Dialog
In the Altas UI, from Clusters view click the ... button for the destination cluster and select Migrate Data To This Cluster.
Atlas provides a summary of the Live Migration procedure. Once you have read through it, click I'm Ready To Migrate to open the configuration dialog.
Step 2: Enter the Source Cluster Connection Information
The Live Migration configuration dialog requires the following information from the mLab cluster view:
Portof the primary replica set member in the mLab cluster,
Usernamefor administrative user created in an earlier step, and
Passwordfor the administrative user created in an earlier step.
The mLab cluster view displays the hostname and port of the primary replica set member as a part of the mongo shell connection dialog:
mongo example.mlab.com:59622/<database> -u <dbuser> -p <dbpassword>
The primary replica set member's hostname and port is
Copy the hostname, username, and password into the Live Migration configuration dialog.
If your mLab cluster requires SSL for connectivity, you must retrieve the mLab's root certificate. Follow mLab's documentation to retrieve the SSL certificate text. In general, you must:
- Download the root mLab certificate.
mLab provides the root certificate in the DER binary format. You must convert this to a PEM ASCII-based format.
The following example uses the
openssltool to convert the root mLab certificate to PEM:
openssl x509 -inform der -in <path-to-DER-certificate> -out <path-to-PEM-certificate>
Copy the entire certificate, including the
- In the Atlas Live Migration configuration dialog, toggle Is SSL Enabled to
Yesto display a text box for entering the certificate.
- Paste the entire the certificate into the Atlas Live Migration configuration dialog.
Step 3: Validate the Live Migration Settings
Click Validate to prompt Atlas to confirm it can successfully connect to the mLab cluster. If the connection fails to validate, ensure you have entered all information correctly and that you have configured the mLab cluster whitelist.
If errors persist, open a support ticket in Atlas UI by clicking `Support in the left-hand navigation and filling out the requested information.
Step 4: Begin the Live Migration Procedure
Once your connection is validated, click Start Migration. Atlas begins the migration procedure and displays a counter in the UI that represents the time remaining for the Atlas cluster to catch up to the Compose.io cluster.
When the timer turns green, click the Start Cut Over button. Atlas displays a walk-through with instructions on how to proceed with the cut over. Once you click the Start Cut Over button, Atlas starts an extendable 72 hour timer to begin the cut over procedure. If the 72 hour period passes, Atlas stops synchronizing with the source cluster. You can extend the time remaining by 24 hours by clicking the Extend time hyperlink below the timer.
- Stop all applications from reading or writing to the Compose.io cluster.
- Wait for the timer to hit
- Update applications with the Atlas cluster connection URI as displayed in Atlas.
- Update applications to use Atlas MongoDB users, such that they retain the same level of data and operational access.
- Restart your applications and confirm they are reading from and writing to the Atlas cluster.
Once your applications are up, you can confirm they have connected successfully to the Atlas cluster and are writing normally. When you have validated that your applications are working as expected, you can click I'm done to complete the migration procedure and stop reading data from the mLab cluster.