gitlab-runner

Purpose

This module provides an AWS Docker-Machine based gitlab-runner for your CI/CD work.

Description

Provisions resources necessary to run gitlab-runner in AWS with autoscaling of EC2 instances using Docker Machine. See here.

EC2 instance gitlab-runner-bastion uses Docker Machine to spin up additional EC2 instances as needed to support your build needs.

Usage Instructions

Copy and paste into your Terraform configuration, insert or update the variables, and run terraform init:

module "gitlab-runner" {
  source                   = "git@code.vt.edu:devcom/terraform-modules/aws-gitlab-runner.git"
  environment              = "all"
  gitlab_runner_cache_name = "vt-foo-gitlab-runner-cache"
  gitlab_token             = "my-ci-cd-token-from-gitlab"
  responsible_party        = "sally"
  runner_name              = "foo-aws-gitlab-runner"
  ssh_key_name             = "sally"
  subnet_ids               = ["subnet-123456", "subnet-67890"]
  vcs                      = "git@code.vt.edu:path/to/my/repo"
  vpc_id                   = "vpc-123456"
  ...
}

Preconditions and Assumptions

The following need to exist in AWS already:

• An SSH key (for logging in to EC2 instances)
• VPC + Subnet

You also need to generate a runner token in Gitlab.

Dependencies

• vt-globals

Inputs

Required Inputs

These variables are required.

Optional Inputs

These variables have default values and don't have to be set to use this module. You may set these variables to override their default values.

Notes

1. One of gitlab_config_secret_id or gitlab_token must be provided
2. The secret referenced by gitlab_config_secret_id should be a valid gitlab-runner config.toml file (not JSON).
3. offpeak period is defined as the union of the following cron expressions:

* * 0-6,18-23 * * mon-fri *
* * * * * sat,sun *

Outputs

This module provides no outputs.

Versions

TODO

• Switch to using AWS Spot instances