Skip to content

Commit d2aa695

Browse files
npalmnpalm
committed
Release 0.2.0
1 parent 4aa3693 commit d2aa695

File tree

5 files changed

+75
-61
lines changed

5 files changed

+75
-61
lines changed

‎CHANGELOG.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,36 @@
11
# Changelog
2+
23
All notable changes to this project will be documented in this file.
34

45
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
56
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
67

78
## [Unreleased]
89

9-
## [0.1.0] - 2025-05-25
10+
## [0.2.0] - 2020-06-15
11+
12+
### Added
13+
14+
- #34 encrypt secrets via KMS (#37)
15+
16+
## [0.1.0] - 2020-05-25
17+
1018
### Added
19+
1120
- #30 - Add parameter to terraform to set max number of runners (#31)
1221

1322
### Updated
23+
1424
- #17 - adding tests for syncer (#33)
1525
- #20 #21 - Improve docs, add readme, add hook generate terraform docs
1626

1727
## [0.0.1] - 2020-05-19
28+
1829
### Added
30+
1931
- First release.
2032

21-
[Unreleased]: https://github.com/philips-labs/terraform-aws-github-runner/compare/v0.1.0..HEAD
33+
[unreleased]: https://github.com/philips-labs/terraform-aws-github-runner/compare/v0.2.0..HEAD
34+
[0.2.0]: https://github.com/philips-labs/terraform-aws-github-runner/releases/tag/v0.1.0..v0.2.0
2235
[0.1.0]: https://github.com/philips-labs/terraform-aws-github-runner/releases/tag/v0.0.1..v0.1.0
23-
[0.0.1]: https://github.com/philips-labs/terraform-aws-github-runner/releases/tag/v0.0.1
36+
[0.0.1]: https://github.com/philips-labs/terraform-aws-github-runner/releases/tag/v0.0.1

‎README.md

