Overview

We’ve run into situations where the migration API request times out, but the process is still working behind the scenes. This is confusing to the operator and leaves them in a situation where it’s unclear what the state of things is. By making this API asynchronous, and providing a way for the status to of the migration to be checked, we can avoid a lot of confusion.

Scope

• Introduce an asynchronous migration API

• Implement an API which allows the operator to check on the status of a migration

• Only one migration per tenant should be allowed at once. An error response should be returned if a migration is in progress and another one is attempted.

Out of scope/Future consideration:

• Deprecation of the synchronous migration API

• Being able to see migration history would add even more clarity - what migrations occurred, when, how long did they take, did they complete successfully or fail, etc. (Nice to have)

Acceptance Criteria

• It’s possible to invoke migration asynchronously, getting a response immediately, and then being able to check on the status of your migration

• Only on migration per tenant is allowed at a time

• Tests have been updated and coverage is 80%+