How automated migration works for Forge

This page explains how you can prepare to migrate your Jira or Confluence app data from server to Forge.

Migration steps

There are two main steps when migrating your Forge app data:

1. Pre-migration
2. Migration

1. Pre-migration

Here's an overview of the pre-migration setup.

Before app data migration begins, you need to prepare your server app and cloud app.

Prepare your server app

Implement a listener to enable communication between the server app and the app migration platform. This enables the server app to register with the platform and access the data mapping context to prepare for migration.

Prepare your Forge app

Add your Forge function triggers to your app's manifest.

2. Migration

During the course of the migration your app will mainly interact with an app migration transfer.

Learn more about app migration transfers

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:

• Your registered server app migration is triggered, after a core data migration
• Your server app exported data to the Atlassian secure cloud storage

This infographic shows an ideal data migration process.

Summary of stages

1. The Cloud Migration Assistant migrates core data from server to the cloud.
2. The app migration platform uploads data to a secure cloud storage location.
3. The app migration platform notifies cloud app of migration when data is uploaded to cloud storage.
4. The cloud app accesses the app data export from the cloud storage location.

On your Forge app

For every uploaded data (event avi:ecosystem.migration:uploaded:app_data), your Forge function will need to inform us that the data got processed. That's done by invoking messageProcessed(transferId: string, messageId: string) from the @forge/migrations module. The transferId and messageId are provided in the event payload.

On your server app

See the following pages for instructions on how to:

• Send app data to cloud storage
• Request mappings from your server app

Publish your migration path

Once you've implemented your migration path, assess its readiness and publish its availability to your customers.

Need help?

Check out our sample apps and tutorials to learn more about how the app migration platform works, or visit our support page.

For more information about migrating to cloud as a Marketplace Partner, check out our journey to cloud hub in the Partner Portal.

Request access to the Partner Portal.

---