index.md 6.82 KB
Newer Older
1
---
2
comments: false
3
last_updated: 2019-01-17
4 5
---

6 7 8
# GitLab Runner

GitLab Runner is the open source project that is used to run your jobs and
9
send the results back to GitLab. It is used in conjunction with [GitLab CI](https://about.gitlab.com/product/continuous-integration/),
10 11 12 13 14
the open-source continuous integration service included with GitLab that
coordinates the jobs.

## Requirements

15
GitLab Runner is written in [Go](https://golang.org) and can be run as a single binary, no
16
language specific requirements are needed.
17

18 19 20
It is designed to run on the GNU/Linux, macOS, and Windows operating systems.
Other operating systems will probably work as long as you can compile a Go
binary on them.
21

22 23
If you want to use Docker make sure that you have version `v1.5.0` at least
installed.
24 25 26 27

## Features

- Allows to run:
28 29 30
  - Multiple jobs concurrently.
  - Use multiple tokens with multiple server (even per-project).
  - Limit number of concurrent jobs per-token.
31
- Jobs can be run:
32 33 34 35 36 37 38 39 40 41 42 43 44 45
  - Locally.
  - Using Docker containers.
  - Using Docker containers and executing job over SSH.
  - Using Docker containers with autoscaling on different clouds and virtualization hypervisors.
  - Connecting to remote SSH server.
- Is written in Go and distributed as single binary without any other requirements.
- Supports Bash, Windows Batch, and Windows PowerShell.
- Works on GNU/Linux, macOS, and Windows (pretty much anywhere you can run Docker).
- Allows customization of the job running environment.
- Automatic configuration reload without restart.
- Easy to use setup with support for Docker, Docker-SSH, Parallels, or SSH running environments.
- Enables caching of Docker containers.
- Easy installation as a service for GNU/Linux, macOS, and Windows.
- Embedded Prometheus metrics HTTP server.
46

47 48
## Compatibility chart

49 50 51
The GitLab Runner version should be in sync with the GitLab version. While older
Runners may still work with newer GitLab versions, and vice versa, in some cases,
features may be not available or work properly if there's a version difference.
52

53
Backward incompatibility is allowed only for major version updates.
54

55
## Install GitLab Runner
56

57
GitLab Runner can be [installed](install/index.md) and used on GNU/Linux, macOS, FreeBSD, and Windows.
angussidney's avatar
angussidney committed
58
You can install it using Docker, download the binary manually or use the
59
repository for rpm/deb packages that GitLab offers. Below you can find
60 61
information on the different installation methods:

62 63 64 65 66 67 68 69 70
- [Install using GitLab's repository for Debian/Ubuntu/CentOS/RedHat (preferred)](install/linux-repository.md).
- [Install on GNU/Linux manually (advanced)](install/linux-manually.md).
- [Install on macOS](install/osx.md).
- [Install on Windows](install/windows.md).
- [Install as a Docker service](install/docker.md).
- [Install in autoscaling mode using Docker machine](executors/docker_machine.md).
- [Install on FreeBSD](install/freebsd.md).
- [Install on Kubernetes](install/kubernetes.md).
- [Install the nightly binary manually (development)](install/bleeding-edge.md).
71

72
## Register GitLab Runner
73 74 75 76 77

Once GitLab Runner is installed, you need to register it with GitLab.

Learn how to [register a GitLab Runner](register/index.md).

78 79
## Using GitLab Runner

80
- See the [commands documentation](commands/README.md).
81

82
## Selecting the executor
83

84
GitLab Runner implements a number of [executors](executors/README.md) that can be used to run your
85
builds in different scenarios. If you are not sure what to select, read the
86
[I am not sure](executors/README.md#i-am-not-sure) section.
87
Visit the [compatibility chart](executors/README.md#compatibility-chart) to find
88 89
out what features each executor supports and what not.

90 91 92 93 94 95 96 97 98
To jump into the specific documentation of each executor, see:

- [Shell](executors/shell.md).
- [Docker](executors/docker.md).
- [Docker Machine and Docker Machine SSH (autoscaling)](executors/docker_machine.md).
- [Parallels](executors/parallels.md).
- [VirtualBox](executors/virtualbox.md).
- [SSH](executors/ssh.md).
- [Kubernetes](executors/kubernetes.md).
99

100
## Configuring GitLab Runner
101

102
See information on [configuring GitLab Runner](configuration/index.md), and:
103

104 105 106
- [Advanced configuration options](configuration/advanced-configuration.md): Learn how to use the [TOML](https://github.com/toml-lang/toml) configuration file that GitLab Runner uses.
- [Use self-signed certificates](configuration/tls-self-signed.md): Configure certificates that are used to verify TLS peer when connecting to the GitLab server.
- [Autoscaling using Docker machine](configuration/autoscale.md): Execute jobs on machines that are created on demand using Docker machine.
107
- [Autoscaling GitLab Runner on AWS](configuration/runner_autoscale_aws/index.md)
108
- [The init system of GitLab Runner](configuration/init.md): Learn how the Runner installs its init service files based on your operating system.
109
- [Supported shells](shells/index.md): Learn what shell script generators are supported that allow to execute builds on different systems.
110 111 112 113 114 115
- [Security considerations](security/index.md): Be aware of potential security implications when running your jobs with GitLab Runner.
- [Runner monitoring](monitoring/README.md): Learn how to monitor the Runner's behavior.
- [Cleanup the Docker images automatically](https://gitlab.com/gitlab-org/gitlab-runner-docker-cleanup): A simple Docker application that automatically garbage collects the GitLab Runner caches and images when running low on disk space.
- [Configure GitLab Runner to run behind a proxy](configuration/proxy.md): Learn how to set up a Linux proxy and configure GitLab Runner. Especially useful for the Docker executor.
- [Feature Flags](configuration/feature-flags.md): Learn how to use feature flags to get access to features in beta stage or to enable breaking changes before the full deprecation and replacement is handled.
- [Configure Session Server](configuration/advanced-configuration.md#the-session_server-section): Learn how to configure a session server for interacting with jobs the Runner is responsible for.
116 117 118 119 120 121 122 123 124 125 126 127

## Troubleshooting

Read the [FAQ](faq/README.md) for troubleshooting common issues.

## Release process

The description of release process of the GitLab Runner project can be found in
the [release documentation](release_process/README.md).

## Contributing

128
Contributions are welcome, see [`CONTRIBUTING.md`](https://gitlab.com/gitlab-org/gitlab-runner/blob/master/CONTRIBUTING.md) for more details.
129

130 131 132 133 134
## Development

See the [development documentation](development/README.md) to hack on GitLab
Runner.

135
If you're a reviewer of GitLab Runner project, then please take a moment to read the
Tomasz Maczukin's avatar
Tomasz Maczukin committed
136
[Reviewing GitLab Runner](development/reviewing-gitlab-runner.md) document.
137

138 139
## Changelog

140
See the [CHANGELOG](https://gitlab.com/gitlab-org/gitlab-runner/blob/master/CHANGELOG.md) to view recent changes.
141 142 143

## License

144
This code is distributed under the MIT license, see the [LICENSE](https://gitlab.com/gitlab-org/gitlab-runner/blob/master/LICENSE) file.