Merge branch 'release/0.4.0'

Author: npalm

CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.4.0] - 2020-08-10
+
+### Added 
+
+- feat: idle runners #113
+
 ## [0.3.0] - 2020-08-06
 
 ### Added
@@ -44,7 +50,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - First release.
 
-[unreleased]: https://github.com/philips-labs/terraform-aws-github-runner/compare/v0.3.0..HEAD
+[unreleased]: https://github.com/philips-labs/terraform-aws-github-runner/compare/v0.4.0..HEAD
+[0.4.0]: https://github.com/philips-labs/terraform-aws-github-runner/releases/tag/v0.3.0..v0.4.0
 [0.3.0]: https://github.com/philips-labs/terraform-aws-github-runner/releases/tag/v0.2.0..v0.3.0
 [0.2.0]: https://github.com/philips-labs/terraform-aws-github-runner/releases/tag/v0.1.0..v0.2.0
 [0.1.0]: https://github.com/philips-labs/terraform-aws-github-runner/releases/tag/v0.0.1..v0.1.0

README.md

@@ -3,15 +3,15 @@ module "lambdas" {
   lambdas = [
     {
       name = "webhook"
-      tag  = "v0.2.0"
+      tag  = "v0.3.0"
     },
     {
       name = "runners"
-      tag  = "v0.2.0"
+      tag  = "v0.3.0"
     },
     {
       name = "runner-binaries-syncer"
-      tag  = "v0.2.0"
+      tag  = "v0.3.0"
     }
   ]
 }

examples/default/lambdas-download/main.tf

@@ -33,8 +33,13 @@ module "runners" {
   enable_organization_runners = false
   runner_extra_labels         = "default,example"
 
-  # instance_type = "a1.large"
+  # Uncommet idle config to have idle runners from 9 to 5 in time zone Amsterdam
+  # idle_config = [{
+  #   cron      = "* * 9-17 * * *"
+  #   timeZone  = "Europe/Amsterdam"
+  #   idleCount = 1
+  # }]
 
   # disable KMS and encryption
-  # encrypt_secrets = true
+  # encrypt_secrets = false
 }

examples/default/main.tf

@@ -3,15 +3,15 @@ module "lambdas" {
   lambdas = [
     {
       name = "webhook"
-      tag  = "v0.2.0"
+      tag  = "v0.3.0"
     },
     {
       name = "runners"
-      tag  = "v0.2.0"
+      tag  = "v0.3.0"
     },
     {
       name = "runner-binaries-syncer"
-      tag  = "v0.2.0"
+      tag  = "v0.3.0"
     }
   ]
 }

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

