Docs Menu
Docs Home
/
MongoDB Cloud Manager
/
Create Deployments
/
Provision Servers

Provision a Migration Host for MongoDB Agent

On this page

  • Overview
  • Considerations
  • Prerequisites
  • Migration Host Resource Requirements
  • Procedure
  • Next Steps

Important

Live Migration (push) Deprecated or Not Supported for Source Deployments Managed or Monitored by Ops Manager

  • For source deployments running any MongoDB 6.0.+ versions, where the deployments are managed or monitored by Ops Manager, live migration (push) is not supported.

  • For source deployments running any MongoDB 5.0 and earlier versions, where the deployments are managed or monitored by Ops Manager, live migration (push) is deprecated.

  • For source deployments running MongoDB 6.0.+, where the deployments are monitored by Cloud Manager, live migration (push) is supported. To learn more, see Live Migrate Your MongoDB Cluster Monitored by Cloud Manager to Atlas.

To live migrate your source MongoDB deployment monitored in Cloud Manager to Atlas, provision a server for the migration host.

Overview

The migration host is a server on which you install a dedicated MongoDB Agent. This MongoDB Agent automates live migration operations. It requires that you set its configuration option agentFeatureCloudMigrationEnabled to true.

You use the migration host to manage the live migration process of your deployment from Cloud Manager to Atlas. You can't use the migration host for any other purposes.

After you provision the migration host, its server appears under the Servers tab. A MongoDB Agent on the migration host runs a one-time migration of data from Cloud Manager to Atlas and reports the live migration status back to Cloud Manager.

To learn about starting a live migration from Cloud Manager, see Migrate a Deployment to Atlas and review the workflow for live migration to Atlas.

Considerations

If you plan to migrate more than one deployment at a time, create a dedicated migration host for each of the deployments that you want to migrate to Atlas.

Note

Using an HTTP proxy, which intercepts and replaces TLS certificates for the relayed HTTPS requests is not supported by Ops Manager when you use it in hybrid mode.

Prerequisites

The migration host must use a 64-bit CPU architecture and one of the following supported platforms. The platforms depend on the migration tool that the migration host will be running to facilitate the migration.

  • Migration host for live migrations (push) of source deployments of MongoDB versions 5.0+ but not 6.0 (FCV) that you add to monitoring in Cloud Manager, where the migration host runs mongomirror:

    Architecture
    Distro/OS
    5.0
    x86_64
    RHEL/Centos 7
    RHEL/Centos 8
    Amazon Linux 2
    SUSE12
    SUSE15
    Debian 9
    Debian 10
    Debian 11
    Ubuntu 18.x
    Ubuntu 20.x
    ARM
    RHEL/Centos 8
    Amazon Linux 2
    PowerPC/ ppc64le
    RHEL/ Centos 7
    RHEL/ Centos 8
    zSeries/ 390x
    RHEL 7
    RHEL 8
    Windows

    Note

    The configuration of a migration host for live migration is not supported on Windows or macOS. You can still live migrate (push) your data from a Windows-based deployment to Atlas if you provision your migration host on one of the platforms it supports. You can't live migrate your data from a macOS-based deployment to Atlas.

    If Cloud Manager is running in local mode, you must have outgoing access to the following server to download mongomirror.

    translators-connectors-releases.s3.amazonaws.com

  • Migration host for live migrations (push) of MongoDB 6.0.8+ source deployments monitored in Cloud Manager, where the migration host runs mongosync:

    The migration host must use a 64-bit CPU architecture and one of the mongosync platforms.

Migration Host Resource Requirements

The live migration process is CPU-intensive and requires sufficient network bandwidth. Use a cloud instance with enough resources to help ensure a successful migration.

Avoid host environments that have been characterized as having low network bandwidth.

You may also need to provision additional storage for the cloudMigrationOplogPath option described in the following procedure.

  • MongoDB 6.0.8+. For the migration host that runs mongosync to facilitate push live migrations, use an instance with a minimum of 8 CPUs and 24 GB of RAM.

  • MongoDB versions 5.0+ but not 6.0 (FCV). For the migration host that runs mongomirror to facilitate push live migrations, use a host with 2-4 CPU cores and 4-8 GB of RAM to migrate a replica set. Use an instance with 2-4 CPU cores per shard to migrate a sharded cluster.

Procedure

1

In MongoDB Cloud Manager, go to the Deployment page for your project.

  1. If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.

  2. If it's not already displayed, select your desired project from the Projects menu in the navigation bar.

  3. If the Deployment page is not already displayed, click Deployment in the sidebar.

    The Deployment page displays.

2

Go to the Agents page.

Click the Agents tab for your deployment.

The Agents page displays.

3

Click the Downloads & Settings tab.

4

Under Automation, select your operating system and follow the instructions to install and run the agent on the migration host.

To learn more, see Install the MongoDB Agent to Only Monitor or Backup Deployments.

5

Edit the MongoDB Agent configuration file to enable Live Migration.

  1. If you don't already have the automation-agent.config file open from the previous step, open it in your preferred text editor:

    sudo vi /etc/mongodb-mms/automation-agent.config

  2. Add or update the following live migration configuration options:

    Key
    Value
    true
    Path to the oplog files for the live migration process. This key is optional and if set, requires provisioning enough storage in the specified directory for the oplog buffering. Contact MongoDB Support if you need assistance determining whether you need to set this key for your deployment.

  3. Ensure that the resulting changes to the automation-agent.config file contain the following necessary configuration options for live migration:

mmsGroupId=<The ID of your project>
mmsApiKey=<The Agent API key of your project>
agentFeatureCloudMigrationEnabled=true
cloudMigrationOplogPath=<The path to the oplog files>
6

An additional server appears under the Servers tab, and an additional MongoDB Agent appears under the Agents tab.

Next Steps

Once you have provisioned the migration host, you can switch to Atlas and follow the steps in the wizard to start the live migration process.

Back

Use Automation

Next

Add Existing Processes