README.md 1.88 KB
Newer Older
Erik-jan Riemers's avatar
Erik-jan Riemers committed
1
GitLab Runner [![Build Status](https://api.travis-ci.org/riemers/ansible-gitlab-runner.svg?branch=master)](https://travis-ci.org/riemers/ansible-gitlab-runner) [![Ansible Role](https://img.shields.io/badge/role-riemers.gitlab--runner-blue.svg?maxAge=2592000)](https://galaxy.ansible.com/riemers/gitlab-runner/)
Harold Barker's avatar
Harold Barker committed
2 3
=============

Harold Barker's avatar
Harold Barker committed
4
This role will install the [official GitLab Runner](https://gitlab.com/gitlab-org/gitlab-ci-multi-runner)
5
(fork from haroldb) with updates. Needed something simple and working, this did the trick for me. Open for changes though.
Harold Barker's avatar
Harold Barker committed
6 7 8 9 10 11 12 13 14

Requirements
------------

This role requires Ansible 2.0 or higher.

Role Variables
--------------

Harold Barker's avatar
Harold Barker committed
15
`gitlab_runner_concurrent`
Harold Barker's avatar
Harold Barker committed
16 17 18
The maximum number of jobs to run concurrently.
Defaults to the number of processor cores.

Harold Barker's avatar
Harold Barker committed
19 20 21
`gitlab_runner_registration_token`
The GitLab registration token. If this is specified, a runner will be registered to a GitLab server.

Harold Barker's avatar
Harold Barker committed
22
`gitlab_runner_coordinator_url`
Harold Barker's avatar
Harold Barker committed
23
The GitLab coordinator URL.
Harold Barker's avatar
Harold Barker committed
24
Defaults to `https://gitlab.com/ci`.
Harold Barker's avatar
Harold Barker committed
25

Harold Barker's avatar
Harold Barker committed
26
`gitlab_runner_description`
Harold Barker's avatar
Harold Barker committed
27 28 29
The description of the runner.
Defaults to the hostname.

Harold Barker's avatar
Harold Barker committed
30
`gitlab_runner_executor`
Harold Barker's avatar
Harold Barker committed
31
The executor used by the runner.
Harold Barker's avatar
Harold Barker committed
32
Defaults to `shell`.
Harold Barker's avatar
Harold Barker committed
33

34 35 36
`gitlab_runner_docker_image`
The default Docker image to use. Required when executor is `docker`.

Harold Barker's avatar
Harold Barker committed
37
`gitlab_runner_tags`
Harold Barker's avatar
Harold Barker committed
38 39
The tags assigned to the runner,
Defaults to an empty list.
Harold Barker's avatar
Harold Barker committed
40

41 42
See the [config for more options](https://github.com/riemers/ansible-gitlab-runner/blob/master/tasks/register-runner.yml)

Harold Barker's avatar
Harold Barker committed
43 44
Example Playbook
----------------
Harold Barker's avatar
Harold Barker committed
45 46 47 48 49 50
```yaml
- hosts: all
  remote_user: root
  vars_files:
    - vars/main.yml
  roles:
51
    - { role: riemers.gitlab-runner }
Harold Barker's avatar
Harold Barker committed
52 53 54 55 56 57 58 59 60 61
```

Inside `vars/main.yml`
```yaml
gitlab_runner_registration_token: 'HUzTMgnxk17YV8Rj8ucQ'
gitlab_runner_description: 'Example GitLab Runner'
gitlab_runner_tags:
  - node
  - ruby
  - mysql
62 63 64
gitlab_runner_docker_volumes:
  - "/var/run/docker.sock:/var/run/docker.sock"
  - "/cache"
Harold Barker's avatar
Harold Barker committed
65
```