README
¶
GitLab Runner
This is the repository of the official GitLab Runner written in Go. It runs tests and sends the results to GitLab. GitLab CI is the open-source continuous integration service included with GitLab that coordinates the testing.
Contributing
The official repository for this project is on GitLab.com.
Requirements
None: GitLab Runner is run as a single binary.
This project is designed for the Linux, OS X and Windows operating systems.
If you want to use Docker make sure that you have 1.5.0 at least installed.
Features
- Allows to run:
- multiple jobs concurrently
- use multiple tokens with multiple server (even per-project)
- limit number of concurrent jobs per-token
- Jobs can be run:
- locally
- using Docker container
- using Docker container and executing job over SSH
- using Docker container 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 Ubuntu, Debian, OS X and Windows (and anywhere you can run Docker)
- Allows to customize 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 service for Linux, OSX and Windows
Compatibility chart
Supported features by different executors:
| Executor | Shell | Docker | Docker-SSH | VirtualBox | Parallels | SSH |
|---|---|---|---|---|---|---|
| Secure Variables | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| GitLab Runner Exec command | ✓ | ✓ | ✓ | no | no | no |
| gitlab-ci.yml: image | no | ✓ | ✓ | no | no | no |
| gitlab-ci.yml: services | no | ✓ | ✓ | no | no | no |
| gitlab-ci.yml: cache | ✓ | ✓ | no | no | no | no |
| gitlab-ci.yml: artifacts | ✓ | ✓ | no | no | no | no |
| Absolute paths: caching, artifacts | no | no | no | no | no | no |
| Passing artifacts between stages | ✓ | ✓ | no | no | no | no |
Supported systems by different shells:
| Shells | Bash | Windows Batch | PowerShell |
|---|---|---|---|
| Windows | ✓ | ✓ (default) | ✓ |
| Linux | ✓ (default) | no | no |
| OSX | ✓ (default) | no | no |
| FreeBSD | ✓ (default) | no | no |
Install GitLab Runner
- Install using GitLab's repository for Debian/Ubuntu/CentOS/RedHat (preferred)
- Install on OSX (preferred)
- Install on Windows (preferred)
- Install as Docker Service
- Install in Auto-scaling mode
- Use on FreeBSD
Use GitLab Runner
Select executor
Troubleshooting
Advanced Configuration
- Auto-scaling
- Install Bleeding Edge (development)
- Manual installation (advanced)
- See details about the shells
- See advanced configuration options
- See security considerations
Extra projects?
If you want to add another project, token or image simply RE-RUN SETUP. You don't have to re-run the runner. It will automatically reload configuration once it changes.
Changelog
Visit Changelog to view recent changes.
Version 0.5.0
Version 0.5.0 introduces many security related changes.
One of such changes is the different location of config.toml.
Previously (prior 0.5.0) config was read from current working directory.
Currently, when gitlab-runner is executed by root or with sudo config is read from /etc/gitlab-runner/config.toml.
If gitlab-runner is executed by non-root user, the config is read from $HOME/.gitlab-runner/config.toml.
However, this doesn't apply to Windows where config is still read from current working directory, but this most likely will change in future.
The config file is automatically migrated when GitLab Runner was installed from GitLab's repository. For manual installations the config needs to be moved by hand.
The future
- Please see the GitLab Direction page.
- Feel free submit issues with feature proposals on the issue tracker.
Author
License
This code is distributed under the MIT license, see the LICENSE file.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Godeps
|
|
|
_workspace/src/github.com/Sirupsen/logrus
Package logrus is a structured logger for Go, completely API compatible with the standard library logger.
|
Package logrus is a structured logger for Go, completely API compatible with the standard library logger. |
|
_workspace/src/github.com/ayufan/golang-kardianos-service
Package service provides a simple way to create a system service.
|
Package service provides a simple way to create a system service. |
|
_workspace/src/github.com/ayufan/golang-kardianos-service/example/logging
Simple service that only works by printing a log message every few seconds.
|
Simple service that only works by printing a log message every few seconds. |
|
_workspace/src/github.com/ayufan/golang-kardianos-service/example/runner
Simple service that only works by printing a log message every few seconds.
|
Simple service that only works by printing a log message every few seconds. |
|
_workspace/src/github.com/ayufan/golang-kardianos-service/example/simple
simple does nothing except block while running the service.
|
simple does nothing except block while running the service. |
|
_workspace/src/github.com/ayufan/golang-kardianos-service/example/stopPause
simple does nothing except block while running the service.
|
simple does nothing except block while running the service. |
|
_workspace/src/github.com/codegangsta/cli
Package cli provides a minimal framework for creating and organizing command line Go applications.
|
Package cli provides a minimal framework for creating and organizing command line Go applications. |
|
_workspace/src/github.com/fsouza/go-dockerclient
Package docker provides a client for the Docker remote API.
|
Package docker provides a client for the Docker remote API. |
|
_workspace/src/github.com/fsouza/go-dockerclient/external/github.com/Sirupsen/logrus
Package logrus is a structured logger for Go, completely API compatible with the standard library logger.
|
Package logrus is a structured logger for Go, completely API compatible with the standard library logger. |
|
_workspace/src/github.com/fsouza/go-dockerclient/external/github.com/docker/docker/pkg/pools
Package pools provides a collection of pools which provide various data types with buffers.
|
Package pools provides a collection of pools which provide various data types with buffers. |
|
_workspace/src/github.com/fsouza/go-dockerclient/external/github.com/docker/go-units
Package units provides helper function to parse and print size and time units in human-readable format.
|
Package units provides helper function to parse and print size and time units in human-readable format. |
|
_workspace/src/github.com/fsouza/go-dockerclient/external/github.com/gorilla/context
Package context stores values shared during a request lifetime.
|
Package context stores values shared during a request lifetime. |
|
_workspace/src/github.com/fsouza/go-dockerclient/external/github.com/gorilla/mux
Package gorilla/mux implements a request router and dispatcher.
|
Package gorilla/mux implements a request router and dispatcher. |
|
_workspace/src/github.com/fsouza/go-dockerclient/external/golang.org/x/net/context
Package context defines the Context type, which carries deadlines, cancelation signals, and other request-scoped values across API boundaries and between processes.
|
Package context defines the Context type, which carries deadlines, cancelation signals, and other request-scoped values across API boundaries and between processes. |
|
_workspace/src/github.com/fsouza/go-dockerclient/external/golang.org/x/sys/unix
Package unix contains an interface to the low-level operating system primitives.
|
Package unix contains an interface to the low-level operating system primitives. |
|
_workspace/src/github.com/fsouza/go-dockerclient/testing
Package testing provides a fake implementation of the Docker API, useful for testing purpose.
|
Package testing provides a fake implementation of the Docker API, useful for testing purpose. |
|
_workspace/src/github.com/golang/mock/gomock
GoMock - a mock framework for Go.
|
GoMock - a mock framework for Go. |
|
_workspace/src/github.com/kardianos/osext
Extensions to the standard "os" package.
|
Extensions to the standard "os" package. |
|
_workspace/src/github.com/stretchr/objx
objx - Go package for dealing with maps, slices, JSON and other data.
|
objx - Go package for dealing with maps, slices, JSON and other data. |
|
_workspace/src/github.com/stretchr/testify/assert
A set of comprehensive testing tools for use with the normal Go testing system.
|
A set of comprehensive testing tools for use with the normal Go testing system. |
|
_workspace/src/github.com/stretchr/testify/mock
Provides a system by which it is possible to mock your objects and verify calls are happening as expected.
|
Provides a system by which it is possible to mock your objects and verify calls are happening as expected. |
|
_workspace/src/github.com/stretchr/testify/require
Alternative testing tools which stop test execution if test failed.
|
Alternative testing tools which stop test execution if test failed. |
|
_workspace/src/golang.org/x/crypto/curve25519
Package curve25519 provides an implementation of scalar multiplication on the elliptic curve known as curve25519.
|
Package curve25519 provides an implementation of scalar multiplication on the elliptic curve known as curve25519. |
|
_workspace/src/golang.org/x/crypto/ssh
Package ssh implements an SSH client and server.
|
Package ssh implements an SSH client and server. |
|
_workspace/src/golang.org/x/crypto/ssh/agent
Package agent implements a client to an ssh-agent daemon.
|
Package agent implements a client to an ssh-agent daemon. |
|
_workspace/src/golang.org/x/crypto/ssh/terminal
Package terminal provides support functions for dealing with terminals, as commonly found on UNIX systems.
|
Package terminal provides support functions for dealing with terminals, as commonly found on UNIX systems. |
|
_workspace/src/golang.org/x/crypto/ssh/test
This package contains integration tests for the golang.org/x/crypto/ssh package.
|
This package contains integration tests for the golang.org/x/crypto/ssh package. |
|
_workspace/src/golang.org/x/sys/unix
Package unix contains an interface to the low-level operating system primitives.
|
Package unix contains an interface to the low-level operating system primitives. |
|
_workspace/src/golang.org/x/sys/windows/registry
Package registry provides access to the Windows registry.
|
Package registry provides access to the Windows registry. |
|
_workspace/src/golang.org/x/sys/windows/svc
Package svc provides everything required to build Windows service.
|
Package svc provides everything required to build Windows service. |
|
_workspace/src/golang.org/x/sys/windows/svc/debug
Package debug provides facilities to execute svc.Handler on console.
|
Package debug provides facilities to execute svc.Handler on console. |
|
_workspace/src/golang.org/x/sys/windows/svc/eventlog
Package eventlog implements access to Windows event log.
|
Package eventlog implements access to Windows event log. |
|
_workspace/src/golang.org/x/sys/windows/svc/example
Example service program that beeps.
|
Example service program that beeps. |
|
_workspace/src/golang.org/x/sys/windows/svc/mgr
Package mgr can be used to manage Windows service programs.
|
Package mgr can be used to manage Windows service programs. |
|
_workspace/src/gopkg.in/yaml.v1
Package yaml implements YAML support for the Go language.
|
Package yaml implements YAML support for the Go language. |
|
apps
|
|
Click to show internal directories.
Click to hide internal directories.