Forge Home

gitlab_ci_runner

tasks
Installation and configuration of Gitlab CI Runner

Vox Pupuli

puppet

347,997 downloads

830 latest version

5.0 quality score

Version information

  • 4.0.0 (latest)
  • 3.0.0
  • 2.1.0
  • 2.0.0
  • 1.0.0
released Aug 26th 2021
This version is compatible with:
  • Puppet Enterprise 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x
  • Puppet >= 6.1.0 < 8.0.0
  • RedHat
    ,
    CentOS
    ,
    OracleLinux
    ,
    Scientific
    ,
    Debian
    ,
    Ubuntu
Tasks:
  • register_runner
  • unregister_runner

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'puppet-gitlab_ci_runner', '4.0.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add puppet-gitlab_ci_runner
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install puppet-gitlab_ci_runner --version 4.0.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download
Tags: git, gitlab

Documentation

puppet/gitlab_ci_runner — version 4.0.0 Aug 26th 2021

Gitlab-CI runner module for Puppet

Puppet Forge Puppet Forge - downloads Puppet Forge - endorsement Puppet Forge - scores

Table of Contents

  1. Overview
  2. Usage - Configuration options and additional functionality
  3. Limitations - OS compatibility, etc.
  4. Upgrading from version 3
  5. 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:

To use the Gitlab CI runners it is required to have the puppetlabs/docker module.

$manage_docker can be set to false if docker is managed externally.

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"

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

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

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.

:warning: 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',
      '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

The Gitlab CI runner installation is at the moment only tested on:

  • CentOS 7/8
  • Debian 9/10
  • Ubuntu 18.04/20.04

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.