README.md

# GitLab CI Runners for the ORNL Research Cloud VM instances 
  
This Terraform setup creates and registers GitLab CI Runner
VMS in the ORNL Research Cloud using Docker executor mode.
The steps are:

1. Setup the SSH key pair in the ORNL Research Cloud.
2. Spin up the VMs.
3. Provision using the `template_file` called `user-data.sh`
   to install Docker and `gitlab-runner`
4. Setup each VM as a GitLab Runner
5. For each GitLab Token, each runner is registered with that
   project
6. When the resources is destroyed, the runners will be 
   unregistered from all GitLab projects

There are many "modifable" inputs but the required ones are:

1. `prefix` - prefix to append to all runner names
2. `runner_count` - number of runners
3. `runner_tokens` - tokens of GitLab projects to register the runner against

You can also add installation requirements on the runner using the `user_data`
input variable to customize the runner.

The module inputs can be found in `modules/ornl-cloud-gitlab-runners/inputs.tf`