Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/voxpupuli/puppet-gitlab_ci_runner
Module to mange gitlab CI runners. Extracted from https://github.com/voxpupuli/puppet-gitlab
https://github.com/voxpupuli/puppet-gitlab_ci_runner
centos-puppet-module debian-puppet-module hacktoberfest linux-puppet-module oraclelinux-puppet-module puppet redhat-puppet-module scientific-puppet-module ubuntu-puppet-module
Last synced: 4 days ago
JSON representation
Module to mange gitlab CI runners. Extracted from https://github.com/voxpupuli/puppet-gitlab
- Host: GitHub
- URL: https://github.com/voxpupuli/puppet-gitlab_ci_runner
- Owner: voxpupuli
- License: apache-2.0
- Created: 2018-07-08T21:24:40.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-17T07:50:33.000Z (4 months ago)
- Last Synced: 2024-10-29T14:22:35.643Z (2 months ago)
- Topics: centos-puppet-module, debian-puppet-module, hacktoberfest, linux-puppet-module, oraclelinux-puppet-module, puppet, redhat-puppet-module, scientific-puppet-module, ubuntu-puppet-module
- Language: Ruby
- Homepage:
- Size: 407 KB
- Stars: 14
- Watchers: 39
- Forks: 54
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Gitlab-CI runner module for Puppet
[](https://github.com/voxpupuli/puppet-gitlab_ci_runner/actions?query=workflow%3ACI)
[](https://github.com/voxpupuli/puppet-gitlab_ci_runner/actions/workflows/release.yml)
[](https://forge.puppetlabs.com/puppet/gitlab_ci_runner)
[](https://forge.puppetlabs.com/puppet/gitlab_ci_runner)
[](https://forge.puppetlabs.com/puppet/gitlab_ci_runner)
[](https://forge.puppetlabs.com/puppet/gitlab_ci_runner)
[](http://www.puppetmodule.info/m/puppet-gitlab_ci_runner)
[](LICENSE)
#### Table of Contents
- [Gitlab-CI runner module for Puppet](#gitlab-ci-runner-module-for-puppet)
- [Table of Contents](#table-of-contents)
- [Overview](#overview)
- [Usage](#usage)
- [SLES](#sles)
- [Upgrading from version 3](#upgrading-from-version-3)
- [Limitations](#limitations)
- [License](#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](https://forge.puppetlabs.com/puppetlabs/docker) module.
```yaml
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:
```yaml
gitlab_ci_runner::runners:
test_runner1:{}
test_runner2:{}
test_runner3:
url: "https://git.alternative.org/ci"
registration-token: "abcdef1234567890"
ensure: absent
```
## 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](https://github.com/voxpupuli/puppet-archive) module.
Please set the following data to be able to use this module on SLES:
```yaml
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](https://puppet.com/docs/puppet/6/deferring_functions.html) 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:
```puppet
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:
```puppet
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](lib/puppet_x/gitlab/dumper.rb) is licensed under MIT. All other code is licensed under Apache 2.0.