Change Deployment Models

Overview

You can change an existing App's deployment configuration to deploy it in a new model, region, and/or cloud provider. For example, you might switch your App from a global deployment to a specific local AWS region or switch an App deployed in the Eastern USA from AWS to Azure. For a list of all available options, see Deployment Models & Regions.

To move an existing App, you begin a Deployment Migration that automatically moves your App's data and configuration to the new configuration. The migration process is designed to be as seamless as possible but requires up to 30 minutes of downtime. You can monitor the migration status but no requests will be processed until the migration is complete. For more information, see Deployment Migration Process.

If you connect to your App from a Realm SDK, you must update your SDK to a version that supports changing deployment models. If you change deployment models before upgrading, the SDK will not be able to connect and requests will fail.

Run a Deployment Migration

You can begin a deployment migration at any time. Only one migration may be in progress at a time for a single App. If you try to start a migration while another is in progress, the new migration does not run and fails with an error.

Deployment Migration Process

Deployment migrations move your App's data and configuration to one or more new regions in a series of stages. At each stage, the process migrates a portion of your App to the new model and cleans up any artifacts from the previous model.

A deployment migration moves through the following stages in order:

1. "started": the migration has been started

2. "downtime": the App is unavailable while the migration is in progress

3. "enabling_event_subscriptions": the App's Triggers and Device Sync translators are being enabled

4. "cleanup": deployment artifacts are being cleaned up

5. The migration is complete and can be in one of two states:

   • "successful": the migration completed successfully

   • "failed": the migration failed

The migration process does not affect any application data stored in a MongoDB Atlas cluster.

The migration process migrates the following components of your App:

• User accounts

• App configuration files

• Triggers

• API Services

• Device Sync translators

The migration process does not migrate the following data:

• Application logs

• Deployment drafts

• Data stored in a MongoDB Atlas cluster