- Requirements
- Configuration
- Deploying a stand-alone runner
- Using Docker-in-Docker
- Default runner configuration
Using the GitLab Runner chart
The GitLab Runner subchart provides a GitLab Runner for running CI jobs. It is enabled by default and should work out of the box with support for caching using s3 compatible object storage.
Requirements
This chart depends on the shared-secrets Job to populate its registrationToken
for automatic registration. If you intend to run this chart as a stand-alone chart with an existing GitLab instance then you will need to manually set the registrationToken
in the gitlab-runner
secret to be equal to that displayed by the running GitLab instance.
Configuration
For more information, see the documentation on usage and configuration.
Deploying a stand-alone runner
By default we do infer gitlabUrl
, automatically generate a registration token, and generate it through the migrations
chart. This behavior will not work if you intend to deploy it with a running GitLab instance.
In this case you will need to set gitlabUrl
value to be the URL of the running GitLab instance. You will also need to manually create gitlab-runner
secret and fill it with the registrationToken
provided by the running GitLab.
Using Docker-in-Docker
In order to run Docker-in-Docker, the runner container needs to be privileged to have access to the needed capabilities. To enable it set the privileged
value to true
. See the upstream documentation in regards to why this is does not default to true
.
Security concerns
Privileged containers have extended capabilities, for example they can mount arbitrary files from the host they run on. Make sure to run the container in an isolated environment such that nothing important runs beside it.
Default runner configuration
The default runner configuration used in the GitLab chart has been customized to use the included MinIO for cache by default. If you are setting the runner config
value, you will need to also configure your own cache configuration.
gitlab-runner:
runners:
config: |
[[runners]]
[runners.kubernetes]
image = "ubuntu:22.04"
{{- if .Values.global.minio.enabled }}
[runners.cache]
Type = "s3"
Path = "gitlab-runner"
Shared = true
[runners.cache.s3]
ServerAddress = {{ include "gitlab-runner.cache-tpl.s3ServerAddress" . }}
BucketName = "runner-cache"
BucketLocation = "us-east-1"
Insecure = false
{{ end }}
All customized GitLab Runner chart configuration is available in the
top-level values.yaml
file
under the gitlab-runner
key.