Docs Menu
Docs Home
/
Relational Migrator

Installation

On this page

  • Supported Deployment Models
  • Deployment Considerations
  • Get Started

Supported Deployment Models

The following table describes Relational Migrator's supported deployment models and the recommended migration scenario for each deployment model:

Deployment Model
Description
Use Cases
Details

Local Desktop

Install Relational Migrator to a single machine that cannot be externally accessed.

For more information, see Developer Installation Guide.

  • Evaluation

  • Data Modeling

  • Testing

Evaluation and small production jobs expected to run for less than a day. Note that larger migrations can be broken down into separate jobs using table filters.

Unattended Server/VM

Install Relational Migrator on an unattended server that binds Relational Migrator to an IP address and port and exposes it as a web application.

For more information, see Production Installation Guide.

  • Testing

  • Smaller (<100GB) Production Migrations

Suitable for the majority of use cases, including tests and small production migrations. Note that installing as an unattended server is not a highly-availably solution, and users may need to intervene in the event of an application issue.

Kafka Cluster

Apache Kafka is an open-source platform for distributed workloads.

Use Relational Migrator as a Kafka Connect plugin to improve resilience and scalibility of big data migration jobs.

For more information, see Kafka Deployment Guide.

  • Mission Critical Migrations

  • Long Running Migrations

Critical production workloads and/or long-running CDC syncs. Using Relational Migrator with Kafka enables high availability and automatic failure recovery where supported by the underlying cluster configuration.

Kafka on Confluent Cloud

Confluent is a fully-managed Kafka hosting provider run by the founders of Kafka.

Use APIs to add the newest Relational Migrator sink connectors to Confluent Cloud as managed connectors.

For more information, see Install with Confluent Cloud.

  • Mission Critical Migrations

  • Long Running Migrations

Ideal for users that prefer a fully-managed cloud-based solution.

Deployment Considerations

Where to Run Relational Migrator

For best performance, locate the machine or server running Relational Migrator as geographically close to the source and target databases as possible. Proximity to the target database influences performance the most:

  • If you're using Relational Migrator for an on-premises migration, run Relational Migrator in the same data center as the source database.

  • If you're using a cloud hosted database, run Relational Migrator on an EC2 instance or VM in the same VPC as the source database.

Tip

Check the sleep timeout setting for your operating system. If your machine goes to sleep during a migration, the migration job fails.

Network Considerations

When using Relational Migrator, the system firewall on the machine or server must allow outbound TCP traffic to both the source and destination databases.

Cloud Networking

When running Relational Migrator in a cloud environment, check the cloud specific firewall (security group), router table, and the server firewall configurations. For details on specific cloud provider network configurations, see these pages:

Telemetry

By default, Relational Migrator includes telemetry that reports usage information and errors back to MongoDB to help improve the product. This telemetry does not include any sensitive details such as database connection strings, schema information or customer data.

You can disable telemetry by editing the application's user.properties file, adding the following line, and restarting Relational Migrator:

migrator.app.telemetry.enable: false

System Hardware

For specific hardware recommendations, see System Requirements.

Note

Scaling up the Atlas cluster size can significantly improve migration speeds. For details, see Modify the Cluster Tier.

Get Started

Back

UI Overview

Next

System Requirements