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
| ami\_filter |List of maps used to create the AMI filter for the action runner AMI. |`map(list(string))`| <pre>{<br> "name": [<br> "amzn2-ami-hvm-2.*-x86_64-ebs"<br> ]<br>}</pre> | no |
90
+
| ami\_filter |Map of lists used to create the AMI filter for the action runner AMI. |`map(list(string))`| <pre>{<br> "name": [<br> "amzn2-ami-hvm-2.*-x86_64-ebs"<br> ]<br>}</pre> | no |
91
91
| ami\_owners | The list of owners used to select the AMI of action runner instances. |`list(string)`| <pre>[<br> "amazon"<br>]</pre> | no |
| block\_device\_mappings | The EC2 instance block device configuration. Takes the following keys: `device_name`, `delete_on_termination`, `volume_type`, `volume_size`, `encrypted`, `iops`|`map(string)`|`{}`| no |
94
94
| cloudwatch\_config | (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. |`string`|`null`| no |
95
-
| create\_service\_linked\_role\_spot | (optional) create the serviced linked role for spot instances that is required by the scale-up lambda. |`bool`|`false`| no |
95
+
| 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 |
96
96
| enable\_cloudwatch\_agent | Enabling the cloudwatch agent on the ec2 runner instances, the runner contains default config. Configuration can be overridden via `cloudwatch_config`. |`bool`|`true`| no |
| 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. |`bool`| n/a | yes |
98
+
| enable\_ssm\_on\_runners | Enable to allow access to the runner instances for debugging purposes via SSM. Note that this adds additional permissions to the runner instances. |`bool`| n/a | yes |
99
99
| environment | A name that identifies the environment, used as prefix and for tagging. |`string`| n/a | yes |
100
100
| ghes\_url | GitHub Enterprise Server URL. DO NOT SET IF USING PUBLIC GITHUB |`string`|`null`| no |
101
101
| github\_app\_parameters | Parameter Store for GitHub App Parameters. | <pre>object({<br> key_base64 = map(string)<br> id = map(string)<br> client_id = map(string)<br> client_secret = map(string)<br> })</pre> | n/a | yes |
@@ -114,16 +114,17 @@ No Modules.
114
114
| 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 |
115
115
| market\_options | Market options for the action runner instances. |`string`|`"spot"`| no |
116
116
| minimum\_running\_time\_in\_minutes | The time an ec2 action runner should be running at minimum before terminated if non busy. |`number`|`5`| no |
117
-
| overrides | This maps provides the possibility to override some defaults. The following attributes are supported: `name_sg`overwrite the `Name` tag for all security groups created by this module. `name_runner_agent_instance`override the `Name` tag for the ec2 instance defined in the auto launch configuration. `name_docker_machine_runners`override the `Name` tag spot instances created by the runner agent. |`map(string)`| <pre>{<br> "name_runner": "",<br> "name_sg": ""<br>}</pre> | no |
118
-
| role\_path | The path that will be added to the role, if not set the environment name will be used. |`string`|`null`| no |
117
+
| overrides | This map provides the possibility to override some defaults. The following attributes are supported: `name_sg`overrides the `Name` tag for all security groups created by this module. `name_runner_agent_instance`overrides the `Name` tag for the ec2 instance defined in the auto launch configuration. `name_docker_machine_runners`overrides the `Name` tag spot instances created by the runner agent. |`map(string)`| <pre>{<br> "name_runner": "",<br> "name_sg": ""<br>}</pre> | no |
118
+
| role\_path | The path that will be added to the role; if not set, the environment name will be used. |`string`|`null`| no |
119
119
| role\_permissions\_boundary | Permissions boundary that will be added to the created role for the lambda. |`string`|`null`| no |
120
120
| runner\_additional\_security\_group\_ids | (optional) List of additional security groups IDs to apply to the runner |`list(string)`|`[]`| no |
121
121
| runner\_architecture | The platform architecture of the runner instance\_type. |`string`|`"x64"`| no |
122
122
| runner\_as\_root | Run the action runner under the root user. |`bool`|`false`| no |
123
+
| runner\_boot\_time\_in\_minutes | The minimum time for an EC2 runner to boot and register as a runner. |`number`|`5`| no |
123
124
| runner\_extra\_labels | Extra labels for the runners (GitHub). Separate each label by a comma |`string`|`""`| no |
124
125
| runner\_group\_name | Name of the runner group. |`string`|`"Default"`| no |
125
126
| runner\_iam\_role\_managed\_policy\_arns | Attach AWS or customer-managed IAM policies (by ARN) to the runner IAM role |`list(string)`|`[]`| no |
126
-
| runner\_log\_files | (optional) List of logfiles to send to cloudwatch, will only be used if `enable_cloudwatch_agent` is set to true. Object description: `log_group_name`: Name of the log group, `prefix_log_group`: If true, the log group name will be prefixed with `/github-self-hosted-runners/<var.environment>`, `file_path`: path to the log file, `log_stream_name`: name of the log stream. | <pre>list(object({<br> log_group_name = string<br> prefix_log_group = bool<br> file_path = string<br> log_stream_name = string<br> }))</pre> | <pre>[<br> {<br> "file_path": "/var/log/messages",<br> "log_group_name": "messages",<br> "log_stream_name": "{instance_id}",<br> "prefix_log_group": true<br> },<br> {<br> "file_path": "/var/log/user-data.log",<br> "log_group_name": "user_data",<br> "log_stream_name": "{instance_id}",<br> "prefix_log_group": true<br> },<br> {<br> "file_path": "/home/ec2-user/actions-runner/_diag/Runner_**.log",<br> "log_group_name": "runner",<br> "log_stream_name": "{instance_id}",<br> "prefix_log_group": true<br> }<br>]</pre> | no |
127
+
| runner\_log\_files | (optional) List of logfiles to send to CloudWatch, will only be used if `enable_cloudwatch_agent` is set to true. Object description: `log_group_name`: Name of the log group, `prefix_log_group`: If true, the log group name will be prefixed with `/github-self-hosted-runners/<var.environment>`, `file_path`: path to the log file, `log_stream_name`: name of the log stream. | <pre>list(object({<br> log_group_name = string<br> prefix_log_group = bool<br> file_path = string<br> log_stream_name = string<br> }))</pre> | <pre>[<br> {<br> "file_path": "/var/log/messages",<br> "log_group_name": "messages",<br> "log_stream_name": "{instance_id}",<br> "prefix_log_group": true<br> },<br> {<br> "file_path": "/var/log/user-data.log",<br> "log_group_name": "user_data",<br> "log_stream_name": "{instance_id}",<br> "prefix_log_group": true<br> },<br> {<br> "file_path": "/home/ec2-user/actions-runner/_diag/Runner_**.log",<br> "log_group_name": "runner",<br> "log_stream_name": "{instance_id}",<br> "prefix_log_group": true<br> }<br>]</pre> | no |
127
128
| runners\_lambda\_s3\_key | S3 key for runners lambda function. Required if using S3 bucket to specify lambdas. |`any`|`null`| no |
128
129
| runners\_lambda\_s3\_object\_version | S3 object version for runners lambda function. Useful if S3 versioning is enabled on source bucket. |`any`|`null`| no |
129
130
| runners\_maximum\_count | The maximum number of runners that will be created. |`number`|`3`| no |
| subnet\_ids | List of subnets in which the action runners will be launched, the subnets needs to be subnets in the `vpc_id`. |`list(string)`| n/a | yes |
135
136
| tags | Map of tags that will be added to created resources. By default resources will be tagged with name and environment. |`map(string)`|`{}`| no |
136
-
| userdata\_post\_install | User-data script snippet to insert after GitHub acton runner install |`string`|`""`| no |
137
-
| userdata\_pre\_install | User-data script snippet to insert before GitHub acton runner install |`string`|`""`| no |
137
+
| userdata\_post\_install | User-data script snippet to insert after GitHub action runner install |`string`|`""`| no |
138
+
| userdata\_pre\_install | User-data script snippet to insert before GitHub action runner install |`string`|`""`| no |
138
139
| 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 |
139
140
| volume\_size | Size of runner volume |`number`|`30`| no |
140
141
| vpc\_id | The VPC for the security groups. |`string`| n/a | yes |
0 commit comments