docs: auto update terraform docs

README.md

@@ -179,6 +179,7 @@ Talk to the forestkeepers in the `runners-channel` on Slack.
 | <a name="input_log_level"></a> [log\_level](#input\_log\_level) | Logging level for lambda logging. Valid values are  'silly', 'trace', 'debug', 'info', 'warn', 'error', 'fatal'. | `string` | `"info"` | no |
 | <a name="input_logging_kms_key_id"></a> [logging\_kms\_key\_id](#input\_logging\_kms\_key\_id) | Specifies the kms key id to encrypt the logs with. | `string` | `null` | no |
 | <a name="input_logging_retention_in_days"></a> [logging\_retention\_in\_days](#input\_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 |
+| <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`, `Advanced`, and `Intelligent-Tiering`. | `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 |

modules/multi-runner/README.md

@@ -147,6 +147,7 @@ module "multi-runner" {
 | <a name="input_log_level"></a> [log\_level](#input\_log\_level) | Logging level for lambda logging. Valid values are  'silly', 'trace', 'debug', 'info', 'warn', 'error', 'fatal'. | `string` | `"info"` | no |
 | <a name="input_logging_kms_key_id"></a> [logging\_kms\_key\_id](#input\_logging\_kms\_key\_id) | Specifies the kms key id to encrypt the logs with | `string` | `null` | no |
 | <a name="input_logging_retention_in_days"></a> [logging\_retention\_in\_days](#input\_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 |
+| <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`, `Advanced`, and `Intelligent-Tiering`. | `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_multi_runner_config"></a> [multi\_runner\_config](#input\_multi\_runner\_config) | multi\_runner\_config = {<br>      runner\_config: {<br>        runner\_os: "The EC2 Operating System type to use for action runner instances (linux,windows)."<br>        runner\_architecture: "The platform architecture of the runner instance\_type."<br>        runner\_metadata\_options: "(Optional) Metadata options for the ec2 runner instances."<br>        ami\_filter: "(Optional) List of maps used to create the AMI filter for the action runner AMI. By default amazon linux 2 is used."<br>        ami\_owners: "(Optional) The list of owners used to select the AMI of action runner instances."<br>        create\_service\_linked\_role\_spot: (Optional) create the serviced linked role for spot instances that is required by the scale-up lambda.<br>        credit\_specification: "(Optional) The credit specification of the runner instance\_type. Can be unset, `standard` or `unlimited`.<br>        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."<br>        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/)"<br>        ebs\_optimized: "The EC2 EBS optimized configuration."<br>        enable\_ephemeral\_runners: "Enable ephemeral runners, runners will only be used once."<br>        enable\_job\_queued\_check: "Enables JIT configuration for creating runners instead of registration token based registraton. JIT configuration will only be applied for ephemeral runners. By default JIT confiugration is enabled for ephemeral runners an can be disabled via this override. When running on GHES without support for JIT configuration this variable should be set to true for ephemeral runners."<br>        enable\_runner\_on\_demand\_failover\_for\_errors "Enable on-demand failover. For example to fall back to on demand when no spot capacity is available the variable can be set to `InsufficientInstanceCapacity`. When not defined the default behavior is to retry later."<br>        enable\_organization\_runners: "Register runners to organization, instead of repo level"<br>        enable\_runner\_binaries\_syncer: "Option to disable the lambda to sync GitHub runner distribution, useful when using a pre-build AMI."<br>        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."<br>        enable\_userdata: "Should the userdata script be enabled for the runner. Set this to false if you are using your own prebuilt AMI."<br>        instance\_allocation\_strategy: "The allocation strategy for spot instances. AWS recommends to use `capacity-optimized` however the AWS default is `lowest-price`."<br>        instance\_max\_spot\_price: "Max price price for spot intances per hour. This variable will be passed to the create fleet as max spot price for the fleet."<br>        instance\_target\_capacity\_type: "Default lifecycle used for runner instances, can be either `spot` or `on-demand`."<br>        instance\_types: "List of instance types for the action runner. Defaults are based on runner\_os (al2023 for linux and Windows Server Core for win)."<br>        job\_queue\_retention\_in\_seconds: "The number of seconds the job is held in the queue before it is purged"<br>        minimum\_running\_time\_in\_minutes: "The time an ec2 action runner should be running at minimum before terminated if not busy."<br>        pool\_runner\_owner: "The pool will deploy runners to the GitHub org ID, set this value to the org to which you want the runners deployed. Repo level is not supported."<br>        runner\_additional\_security\_group\_ids: "List of additional security groups IDs to apply to the runner. If added outside the multi\_runner\_config block, the additional security group(s) will be applied to all runner configs. If added inside the multi\_runner\_config, the additional security group(s) will be applied to the individual runner."<br>        runner\_as\_root: "Run the action runner under the root user. Variable `runner_run_as` will be ignored."<br>        runner\_boot\_time\_in\_minutes: "The minimum time for an EC2 runner to boot and register as a runner."<br>        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 `multi_runner_config.matcherConfig.exactMatch`. GitHub read-only labels should not be provided."<br>        runner\_group\_name: "Name of the runner group."<br>        runner\_name\_prefix: "Prefix for the GitHub runner name."<br>        runner\_run\_as: "Run the GitHub actions agent as user."<br>        runners\_maximum\_count: "The maximum number of runners that will be created. Setting the variable to `-1` desiables the maximum check."<br>        scale\_down\_schedule\_expression: "Scheduler expression to check every x for scale down."<br>        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."<br>        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."<br>        enable\_jit\_config "Overwrite the default behavior for JIT configuration. By default JIT configuration is enabled for ephemeral runners and disabled for non-ephemeral runners. In case of GHES check first if the JIT config API is avaialbe. In case you upgradeing from 3.x to 4.x you can set `enable_jit_config` to `false` to avoid a breaking change when having your own AMI."<br>        enable\_runner\_detailed\_monitoring: "Should detailed monitoring be enabled for the runner. Set this to true if you want to use detailed monitoring. See https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch-new.html for details."<br>        enable\_cloudwatch\_agent: "Enabling the cloudwatch agent on the ec2 runner instances, the runner contains default config. Configuration can be overridden via `cloudwatch_config`."<br>        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."<br>        userdata\_pre\_install: "Script to be ran before the GitHub Actions runner is installed on the EC2 instances"<br>        userdata\_post\_install: "Script to be ran after the GitHub Actions runner is installed on the EC2 instances"<br>        runner\_ec2\_tags: "Map of tags that will be added to the launch template instance tag specifications."<br>        runner\_iam\_role\_managed\_policy\_arns: "Attach AWS or customer-managed IAM policies (by ARN) to the runner IAM role"<br>        vpc\_id: "The VPC for security groups of the action runners. If not set uses the value of `var.vpc_id`."<br>        subnet\_ids: "List of subnets in which the action runners will be launched, the subnets needs to be subnets in the `vpc_id`. If not set, uses the value of `var.subnet_ids`."<br>        idle\_config: "List of time period that can be defined as cron expression to keep a minimum amount of runners active instead of scaling down to 0. By defining this list you can ensure that in time periods that match the cron expression within 5 seconds a runner is kept idle."<br>        runner\_log\_files: "(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."<br>        block\_device\_mappings: "The EC2 instance block device configuration. Takes the following keys: `device_name`, `delete_on_termination`, `volume_type`, `volume_size`, `encrypted`, `iops`, `throughput`, `kms_key_id`, `snapshot_id`."<br>        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."<br>      }<br>      matcherConfig: {<br>        labelMatchers: "The list of list of labels supported by the runner configuration. `[[self-hosted, linux, x64, example]]`"<br>        exactMatch: "If set to true all labels in the workflow job must match the GitHub labels (os, architecture and `self-hosted`). When false if __any__ workflow label matches it will trigger the webhook."<br>        priority: "If set it defines the priority of the matcher, the matcher with the lowest priority will be evaluated first. Default is 999, allowed values 0-999."<br>      }<br>      fifo: "Enable a FIFO queue to remain the order of events received by the webhook. Suggest to set to true for repo level runners."<br>      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."<br>    } | <pre>map(object({<br>    runner_config = object({<br>      runner_os           = string<br>      runner_architecture = string<br>      runner_metadata_options = optional(map(any), {<br>        instance_metadata_tags      = "enabled"<br>        http_endpoint               = "enabled"<br>        http_tokens                 = "required"<br>        http_put_response_hop_limit = 1<br>      })<br>      ami_filter                              = optional(map(list(string)), { state = ["available"] })<br>      ami_owners                              = optional(list(string), ["amazon"])<br>      ami_id_ssm_parameter_name               = optional(string, null)<br>      ami_kms_key_arn                         = optional(string, "")<br>      create_service_linked_role_spot         = optional(bool, false)<br>      credit_specification                    = optional(string, null)<br>      delay_webhook_event                     = optional(number, 30)<br>      disable_runner_autoupdate               = optional(bool, false)<br>      ebs_optimized                           = optional(bool, false)<br>      enable_ephemeral_runners                = optional(bool, false)<br>      enable_job_queued_check                 = optional(bool, null)<br>      enable_on_demand_failover_for_errors    = optional(list(string), [])<br>      enable_organization_runners             = optional(bool, false)<br>      enable_runner_binaries_syncer           = optional(bool, true)<br>      enable_ssm_on_runners                   = optional(bool, false)<br>      enable_userdata                         = optional(bool, true)<br>      instance_allocation_strategy            = optional(string, "lowest-price")<br>      instance_max_spot_price                 = optional(string, null)<br>      instance_target_capacity_type           = optional(string, "spot")<br>      instance_types                          = list(string)<br>      job_queue_retention_in_seconds          = optional(number, 86400)<br>      minimum_running_time_in_minutes         = optional(number, null)<br>      pool_runner_owner                       = optional(string, null)<br>      runner_as_root                          = optional(bool, false)<br>      runner_boot_time_in_minutes             = optional(number, 5)<br>      runner_extra_labels                     = optional(list(string), [])<br>      runner_group_name                       = optional(string, "Default")<br>      runner_name_prefix                      = optional(string, "")<br>      runner_run_as                           = optional(string, "ec2-user")<br>      runners_maximum_count                   = number<br>      runner_additional_security_group_ids    = optional(list(string), [])<br>      scale_down_schedule_expression          = optional(string, "cron(*/5 * * * ? *)")<br>      scale_up_reserved_concurrent_executions = optional(number, 1)<br>      userdata_template                       = optional(string, null)<br>      userdata_content                        = optional(string, null)<br>      enable_jit_config                       = optional(bool, null)<br>      enable_runner_detailed_monitoring       = optional(bool, false)<br>      enable_cloudwatch_agent                 = optional(bool, true)<br>      cloudwatch_config                       = optional(string, null)<br>      userdata_pre_install                    = optional(string, "")<br>      userdata_post_install                   = optional(string, "")<br>      runner_ec2_tags                         = optional(map(string), {})<br>      runner_iam_role_managed_policy_arns     = optional(list(string), [])<br>      vpc_id                                  = optional(string, null)<br>      subnet_ids                              = optional(list(string), null)<br>      idle_config = optional(list(object({<br>        cron             = string<br>        timeZone         = string<br>        idleCount        = number<br>        evictionStrategy = optional(string, "oldest_first")<br>      })), [])<br>      runner_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>      })), null)<br>      block_device_mappings = optional(list(object({<br>        delete_on_termination = optional(bool, true)<br>        device_name           = optional(string, "/dev/xvda")<br>        encrypted             = optional(bool, true)<br>        iops                  = optional(number)<br>        kms_key_id            = optional(string)<br>        snapshot_id           = optional(string)<br>        throughput            = optional(number)<br>        volume_size           = number<br>        volume_type           = optional(string, "gp3")<br>        })), [{<br>        volume_size = 30<br>      }])<br>      pool_config = optional(list(object({<br>        schedule_expression = string<br>        size                = number<br>      })), [])<br>    })<br><br>    matcherConfig = object({<br>      labelMatchers = list(list(string))<br>      exactMatch    = optional(bool, false)<br>      priority      = optional(number, 999)<br>    })<br>    fifo = optional(bool, false)<br>    redrive_build_queue = optional(object({<br>      enabled         = bool<br>      maxReceiveCount = number<br>      }), {<br>      enabled         = false<br>      maxReceiveCount = null<br>    })<br>  }))</pre> | n/a | yes |
 | <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 |