You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
| <aname="input_cloudwatch_config"></a> [cloudwatch\_config](#input\_cloudwatch\_config)| (optional) Replaces the module's default cloudwatch log config. See https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Agent-Configuration-File-Details.html for details. |`string`|`null`| no |
119
119
| <aname="input_create_service_linked_role_spot"></a> [create\_service\_linked\_role\_spot](#input\_create\_service\_linked\_role\_spot)| (optional) create the service linked role for spot instances that is required by the scale-up lambda. |`bool`|`false`| no |
120
-
| <aname="input_scale_errors"></a> [custom\_scale\_errors](#input\_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|`list(string)`|`[]`| no |
121
120
| <aname="input_delay_webhook_event"></a> [delay\_webhook\_event](#input\_delay\_webhook\_event)| The number of seconds the event accepted by the webhook is invisible on the queue before the scale up lambda will receive the event. |`number`|`30`| no |
122
121
| <aname="input_disable_runner_autoupdate"></a> [disable\_runner\_autoupdate](#input\_disable\_runner\_autoupdate)| Disable the auto update of the github runner agent. Be aware there is a grace period of 30 days, see also the [GitHub article](https://github.blog/changelog/2022-02-01-github-actions-self-hosted-runners-can-now-disable-automatic-updates/)|`bool`|`false`| no |
123
122
| <aname="input_enable_ami_housekeeper"></a> [enable\_ami\_housekeeper](#input\_enable\_ami\_housekeeper)| Option to disable the lambda to clean up old AMIs. |`bool`|`false`| no |
@@ -198,6 +197,7 @@ Join our discord community via [this invite link](https://discord.gg/bxgXW8jJGh)
198
197
| <aname="input_runner_hook_job_completed"></a> [runner\_hook\_job\_completed](#input\_runner\_hook\_job\_completed)| Script to be ran in the runner environment at the end of every job |`string`|`""`| no |
199
198
| <aname="input_runner_hook_job_started"></a> [runner\_hook\_job\_started](#input\_runner\_hook\_job\_started)| Script to be ran in the runner environment at the beginning of every job |`string`|`""`| no |
200
199
| <aname="input_runner_iam_role_managed_policy_arns"></a> [runner\_iam\_role\_managed\_policy\_arns](#input\_runner\_iam\_role\_managed\_policy\_arns)| Attach AWS or customer-managed IAM policies (by ARN) to the runner IAM role |`list(string)`|`[]`| no |
200
+
| <aname="input_runner_license_specifications"></a> [runner\_license\_specifications](#input\_runner\_license\_specifications)| The license specifications for the instance. See https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/launch_template#license_specification for details. | <pre>list(object({<br/> license_configuration_arn = string<br/> }))</pre> |`[]`| no |
201
201
| <aname="input_runner_log_files"></a> [runner\_log\_files](#input\_runner\_log\_files)| (optional) Replaces the module default cloudwatch log config. See https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Agent-Configuration-File-Details.html for details. | <pre>list(object({<br/> log_group_name = string<br/> prefix_log_group = bool<br/> file_path = string<br/> log_stream_name = string<br/> }))</pre> |`null`| no |
202
202
| <aname="input_runner_metadata_options"></a> [runner\_metadata\_options](#input\_runner\_metadata\_options)| Metadata options for the ec2 runner instances. By default, the module uses metadata tags for bootstrapping the runner, only disable `instance_metadata_tags` when using custom scripts for starting the runner. |`map(any)`| <pre>{<br/> "http_endpoint": "enabled",<br/> "http_put_response_hop_limit": 1,<br/> "http_tokens": "required",<br/> "instance_metadata_tags": "enabled"<br/>}</pre> | no |
203
203
| <aname="input_runner_name_prefix"></a> [runner\_name\_prefix](#input\_runner\_name\_prefix)| The prefix used for the GitHub runner name. The prefix will be used in the default start script to prefix the instance name when register the runner in GitHub. The value is available via an EC2 tag 'ghr:runner\_name\_prefix'. |`string`|`""`| no |
| <aname="input_environment"></a> [environment](#input\_environment)| Environment name, used as prefix. |`string`|`null`| no |
35
34
| <aname="input_host_groups"></a> [host\_groups](#input\_host\_groups)| Map of host groups, each with a name, host instance type, and a list of hosts (name + AZ). | <pre>map(object({<br/> name = string<br/> host_instance_type = string<br/> hosts = list(object({<br/> name = string<br/> availability_zone = string<br/> }))<br/> }))</pre> | n/a | yes |
36
-
| <aname="input_tags"></a> [tags](#input\_tags)| A map of tags to apply to resources. |`map(string)`| n/a | yes |
Copy file name to clipboardExpand all lines: modules/runners/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -145,7 +145,6 @@ yarn run dist
145
145
| <aname="input_cpu_options"></a> [cpu\_options](#input\_cpu\_options)| The CPU options for the instance. See https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/launch_template#cpu-options for details. Note that not all instance types support CPU options, see https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html#instance-cpu-options| <pre>object({<br/> core_count = number<br/> threads_per_core = number<br/> })</pre> |`null`| no |
146
146
| <aname="input_create_service_linked_role_spot"></a> [create\_service\_linked\_role\_spot](#input\_create\_service\_linked\_role\_spot)| (optional) create the service linked role for spot instances that is required by the scale-up lambda. |`bool`|`false`| no |
147
147
| <aname="input_credit_specification"></a> [credit\_specification](#input\_credit\_specification)| The credit option for CPU usage of a T instance. Can be unset, "standard" or "unlimited". |`string`|`null`| no |
148
-
| <aname="input_scale_errors"></a> [custom\_scale\_errors](#input\_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|`list(string)`|`[]`| no |
149
148
| <aname="input_disable_runner_autoupdate"></a> [disable\_runner\_autoupdate](#input\_disable\_runner\_autoupdate)| Disable the auto update of the github runner agent. Be aware there is a grace period of 30 days, see also the [GitHub article](https://github.blog/changelog/2022-02-01-github-actions-self-hosted-runners-can-now-disable-automatic-updates/)|`bool`|`false`| no |
150
149
| <aname="input_ebs_optimized"></a> [ebs\_optimized](#input\_ebs\_optimized)| The EC2 EBS optimized configuration. |`bool`|`false`| no |
| <aname="input_lambda_timeout_scale_down"></a> [lambda\_timeout\_scale\_down](#input\_lambda\_timeout\_scale\_down)| Time out for the scale down lambda in seconds. |`number`|`60`| no |
187
186
| <aname="input_lambda_timeout_scale_up"></a> [lambda\_timeout\_scale\_up](#input\_lambda\_timeout\_scale\_up)| Time out for the scale up lambda in seconds. |`number`|`60`| no |
188
187
| <aname="input_lambda_zip"></a> [lambda\_zip](#input\_lambda\_zip)| File location of the lambda zip file. |`string`|`null`| no |
188
+
| <aname="input_license_specifications"></a> [license\_specifications](#input\_license\_specifications)| The license specifications for the instance. See https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/launch_template#license_specification for details. | <pre>list(object({<br/> license_configuration_arn = string<br/> }))</pre> |`[]`| no |
189
189
| <aname="input_log_level"></a> [log\_level](#input\_log\_level)| Logging level for lambda logging. Valid values are 'silly', 'trace', 'debug', 'info', 'warn', 'error', 'fatal'. |`string`|`"info"`| no |
190
190
| <aname="input_logging_kms_key_id"></a> [logging\_kms\_key\_id](#input\_logging\_kms\_key\_id)| Specifies the kms key id to encrypt the logs with |`string`|`null`| no |
191
191
| <aname="input_logging_retention_in_days"></a> [logging\_retention\_in\_days](#input\_logging\_retention\_in\_days)| Specifies the number of days you want to retain log events for the lambda log group. Possible values are: 0, 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, and 3653. |`number`|`180`| no |
0 commit comments