Rate this page:
Latest updates
The App migration platform is currently running beta version.
Refer our release notes for the latest information on the platform.
About the App migration platform
Welcome to the App migration platform developer documentation. This page provides an overview of how Marketplace Partners can move Jira and Confluence app data from server to cloud using the App migration platform.
App data migration begins after an administrator migrates the Jira or Confluence core product data from server to cloud using a Jira or Confluence migration assistant. Read our docs for information on migrating Jira or Confluence core product data.
Migrating your app data from server to cloud
There are three main steps when migrating your app data:
- Pre-migration: Prepare your server and cloud apps for data migration.
- Migration: Migrate your data with the App migration platform.
- Post-migration: Configure your cloud app for migration updates.
Server to cloud app migration is available for two scenarios:
- A single server app migrating data to a single cloud app
- Multiple server apps migrating data to a single cloud app
The sections that follow provide a high-level overview of the pre-migration, migration, and post-migration steps.
Pre-migration: Prepare your apps for migration
Before app data migration begins, you will need to prepare your server app and cloud app for migration. The infographic that follows provides a high-level overview of the pre-migration setup.
On your cloud app
Register webhooks to set up the communication between the App migration platform and your cloud app. This enables the App migration platform to notify your cloud app when specific events happen on your server app during migration. Use the Notification API to register webhooks with the App migration platform.
Key components and tools
| Component | Description |
|---|---|
| Your cloud app | Your app installed on the cloud site |
| Atlassian Connect | The framework that your cloud app uses to interact with the App migration platform and the cloud products, and contains all the endpoints for migration |
| Notification API | Provides endpoints to register/deregister your cloud app, and to receive notifications about migration events |
On your server app
Set up interfaces for communication between the server app and the App migration platform. This enables the server app to register with the App migration platform and access the data mapping context to prepare for migration.
Key components and tools
| Component | Description |
|---|---|
| Your server app | Your server app that's hosted with Jira or Confluence on a user's server instance |
| Jira or Confluence Cloud Migration Assistant (JCMA/CCMA) | Contains all the libraries and functions you'll require to migrate data, and provides a user interface that displays the data to be migrated on a server instance |
| App cloud migration library | Used to implement the interfaces to enable communication between your server app and the App migration platform |
| Mappings API | Provides endpoints to retrieve mappings |
Read more about pre-migration steps in our docs.
Migration: Migrate app data with the App migration platform
The app data migration begins after the core data (Jira or Confluence product data) has been migrated from server to cloud. In the migration phase, you will need to prepare your cloud app to respond to notifications about specific migration events on the server app. The App migration platform notifies your cloud app when the following events take place:
- your registered server app migration is triggered, after a core data migration
- your server app exported data to the Atlassian secure cloud storage
Read the further details related to events here.
The infographic that follows provides a high-level overview of an ideal data migration process.
Summary of stages
- The migration assistant migrates core data from server to the cloud.
- The App migration platform uploads data to a secure cloud storage location.
- The App migration platform notifies cloud app of migration when data is uploaded to cloud storage.
- The cloud app accesses the app data export from the cloud storage location.
Key components and tools
| Component | Description |
|---|---|
| App data retrieval API | Provides endpoints to access the exported app data from your server app |
| Feedback channel API | Provides endpoints to send information from your cloud app to the server product |
Post-migration: Configure your cloud app for migration updates
After or during the app data migration to the cloud site, you configure your cloud app to provide updates about the migration status to the App migration platform. The platform displays the status of migration on your server app in the Cloud Migration Assistant.
The infographic that follows provides a high-level overview of post-migration.
Key components and tools
| Component | Description |
|---|---|
| Your Jira/Confluence server app | Your server app that's hosted with Jira or Confluence on a user's server instance |
| Jira or Confluence Cloud Migration Assistant (JCMA/CCMA) | Contains all the libraries and functions you'll require to migrate data, and provides a user interface that displays the data to be migrated on a server instance |
| Status API | Provides the status of your migration to the server product. |
Publish your migration path
Once your migration path is implemented, you need to assess its readiness and publish it so it's available and visible to your customers in the Cloud Migration Assistants.
Read the readiness checklist in our docs.
Rate this page: