Skip to content

Commit

Permalink
docs: Add a basic example
Browse files Browse the repository at this point in the history
  • Loading branch information
PurpleBooth committed Oct 4, 2023
1 parent dd8b8c8 commit ae82a28
Show file tree
Hide file tree
Showing 4 changed files with 161 additions and 0 deletions.
127 changes: 127 additions & 0 deletions examples/default/.terraform.lock.hcl

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 10 additions & 0 deletions examples/default/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Action runners deployment default example

This module shows how to create GitHub action runners that run on ubuntu on EC2.

## Usages

Steps for the full setup, such as creating a GitHub app can be found in the root module's [README](../../README.md).

This is designed to be "It just works" wrapper, if you want more configuration, the [philips module](https://raw.githubusercontent.com/philips-labs/terraform-aws-github-runner) is probably a better
fit.
9 changes: 9 additions & 0 deletions examples/default/main.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
module "runner" {
source = "../../"
aws_region = var.aws_region
github_app_id = var.github_app_id
github_app_install_id = var.github_app_install_id
github_app_key = var.github_app_key
github_organisation = var.github_organisation
}

15 changes: 15 additions & 0 deletions examples/default/variables.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
variable "aws_region" {
type = string
}
variable "github_app_id" {
type = string
}
variable "github_app_install_id" {
type = string
}
variable "github_app_key" {
type = string
}
variable "github_organisation" {
type = string
}

0 comments on commit ae82a28

Please sign in to comment.