Metroline Logo
GithubTwitter

#Runner Environment Reference

#DEBUG

Default: none

Type: string

Description:

Enable debug using the popular debug Npm package. To limit logs to Metroline, use DEBUG=metroline.runner*.

#METROLINE_WORKSPACE_CLEANUP_TIMEOUT

Default: 5

Type: number

Description:

When we try to remove a pipeline workspace, we wait until all it's containers have been removed. This sets how much time (seconds) to wait for before we timeout.

#METROLINE_MAX_PARALLEL_JOBS

Default: 2

Type: number

Description:

Maximum number of parallel jobs.

#METROLINE_PULL_INTERVAL

Default: 1

Type: number

Description:

How often (seconds) the runner should pull for jobs. Note that runners are notified when new jobs are available, but this mechanism ensures that jobs are pulled when runners (re)connect. This value should have little impact on how fast jobs are picked up by runners.

#METROLINE_SERVER_ADDRESS

Default: none

Type: string

Description:

Address of the Metroline server.

#METROLINE_SOCKET_TIMEOUT

Default: 5

Type: number

Description:

How much time (seconds) to wait for the server to acknowledge runner registration. After timeout, we log an error but the runner keeps running. Socket.io tries to reconnect regularly.

#METROLINE_RUNNER_SECRET

Default: none

Type: string

Description:

Secret to use for communicating with the server.

#METROLINE_SSL_VERIFY

Default: true

Type: boolean

Description:

When set to false, the runner will not verify the SSL certificate served by the server.

#METROLINE_DOCKER_OPTIONS

Default: "{socketPath: '/var/run/docker.sock'}"

Type: string

Description:

Allows you to configure how the runner connects to the Docker daemon. This is a JSON string with a dockerode constructor options.

#METROLINE_JOB_DOCKER_SOCK

Default: null

Type: string

Description:

This variable allows you to provide jobs with a Docker daemon so that they can run commands like docker ps, docker run, docker build. It should be the path to a Docker daemon. When set, this path is mounted as a volume in jobs, pointing to /var/run/docker.sock.

Setting this option provides jobs with access to the Docker daemon on your runner's host, and hence can be a security issue. We will be working on ways to improve this in the future with services and Docker-in-docker, but for now this is a decent solution for making it possible to build Docker images in Metroline.