Migration

Following are migration guides for breaking changes introduced in the RefArch which require some more work.

Split gateway and frontend

Main change: separated centrally maintained gateway -> separate image for frontend

Prerequisites

In general the migration can be done if the gateway was never modified (e.g. some custom filters).

Even if some changes were introduces there is the possibility to migrate, by either switching to some other already included feature (e.g. client routes) or by contributing the changes to the central gateway if they can also be useful for other projects.

Steps

The migration consists of two parts: extracting the frontend and using the centralized gateway

Frontend

• Extract the frontend code into a separate repo or folder (in a mono repo)
• Copy Dockerfile and nginx config docker/nginx/ from refarch-frontend template
• Adopt and configure maven-node-build.yml and npm-release.yml GitHub Actions workflows, see .github
  • For internal GitLab migration see according docs

Gateway

For local development adopt the development stack (containing the gateway) from the RefArch templates. Changing of the routes might be required to match the previous setup by modifying the environment variables inside the Docker compose file.

For deploying the central Gateway use the according container image and compare your working config with the application.yml, application-local.yml (inside gateway code resources folder) and configuration section to find properties which need to be migrated.