Skip to content
Snippets Groups Projects
README.md 1.31 KiB
Newer Older
Harold Barker's avatar
Harold Barker committed
GitLab Runner
=============

Harold Barker's avatar
Harold Barker committed
This role will install the [official GitLab Runner](https://gitlab.com/gitlab-org/gitlab-ci-multi-runner)
Harold Barker's avatar
Harold Barker committed

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

This role requires Ansible 2.0 or higher.


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

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

Harold Barker's avatar
Harold Barker committed
`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
`gitlab_runner_coordinator_url`
The GitLab coordinator URL.
Harold Barker's avatar
Harold Barker committed
Defaults to `https://gitlab.com/ci`.
Harold Barker's avatar
Harold Barker committed
`gitlab_runner_description`
The description of the runner.
Defaults to the hostname.

Harold Barker's avatar
Harold Barker committed
`gitlab_runner_executor`
The executor used by the runner.
Harold Barker's avatar
Harold Barker committed
Defaults to `shell`.
`gitlab_runner_docker_image`
The default Docker image to use. Required when executor is `docker`.

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

Dependencies
------------

None

Example Playbook
----------------
Harold Barker's avatar
Harold Barker committed
```yaml
- hosts: all
  remote_user: root
  vars_files:
    - vars/main.yml
  roles:
    - { role: haroldb.gitlab-runner }
```

Inside `vars/main.yml`
```yaml
gitlab_runner_registration_token: 'HUzTMgnxk17YV8Rj8ucQ'
gitlab_runner_description: 'Example GitLab Runner'
gitlab_runner_tags:
  - node
  - ruby
  - mysql
```
Harold Barker's avatar
Harold Barker committed

License
-------

MIT