@@ -74,6 +74,7 @@ module "runners" {
   runner_extra_labels             = var.runner_extra_labels
   runner_as_root                  = var.runner_as_root
   runners_maximum_count           = var.runners_maximum_count
+  idle_config                     = var.idle_config
 
   lambda_zip                = var.runners_lambda_zip
   lambda_timeout_scale_up   = var.runners_scale_up_lambda_timeout
@@ -101,7 +102,6 @@ module "runner_binaries" {
   lambda_zip     = var.runner_binaries_syncer_lambda_zip
   lambda_timeout = var.runner_binaries_syncer_lambda_timeout
 
-
   role_path                 = var.role_path
   role_permissions_boundary = var.role_permissions_boundary
 }

main.tf

@@ -10,32 +10,33 @@ module "lambdas" {
   lambdas = [
     {
       name = "webhook"
-      tag  = "v0.2.0"
+      tag  = "v0.3.0"
     },
     {
       name = "runners"
-      tag  = "v0.2.0"
+      tag  = "v0.3.0"
     },
     {
       name = "runner-binaries-syncer"
-      tag  = "v0.2.0"
+      tag  = "v0.3.0"
     }
   ]
 }
 ```
 
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+
 ## Inputs
 
-| Name | Description | Type | Default | Required |
-|------|-------------|:----:|:-----:|:-----:|
-| lambdas | Name and tag for lambdas to download. | object | n/a | yes |
+| Name    | Description                           |  Type  | Default | Required |
+| ------- | ------------------------------------- | :----: | :-----: | :------: |
+| lambdas | Name and tag for lambdas to download. | object |   n/a   |   yes    |
 
 ## Outputs
 
-| Name | Description |
-|------|-------------|
-| files |  |
+| Name  | Description |
+| ----- | ----------- |
+| files |             |
 
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 

modules/download-lambda/README.md

@@ -34,29 +34,39 @@ yarn run dist
 ```
 
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+## Requirements
+
+No requirements.
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| aws | n/a |
+
 ## Inputs
 
 | Name | Description | Type | Default | Required |
-|------|-------------|:----:|:-----:|:-----:|
-| aws\_region | AWS region. | string | n/a | yes |
-| distribution\_bucket\_name | Bucket for storing the action runner distribution. | string | n/a | yes |
-| environment | A name that identifies the environment, used as prefix and for tagging. | string | n/a | yes |
-| lambda\_schedule\_expression | Scheduler expression for action runner binary syncer. | string | `"cron(27 * * * ? *)"` | no |
-| lambda\_timeout | Time out of the lambda in seconds. | number | `"300"` | no |
-| lambda\_zip | File location of the lambda zip file. | string | `"null"` | no |
-| role\_path | The path that will be added to the role, if not set the environment name will be used. | string | `"null"` | no |
-| role\_permissions\_boundary | Permissions boundary that will be added to the created role for the lambda. | string | `"null"` | no |
-| runner\_architecture | The platform architecture for the runner instance \(x64, arm64\), defaults to 'x64' | string | `"x64"` | 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 |
+|------|-------------|------|---------|:--------:|
+| aws\_region | AWS region. | `string` | n/a | yes |
+| distribution\_bucket\_name | Bucket for storing the action runner distribution. | `string` | n/a | yes |
+| environment | A name that identifies the environment, used as prefix and for tagging. | `string` | n/a | yes |
+| lambda\_schedule\_expression | Scheduler expression for action runner binary syncer. | `string` | `"cron(27 * * * ? *)"` | no |
+| lambda\_timeout | Time out of the lambda in seconds. | `number` | `300` | no |
+| lambda\_zip | File location of the lambda zip file. | `string` | `null` | no |
+| role\_path | The path that will be added to the role, if not set the environment name will be used. | `string` | `null` | no |
+| role\_permissions\_boundary | Permissions boundary that will be added to the created role for the lambda. | `string` | `null` | no |
+| runner\_architecture | The platform architecture for the runner instance (x64, arm64), defaults to 'x64' | `string` | `"x64"` | 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 |
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| bucket |  |
-| lambda |  |
-| lambda\_role |  |
-| runner\_distribution\_object\_key |  |
+| bucket | n/a |
+| lambda | n/a |
+| lambda\_role | n/a |
+| runner\_distribution\_object\_key | n/a |
 
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 

modules/runner-binaries-syncer/README.md

@@ -14,13 +14,13 @@
   },
   "devDependencies": {
     "@octokit/rest": "^18.0.3",
-    "@types/jest": "^26.0.4",
+    "@types/jest": "^26.0.9",
     "@types/node": "^14.0.27",
     "@types/request": "^2.48.4",
     "@typescript-eslint/eslint-plugin": "^2.30.0",
     "@typescript-eslint/parser": "^2.30.0",
     "@zeit/ncc": "^0.22.1",
-    "aws-sdk": "^2.725.0",
+    "aws-sdk": "^2.729.0",
     "eslint": "^6.8.0",
     "jest": "^26.1.0",
     "ts-jest": "^26.1.2",

modules/runner-binaries-syncer/lambdas/runner-binaries-syncer/package.json

@@ -654,10 +654,10 @@
     "@types/istanbul-lib-coverage" "*"
     "@types/istanbul-lib-report" "*"
 
-"@types/jest@^26.0.4":
-  version "26.0.8"
-  resolved "https://registry.yarnpkg.com/@types/jest/-/jest-26.0.8.tgz#f5c5559cf25911ce227f7ce30f1f160f24966369"
-  integrity sha512-eo3VX9jGASSuv680D4VQ89UmuLZneNxv2MCZjfwlInav05zXVJTzfc//lavdV0GPwSxsXJTy2jALscB7Acqg0g==
+"@types/jest@^26.0.9":
+  version "26.0.9"
+  resolved "https://registry.yarnpkg.com/@types/jest/-/jest-26.0.9.tgz#0543b57da5f0cd949c5f423a00c56c492289c989"
+  integrity sha512-k4qFfJ5AUKrWok5KYXp2EPm89b0P/KZpl7Vg4XuOTVVQEhLDBDBU3iBFrjjdgd8fLw96aAtmnwhXHl63bWeBQQ==
   dependencies:
     jest-diff "^25.2.1"
     pretty-format "^25.2.1"
@@ -927,10 +927,10 @@ atob@^2.1.2:
   resolved "https://registry.yarnpkg.com/atob/-/atob-2.1.2.tgz#6d9517eb9e030d2436666651e86bd9f6f13533c9"
   integrity sha512-Wm6ukoaOGJi/73p/cl2GvLjTI5JM1k/O14isD73YML8StrH/7/lRFgmg8nICZgD3bZZvjwCGxtMOD3wWNAu8cg==
 
-aws-sdk@^2.725.0:
-  version "2.725.0"
-  resolved "https://registry.yarnpkg.com/aws-sdk/-/aws-sdk-2.725.0.tgz#287ef3b55aa66f10c88671ec62300e96015aaf6a"
-  integrity sha512-Qd/MlxfQC9NpTxFUQ7u2BdsjiwNtbn5oVp04NPfXEc0xyT216TtcIs+jNyiJ9WaH7AgkHouU1BbBcReO8byYzg==
+aws-sdk@^2.729.0:
+  version "2.729.0"
+  resolved "https://registry.yarnpkg.com/aws-sdk/-/aws-sdk-2.729.0.tgz#3d850f7825b94b5d8b2aca58ec096973bc4c7e34"
+  integrity sha512-x5q/+9wM37tBYCmYNGMj+aU9qeXqhbUH0Dz3wlSpAW55+N4NwlBbpqhyCV3oF9bePEJtEnxLGWNXpb9BNWNhew==
   dependencies:
     buffer "4.9.2"
     events "1.1.1"