Gitlab-CI runner module for Puppet

Table of Contents

• Gitlab-CI runner module for Puppet - Table of Contents
  • Overview
  • Usage
  • SLES
  • Upgrading from version 3
  • Limitations
  • License

Overview

This module installs and configures the Gitlab CI Runner Package or nodes.

Usage

Here is an example how to configure Gitlab CI runners using Hiera:

Set $manage_docker to false (the default) if Docker is not required (e.g., with executor: "shell") or is managed by other means.

Setting $manage_docker to true requires the puppetlabs/docker module.

gitlab_ci_runner::concurrent: 4

gitlab_ci_runner::check_interval: 4

gitlab_ci_runner::metrics_server: "localhost:8888"

gitlab_ci_runner::manage_docker: true

gitlab_ci_runner::config_path: "/etc/gitlab-runner/config.toml"

gitlab_ci_runner::runners:
  test_runner1:{}
  test_runner2:{}
  test_runner3:
    url: "https://git.alternative.org/ci"
    registration-token: "abcdef1234567890"
    tag-list: "aws,docker,example-tag"
    ca_file: "/etc/pki/cert/foo.pem"

gitlab_ci_runner::runner_defaults:
  url: "https://git.example.com/ci"
  registration-token: "1234567890abcdef"
  executor: "docker"
  docker:
    image: "ubuntu:focal"

To unregister a specific runner you may use ensure param:

gitlab_ci_runner::runners:
  test_runner1:{}
  test_runner2:{}
  test_runner3:
    url: "https://git.alternative.org/ci"
    registration-token: "abcdef1234567890"
    ensure: absent

New GitLab Runner creation and registration process

GitLab version 15.10 introduced a new runner registration process using authentication token.

The authentication token can be obtained from GitLab using the user/runners API endpoint. More information can be found on the GitLab Tutorial: Automate runner creation and registration

This module is aware of this but needs some slight changes to the runners configuration:

1. switch from registration-token to token
2. remove deprecated tag-list config option - this must be specified when registering a runner in GitLab

Please note that one can reuse the same authentication token multiple times.

gitlab_ci_runner::runners:
  test_runner1:{}
  test_runner2:{}
  test_runner3:
    url: "https://git.alternative.org/ci"
    token: "abcdef1234567890"
    ca_file: "/etc/pki/cert/foo.pem"

gitlab_ci_runner::runner_defaults:
  url: "https://git.example.com/ci"
  token: "1234567890abcdef"
  executor: "docker"
  docker:
    image: "ubuntu:focal"

SLES

There are no gitlab_ci_runner repositories for SLES/zypper available! Instead one can use the go binary. This setup requires the puppet-archive module.

Please set the following data to be able to use this module on SLES:

gitlab_ci_runner::install_method: 'binary' # required for SLES
gitlab_ci_runner::binary_source: 'https://s3.dualstack.us-east-1.amazonaws.com/gitlab-runner-downloads/latest/binaries/gitlab-runner-linux-amd64' # default value
gitlab_ci_runner::binary_path: '/usr/local/bin/gitlab-runner' # default value

Upgrading from version 3

Version 4 of this module introduces some big changes. Puppet 6 or above is now required as the module now makes use of Deferred Functions when registering a runner.

Previously the gitlab_ci_runner::runner:config was only used when a runner was registered. The configuration was used as the arguments to the runner register command, which would write the configuration file after registering with the gitlab server. Puppet did not manage this file directly.

The module now manages the configuration file properly. That means, it's now possible to update most configuration settings after the initial registration, and more advanced configurations are supported.

⚠️ When upgrading, your runners will be re-registered.

When upgrading to version 4 you may need to update some of your manifests accordingly. For example:

class { 'gitlab_ci_runner':
  # [...]
  runners => {
    'my_runner' => {
      'url'                => 'https://gitlab.com/ci',
      'registration-token' => 'abcdef1234567890',
      'docker-image'       => 'ubuntu:focal',
    },
  },
}

would need to be converted to:

class { 'gitlab_ci_runner':
  # [...]
  runners => {
    'my_runner' => {
      'url'                => 'https://gitlab.com',
      'registration-token' => 'abcdef1234567890',
      'docker'             => {
        'image' => 'ubuntu:focal',
      },
    },
  },
}

Configuration keys that are specific to registration, (such as registration-token, run_untagged etc.) are not written to the runner's configuration file, but are automatically extracted and used during registration only. Changing these after registration has no affect.

Limitations

For the current list of tested and support operating systems, please checkout the metadata.json file.

It is currently not possible to alter registration specific configuration settings after a runner is registered.

License

lib/puppet_x/gitlab/dumper.rb is licensed under MIT. All other code is licensed under Apache 2.0.