4 KB
Newer Older
# Install and register GitLab Runner for autoscaling with Docker Machine
2 3 4

> The auto scale feature was introduced in GitLab Runner 1.1.0.

For an overview of the autoscale architecture, take a look at the
6 7
[comprehensive documentation on autoscaling](../configuration/

## Preparing the environment

In order to use the autoscale feature, Docker and GitLab Runner must be
11 12 13 14
installed in the same machine:

1. Log in to a new Linux-based machine that will serve as a bastion server
   where Docker will spawn new machines from
15 16 17 18 19
1. [Install GitLab Runner](../install/
1. [Install Docker Machine](
1. Optionally but recommended, prepare a
   [proxy container registry and a cache server](../install/
   to be used with the autoscaled Runners
20 21 22 23 24

If you need to use any virtualization/cloud providers that aren't handled by
Docker's Machine internal drivers, the appropriate driver plugin must be
installed. The Docker Machine driver plugin installation and configuration is
out of the scope of this documentation. For more details please read the
[Docker Machine documentation](
26 27 28 29

## Configuring GitLab Runner

1. [Register a GitLab Runner](../register/ and select the
30 31 32 33
   `docker+machine` executor when asked.
1. Edit [`config.toml`](../commands/ and configure
   the Runner to use Docker machine. Visit the dedicated page covering detailed
   information about [GitLab Runner Autoscaling](../configuration/
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
1. The **first time** you're using Docker Machine, it's best to execute manually
   `docker-machine create ...` with your chosen driver and all options from the
   `MachineOptions` section. This will set up the Docker Machine environment
   properly and will also be a good validation of the specified options.
   After this, you can destroy the machine with `docker-machine rm [machine_name]`
   and start the Runner.

    NOTE: **Note:**
    Multiple concurrent requests to `docker-machine create` that are done
    **at first usage** are not good. When the `docker+machine` executor is used,
    the Runner may spin up few concurrent `docker-machine create` commands. If
    Docker Machine was not used before in this environment, each started process
    tries to prepare SSH keys and SSL certificates (for Docker API authentication
    between Runner and Docker Engine on the autoscaled spawned machine), and these
    concurrent processes are disturbing each other. This can end with a non-working
    environment. That's why it's important to create a test machine manually the
    very first time you set up the Runner with Docker Machine.

1. Now, you can try and start a new pipeline in your project. In a few seconds,
   if you run `docker-machine ls` you should see a new machine being created.
54 55 56

## Upgrading the Runner

57 58 59 60 61 62 63
1. Check if your operating system is configured to automatically restart the
   Runner (for example, by checking its service file):
    - **if yes**, ensure that service manager is [configured to use `SIGQUIT`](../configuration/
      and use the service's tools to stop the process:
        # For systemd
        sudo systemctl stop gitlab-runner

65 66 67 68
        # For upstart
        sudo service gitlab-runner stop
    - **if no**, you may stop the Runner's process manually:

70 71 72
        sudo killall -SIGQUIT gitlab-runner

    NOTE: **Note:**
75 76 77
    Sending the [`SIGQUIT` signal](../commands/ will make the
    Runner to stop gracefully. It will stop accepting new jobs, and will exit
    as soon as the current jobs are finished.
78 79 80 81 82 83 84 85 86 87 88

1. Wait until the Runner exits. You can check its status with `gitlab-runner status`
    or await a graceful shutdown for up to 30 minutes with:

    for i in `seq 1 180`; do # 1800 seconds = 30 minutes
        gitlab-runner status || break
        sleep 10

1. You can now safely install the new Runner without interrupting any jobs