cleanup

Author: npalm

README.md

@@ -136,8 +136,41 @@ Go back to the GitHub App and update the following settings.
 3. Provide the webhook secret.
 4. Enable the `Check run` event for the webhook.
 
+
 ## Examples
 
+## Inputs
+
+| Name                                      | Description                                                                                                         | Type                                                                                                                                                                                   | Default                 | Required |
+| ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | :------: |
+| aws\_region                               | AWS region.                                                                                                         | `string`                                                                                                                                                                               | n/a                     |   yes    |
+| enable\_organization\_runners             | n/a                                                                                                                 | `bool`                                                                                                                                                                                 | n/a                     |   yes    |
+| environment                               | A name that identifies the environment, used as prefix and for tagging.                                             | `string`                                                                                                                                                                               | n/a                     |   yes    |
+| github\_app                               | GitHub app parameters, see your github aapp. Ensure the key is base64 encoded.                                      | <pre>object({<br>    key_base64     = string<br>    id             = string<br>    client_id      = string<br>    client_secret  = string<br>    webhook_secret = string<br>  })</pre> | n/a                     |   yes    |
+| subnet\_ids                               | List of subnets in which the action runners will be launched, the subnets needs to be subnets in the `vpc_id`.      | `list(string)`                                                                                                                                                                         | n/a                     |   yes    |
+| vpc\_id                                   | The VPC for security groups of the action runners.                                                                  | `string`                                                                                                                                                                               | n/a                     |   yes    |
+| minimum\_running\_time\_in\_minutes       | The time an ec2 action runner should be running at minium before terminated if non busy.                            | `number`                                                                                                                                                                               | `5`                     |    no    |
+| runner\_binaries\_syncer\_lambda\_timeout | Time out of the binaries sync lambda in seconds.                                                                    | `number`                                                                                                                                                                               | `300`                   |    no    |
+| runner\_binaries\_syncer\_lambda\_zip     | File location of the binaries sync lambda zip file.                                                                 | `string`                                                                                                                                                                               | `null`                  |    no    |
+| runner\_extra\_labels                     | Extra labels for the runners (GitHub). Separate each label by a comma                                               | `string`                                                                                                                                                                               | `""`                    |    no    |
+| runners\_lambda\_zip                      | File location of the lambda zip file for scaling runners.                                                           | `string`                                                                                                                                                                               | `null`                  |    no    |
+| runners\_scale\_down\_lambda\_timeout     | Time out for the scale up lambda in seconds.                                                                        | `number`                                                                                                                                                                               | `60`                    |    no    |
+| runners\_scale\_up\_lambda\_timeout       | Time out for the scale down lambda in seconds.                                                                      | `number`                                                                                                                                                                               | `60`                    |    no    |
+| scale\_down\_schedule\_expression         | Scheduler expression to check every x for scale down.                                                               | `string`                                                                                                                                                                               | `"cron(*/5 * * * ? *)"` |    no    |
+| tags                                      | Map of tags that will be added to created resources. By default resources will be tagged with name and environment. | `map(string)`                                                                                                                                                                          | `{}`                    |    no    |
+| webhook\_lambda\_timeout                  | Time out of the webhook lambda in seconds.                                                                          | `number`                                                                                                                                                                               | `10`                    |    no    |
+| webhook\_lambda\_zip                      | File location of the wehbook lambda zip file.                                                                       | `string`                                                                                                                                                                               | `null`                  |    no    |
+
+## Outputs
+
+| Name             | Description |
+| ---------------- | ----------- |
+| binaries\_syncer | n/a         |
+| runners          | n/a         |
+| webhook          | n/a         |
+
+
+
 ## Philips Forest
 
 This module is part of the Philips Forest.

examples/default/main.tf

@@ -3,16 +3,10 @@ locals {
   aws_region  = "eu-west-1"
 }
 
-
 resource "random_password" "random" {
   length = 32
 }
 
-
-
-
-
-
 module "runners" {
   source = "../../"