Install and run on GitLab CI/CD, Host, Linux and Docker

Requirements

• GitLab;

• Linux host to install the GitLab Runner, featuring:

  • Bash;

  • Git version 2.18.0 or above;

  • GPG;

  • Docker Engine.

Installing the GitLab Runner

Follow official instructions to install the GitLab Runner on your dedicated host.

Installing werf

To install werf on the GitLab Runner host, run the following command:

curl -sSL https://werf.io/install.sh | bash -s -- --ci

Registering the GitLab Runner

Follow official instructions to register GitLab Runner in GitLab: set Shell as the executor. Once the registration is complete, you may want to perform additional GitLab Runner configuration.

Configuring the container registry

Enable garbage collection for your container registry.

Preparing the system for cross-platform building (optional)

This step only needed to build images for platforms other than host platform running werf.

Register emulators on your system using qemu-user-static:

docker run --restart=always --name=qemu-user-static -d --privileged --entrypoint=/bin/sh multiarch/qemu-user-static -c "/register --reset -p yes && tail -f /dev/null"

Configuring the GitLab project

• Enable Require a successful pipeline for merge requests.

• Enable the option to auto-cancel redundant pipelines.

• Create and save the access token to clean up the no longer needed images from the container registry with the following parameters:

  • Token name: werf-images-cleanup;

  • Role: developer;

  • Scopes: api.

• Add the following variables to the project variables:

  • werf version:

    • Key: WERF_VERSION;

    • Value: 2 stable;

  • Access token to clean up the no longer needed images:

    • Key: WERF_IMAGES_CLEANUP_PASSWORD;

    • Value: <"werf-images-cleanup" access token you saved earlier>;

    • Protect variable: yes;

    • Mask variable: yes.

• Add a scheduled nightly task to clean up the no longer needed images in the container registry by setting the main/master branch as the Target branch.

Configuring CI/CD of the project

This is how the repository that uses werf for build and deploy might look:

Extras:

• Add authorization options for werf cleanup in the container registry by following instructions.