Skip to content

Preparations you need to make in advance

1. Create a git project on https://codebase.helmholtz.cloud/groups/ufz/

  • Place the source code used to create the Docker Images in the git project.
  • Attention: Do not use a personal GitLab project (containing your username). This complicates the process of transferring responsibility for an application if you should leave the UFZ one day. Instead, use a GitLab project located in a thematically meaningful group. If you like, you can also place it below "https://codebase.helmholtz.cloud/groups/ufz//".
  • Use the container registry of the git project to store the created Docker Images there. Please do not use the image tag :latest, but use concrete version numbers like :1.0.0
  • For a review of the source code, please also give access to the repository to all persons, that are listed below:
  • Hannes Bohring
  • Quentin Czernin
  • Conrad Ostertag
  • Robin Zinke

2. Store the required Docker images in the GitLab project

  • Use a CI/CD pipeline to build the required Docker images and push them to the container registry of the GitLab project. No manual pushing.
  • Ensure that the images contain all data that you have placed into the containers during development via volume mounts (e.g., source code or configuration files).
  • The goal is for your application to be able to start exclusively based on the Docker images stored in the GitLab container registry – i.e., without having access to the source code of the GitLab project. All data (with the exception of credentials or data from central databases) must be contained in the images!

3. Create a Docker Compose setup for the WOMBAT cluster

In your GitLab project, place a docker-compose.yml file in this directory that meets the following criteria:

  • No build attributes are used (that means no images are built via the docker compose setup) - instead, all services use only images from central container registries (GitLab, Docker Hub, or similar).
  • All services of the Docker Compose setup use external ports that no other service of the setup uses as an external port

If you are not using Docker Compose, please document in a README.md file the docker run command that will allow the app to run while meeting the previously mentioned criteria.

4. Testing the Docker Compose setup for the WOMBAT cluster

  • Start the Docker-Compose setup you created earlier using docker compose -f docker-compose.yml up (or execute the documented docker run command).
  • The app will later be accessible via the URL "https://web.app.ufz.de/path/to/app" or "https://web-intern.app.ufz.de/path/to/app". Choose an appropriate path for "/path/to/app" and ensure that the locally started Docker-Compose setup (for WOMBAT) is accessible at the address "http://localhost/path/to/app". Alternatively, it is also possible to obtain a subdomain for the app. The URL would then look like this: https://app.web.app.ufz.de/