Gitlab-runner

General notes on the usage of Gitab-CI

When using gitab CI for your project, you should be aware, that your CI can be controlled by the .gitlab-ci.yml file, located in the root directory of your repository. That implies that:

• it can be viewed by anyone allowed to view your repository, so do not include any sensitive information. Use instead secret variables to pass sensitive informations to your job, if necessary.

• potentially anybody allowed to commit changes, can alter your .gitlab-ci.yml and by this control your CI jobs. Thus, you need to carefully configure your CI (by means of your .gitlab-ci.yml and your gitlab-project management interface), so that it is only triggered and changed if and by whom you want it to. We recommend to use the rules keyword in your .gitlab-ci.yml to explicitly define what triggers your job (e.g. certain branches, tags etc.).

DKRZ runners

The DKRZ offers a set of instance runners to build and test your code in specific environments and/or build and publish your documentation via gitlab pages.

DKRZ Runners

Description	Tags	Image Details
Runner to build conda or PyPi packages	condaforge, dkrz	click here
Runner to build doxygen pages	doxygen, dkrz	click here
Runner to build sphinx pages	sphinx, dkrz	click here
Runner to build quarto pages	quarto, dkrz	click here
Runner to build latex projects	latex, dkrz	click here
Runner with bare alpine image for own customizations	alpine, dkrz	alpine:latest
Runner accepting arbitrary docker images	docker-any-image, dkrz	gcr.io/kaniko-project/executor:debug
Runner providing slurm access to levante; the jobs are executed as the user, who triggered the pipeline	levante, hpc, dkrz	not applicable

These runners can be used by all projects and simply need to be enabled in the respective project under Settings CI/CD Runners. All runners are tagged and only run tagged jobs. That implies, that you need to specify the correct tags in your .gitlab-ci.yml file to use any of the dkrz runners.

Please choose the appropriate runner for your task with care. On the one hand, the resources for all the runners are limited and using one of our more specialized runner (as e.g. the docker-any-image runner) for a task that could be done with a simple runner (like e.g. the alpine runner) might unnecessarily increase the waiting time for your colleagues; On the other hand using a too elaborate runner (as e.g. the levante runner) for a simple task, like copying files in a pages job, might tremendously increase the execution time of your job.

We recommend to use our ci-templates, if applicable, in order to ensure that your ci is in line with certain defaults and/or best practices. We also invite you to check and contribute to the examples in our ci-example repository .

The provided runners mostly use docker executors with images created and stored in our gitlab. You can find more details to some of the images here (gitlab login required). You can install additional packages, needed for your project, in the script section of your .gitlab-ci.yml file.

The usage and/or creation of own images is possible only in the docker-any-image runner.

If the offered runner do not satisfy your requirements, you are always free to setup your own runners, or contact support@dkrz.de in case you believe that your requirements would meet the needs of a larger community, making the setup of an additional instance runner feasible. Yet, be aware that we intentially do not offer any docker-in-docker solutions due to the implied security risks.