README.md

terraform-google-github-actions-runners

Description

Using these Terraform modules you can quickly deploy self-hosted GitHub Runners for jobs in your GitHub Actions workflows

Modules

Self Hosted Runners on GKE

The gh-runner-gke module provisions the resources required to deploy Self Hosted Runners on GCP infrastructure using GKE. This module follows the guidance for using Actions Runner Controller provided by GitHub

Examples:

• Simple Self Hosted Runners on GKE
• Self Hosted runners on GKE that support Docker Workflows
• Self Hosted runners on GKE that support Docker Workflows in rootless configuration

More examples of Self Hosted Runners on GKE/Anthos.

Self Hosted Runners on Managed Instance Groups using VMs

The gh-runner-mig-vm module provisions the resources required to deploy Self Hosted Runners on GCP infrastructure using Managed Instance Groups.

Examples:

• Simple Self Hosted Runner on MIG VMs
• Self Hosted Runner on MIG VMs from Packer Image

Self Hosted Runners on Managed Instance Groups using Container VMs

The gh-runner-mig-container-vm module provisions the resources required to deploy Self Hosted Runners on GCP infrastructure using Managed Instance Groups.

Examples:

• Simple Self Hosted Runner on MIG Container VMs
• Self Hosted runners on MIG Container VMs that support Docker Workflows

GitHub OIDC

This module handles the opinionated creation of infrastructure necessary to configure Workload Identity pools and providers for authenticating to GCP using GitHub Actions OIDC tokens.

Examples:

• Simple Workload Identity configuration for GitHub OIDC

Requirements

These sections describe requirements for using this module.

Software

The following dependencies must be available:

• Terraform v0.13
• Terraform Provider for GCP

Contributing

Refer to the contribution guidelines for information on contributing to this module.

Security Disclosures

Please see our security disclosure process.