Deployment of CoMPAS

We deploy the (native) Docker image of all CoMPAS services to Docker Hub. This way, it can be pulled and deployed into environments of your choice (OpenShift for example).

Deploy demo environment

The compas deployment repository contains the deployment definition and workflow. To deploy a new version follow these steps.

1. Create a new branch and update the relevant Docker image tags to the new versions in compas/docker-compose-postgresql.yml

2. Create a pull request from your branch and request a review from one of the contributors.

3. Once the pipeline passed and the PR is approved, merge it.

4. Merging the PR triggers the deployment process via Github Actions. Visit http://demo.compas.energy to confirm the new version is deployed and functioning correctly.

Quick Deployment instructions (under construction)

The following instructions are terminal instructions for publishing a Quarkus docker image to Docker Hub. This should be done by a GitHub Action in the future.

docker login # Creating a Docker session

In order to publish it to Docker Hub, you have to login first and create a session.

./gradlew clean build -Pnative -Dquarkus.native.container-build=true -Dquarkus.container-image.build=true -Dquarkus.container-image.group=group -Dquarkus.container-image.name=name -Dquarkus.container-image.push=true

Few points in this single command:

• -Pnative creates a native executable (this needs some prework, see the Building Native Image documentation).
• -Dquarkus.native.container-build=true creates a Linux executable without GraalVM being installed (only necessary if GraalVM is not installed).
• -Dquarkus.container-image.build=true creates a container image with the native executable in it.
• -Dquarkus.container-image.group=group defining the group name. Standard it’s the system user name.
• -Dquarkus.container-image.name=name defining the name of the image. Standard it’s ‘app’.
• -Dquarkus.container-image.push=true deploys to docker image to Docker Hub.

Sources

Full documentation about deploying Quarkus application to Docker Hub