Skip to content

Commit 82712f8

Browse files
chore: update variable description
1 parent eb7236e commit 82712f8

3 files changed

Lines changed: 3 additions & 3 deletions

File tree

modules/multi-runner/variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ variable "multi_runner_config" {
198198
enable_ephemeral_runners: "Enable ephemeral runners, runners will only be used once."
199199
enable_job_queued_check: "Enables JIT configuration for creating runners instead of registration token based registraton. JIT configuration will only be applied for ephemeral runners. By default JIT configuration is enabled for ephemeral runners an can be disabled via this override. When running on GHES without support for JIT configuration this variable should be set to true for ephemeral runners."
200200
enable_on_demand_failover_for_errors: "Enable on-demand failover. For example to fall back to on demand when no spot capacity is available the variable can be set to `InsufficientInstanceCapacity`. When not defined the default behavior is to retry later."
201-
custom_scale_errors: "List of custom aws error codes that should trigger retry during scale up."
201+
custom_scale_errors: "List of aws error codesthat should trigger retry during scale up. This list will replace the default errors defined in the variable `defaultScaleErrors` in https://github.com/github-aws-runners/terraform-aws-github-runner/blob/main/lambdas/functions/control-plane/src/aws/runners.ts"
202202
enable_organization_runners: "Register runners to organization, instead of repo level"
203203
enable_runner_binaries_syncer: "Option to disable the lambda to sync GitHub runner distribution, useful when using a pre-build AMI."
204204
enable_ssm_on_runners: "Enable to allow access the runner instances for debugging purposes via SSM. Note that this adds additional permissions to the runner instances."

modules/runners/variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -702,7 +702,7 @@ variable "enable_on_demand_failover_for_errors" {
702702
}
703703

704704
variable "custom_scale_errors" {
705-
description = "List of custom aws error codes that should trigger retry during scale up."
705+
description = "List of aws error codesthat should trigger retry during scale up. This list will replace the default errors defined in the variable `defaultScaleErrors` in https://github.com/github-aws-runners/terraform-aws-github-runner/blob/main/lambdas/functions/control-plane/src/aws/runners.ts"
706706
type = list(string)
707707
default = []
708708
}

variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,7 @@ variable "enable_runner_on_demand_failover_for_errors" {
284284
}
285285

286286
variable "custom_scale_errors" {
287-
description = "List of custom aws error codes that should trigger retry during scale up."
287+
description = "List of aws error codesthat should trigger retry during scale up. This list will replace the default errors defined in the variable `defaultScaleErrors` in https://github.com/github-aws-runners/terraform-aws-github-runner/blob/main/lambdas/functions/control-plane/src/aws/runners.ts"
288288
type = list(string)
289289
default = []
290290
}

0 commit comments

Comments
 (0)