Migration path readiness checklist

These are the steps you must perform to assess the readiness of your migration path. They will allow customers to successfully migrate their server app data to your cloud app.

Types of migration paths

To understand which steps to follow, first identify your app's migration path:

• Fully automated:

  • Is integrated with the Cloud Migration Assistant (aka CMA) using server listeners
  • Doesn't require any manual post-migration action to be performed by the customer

• Partially automated:

  • Is integrated with the Cloud Migration Assistant (aka CMA) using server listeners
  • Requires manual post-migration steps to be performed by the customer

• Included with the core migration of the Cloud Migration Assistant (CMA):

  • Doesn't require any implementation using server listeners
  • Doesn't require any manual post-migration steps to be performed by the customer. This scenario is common to Confluence apps based on macros, as the macros migrate with the content of the pages.

Fully automated and Partially automated

Step 1: Implement the 'Progress reporting' feature

Step 2: Publish a new version of your server app to Marketplace

• After you've tested your migration path, build your app and publish it to Marketplace. At this stage, your migration path availability still won't be displayed to customers.

Step 3: Publish the availability of your migration path

• Use the Marketplace Migrations API to inform customers about the availability of your migration path in the Assess your apps screen of the CMA:

  

  • Provide migrationPath field with the value set to AUTOMATED.

  • Provide the cloudMigrationAssistantCompatibilityRanges field value to the Marketplace Migrations API. This field value should indicate the version ranges of your server app with the automated migration path implementation. The CMA will ask your customers to upgrade their server app if the installed version is lower than the versions specified in these ranges.

  • (Optional) Provide the featureDifferenceDocumentation field value to link to a page that explains the differences between the server and cloud versions of your app.

  • (Optional) Provide the migrationDocumentation field value to link to your app's migration guide.

Included in the core migration of the Cloud Migration Assistant

Step 1: Publish the availability of your migration path

• Use the Marketplace Migrations API to inform customers about the availability of your migration path in the Assess your apps screen of the CMA:

  

  • Provide migrationPath field with the value set to INSTALL_ONLY.

  • Provide the cloudMigrationAssistantCompatibilityRanges field value to the Marketplace Migrations API. This field value should indicate the version ranges of your server app with the automated migration path implementation. The CMA will ask your customers to upgrade their server app if the installed version is lower than the versions specified in these ranges.

  • (Optional) Provide the migrationDocumentation field value to link to your app's migration guide.

  • (Optional) Provide the featureDifferenceDocumentation field value to link to a page that explains the differences between the server and cloud versions of your app.

Checking your migration path

If your app has an automated path, the app assessment screen should reflect this. Refer to understanding app assessment for more information.