eks-github-runner

DNXLabs/eks-github-runner/aws

Terraform Module HCL AWS

Install

module "eks-github-runner" {

source = "DNXLabs/eks-github-runner/aws"

version = "0.3.1"

}

plain text: /constructs/tfmod-dnxlabs-eks-github-runner-aws/install.txt

⭐ Source on GitHub 📦 Registry page

README

terraform-aws-eks-github-runner ![Lint Status](https://github.com/DNXLabs/terraform-aws-eks-github-runner/actions) ![LICENSE](https://github.com/DNXLabs/terraform-aws-eks-github-runner/blob/master/LICENSE) Terraform module for deploying GitHub Actions Runner Operator inside a pre-existing EKS cluster. Setting Up Authentication with GitHub API There are two ways for actions-runner-controller to authenticate with the GitHub API (only 1 can be configured at a time however): 1. Using a GitHub App (not supported for enterprise level runners due to lack of support from GitHub) 2. Using a PAT Functionality wise, there isn't much of a difference between the 2 authentication methods. The primarily benefit of authenticating via a GitHub App is an increased API quota. If you are deploying the solutio

Inputs (23)

Name	Type	Description	Default
cluster_identity_oidc_issuer_arn	string	The OIDC Identity issuer ARN for the cluster that can be used to associate IAM r	required
github_app_installation_id	string	The ID of your GitHub App installation. This can't be set at the same time as `g	required
github_app_private_key	string	The multiline string of your GitHub App's private key. This can't be set at the	required
mod_dependency	string	Dependence variable binds all AWS resources allocated by this module, dependent	required
cluster_identity_oidc_issuer	string	The OIDC Identity issuer for the cluster.	required
github_app_app_id	string	The ID of your GitHub App. This can't be set at the same time as `github_token`	required
cluster_name	string	The name of the cluster.	required
helm_chart_version	string	GitHub Runner Controller Helm chart version.	`"0.12.2"`
github_repositories	list(object({ name = s		`[]`
create_iam_role	bool	Variable indicating whether it creates iam role.	`true`
service_account_iam_role_arn	string	Variable indicating the iam role arn to be used by the service account.	`""`
helm_chart_name	string	GitHub Runner Controller Helm chart name.	`"actions-runner-controller"`
helm_chart_release_name	string	GitHub Runner Controller Helm chart release name.	`"actions-runner-controller"`
helm_chart_repo	string	GitHub Runner Controller Helm repository name.	`"https://actions-runner-controller.githu`
github_token	string	Your chosen GitHub PAT token. This can't be set at the same time as the `github_	`""`
ephemeral_runner	bool	Variable indicating whether the runner restarts after running jobs.	`true`
settings	map	Additional settings which will be passed to the Helm chart values, see https://g	`{}`
service_account_name	string	GitHub runner service account name.	`"github-actions-runner-controller"`
github_organizations	list(object({ name = s		`[]`
namespace	string	GitHub Runner Controller Helm chart namespace which the service will be created.	`"actions-runner-system"`
enabled	bool	Variable indicating whether deployment is enabled.	`true`
policy_arns	list(string)		`[]`
create_namespace	bool	Whether to create Kubernetes namespace with name defined by `namespace`.	`true`