Automatically run MongoDB migration script when upgrading APIM

gaetanmaisse commented 2 years ago

:rainbow: Feature

As an APIM installation admin

I want to upgrade my APIM installation connected to MongoDB without having to run any migration script manually

So that data migration process is transparent and less error-prone (and we can not forget to run any script)

:sunrise_over_mountains: Additional information

A first investigation was done to see if Liquibase MongoDB could be a solution: https://github.com/gravitee-io/issues/issues/6075

TLDR;

Liquibase MongoDB will not be enough to handle complex migration as we are currently doing with JS script.

Also, some work has been done by the Archi team on an Upgrader Framework, we need to deep dive on this too:

Draft PR on APIM: https://github.com/gravitee-io/gravitee-api-management/pull/1407
Draft PR on gravitee-node: https://github.com/gravitee-io/gravitee-node/pull/134
Doc: https://gravitee.slab.com/posts/upgraders-d2r8w0uf & https://gravitee.slab.com/posts/adr-006-upgrader-framework-axesq88k

Finally, the AM team will have to handle the same thing so it could worth to sync with them when they will start: https://github.com/gravitee-io/issues/issues/7496

:link: Dependencies

https://github.com/gravitee-io/issues/issues/6075

:camera: Mockups

NA

:books: Documentation required

A small documentation section will be needed to explain the old vs new behavior.

:superhero: Acceptance criteria

[ ] Given an APIM installation, with ZIP file, connected to MongoDB When I upgrade to the next version Then data are properly migrated without any extra manual step
[ ] Given an APIM installation, with docker image in a k8s Kubernetes, connected to MongoDB When I upgrade to the next version Then data are properly migrated without any extra manual step

:warning: Potential impacts

NA

:rocket:

stale[bot] commented 2 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] commented 1 year ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] commented 1 year ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

gaetanmaisse commented 1 year ago

Closing as it's done in APIM 4.0 🙌

gravitee-io / issues