Skip to content

Commit

Permalink
docs: Update Terraform docs (#4070)
Browse files Browse the repository at this point in the history 
Automated changes by
[create-pull-request](https://github.com/peter-evans/create-pull-request)
GitHub action

Co-authored-by: npalm <[email protected]>
  • Loading branch information
@github-actions @npalm
github-actions[bot] and npalm authored Aug 16, 2024
1 parent b8f9eb4 commit 9086a29
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ Talk to the forestkeepers in the `runners-channel` on Slack.
| <a name="input_matcher_config_parameter_store_tier"></a> [matcher\_config\_parameter\_store\_tier](#input\_matcher\_config\_parameter\_store\_tier) | The tier of the parameter store for the matcher configuration. Valid values are `Standard`, and `Advanced`. | `string` | `"Standard"` | no |
| <a name="input_metrics_namespace"></a> [metrics\_namespace](#input\_metrics\_namespace) | The namespace for the metrics created by the module. Merics will only be created if explicit enabled. | `string` | `"GitHub Runners"` | no |
| <a name="input_minimum_running_time_in_minutes"></a> [minimum\_running\_time\_in\_minutes](#input\_minimum\_running\_time\_in\_minutes) | The time an ec2 action runner should be running at minimum before terminated, if not busy. | `number` | `null` | no |
| <a name="input_pool_config"></a> [pool\_config](#input\_pool\_config) | The configuration for updating the pool. The `pool_size` to adjust to by the events triggered by the `schedule_expression`. For example you can configure a cron expression for weekdays to adjust the pool to 10 and another expression for the weekend to adjust the pool to 1. | <pre>list(object({<br> schedule_expression = string<br> size = number<br> }))</pre> | `[]` | no |
| <a name="input_pool_config"></a> [pool\_config](#input\_pool\_config) | The configuration for updating the pool. The `pool_size` to adjust to by the events triggered by the `schedule_expression`. For example you can configure a cron expression for weekdays to adjust the pool to 10 and another expression for the weekend to adjust the pool to 1. Use `schedule_expression_timezone` to override the schedule time zone (defaults to UTC). | <pre>list(object({<br> schedule_expression = string<br> schedule_expression_timezone = optional(string)<br> size = number<br> }))</pre> | `[]` | no |
| <a name="input_pool_lambda_memory_size"></a> [pool\_lambda\_memory\_size](#input\_pool\_lambda\_memory\_size) | Memory size limit for scale-up lambda. | `number` | `512` | no |
| <a name="input_pool_lambda_reserved_concurrent_executions"></a> [pool\_lambda\_reserved\_concurrent\_executions](#input\_pool\_lambda\_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 |
| <a name="input_pool_lambda_timeout"></a> [pool\_lambda\_timeout](#input\_pool\_lambda\_timeout) | Time out for the pool lambda in seconds. | `number` | `60` | no |
Expand Down
2 changes: 1 addition & 1 deletion modules/multi-runner/README.md
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion modules/runners/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ yarn run dist
| <a name="input_metadata_options"></a> [metadata\_options](#input\_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 |
| <a name="input_minimum_running_time_in_minutes"></a> [minimum\_running\_time\_in\_minutes](#input\_minimum\_running\_time\_in\_minutes) | The time an ec2 action runner should be running at minimum before terminated if non busy. If not set the default is calculated based on the OS. | `number` | `null` | no |
| <a name="input_overrides"></a> [overrides](#input\_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 |
| <a name="input_pool_config"></a> [pool\_config](#input\_pool\_config) | The configuration for updating the pool. The `pool_size` to adjust to by the events triggered by the `schedule_expression`. For example you can configure a cron expression for week days to adjust the pool to 10 and another expression for the weekend to adjust the pool to 1. | <pre>list(object({<br> schedule_expression = string<br> size = number<br> }))</pre> | `[]` | no |
| <a name="input_pool_config"></a> [pool\_config](#input\_pool\_config) | The configuration for updating the pool. The `pool_size` to adjust to by the events triggered by the `schedule_expression`. For example you can configure a cron expression for week days to adjust the pool to 10 and another expression for the weekend to adjust the pool to 1. Use `schedule_expression_timezone ` to override the schedule time zone (defaults to UTC). | <pre>list(object({<br> schedule_expression = string<br> schedule_expression_timezone = optional(string)<br> size = number<br> }))</pre> | `[]` | no |
| <a name="input_pool_lambda_memory_size"></a> [pool\_lambda\_memory\_size](#input\_pool\_lambda\_memory\_size) | Lambda Memory size limit in MB for pool lambda | `number` | `512` | no |
| <a name="input_pool_lambda_reserved_concurrent_executions"></a> [pool\_lambda\_reserved\_concurrent\_executions](#input\_pool\_lambda\_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 |
| <a name="input_pool_lambda_timeout"></a> [pool\_lambda\_timeout](#input\_pool\_lambda\_timeout) | Time out for the pool lambda in seconds. | `number` | `60` | no |
Expand Down
10 changes: 6 additions & 4 deletions modules/runners/pool/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,26 +27,28 @@ No modules.

| Name | Type |
|------|------|
| [aws_cloudwatch_event_rule.pool](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_event_rule) | resource |
| [aws_cloudwatch_event_target.pool](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_event_target) | resource |
| [aws_cloudwatch_log_group.pool](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_log_group) | resource |
| [aws_iam_role.pool](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |
| [aws_iam_role.scheduler](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |
| [aws_iam_role_policy.pool](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy) | resource |
| [aws_iam_role_policy.pool_logging](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy) | resource |
| [aws_iam_role_policy.pool_xray](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy) | resource |
| [aws_iam_role_policy_attachment.ami_id_ssm_parameter_read](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
| [aws_iam_role_policy_attachment.pool_vpc_execution_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
| [aws_lambda_function.pool](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lambda_function) | resource |
| [aws_lambda_permission.pool](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lambda_permission) | resource |
| [aws_scheduler_schedule.pool](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/scheduler_schedule) | resource |
| [aws_scheduler_schedule_group.pool](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/scheduler_schedule_group) | resource |
| [aws_iam_policy_document.lambda_assume_role_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
| [aws_iam_policy_document.lambda_xray](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
| [aws_iam_policy_document.scheduler](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
| [aws_iam_policy_document.scheduler_assume](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |

## Inputs

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_aws_partition"></a> [aws\_partition](#input\_aws\_partition) | (optional) partition for the arn if not 'aws' | `string` | `"aws"` | no |
| <a name="input_config"></a> [config](#input\_config) | Lookup details in parent module. | <pre>object({<br> lambda = object({<br> log_level = string<br> logging_retention_in_days = number<br> logging_kms_key_id = string<br> reserved_concurrent_executions = number<br> s3_bucket = string<br> s3_key = string<br> s3_object_version = string<br> security_group_ids = list(string)<br> runtime = string<br> architecture = string<br> memory_size = number<br> timeout = number<br> zip = string<br> subnet_ids = list(string)<br> })<br> tags = map(string)<br> ghes = object({<br> url = string<br> ssl_verify = string<br> })<br> github_app_parameters = object({<br> key_base64 = map(string)<br> id = map(string)<br> })<br> subnet_ids = list(string)<br> runner = object({<br> disable_runner_autoupdate = bool<br> ephemeral = bool<br> enable_jit_config = bool<br> enable_on_demand_failover_for_errors = list(string)<br> boot_time_in_minutes = number<br> labels = list(string)<br> launch_template = object({<br> name = string<br> })<br> group_name = string<br> name_prefix = string<br> pool_owner = string<br> role = object({<br> arn = string<br> })<br> })<br> instance_types = list(string)<br> instance_target_capacity_type = string<br> instance_allocation_strategy = string<br> instance_max_spot_price = string<br> prefix = string<br> pool = list(object({<br> schedule_expression = string<br> size = number<br> }))<br> role_permissions_boundary = string<br> kms_key_arn = string<br> ami_kms_key_arn = string<br> role_path = string<br> ssm_token_path = string<br> ssm_config_path = string<br> ami_id_ssm_parameter_name = string<br> ami_id_ssm_parameter_read_policy_arn = string<br> arn_ssm_parameters_path_config = string<br> lambda_tags = map(string)<br> })</pre> | n/a | yes |
| <a name="input_config"></a> [config](#input\_config) | Lookup details in parent module. | <pre>object({<br> lambda = object({<br> log_level = string<br> logging_retention_in_days = number<br> logging_kms_key_id = string<br> reserved_concurrent_executions = number<br> s3_bucket = string<br> s3_key = string<br> s3_object_version = string<br> security_group_ids = list(string)<br> runtime = string<br> architecture = string<br> memory_size = number<br> timeout = number<br> zip = string<br> subnet_ids = list(string)<br> })<br> tags = map(string)<br> ghes = object({<br> url = string<br> ssl_verify = string<br> })<br> github_app_parameters = object({<br> key_base64 = map(string)<br> id = map(string)<br> })<br> subnet_ids = list(string)<br> runner = object({<br> disable_runner_autoupdate = bool<br> ephemeral = bool<br> enable_jit_config = bool<br> enable_on_demand_failover_for_errors = list(string)<br> boot_time_in_minutes = number<br> labels = list(string)<br> launch_template = object({<br> name = string<br> })<br> group_name = string<br> name_prefix = string<br> pool_owner = string<br> role = object({<br> arn = string<br> })<br> })<br> instance_types = list(string)<br> instance_target_capacity_type = string<br> instance_allocation_strategy = string<br> instance_max_spot_price = string<br> prefix = string<br> pool = list(object({<br> schedule_expression = string<br> schedule_expression_timezone = string<br> size = number<br> }))<br> role_permissions_boundary = string<br> kms_key_arn = string<br> ami_kms_key_arn = string<br> role_path = string<br> ssm_token_path = string<br> ssm_config_path = string<br> ami_id_ssm_parameter_name = string<br> ami_id_ssm_parameter_read_policy_arn = string<br> arn_ssm_parameters_path_config = string<br> lambda_tags = map(string)<br> })</pre> | n/a | yes |
| <a name="input_tracing_config"></a> [tracing\_config](#input\_tracing\_config) | Configuration for lambda tracing. | <pre>object({<br> mode = optional(string, null)<br> capture_http_requests = optional(bool, false)<br> capture_error = optional(bool, false)<br> })</pre> | `{}` | no |

## Outputs
Expand Down

0 comments on commit 9086a29

Please sign in to comment.