diff --git a/docs/index.md b/docs/index.md index ffc5326f83..9cc0ccd184 100644 --- a/docs/index.md +++ b/docs/index.md @@ -15,9 +15,9 @@ A pertinent question may arise: why not opt for Kubernetes? The current strategy ## Overview -The module is designed to be used in a GitHub organization. It can also be used in a GitHub repository, but this does not supports all features. The module is receiving GitHub webhook events for the `workflow_job` event. The module will create a new runner if the event is for a workflow that requires a runner, and no runner is available. Alternatively the module can be configured as ephemeral runners. In this case the module will create a new runner for each workflow job event. +The module is designed to be used in a GitHub organization. It can also be used in a GitHub repository, but this does not support all features. The module is receiving GitHub webhook events for the `workflow_job` event. The module will create a new runner if the event is for a workflow that requires a runner, and no runner is available. Alternatively the module can be configured as ephemeral runners. In this case the module will create a new runner for each workflow job event. -For ephemeral runners a pool is can be configured. The pool maintains a minimum number of runners based on a schedule. The pool works only for org level runners. +For ephemeral runners a pool can be configured. The pool maintains a minimum number of runners based on a schedule. The pool works only for org level runners. For non ephemeral runners with the idle config the module will avoid scaling down back to zero. Instead it will maintain a minimum number of runners based on a schedule. This avoids the need to scale up when a new workflow is triggered. diff --git a/examples/default/main.tf b/examples/default/main.tf index ca04eca78c..2addb372a4 100644 --- a/examples/default/main.tf +++ b/examples/default/main.tf @@ -42,7 +42,7 @@ module "runners" { # iops = null # }] - # When not explicitly set lambda zip files are grapped from the module requiring lambda build. + # When not explicitly set lambda zip files are grabbed from the module requiring lambda build. # Alternatively you can set the path to the lambda zip files here. # # For example grab zip files via lambda_download @@ -68,7 +68,7 @@ module "runners" { # enable S3 versioning for runners S3 bucket # runner_binaries_s3_versioning = "Enabled" - # Uncommet idle config to have idle runners from 9 to 5 in time zone Amsterdam + # Uncomment idle config to have idle runners from 9 to 5 in time zone Amsterdam # idle_config = [{ # cron = "* * 9-17 * * *" # timeZone = "Europe/Amsterdam"