Skip to content

Commit 09f9f2e

Browse files
github-actions[bot]github-actions[bot]
authored
docs: auto update terraform docs
1 parent 9008db2 commit 09f9f2e

8 files changed

Lines changed: 48 additions & 48 deletions

File tree

‎modules/multi-runner/README.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -159,23 +159,23 @@ module "multi-runner" {
159159
## Requirements
160160

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

167167
## Providers
168168

169169
| Name | Version |
170-
| ---- | ------- |
171-
| <a name="provider_aws"></a> [aws](#provider\_aws) | 6.60.0 |
172-
| <a name="provider_random"></a> [random](#provider\_random) | 3.9.0 |
170+
|------|---------|
171+
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 6.33 |
172+
| <a name="provider_random"></a> [random](#provider\_random) | ~> 3.0 |
173173
| <a name="provider_terraform"></a> [terraform](#provider\_terraform) | n/a |
174174

175175
## Modules
176176

177177
| Name | Source | Version |
178-
| ---- | ------ | ------- |
178+
|------|--------|---------|
179179
| <a name="module_ami_housekeeper"></a> [ami\_housekeeper](#module\_ami\_housekeeper) | ../ami-housekeeper | n/a |
180180
| <a name="module_instance_termination_watcher"></a> [instance\_termination\_watcher](#module\_instance\_termination\_watcher) | ../termination-watcher | n/a |
181181
| <a name="module_runner_binaries"></a> [runner\_binaries](#module\_runner\_binaries) | ../runner-binaries-syncer | n/a |
@@ -187,7 +187,7 @@ module "multi-runner" {
187187
## Resources
188188

189189
| Name | Type |
190-
| ---- | ---- |
190+
|------|------|
191191
| [aws_sqs_queue.queued_builds](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sqs_queue) | resource |
192192
| [aws_sqs_queue.queued_builds_dlq](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sqs_queue) | resource |
193193
| [aws_sqs_queue_policy.build_queue_dlq_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sqs_queue_policy) | resource |
@@ -199,7 +199,7 @@ module "multi-runner" {
199199
## Inputs
200200

201201
| Name | Description | Type | Default | Required |
202-
| ---- | ----------- | ---- | ------- | :------: |
202+
|------|-------------|------|---------|:--------:|
203203
| <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 |
204204
| <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 |
205205
| <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 |
@@ -284,7 +284,7 @@ module "multi-runner" {
284284
## Outputs
285285

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

‎modules/multi-runner/tests/fixtures/computed-runner-inputs/README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,26 @@
22
## Requirements
33

44
| Name | Version |
5-
| ---- | ------- |
5+
|------|---------|
66
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3 |
77
| <a name="requirement_random"></a> [random](#requirement\_random) | ~> 3.0 |
88

99
## Providers
1010

1111
| Name | Version |
12-
| ---- | ------- |
12+
|------|---------|
1313
| <a name="provider_random"></a> [random](#provider\_random) | ~> 3.0 |
1414

1515
## Modules
1616

1717
| Name | Source | Version |
18-
| ---- | ------ | ------- |
18+
|------|--------|---------|
1919
| <a name="module_multi_runner"></a> [multi\_runner](#module\_multi\_runner) | ../../.. | n/a |
2020

2121
## Resources
2222

2323
| Name | Type |
24-
| ---- | ---- |
24+
|------|------|
2525
| [random_id.managed_policy](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/id) | resource |
2626

2727
## Inputs
@@ -31,7 +31,7 @@ No inputs.
3131
## Outputs
3232

3333
| Name | Description |
34-
| ---- | ----------- |
34+
|------|-------------|
3535
| <a name="output_binaries_syncer_keys"></a> [binaries\_syncer\_keys](#output\_binaries\_syncer\_keys) | n/a |
3636
| <a name="output_runner_stack_keys"></a> [runner\_stack\_keys](#output\_runner\_stack\_keys) | n/a |
3737
<!-- END_TF_DOCS -->

‎modules/runner-stack/README.md‎

Lines changed: 7 additions & 7 deletions
Large diffs are not rendered by default.

‎modules/runner-stack/job-retry/README.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@ The module is an inner module used by the runner stack when the opt-in feature f
1111
## Requirements
1212

1313
| Name | Version |
14-
| ---- | ------- |
14+
|------|---------|
1515
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3.0 |
1616
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 6.21 |
1717

1818
## Providers
1919

2020
| Name | Version |
21-
| ---- | ------- |
22-
| <a name="provider_aws"></a> [aws](#provider\_aws) | 6.60.0 |
21+
|------|---------|
22+
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 6.21 |
2323

2424
## Modules
2525

@@ -28,7 +28,7 @@ No modules.
2828
## Resources
2929

3030
| Name | Type |
31-
| ---- | ---- |
31+
|------|------|
3232
| [aws_cloudwatch_log_group.job_retry](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_log_group) | resource |
3333
| [aws_iam_role.job_retry](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |
3434
| [aws_iam_role_policy.job_retry](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy) | resource |
@@ -49,13 +49,13 @@ No modules.
4949
## Inputs
5050

5151
| Name | Description | Type | Default | Required |
52-
| ---- | ----------- | ---- | ------- | :------: |
52+
|------|-------------|------|---------|:--------:|
5353
| <a name="input_config"></a> [config](#input\_config) | Provider-neutral job-retry configuration assembled by runner-stack.<br/><br/>- `prefix`: Prefix used to name job-retry resources.<br/>- `aws_partition`: AWS partition used to construct the Lambda VPC managed-policy ARN.<br/>- `lambda.artifact.zip`: Resolved local control-plane archive.<br/>- `lambda.artifact.s3.bucket`: Optional S3 bucket containing the Lambda archive.<br/>- `lambda.artifact.s3.key`: Object key of the Lambda archive.<br/>- `lambda.artifact.s3.object_version`: Optional object version of the Lambda archive.<br/>- `lambda.runtime`: Runtime used by the job-retry Lambda.<br/>- `lambda.architecture`: Instruction-set architecture used by the job-retry Lambda.<br/>- `lambda.memory_size`: Memory allocated to the job-retry Lambda.<br/>- `lambda.timeout`: Lambda timeout and retry-queue visibility timeout in seconds.<br/>- `lambda.reserved_concurrent_executions`: Reserved concurrency for the Lambda. Use `-1` for unreserved concurrency.<br/>- `lambda.environment_variables`: Additional Lambda environment variables. Required job-retry variables override matching keys.<br/>- `lambda.vpc.subnet_ids`: Subnets used for Lambda VPC configuration.<br/>- `lambda.vpc.security_group_ids`: Security groups used for Lambda VPC configuration.<br/>- `lambda.role.path`: IAM path used for the job-retry Lambda role.<br/>- `lambda.role.permissions_boundary`: Optional permissions boundary for the Lambda role.<br/>- `lambda.role.principals`: Extra principals allowed to assume the Lambda role, for example during local testing.<br/>- `runner.name_prefix`: Prefix used to identify runners belonging to this runner configuration.<br/>- `github.organization_runners`: Enables organization runners.<br/>- `github.enterprise_server.url`: Optional GitHub Enterprise Server URL.<br/>- `github.enterprise_server.ssl_verify`: Enables TLS certificate verification for GitHub Enterprise Server requests.<br/>- `github.user_agent`: Optional User-Agent sent to GitHub.<br/>- `github.app_parameters.key_base64`: Ordered Parameter Store references for GitHub App private keys.<br/>- `github.app_parameters.id`: Ordered Parameter Store references for GitHub App IDs.<br/>- `github.app_parameters.installation_id`: Ordered optional Parameter Store references for GitHub App installation IDs.<br/>- `queue.build`: URL and ARN of the build queue to which retry messages are published.<br/>- `queue.event_source_mapping.batch_size`: Maximum records delivered per job-retry invocation.<br/>- `queue.event_source_mapping.maximum_batching_window_in_seconds`: Maximum event batching window.<br/>- `queue.encryption`: Server-side encryption configuration for the retry queue.<br/>- `ssm.kms_key_id`: Optional KMS key ARN used by the job-retry IAM policy. Its value may be unknown until apply.<br/>- `observability.logs`: Logging level, retention, encryption, and log-class configuration.<br/>- `observability.tracing`: Lambda X-Ray and tracing-helper configuration.<br/>- `observability.metrics`: Metrics enablement, namespace, and job-retry metric configuration.<br/>- `tags.resources`: Tags for the job-retry Lambda role and component resources.<br/>- `tags.lambda`: Tags for the job-retry Lambda function.<br/>- `tags.log_group`: Tags for the job-retry log group.<br/>- `tags.queue`: Tags for the retry queue.<br/>- `tags.event_source_mapping`: Tags for the retry-queue event-source mapping. | <pre>object({<br/> prefix = string<br/> aws_partition = string<br/> lambda = object({<br/> artifact = object({<br/> zip = string<br/> s3 = object({<br/> bucket = optional(string, null)<br/> key = optional(string, null)<br/> object_version = optional(string, null)<br/> })<br/> })<br/> runtime = string<br/> architecture = string<br/> memory_size = number<br/> timeout = number<br/> reserved_concurrent_executions = number<br/> environment_variables = map(string)<br/> vpc = object({<br/> subnet_ids = list(string)<br/> security_group_ids = list(string)<br/> })<br/> role = object({<br/> path = string<br/> permissions_boundary = optional(string, null)<br/> principals = list(object({<br/> type = string<br/> identifiers = list(string)<br/> }))<br/> })<br/> })<br/> runner = object({<br/> name_prefix = string<br/> })<br/> github = object({<br/> organization_runners = bool<br/> enterprise_server = object({<br/> url = optional(string, null)<br/> ssl_verify = optional(bool, true)<br/> })<br/> user_agent = optional(string, null)<br/> app_parameters = object({<br/> key_base64 = list(map(string))<br/> id = list(map(string))<br/> installation_id = list(object({ name = string, arn = string }))<br/> })<br/> })<br/> queue = object({<br/> build = object({<br/> url = string<br/> arn = string<br/> })<br/> event_source_mapping = object({<br/> batch_size = number<br/> maximum_batching_window_in_seconds = number<br/> })<br/> encryption = object({<br/> sqs_managed_sse_enabled = bool<br/> kms_master_key_id = optional(string, null)<br/> kms_data_key_reuse_period_seconds = optional(number, null)<br/> })<br/> })<br/> ssm = object({<br/> kms_key_id = optional(string, null)<br/> })<br/> observability = object({<br/> logs = object({<br/> level = string<br/> retention_in_days = number<br/> kms_key_id = optional(string, null)<br/> class = string<br/> })<br/> tracing = object({<br/> mode = optional(string, null)<br/> capture_http_requests = bool<br/> capture_error = bool<br/> })<br/> metrics = object({<br/> enable = bool<br/> namespace = string<br/> metric = object({<br/> enable_github_app_rate_limit = bool<br/> enable_job_retry = bool<br/> })<br/> })<br/> })<br/> tags = object({<br/> resources = map(string)<br/> lambda = map(string)<br/> log_group = map(string)<br/> queue = map(string)<br/> event_source_mapping = map(string)<br/> })<br/> })</pre> | n/a | yes |
5454

5555
## Outputs
5656

5757
| Name | Description |
58-
| ---- | ----------- |
58+
|------|-------------|
5959
| <a name="output_job_retry_check_queue"></a> [job\_retry\_check\_queue](#output\_job\_retry\_check\_queue) | Queue consumed by the job-retry Lambda. |
6060
| <a name="output_lambda"></a> [lambda](#output\_lambda) | Job-retry Lambda resources. |
6161
<!-- END_TF_DOCS -->

0 commit comments

Comments
 (0)