Skip to content

Commit 5d17349

Browse files
docs: auto update terraform docs
1 parent 50e82c7 commit 5d17349

3 files changed

Lines changed: 17 additions & 17 deletions

File tree

modules/compute-providers/aws/microvm/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ The resolved provider-neutral `runner.iam.role` is passed to Lambda as the Micro
1212
## Requirements
1313

1414
| Name | Version |
15-
| ---- | ------- |
15+
|------|---------|
1616
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.4.0 |
1717
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 6.33 |
1818

1919
## Providers
2020

2121
| Name | Version |
22-
| ---- | ------- |
22+
|------|---------|
2323
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 6.33 |
2424
| <a name="provider_terraform"></a> [terraform](#provider\_terraform) | n/a |
2525

@@ -30,7 +30,7 @@ No modules.
3030
## Resources
3131

3232
| Name | Type |
33-
| ---- | ---- |
33+
|------|------|
3434
| [aws_cloudwatch_log_group.gh_runners](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_log_group) | resource |
3535
| [aws_cloudwatch_log_group.runtime](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_log_group) | resource |
3636
| [aws_ssm_parameter.cloudwatch_agent_config_runner](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ssm_parameter) | resource |
@@ -48,7 +48,7 @@ No modules.
4848
## Inputs
4949

5050
| Name | Description | Type | Default | Required |
51-
| ---- | ----------- | ---- | ------- | :------: |
51+
|------|-------------|------|---------|:--------:|
5252
| <a name="input_aws_partition"></a> [aws\_partition](#input\_aws\_partition) | AWS partition used to construct IAM ARNs. | `string` | `"aws"` | no |
5353
| <a name="input_aws_region"></a> [aws\_region](#input\_aws\_region) | AWS region used by compute-provider resources and policy documents. | `string` | n/a | yes |
5454
| <a name="input_config"></a> [config](#input\_config) | Lambda MicroVM compute-provider configuration. Paths match `compute_provider.aws.microvm` in runner-config.<br/><br/>- `image_arn`: ARN of the MicroVM image used to run GitHub runners.<br/>- `image_version`: Optional MicroVM image version.<br/>- `ingress_network_connectors`: Up to 10 Lambda network-connector ARNs passed to RunMicrovm.<br/>- `egress_network_connectors`: Up to 10 Lambda network-connector ARNs passed to RunMicrovm.<br/>- `cloudwatch_agent.enabled`: Enables the image CloudWatch agent through the shared runner configuration path.<br/>- `cloudwatch_agent.config`: Optional complete CloudWatch agent configuration. Null renders the provider default from `log_files`. Custom log destinations must also be declared in `log_files` so Terraform creates their groups and IAM permissions.<br/>- `log_files`: Optional files collected by the CloudWatch agent. Null uses the MicroVM defaults.<br/>- `log_files[].log_group_name`: CloudWatch log-group name before optional prefixing.<br/>- `log_files[].prefix_log_group`: Prefixes the log-group name with the runner configuration path.<br/>- `log_files[].file_path`: File or glob read by the CloudWatch agent.<br/>- `log_files[].log_stream_name`: Log-stream template. The image replaces `{microvm_id}` with the current MicroVM identifier.<br/>- `log_files[].log_class`: CloudWatch log-group class for the collected file.<br/>- `environment_variables`: Additional provider-specific Lambda environment variables merged into scale-up, scale-down, and pool.<br/>- `iam.resource_arns.images`: Optional MicroVM image ARN allowlist for RunMicrovm and TerminateMicrovm. Null restricts both actions to `image_arn`; set an explicit list when dynamic image overrides are enabled. Provider-required list and connector permissions remain separately scoped to `*`.<br/>- `iam.additional_policy_json.scale_up`: Optional additional provider policy attached separately to the scale-up Lambda role.<br/>- `iam.managed_policies.scale_up`: Optional managed-policy wrapper attached to the scale-up Lambda role. Wrapper presence controls resource creation during planning.<br/>- `iam.managed_policies.scale_up.arn`: ARN of the scale-up managed policy. The ARN may remain unknown until apply.<br/>- `iam.managed_policies.pool`: Optional managed-policy wrapper attached to the pool Lambda role. Wrapper presence controls resource creation during planning.<br/>- `iam.managed_policies.pool.arn`: ARN of the pool managed policy. The ARN may remain unknown until apply. | <pre>object({<br/> image_arn = string<br/> image_version = optional(string, null)<br/> ingress_network_connectors = optional(list(string), [])<br/> egress_network_connectors = optional(list(string), [])<br/> cloudwatch_agent = optional(object({<br/> enabled = optional(bool, true)<br/> config = optional(string, null)<br/> }), {})<br/> log_files = optional(list(object({<br/> log_group_name = string<br/> prefix_log_group = bool<br/> file_path = string<br/> log_stream_name = string<br/> log_class = optional(string, "STANDARD")<br/> })), null)<br/> environment_variables = optional(map(string), {})<br/> iam = optional(object({<br/> resource_arns = optional(object({<br/> images = optional(list(string), null)<br/> }), {})<br/> additional_policy_json = optional(object({<br/> scale_up = optional(string, null)<br/> }), {})<br/> managed_policies = optional(object({<br/> scale_up = optional(object({<br/> arn = string<br/> }), null)<br/> pool = optional(object({<br/> arn = string<br/> }), null)<br/> }), {})<br/> }), {})<br/> })</pre> | n/a | yes |
@@ -62,7 +62,7 @@ No modules.
6262
## Outputs
6363

6464
| Name | Description |
65-
| ---- | ----------- |
65+
|------|-------------|
6666
| <a name="output_environment_variables"></a> [environment\_variables](#output\_environment\_variables) | Provider-specific Lambda environment variable fragments consumed by runner-config. |
6767
| <a name="output_policies"></a> [policies](#output\_policies) | Provider-specific IAM policy fragments consumed by runner-config. |
6868
| <a name="output_provider"></a> [provider](#output\_provider) | Nested Lambda MicroVM compute-provider contract consumed by runner-config. |

modules/multi-runner/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -156,23 +156,23 @@ module "multi-runner" {
156156
## Requirements
157157

158158
| Name | Version |
159-
| ---- | ------- |
159+
|------|---------|
160160
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.4.0 |
161161
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 6.33 |
162162
| <a name="requirement_random"></a> [random](#requirement\_random) | ~> 3.0 |
163163

164164
## Providers
165165

166166
| Name | Version |
167-
| ---- | ------- |
167+
|------|---------|
168168
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 6.33 |
169169
| <a name="provider_random"></a> [random](#provider\_random) | ~> 3.0 |
170170
| <a name="provider_terraform"></a> [terraform](#provider\_terraform) | n/a |
171171

172172
## Modules
173173

174174
| Name | Source | Version |
175-
| ---- | ------ | ------- |
175+
|------|--------|---------|
176176
| <a name="module_ami_housekeeper"></a> [ami\_housekeeper](#module\_ami\_housekeeper) | ../ami-housekeeper | n/a |
177177
| <a name="module_instance_termination_watcher"></a> [instance\_termination\_watcher](#module\_instance\_termination\_watcher) | ../termination-watcher | n/a |
178178
| <a name="module_runner_binaries"></a> [runner\_binaries](#module\_runner\_binaries) | ../runner-binaries-syncer | n/a |
@@ -184,7 +184,7 @@ module "multi-runner" {
184184
## Resources
185185

186186
| Name | Type |
187-
| ---- | ---- |
187+
|------|------|
188188
| [aws_sqs_queue.queued_builds](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sqs_queue) | resource |
189189
| [aws_sqs_queue.queued_builds_dlq](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sqs_queue) | resource |
190190
| [aws_sqs_queue_policy.build_queue_dlq_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sqs_queue_policy) | resource |
@@ -196,7 +196,7 @@ module "multi-runner" {
196196
## Inputs
197197

198198
| Name | Description | Type | Default | Required |
199-
| ---- | ----------- | ---- | ------- | :------: |
199+
|------|-------------|------|---------|:--------:|
200200
| <a name="input_additional_github_apps"></a> [additional\_github\_apps](#input\_additional\_github\_apps) | Additional GitHub Apps for random API rate limit distribution.<br/><br/>The primary app (var.github\_app) is always included and is the one whose<br/>webhook secret is used for incoming webhook signature validation. Only the<br/>primary app needs a webhook configured in GitHub.<br/><br/>Additional apps listed here are used exclusively by the control-plane<br/>lambdas (scale-up, scale-down, pool, job-retry) which randomly select an<br/>app for each GitHub API call. Each additional app must be installed on the<br/>same repositories/organizations as the primary app. | <pre>list(object({<br/> key_base64 = optional(string)<br/> key_base64_ssm = optional(object({ arn = string, name = string }))<br/> id = optional(string)<br/> id_ssm = optional(object({ arn = string, name = string }))<br/> installation_id = optional(string)<br/> installation_id_ssm = optional(object({ arn = string, name = string }))<br/> }))</pre> | `[]` | no |
201201
| <a name="input_ami_housekeeper_cleanup_config"></a> [ami\_housekeeper\_cleanup\_config](#input\_ami\_housekeeper\_cleanup\_config) | Configuration for AMI cleanup. | <pre>object({<br/> maxItems = optional(number)<br/> minimumDaysOld = optional(number)<br/> amiFilters = optional(list(object({<br/> Name = string<br/> Values = list(string)<br/> })))<br/> launchTemplateNames = optional(list(string))<br/> ssmParameterNames = optional(list(string))<br/> dryRun = optional(bool)<br/> })</pre> | `{}` | no |
202202
| <a name="input_ami_housekeeper_lambda_memory_size"></a> [ami\_housekeeper\_lambda\_memory\_size](#input\_ami\_housekeeper\_lambda\_memory\_size) | Memory size limit in MB of the lambda. | `number` | `256` | no |
@@ -281,7 +281,7 @@ module "multi-runner" {
281281
## Outputs
282282

283283
| Name | Description |
284-
| ---- | ----------- |
284+
|------|-------------|
285285
| <a name="output_binaries_syncer_map"></a> [binaries\_syncer\_map](#output\_binaries\_syncer\_map) | n/a |
286286
| <a name="output_instance_termination_handler"></a> [instance\_termination\_handler](#output\_instance\_termination\_handler) | n/a |
287287
| <a name="output_instance_termination_watcher"></a> [instance\_termination\_watcher](#output\_instance\_termination\_watcher) | n/a |

0 commit comments

Comments
 (0)