Lines changed: 41 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -97,19 +97,19 @@ First you need to download the lambda releases. The lambda code is available as
9797
module "github-runner_download-lambda" {
9898
source = "philips-labs/github-runner/aws//modules/download-lambda"
9999
version = "0.1.0"
100-
100+
101101
lambdas = [
102102
{
103103
name = "webhook"
104-
tag = "v0.1.0"
104+
tag = "v0.2.0"
105105
},
106106
{
107107
name = "runners"
108-
tag = "v0.1.0"
108+
tag = "v0.2.0"
109109
},
110110
{
111111
name = "runner-binaries-syncer"
112-
tag = "v0.1.0"
112+
tag = "v0.2.0"
113113
}
114114
]
115115
}
@@ -201,7 +201,6 @@ module "runners" {
201201

202202
Not advised but you can disable the encryption as by setting the variable `encrypt_secrets` to `false`.
203203

204-
205204
## Examples
206205

207206
Examples are located in the [examples](./examples) directory. The following examples are provided:
@@ -225,54 +224,55 @@ The following sub modules are optional and are provided as example or utility:
225224
- _[setup-iam-permissions](./modules/setup-iam-permissions/README.md)_ - Example module to setup permission boundaries
226225

227226
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
227+
228228
## Requirements
229229

230230
No requirements.
231231

232232
## Providers
233233

234-
| Name | Version |
235-
|------|---------|
236-
| aws | n/a |
237-
| random | n/a |
234+
| Name | Version |
235+
| ------ | ------- |
236+
| aws | n/a |
237+
| random | n/a |
238238

239239
## Inputs
240240

241-
| Name | Description | Type | Default | Required |
242-
|------|-------------|------|---------|:--------:|
243-
| aws\_region | AWS region. | `string` | n/a | yes |
244-
| enable\_organization\_runners | n/a | `bool` | n/a | yes |
245-
| encrypt\_secrets | Encrypt secret variables for lambda's such as secrets and private keys. | `bool` | `true` | no |
246-
| environment | A name that identifies the environment, used as prefix and for tagging. | `string` | n/a | yes |
247-
| 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 |
248-
| instance\_profile\_path | The path that will be added to the instance\_profile, if not set the environment name will be used. | `string` | `null` | no |
249-
| kms\_key\_id | Custom KMS key to encrypted lambda secrets, if not provided and `encrypt_secrets` = `true` a KMS key will be created by the module. Secrets will be encrypted with a context `Environment = var.environment`. | `string` | `null` | no |
250-
| manage\_kms\_key | Let the module manage the KMS key. | `bool` | `true` | no |
251-
| minimum\_running\_time\_in\_minutes | The time an ec2 action runner should be running at minium before terminated if non busy. | `number` | `5` | no |
252-
| role\_path | The path that will be added to role path for created roles, if not set the environment name will be used. | `string` | `null` | no |
253-
| role\_permissions\_boundary | Permissions boundary that will be added to the created roles. | `string` | `null` | no |
254-
| runner\_as\_root | Run the action runner under the root user. | `bool` | `false` | no |
255-
| runner\_binaries\_syncer\_lambda\_timeout | Time out of the binaries sync lambda in seconds. | `number` | `300` | no |
256-
| runner\_binaries\_syncer\_lambda\_zip | File location of the binaries sync lambda zip file. | `string` | `null` | no |
257-
| runner\_extra\_labels | Extra labels for the runners (GitHub). Separate each label by a comma | `string` | `""` | no |
258-
| runners\_lambda\_zip | File location of the lambda zip file for scaling runners. | `string` | `null` | no |
259-
| runners\_maxiumum\_count | The maxiumum number of runners tha will be created. | `number` | `3` | no |
260-
| runners\_scale\_down\_lambda\_timeout | Time out for the scale up lambda in seconds. | `number` | `60` | no |
261-
| runners\_scale\_up\_lambda\_timeout | Time out for the scale down lambda in seconds. | `number` | `60` | no |
262-
| scale\_down\_schedule\_expression | Scheduler expression to check every x for scale down. | `string` | `"cron(*/5 * * * ? *)"` | no |
263-
| 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 |
264-
| tags | Map of tags that will be added to created resources. By default resources will be tagged with name and environment. | `map(string)` | `{}` | no |
265-
| vpc\_id | The VPC for security groups of the action runners. | `string` | n/a | yes |
266-
| webhook\_lambda\_timeout | Time out of the webhook lambda in seconds. | `number` | `10` | no |
267-
| webhook\_lambda\_zip | File location of the wehbook lambda zip file. | `string` | `null` | no |
241+
| Name | Description | Type | Default | Required |
242+
| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------- | :------: |
243+
| aws_region | AWS region. | `string` | n/a | yes |
244+
| enable_organization_runners | n/a | `bool` | n/a | yes |
245+
| encrypt_secrets | Encrypt secret variables for lambda's such as secrets and private keys. | `bool` | `true` | no |
246+
| environment | A name that identifies the environment, used as prefix and for tagging. | `string` | n/a | yes |
247+
| 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 |
248+
| instance_profile_path | The path that will be added to the instance_profile, if not set the environment name will be used. | `string` | `null` | no |
249+
| kms_key_id | Custom KMS key to encrypted lambda secrets, if not provided and `encrypt_secrets` = `true` a KMS key will be created by the module. Secrets will be encrypted with a context `Environment = var.environment`. | `string` | `null` | no |
250+
| manage_kms_key | Let the module manage the KMS key. | `bool` | `true` | no |
251+
| minimum_running_time_in_minutes | The time an ec2 action runner should be running at minium before terminated if non busy. | `number` | `5` | no |
252+
| role_path | The path that will be added to role path for created roles, if not set the environment name will be used. | `string` | `null` | no |
253+
| role_permissions_boundary | Permissions boundary that will be added to the created roles. | `string` | `null` | no |
254+
| runner_as_root | Run the action runner under the root user. | `bool` | `false` | no |
255+
| runner_binaries_syncer_lambda_timeout | Time out of the binaries sync lambda in seconds. | `number` | `300` | no |
256+
| runner_binaries_syncer_lambda_zip | File location of the binaries sync lambda zip file. | `string` | `null` | no |
257+
| runner_extra_labels | Extra labels for the runners (GitHub). Separate each label by a comma | `string` | `""` | no |
258+
| runners_lambda_zip | File location of the lambda zip file for scaling runners. | `string` | `null` | no |
259+
| runners_maxiumum_count | The maxiumum number of runners tha will be created. | `number` | `3` | no |
260+
| runners_scale_down_lambda_timeout | Time out for the scale up lambda in seconds. | `number` | `60` | no |
261+
| runners_scale_up_lambda_timeout | Time out for the scale down lambda in seconds. | `number` | `60` | no |
262+
| scale_down_schedule_expression | Scheduler expression to check every x for scale down. | `string` | `"cron(*/5 * * * ? *)"` | no |
263+
| 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 |
264+
| tags | Map of tags that will be added to created resources. By default resources will be tagged with name and environment. | `map(string)` | `{}` | no |
265+
| vpc_id | The VPC for security groups of the action runners. | `string` | n/a | yes |
266+
| webhook_lambda_timeout | Time out of the webhook lambda in seconds. | `number` | `10` | no |
267+
| webhook_lambda_zip | File location of the wehbook lambda zip file. | `string` | `null` | no |
268268

269269
## Outputs
270270

271-
| Name | Description |
272-
|------|-------------|
273-
| binaries\_syncer | n/a |
274-
| runners | n/a |
275-
| webhook | n/a |
271+
| Name | Description |
272+
| --------------- | ----------- |
273+
| binaries_syncer | n/a |
274+
| runners | n/a |
275+
| webhook | n/a |
276276

277277
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
278278

‎examples/default/lambdas-download/main.tf

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@ module "lambdas" {
33
lambdas = [
44
{
55
name = "webhook"
6-
tag = "v0.1.0"
6+
tag = "v0.2.0"
77
},
88
{
99
name = "runners"
10-
tag = "v0.1.0"
10+
tag = "v0.2.0"
1111
},
1212
{
1313
name = "runner-binaries-syncer"
14-
tag = "v0.1.0"
14+
tag = "v0.2.0"
1515
}
1616
]
1717
}

‎examples/permissions-boundary/lambdas-download/main.tf

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@ module "lambdas" {
33
lambdas = [
44
{
55
name = "webhook"
6-
tag = "v0.1.0"
6+
tag = "v0.2.0"
77
},
88
{
99
name = "runners"
10-
tag = "v0.1.0"
10+
tag = "v0.2.0"
1111
},
1212
{
1313
name = "runner-binaries-syncer"
14-
tag = "v0.1.0"
14+
tag = "v0.2.0"
1515
}
1616
]
1717
}

‎modules/download-lambda/README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,42 +10,43 @@ module "lambdas" {
1010
lambdas = [
1111
{
1212
name = "webhook"
13-
tag = "v0.1.0"
13+
tag = "v0.2.0"
1414
},
1515
{
1616
name = "runners"
17-
tag = "v0.1.0"
17+
tag = "v0.2.0"
1818
},
1919
{
2020
name = "runner-binaries-syncer"
21-
tag = "v0.1.0"
21+
tag = "v0.2.0"
2222
}
2323
]
2424
}
2525
```
2626

2727
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
28+
2829
## Requirements
2930

3031
No requirements.
3132

3233
## Providers
3334

3435
| Name | Version |
35-
|------|---------|
36-
| null | n/a |
36+
| ---- | ------- |
37+
| null | n/a |
3738

3839
## Inputs
3940

40-
| Name | Description | Type | Default | Required |
41-
|------|-------------|------|---------|:--------:|
42-
| lambdas | Name and tag for lambdas to download. | <pre>list(object({<br> name = string<br> tag = string<br> }))</pre> | n/a | yes |
41+
| Name | Description | Type | Default | Required |
42+
| ------- | ------------------------------------- | ------------------------------------------------------------------- | ------- | :------: |
43+
| lambdas | Name and tag for lambdas to download. | <pre>list(object({<br> name = string<br> tag = string<br> }))</pre> | n/a | yes |
4344

4445
## Outputs
4546

46-
| Name | Description |
47-
|------|-------------|
48-
| files | n/a |
47+
| Name | Description |
48+
| ----- | ----------- |
49+
| files | n/a |
4950

5051
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
5152

0 commit comments

Comments
 (0)