https://github.com/terraform-google-modules/terraform-google-github-actions-runners

Creates self-hosted GitHub Actions Runners on Google Cloud
https://github.com/terraform-google-modules/terraform-google-github-actions-runners

cft-terraform developer-tools

Last synced: 18 days ago
JSON representation

Creates self-hosted GitHub Actions Runners on Google Cloud

• Host: GitHub
• URL: https://github.com/terraform-google-modules/terraform-google-github-actions-runners
• Owner: terraform-google-modules
• License: apache-2.0
• Created: 2020-03-12T21:23:14.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-12-24T23:18:17.000Z (21 days ago)
• Last Synced: 2024-12-25T00:24:33.005Z (21 days ago)
• Topics: cft-terraform, developer-tools
• Language: HCL
• Homepage: https://registry.terraform.io/modules/terraform-google-modules/github-actions-runners/google
• Size: 654 KB
• Stars: 201
• Watchers: 16
• Forks: 106
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

• awesome-runners - terraform-google-modules/terraform-google-github-actions-runners - google-modules/terraform-google-github-actions-runners.svg)](https://github.com/terraform-google-modules/terraform-google-github-actions-runners/blob/master/LICENSE) [](https://github.com/terraform-google-modules/terraform-google-github-actions-runners/graphs/contributors/) [](https://github.com/terraform-google-modules/terraform-google-github-actions-runners/stargazers/) [](https://GitHub.com/terraform-google-modules/terraform-google-github-actions-runners/issues/) [](https://GitHub.com/terraform-google-modules/terraform-google-github-actions-runners/issues?q=is%3Aissue+is%3Aclosed)| k8s (GKE), Docker, VMs (GCE) | ❌ | Repo | Terraform config/k8s manifests | only on k8s, based on generic pod CPU consumption (HPA metric) | x86 | only worked for Docker | yes | no | no | no | VMs could be configured like this | no | at least one idle runner to allow HPA to kick in based on CPU consumption | (The matrix (might be better readable on [GitHub pages](https://jonico.github.io/awesome-runners/)) / A word about self-hosted action runner images / virtual environments and how to test locally)
• jimsghstars - terraform-google-modules/terraform-google-github-actions-runners - Creates self-hosted GitHub Actions Runners on Google Cloud (HCL)

README

        
# terraform-google-github-actions-runners

[![awesome-runners](https://img.shields.io/badge/listed%20on-awesome--runners-blue.svg)](https://github.com/jonico/awesome-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](modules/gh-runner-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](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/quickstart-for-actions-runner-controller#installing-actions-runner-controller) provided by GitHub

Examples:

- [Simple Self Hosted Runners on GKE](examples/gh-runner-gke-simple/)

- [Self Hosted runners on GKE that support Docker Workflows](examples/gh-runner-gke-dind/)

- [Self Hosted runners on GKE that support Docker Workflows in rootless configuration](examples/gh-runner-gke-dind-rootless/)

More examples of [Self Hosted Runners on GKE/Anthos](https://github.com/github-developer/self-hosted-runners-anthos).

### [Self Hosted Runners on Managed Instance Groups using VMs](modules/gh-runner-mig-vm/)

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](examples/gh-runner-mig-native-simple/)

- [Self Hosted Runner on MIG VMs from Packer Image](examples/gh-runner-mig-native-packer/)

### [Self Hosted Runners on Managed Instance Groups using Container VMs](modules/gh-runner-mig-container-vm/)

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](examples/gh-runner-mig-container-vm-simple/)

- [Self Hosted runners on MIG Container VMs that support Docker Workflows](examples/gh-runner-mig-container-vm-dind/)

### [GitHub OIDC](modules/gh-oidc/)

This module handles the opinionated creation of infrastructure necessary to configure [Workload Identity pools](https://cloud.google.com/iam/docs/workload-identity-federation#pools) and [providers](https://cloud.google.com/iam/docs/workload-identity-federation#providers) for authenticating to GCP using GitHub Actions OIDC tokens.

Examples:

- [Simple Workload Identity configuration for GitHub OIDC](examples/oidc-simple/)

## Requirements

These sections describe requirements for using this module.

### Software

The following dependencies must be available:

- [Terraform][terraform] v0.13

- [Terraform Provider for GCP][terraform-provider-gcp]

## Contributing

Refer to the [contribution guidelines](./CONTRIBUTING.md) for

information on contributing to this module.

[iam-module]: https://registry.terraform.io/modules/terraform-google-modules/iam/google

[project-factory-module]: https://registry.terraform.io/modules/terraform-google-modules/project-factory/google

[terraform-provider-gcp]: https://www.terraform.io/docs/providers/google/index.html

[terraform]: https://www.terraform.io/downloads.html

## Security Disclosures

Please see our [security disclosure process](./SECURITY.md).