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
{{ message }}
This repository was archived by the owner on Jan 16, 2025. It is now read-only.
|[aws_iam_policy_document.deny_unsecure_transport](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document)| data source |
484
484
485
-
## Inputs (to the runner module)
485
+
## Inputs
486
486
487
487
| Name | Description | Type | Default | Required |
@@ -498,7 +498,7 @@ We welcome any improvement to the standard module to make the default as secure
498
498
| <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 |
499
499
| <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 |
500
500
| <aname="input_enable_cloudwatch_agent"></a> [enable\_cloudwatch\_agent](#input\_enable\_cloudwatch\_agent)| Enables the cloudwatch agent on the ec2 runner instances. The runner uses a default config that can be overridden via `cloudwatch_config`. |`bool`|`true`| no |
501
-
| <aname="input_enable_enable_fifo_build_queue"></a> [enable\_enable\_fifo\_build\_queue](#input\_enable\_enable\_fifo\_build\_queue)|DEPRECATED: Replaced by `enable_fifo_build_queue` / `fifo_build_queue`. |`string`|`null`| no |
501
+
| <aname="input_enable_enable_fifo_build_queue"></a> [enable\_enable\_fifo\_build\_queue](#input\_enable\_enable\_fifo\_build\_queue)|DEPCRECATED: Replaced by `enable_fifo_build_queue` / `fifo_build_queue`. |`string`|`null`| no |
502
502
| <aname="input_enable_ephemeral_runners"></a> [enable\_ephemeral\_runners](#input\_enable\_ephemeral\_runners)| Enable ephemeral runners, runners will only be used once. |`bool`|`false`| no |
503
503
| <aname="input_enable_event_rule_binaries_syncer"></a> [enable\_event\_rule\_binaries\_syncer](#input\_enable\_event\_rule\_binaries\_syncer)| Option to disable EventBridge Lambda trigger for the binary syncer, useful to stop automatic updates of binary distribution. |`bool`|`true`| no |
504
504
| <aname="input_enable_fifo_build_queue"></a> [enable\_fifo\_build\_queue](#input\_enable\_fifo\_build\_queue)| Enable a FIFO queue to keep the order of events received by the webhook. Recommended for repo level runners. |`bool`|`false`| no |
@@ -512,9 +512,9 @@ We welcome any improvement to the standard module to make the default as secure
512
512
| <aname="input_enable_user_data_debug_logging_runner"></a> [enable\_user\_data\_debug\_logging\_runner](#input\_enable\_user\_data\_debug\_logging\_runner)| Option to enable debug logging for user-data, this logs all secrets as well. |`bool`|`false`| no |
513
513
| <aname="input_enable_userdata"></a> [enable\_userdata](#input\_enable\_userdata)| Should the userdata script be enabled for the runner. Set this to false if you are using your own prebuilt AMI. |`bool`|`true`| no |
514
514
| <aname="input_enable_workflow_job_events_queue"></a> [enable\_workflow\_job\_events\_queue](#input\_enable\_workflow\_job\_events\_queue)| Enabling this experimental feature will create a secondory sqs queue to which a copy of the workflow\_job event will be delivered. |`bool`|`false`| no |
515
-
| <aname="input_enabled_userdata"></a> [enabled\_userdata](#input\_enabled\_userdata)|DEPRECATED: Replaced by `enable_userdata`. |`string`|`null`| no |
515
+
| <aname="input_enabled_userdata"></a> [enabled\_userdata](#input\_enabled\_userdata)|DEPCRECATED: Replaced by `enable_userdata`. |`string`|`null`| no |
516
516
| <aname="input_environment"></a> [environment](#input\_environment)| DEPRECATED, no longer used. See `prefix`|`string`|`null`| no |
517
-
| <aname="input_fifo_build_queue"></a> [fifo\_build\_queue](#input\_fifo\_build\_queue)|DEPRECATED: Replaced by `enable_fifo_build_queue`. |`string`|`null`| no |
517
+
| <aname="input_fifo_build_queue"></a> [fifo\_build\_queue](#input\_fifo\_build\_queue)|DEPCRECATED: Replaced by `enable_fifo_build_queue`. |`string`|`null`| no |
518
518
| <aname="input_ghes_ssl_verify"></a> [ghes\_ssl\_verify](#input\_ghes\_ssl\_verify)| GitHub Enterprise SSL verification. Set to 'false' when custom certificate (chains) is used for GitHub Enterprise Server (insecure). |`bool`|`true`| no |
519
519
| <aname="input_ghes_url"></a> [ghes\_url](#input\_ghes\_url)| GitHub Enterprise Server URL. Example: https://github.internal.co - DO NOT SET IF USING PUBLIC GITHUB |`string`|`null`| no |
520
520
| <aname="input_github_app"></a> [github\_app](#input\_github\_app)| GitHub app parameters, see your github app. Ensure the key is the base64-encoded `.pem` file (the output of `base64 app.private-key.pem`, not the content of `private-key.pem`). | <pre>object({<br> key_base64 = string<br> id = string<br> webhook_secret = string<br> })</pre> | n/a | yes |
@@ -546,7 +546,7 @@ We welcome any improvement to the standard module to make the default as secure
546
546
| <aname="input_prefix"></a> [prefix](#input\_prefix)| The prefix used for naming resources |`string`|`"github-actions"`| no |
547
547
| <aname="input_queue_encryption"></a> [queue\_encryption](#input\_queue\_encryption)| Configure how data on queues managed by the modules in ecrypted at REST. Options are encryped via SSE, non encrypted and via KMSS. By default encryptes via SSE is enabled. See for more details the Terraform `aws_sqs_queue` resource https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sqs_queue.| <pre>object({<br> kms_data_key_reuse_period_seconds = number<br> kms_master_key_id = string<br> sqs_managed_sse_enabled = bool<br> })</pre> | <pre>{<br> "kms_data_key_reuse_period_seconds": null,<br> "kms_master_key_id": null,<br> "sqs_managed_sse_enabled": true<br>}</pre> | no |
548
548
| <aname="input_redrive_build_queue"></a> [redrive\_build\_queue](#input\_redrive\_build\_queue)| Set options to attach (optional) a dead letter queue to the build queue, the queue between the webhook and the scale up lambda. You have the following options. 1. Disable by setting `enabled` to false. 2. Enable by setting `enabled` to `true`, `maxReceiveCount` to a number of max retries. | <pre>object({<br> enabled = bool<br> maxReceiveCount = number<br> })</pre> | <pre>{<br> "enabled": false,<br> "maxReceiveCount": null<br>}</pre> | no |
549
-
| <aname="input_repository_white_list"></a> [repository\_white\_list](#input\_repository\_white\_list)| List of github repository full names (owner/repo_name) that will be allowed to use the github app. Leave empty for no filtering. |`list(string)`|`[]`| no |
549
+
| <aname="input_repository_white_list"></a> [repository\_white\_list](#input\_repository\_white\_list)| List of github repository full names (owner/repo\_name) that will be allowed to use the github app. Leave empty for no filtering. |`list(string)`|`[]`| no |
550
550
| <aname="input_role_path"></a> [role\_path](#input\_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 |
551
551
| <aname="input_role_permissions_boundary"></a> [role\_permissions\_boundary](#input\_role\_permissions\_boundary)| Permissions boundary that will be added to the created roles. |`string`|`null`| no |
552
552
| <aname="input_runner_additional_security_group_ids"></a> [runner\_additional\_security\_group\_ids](#input\_runner\_additional\_security\_group\_ids)| (optional) List of additional security groups IDs to apply to the runner. |`list(string)`|`[]`| no |
@@ -563,7 +563,7 @@ We welcome any improvement to the standard module to make the default as secure
563
563
| <aname="input_runner_credit_specification"></a> [runner\_credit\_specification](#input\_runner\_credit\_specification)| The credit option for CPU usage of a T instance. Can be unset, "standard" or "unlimited". |`string`|`null`| no |
564
564
| <aname="input_runner_ec2_tags"></a> [runner\_ec2\_tags](#input\_runner\_ec2\_tags)| Map of tags that will be added to the launch template instance tag specifications. |`map(string)`|`{}`| no |
| <aname="input_runner_enable_workflow_job_labels_check_all"></a> [runner\_enable\_workflow\_job\_labels\_check\_all](#input\_runner\_enable\_workflow\_job\_labels\_check\_all)|DEPRECATED: Replaced by `enable_runner_workflow_job_labels_check_all`. |`string`|`null`| no |
566
+
| <aname="input_runner_enable_workflow_job_labels_check_all"></a> [runner\_enable\_workflow\_job\_labels\_check\_all](#input\_runner\_enable\_workflow\_job\_labels\_check\_all)|DEPCRECATED: Replaced by `enable_runner_workflow_job_labels_check_all`. |`string`|`null`| no |
567
567
| <aname="input_runner_extra_labels"></a> [runner\_extra\_labels](#input\_runner\_extra\_labels)| Extra (custom) labels for the runners (GitHub). Separate each label by a comma. Labels checks on the webhook can be enforced by setting `enable_workflow_job_labels_check`. GitHub read-only labels should not be provided. |`string`|`""`| no |
568
568
| <aname="input_runner_group_name"></a> [runner\_group\_name](#input\_runner\_group\_name)| Name of the runner group. |`string`|`"Default"`| no |
569
569
| <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 |
@@ -582,15 +582,15 @@ We welcome any improvement to the standard module to make the default as secure
582
582
| <aname="input_scale_up_reserved_concurrent_executions"></a> [scale\_up\_reserved\_concurrent\_executions](#input\_scale\_up\_reserved\_concurrent\_executions)| Amount of reserved concurrent executions for the scale-up lambda function. A value of 0 disables lambda from being triggered and -1 removes any concurrency limitations. |`number`|`1`| no |
583
583
| <aname="input_ssm_paths"></a> [ssm\_paths](#input\_ssm\_paths)| The root path used in SSM to store configuration and secrets. | <pre>object({<br> root = optional(string, "github-action-runners")<br> app = optional(string, "app")<br> runners = optional(string, "runners")<br> use_prefix = optional(bool, true)<br> })</pre> |`{}`| no |
584
584
| <aname="input_subnet_ids"></a> [subnet\_ids](#input\_subnet\_ids)| List of subnets in which the action runner instances will be launched. The subnets need to exist in the configured VPC (`vpc_id`), and must reside in different availability zones (see https://github.com/philips-labs/terraform-aws-github-runner/issues/2904)|`list(string)`| n/a | yes |
585
-
| <aname="input_syncer_lambda_s3_key"></a> [syncer\_lambda\_s3\_key](#input\_syncer\_lambda\_s3\_key)| S3 key for syncer lambda function. Required if using S3 bucket to specify lambdas. |`string`|`null`| no |
585
+
| <aname="input_syncer_lambda_s3_key"></a> [syncer\_lambda\_s3\_key](#input\_syncer\_lambda\_s3\_key)| S3 key for syncer lambda function. Required if using an S3 bucket to specify lambdas. |`string`|`null`| no |
586
586
| <aname="input_syncer_lambda_s3_object_version"></a> [syncer\_lambda\_s3\_object\_version](#input\_syncer\_lambda\_s3\_object\_version)| S3 object version for syncer lambda function. Useful if S3 versioning is enabled on source bucket. |`string`|`null`| no |
587
587
| <aname="input_tags"></a> [tags](#input\_tags)| Map of tags that will be added to created resources. By default resources will be tagged with name and environment. |`map(string)`|`{}`| no |
588
588
| <aname="input_userdata_post_install"></a> [userdata\_post\_install](#input\_userdata\_post\_install)| Script to be ran after the GitHub Actions runner is installed on the EC2 instances |`string`|`""`| no |
589
589
| <aname="input_userdata_pre_install"></a> [userdata\_pre\_install](#input\_userdata\_pre\_install)| Script to be ran before the GitHub Actions runner is installed on the EC2 instances |`string`|`""`| no |
590
590
| <aname="input_userdata_template"></a> [userdata\_template](#input\_userdata\_template)| Alternative user-data template, replacing the default template. By providing your own user\_data you have to take care of installing all required software, including the action runner. Variables userdata\_pre/post\_install are ignored. |`string`|`null`| no |
591
591
| <aname="input_vpc_id"></a> [vpc\_id](#input\_vpc\_id)| The VPC for security groups of the action runners. |`string`| n/a | yes |
592
592
| <aname="input_webhook_lambda_apigateway_access_log_settings"></a> [webhook\_lambda\_apigateway\_access\_log\_settings](#input\_webhook\_lambda\_apigateway\_access\_log\_settings)| n/a | <pre>object({<br> destination_arn = string<br> format = string<br> })</pre> |`null`| no |
593
-
| <aname="input_webhook_lambda_s3_key"></a> [webhook\_lambda\_s3\_key](#input\_webhook\_lambda\_s3\_key)| S3 key for webhook lambda function. Required if using an S3 bucket to specify lambdas. |`string`|`null`| no |
593
+
| <aname="input_webhook_lambda_s3_key"></a> [webhook\_lambda\_s3\_key](#input\_webhook\_lambda\_s3\_key)| S3 key for webhook lambda function. Required if using S3 bucket to specify lambdas. |`string`|`null`| no |
594
594
| <aname="input_webhook_lambda_s3_object_version"></a> [webhook\_lambda\_s3\_object\_version](#input\_webhook\_lambda\_s3\_object\_version)| S3 object version for webhook lambda function. Useful if S3 versioning is enabled on source bucket. |`string`|`null`| no |
595
595
| <aname="input_webhook_lambda_timeout"></a> [webhook\_lambda\_timeout](#input\_webhook\_lambda\_timeout)| Time out of the webhook lambda in seconds. |`number`|`10`| no |
596
596
| <aname="input_webhook_lambda_zip"></a> [webhook\_lambda\_zip](#input\_webhook\_lambda\_zip)| File location of the webhook lambda zip file. |`string`|`null`| no |
0 commit comments