Docs Menu

Docs Home → Atlas App Services

Change Deployment Models

On this page

  • Overview
  • Run a Deployment Migration
  • Before You Begin
  • Procedure
  • Deployment Migration Process
  • Data Affected

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 5 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.

Important

Contact MongoDB Support

We recommend that you contact MongoDB technical support if you are planning to change your deployment model for a production App. To learn how, visit the MongoDB Support portal.

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.

If you connect to your App from a Realm SDK, you must update your SDK to a version that supports changing deployment models. If your App's SDK version does not support changing deployment models, you'll need to reinstall your app. If you change deployment models before upgrading, the SDK will not be able to connect and requests will fail.

Minimum SDK version:

  • Realm C++ SDK v0.2.0

  • Realm Flutter SDK v1.2.0

  • Realm Kotlin SDK v1.10.0

  • Realm .NET SDK v11.1.0

  • Realm Node.js SDK v12.0.0 (pending release)

  • Realm React Native SDK v12.0.0 (pending release)

  • Realm Swift SDK v10.40.0

Before You Begin

Before changing deployment models, please note the following:

  • All logs and drafts will be lost.

  • Suspended Triggers will restart.

  • Any existing Private Endpoints will need to be recreated for the new region.

  • Triggers and Device Sync operations will be paused during the migration.

Important

Deployment Migration is Permanent

Changing your deployment model is not a draft. This change cannot be reversed after it is saved.

Procedure

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

Data Affected

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

← Set Up a CI/CD Pipeline
Deployment Models & Regions →

On this page