GitLab Documentation

VirtualBox

Note: The Parallels executor works the same as the VirtualBox executor. The caching feature is currently not supported.

VirtualBox allows you to use VirtualBox's virtualization to provide a clean build environment for every build. This executor supports all systems that can be run on VirtualBox. The only requirement is that the virtual machine exposes its SSH server and provide a bash-compatible shell.


Table of Contents generated with DocToc

Overview

The project's source code is checked out to: ~/builds/<namespace>/<project-name>.

Where:

To overwrite the ~/builds directory, specify the builds_dir option under the [[runners]] section in config.toml.

Create a new base virtual machine

  1. Import or create a new virtual machine in VirtualBox
  2. Log into the new virtual machine
  3. If on Windows, see Checklist for Windows VMs
  4. Install the OpenSSH server
  5. Install all other dependencies required by your build
  6. Log out and shutdown the virtual machine

It's completely fine to use automation tools like Vagrant to provision the virtual machine.

Create a new Runner

  1. Install GitLab Runner on the host running VirtualBox
  2. Register a new GitLab Runner with gitlab-ci-multi-runner register
  3. Select the virtualbox executor
  4. Enter the name of the base virtual machine you created earlier (find it under the settings of the virtual machine General > Basic > Name)
  5. Enter the SSH user and password or path to identity_file of the virtual machine

How it works

When a new build is started:

  1. A unique name for the virtual machine is generated: runner-<short-token>-concurrent-<id>
  2. The virtual machine is cloned if it doesn't exist
  3. The port forward rules are created to access the SSH server
  4. The Runner starts or restores the snapshot of the virtual machine
  5. The Runner waits for the SSH server to become accessible
  6. The Runner creates a snapshot of the running virtual machine (this is done to speed up any next builds)
  7. The Runner connects to the virtual machine and executes a build
  8. The Runner stops or shutdowns the virtual machine

Checklist for Windows VMs