This article explains how to install the runner on Linux. The VM runner is packaged as a minimal Docker image distributed on DockerHub.
This runner provides support for multiple drivers, please see the links at the bottom of the page or the section “drivers” for their specific setup information.
By default we use the Amazon ec2 driver.
Install Docker and pull the public image:
The VM runner can be configured using environment variables. This article references the below configuration options. See Reference for a complete list of configuration options.
- provides the hostname (and optional port) of your Drone server. The runner connects to the server at the host address to receive pipelines for execution.
- provides the protocol used to connect to your Drone server. The value must be either http or https.
- provides the shared secret used to authenticate with your Drone server. This must match the secret defined in your Drone server configuration.
- DRONE_MIN_POOL_SIZE (optional)
- provides the minimum size of the pool. The pool will not shrink below this size. The default is 1.
- DRONE_MAX_POOL_SIZE (optional)
- provides the maximum size of the pool. The pool will not grow above this size. The default is 2.
Amazon EC2 prerequisites
By default the runner requires two additional Amazon specific environment variables. For more information look at the amazon specific configuration options for Amazon
- provides the access key id for your AWS account. This must have permissions to create and run EC2 instances.
- provides the secret access key for your AWS account. aws secret.
- AWS_DEFAULT_REGION (optional)
- provides the default region for your AWS account. Defaults to us-east-2.
This will start 2 Ubuntu instances in the us-east-2 region in a pool called “testpool”.
Use the docker logs command to view the logs and verify the runner successfully established a connection with the Drone server.
If the runner is unable to create an instance in Amazon, we have a setup command to help check the AWS configuration, see Amazon Setup.
For more information on advanced runner configuration options, see Reference.
For more information on advanced pool configuration options, see Pool.
More information on using the Amazon driver.
More information on using the Anka driver.
More information on using the Digital Ocean driver.
More information on using the Google driver.