terraform-helm-github-actions-runner-controller

Setup the GitHub Actions Runner Controller (ARC) in an existing kubernetes cluster.

To create runner deployments see the actions runner module from the terraform-kubectl-github-actions-runner repository.

Module Usage

# setup actions-runner-controller
module "actions-runner-controller" {
  source                                    = "../.."
  namespace                                 = "github-actions-runner-controller"
  create_namespace                          = true
  allow_granting_container_mode_permissions = false
  github_app_id                             = var.github_app_id
  github_app_install_id                     = var.github_app_install_id
  github_app_private_key                    = var.github_app_private_key
  kubernetes_secret_name                    = "github-auth-secret"
  helm_deployment_name                      = "actions-runner-controller"
  helm_chart_version                        = "0.23.5"
  replicas                                  = 1
  atomic                                    = true
  timeout                                   = 600
  depends_on = [
    helm_release.cert_manager
  ]
}

Requirements

Name	Version
terraform	>= 0.13
helm	>= 2.11.0
kubernetes	>= 2.23.0

Providers

Name	Version
helm	>= 2.11.0
kubernetes	>= 2.23.0

Resources

Name	Type
helm_release.this	resource
kubernetes_namespace.this	resource
kubernetes_secret.this	resource

Inputs

Name	Description	Type	Default	Required
github_app_id	GitHub App ID	string	n/a	yes
github_app_install_id	GitHub App Install ID	string	n/a	yes
github_app_private_key	GitHub App Private Key	string	n/a	yes
allow_granting_container_mode_permissions	If true, the runner controller will be allowed to grant container mode permissions	bool	false	no
atomic	If true, installation process purges chart on fail. If false, installation process deletes resources created by chart, but not purge them	bool	true	no
create_namespace	If true, the namespace will be created	bool	true	no
helm_chart_version	The version of the helm chart to deploy	string	"0.23.5"	no
helm_deployment_name	The name of the helm deployment	string	"actions-runner-controller"	no
kubernetes_secret_name	The name of the secret to create	string	"github-auth-secret"	no
namespace	The namespace to deploy the runner controller into	string	"github-actions-runner-controller"	no
replicas	The number of replicas for the runner controller	number	3	no
timeout	Time in seconds to wait for helm deployment operation (like Jobs for hooks)	number	600	no

Outputs

Name	Description
helm_deployment_name	The name of the helm deployment
namespace	The namespace runner controller was deployed into
secret_name	The name of the secret created