From 5c2301284e1f475e0f2e563fa3fc2f8732127db0 Mon Sep 17 00:00:00 2001 From: Niek Palm Date: Tue, 8 Apr 2025 15:00:38 +0200 Subject: [PATCH 01/34] feat: Add feature to enable dynamic instance types via workflow labels --- .../src/scale-runners/scale-up.ts | 61 ++++++++++++++++++- .../functions/webhook/src/runners/dispatch.ts | 9 ++- lambdas/functions/webhook/src/sqs/index.ts | 1 + main.tf | 3 +- modules/multi-runner/variables.tf | 4 +- modules/runners/scale-up.tf | 1 + modules/runners/variables.tf | 6 ++ variables.tf | 6 ++ 8 files changed, 85 insertions(+), 6 deletions(-) diff --git a/lambdas/functions/control-plane/src/scale-runners/scale-up.ts b/lambdas/functions/control-plane/src/scale-runners/scale-up.ts index 759be95089..f299a124c2 100644 --- a/lambdas/functions/control-plane/src/scale-runners/scale-up.ts +++ b/lambdas/functions/control-plane/src/scale-runners/scale-up.ts @@ -30,6 +30,7 @@ export interface ActionRequestMessage { installationId: number; repoOwnerType: string; retryCounter?: number; + labels?: string[]; } export interface ActionRequestMessageSQS extends ActionRequestMessage { @@ -250,6 +251,7 @@ export async function createRunners( ghClient: Octokit, ): Promise { const instances = await createRunner({ + environment: ec2RunnerConfig.environment, runnerType: githubRunnerConfig.runnerType, runnerOwner: githubRunnerConfig.runnerOwner, numberOfRunners, @@ -289,9 +291,30 @@ export async function scaleUp(payloads: ActionRequestMessageSQS[]): Promise label.startsWith('ghr-ec2-'))?.replace('ghr-ec2-', ''); + + if (dynamicEc2TypesEnabled && requestedInstanceType) { + logger.info(`Dynamic EC2 instance type requested: ${requestedInstanceType}`); + } + + // Store the requested instance type for use in createRunners + const ec2Config = { + ...payload, + requestedInstanceType: dynamicEc2TypesEnabled ? requestedInstanceType : undefined, + }; + const enableOrgLevel = yn(process.env.ENABLE_ORGANIZATION_RUNNERS, { default: true }); const maximumRunners = parseInt(process.env.RUNNERS_MAXIMUM_COUNT || '3'); - const runnerLabels = process.env.RUNNER_LABELS || ''; + + // Combine configured runner labels with dynamic EC2 instance type label if present + let runnerLabels = process.env.RUNNER_LABELS || ''; + if (dynamicEc2TypesEnabled && requestedInstanceType) { + const ec2Label = `ghr-ec2-${requestedInstanceType}`; + runnerLabels = runnerLabels ? `${runnerLabels},${ec2Label}` : ec2Label; + logger.debug(`Added dynamic EC2 instance type label: ${ec2Label} to runner config.`); + } + const runnerGroup = process.env.RUNNER_GROUP_NAME || 'Default'; const environment = process.env.ENVIRONMENT; const ssmTokenPath = process.env.SSM_TOKEN_PATH; @@ -335,6 +358,7 @@ export async function scaleUp(payloads: ActionRequestMessageSQS[]): Promise(); const rejectedMessageIds = new Set(); for (const payload of payloads) { @@ -343,6 +367,41 @@ export async function scaleUp(payloads: ActionRequestMessageSQS[]): Promise>>>>>> 44737379 (feat: Add feature to enable dynamic instance types via workflow labels) ); rejectedMessageIds.add(messageId); diff --git a/lambdas/functions/webhook/src/runners/dispatch.ts b/lambdas/functions/webhook/src/runners/dispatch.ts index fe81e63a26..1887ef30b1 100644 --- a/lambdas/functions/webhook/src/runners/dispatch.ts +++ b/lambdas/functions/webhook/src/runners/dispatch.ts @@ -81,13 +81,16 @@ export function canRunJob( runnerLabelsMatchers: string[][], workflowLabelCheckAll: boolean, ): boolean { + // Filter out ghr-ec2- labels as they are handled by the dynamic EC2 instance type feature + const filteredLabels = workflowJobLabels.filter(label => !label.startsWith('ghr-ec2-')); + runnerLabelsMatchers = runnerLabelsMatchers.map((runnerLabel) => { return runnerLabel.map((label) => label.toLowerCase()); }); const matchLabels = workflowLabelCheckAll - ? runnerLabelsMatchers.some((rl) => workflowJobLabels.every((wl) => rl.includes(wl.toLowerCase()))) - : runnerLabelsMatchers.some((rl) => workflowJobLabels.some((wl) => rl.includes(wl.toLowerCase()))); - const match = workflowJobLabels.length === 0 ? !matchLabels : matchLabels; + ? runnerLabelsMatchers.some((rl) => filteredLabels.every((wl) => rl.includes(wl.toLowerCase()))) + : runnerLabelsMatchers.some((rl) => filteredLabels.some((wl) => rl.includes(wl.toLowerCase()))); + const match = filteredLabels.length === 0 ? !matchLabels : matchLabels; logger.debug( `Received workflow job event with labels: '${JSON.stringify(workflowJobLabels)}'. The event does ${ diff --git a/lambdas/functions/webhook/src/sqs/index.ts b/lambdas/functions/webhook/src/sqs/index.ts index a028d7dcc4..ecf31f1cfd 100644 --- a/lambdas/functions/webhook/src/sqs/index.ts +++ b/lambdas/functions/webhook/src/sqs/index.ts @@ -12,6 +12,7 @@ export interface ActionRequestMessage { installationId: number; queueId: string; repoOwnerType: string; + labels?: string[]; } export interface MatcherConfig { diff --git a/main.tf b/main.tf index a9a79c87a3..4c6037314b 100644 --- a/main.tf +++ b/main.tf @@ -185,8 +185,9 @@ module "runners" { github_app_parameters = local.github_app_parameters enable_organization_runners = var.enable_organization_runners enable_ephemeral_runners = var.enable_ephemeral_runners - enable_jit_config = var.enable_jit_config + enable_dynamic_ec2_configuration = var.enable_dynamic_ec2_configuration enable_job_queued_check = var.enable_job_queued_check + enable_jit_config = var.enable_jit_config enable_on_demand_failover_for_errors = var.enable_runner_on_demand_failover_for_errors scale_errors = var.scale_errors disable_runner_autoupdate = var.disable_runner_autoupdate diff --git a/modules/multi-runner/variables.tf b/modules/multi-runner/variables.tf index 613cf8b2ce..debda5a44a 100644 --- a/modules/multi-runner/variables.tf +++ b/modules/multi-runner/variables.tf @@ -77,6 +77,7 @@ variable "multi_runner_config" { disable_runner_autoupdate = optional(bool, false) ebs_optimized = optional(bool, false) enable_ephemeral_runners = optional(bool, false) + enable_dynamic_ec2_configuration = optional(bool, false) enable_job_queued_check = optional(bool, null) enable_on_demand_failover_for_errors = optional(list(string), []) scale_errors = optional(list(string), [ @@ -207,7 +208,8 @@ variable "multi_runner_config" { 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/)" ebs_optimized: "The EC2 EBS optimized configuration." enable_ephemeral_runners: "Enable ephemeral runners, runners will only be used once." - 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 configuration 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." + enable_dynamic_ec2_configuration: "Enable dynamic EC2 configs based on workflow job labels. When enabled, jobs can request specific configs via the 'gh-ec2-:' label (e.g., 'gh-ec2-instance-type:t3.large')." + enable_job_queued_check: "(Optional) Only scale if the job event received by the scale up lambda is is in the state queued. By default enabled for non ephemeral runners and disabled for ephemeral. Set this variable to overwrite the default behavior." enable_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." scale_errors: "List of aws error codes that should trigger retry during scale up. This list will replace the default errors defined in the variable `defaultScaleErrors` in https://github.com/github-aws-runners/terraform-aws-github-runner/blob/main/lambdas/functions/control-plane/src/aws/runners.ts" enable_organization_runners: "Register runners to organization, instead of repo level" diff --git a/modules/runners/scale-up.tf b/modules/runners/scale-up.tf index c5503f6394..4cadcb13e2 100644 --- a/modules/runners/scale-up.tf +++ b/modules/runners/scale-up.tf @@ -28,6 +28,7 @@ resource "aws_lambda_function" "scale_up" { AMI_ID_SSM_PARAMETER_NAME = local.ami_id_ssm_parameter_name DISABLE_RUNNER_AUTOUPDATE = var.disable_runner_autoupdate ENABLE_EPHEMERAL_RUNNERS = var.enable_ephemeral_runners + ENABLE_DYNAMIC_EC2_CONFIGURATION = var.enable_dynamic_ec2_configuration ENABLE_JIT_CONFIG = var.enable_jit_config ENABLE_JOB_QUEUED_CHECK = local.enable_job_queued_check ENABLE_METRIC_GITHUB_APP_RATE_LIMIT = var.metrics.enable && var.metrics.metric.enable_github_app_rate_limit diff --git a/modules/runners/variables.tf b/modules/runners/variables.tf index e2a33280b9..20c3cec7dd 100644 --- a/modules/runners/variables.tf +++ b/modules/runners/variables.tf @@ -532,6 +532,12 @@ variable "enable_ephemeral_runners" { default = false } +variable "enable_dynamic_ec2_configuration" { + description = "Enable dynamic EC2 instance types based on workflow job labels. When enabled, jobs can request specific instance types via the 'gh:ec2:instance-type' label." + type = bool + default = false +} + variable "enable_job_queued_check" { description = "Only scale if the job event received by the scale up lambda is is in the state queued. By default enabled for non ephemeral runners and disabled for ephemeral. Set this variable to overwrite the default behavior." type = bool diff --git a/variables.tf b/variables.tf index d739e916fb..b479c85b78 100644 --- a/variables.tf +++ b/variables.tf @@ -673,6 +673,12 @@ variable "enable_ephemeral_runners" { default = false } +variable "enable_dynamic_ec2_configuration" { + description = "Enable dynamic EC2 configs based on workflow job labels. When enabled, jobs can request specific configs via the 'gh-ec2-:' label (e.g., 'gh-ec2-instance-type:t3.large')." + type = bool + default = false +} + variable "enable_job_queued_check" { description = "Only scale if the job event received by the scale up lambda is in the queued state. By default enabled for non ephemeral runners and disabled for ephemeral. Set this variable to overwrite the default behavior." type = bool From 6be37268e47b5d60240aa97481427ca439b1183b Mon Sep 17 00:00:00 2001 From: github-aws-runners-pr|bot Date: Tue, 8 Apr 2025 13:01:09 +0000 Subject: [PATCH 02/34] docs: auto update terraform docs --- README.md | 1 + .../src/scale-runners/scale-up.ts | 60 +------------------ main.tf | 2 +- modules/multi-runner/variables.tf | 4 +- modules/runners/README.md | 1 + modules/runners/scale-up.tf | 2 +- modules/runners/variables.tf | 2 +- variables.tf | 2 +- 8 files changed, 10 insertions(+), 64 deletions(-) diff --git a/README.md b/README.md index 351a160a62..28c79275b1 100644 --- a/README.md +++ b/README.md @@ -121,6 +121,7 @@ Join our discord community via [this invite link](https://discord.gg/bxgXW8jJGh) | [disable\_runner\_autoupdate](#input\_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/) | `bool` | `false` | no | | [enable\_ami\_housekeeper](#input\_enable\_ami\_housekeeper) | Option to disable the lambda to clean up old AMIs. | `bool` | `false` | no | | [enable\_cloudwatch\_agent](#input\_enable\_cloudwatch\_agent) | Enables the cloudwatch agent on the ec2 runner instances. The runner uses a default config that can be overridden via `cloudwatch_config`. | `bool` | `true` | no | +| [enable\_dynamic\_ec2\_types](#input\_enable\_dynamic\_ec2\_types) | Enable dynamic EC2 instance types based on workflow job labels. When enabled, jobs can request specific instance types via the 'gh-ec2-instance-type' label (e.g., 'gh-ec2-t3.large'). | `bool` | `false` | no | | [enable\_ephemeral\_runners](#input\_enable\_ephemeral\_runners) | Enable ephemeral runners, runners will only be used once. | `bool` | `false` | no | | [enable\_jit\_config](#input\_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 available. In case you are upgrading from 3.x to 4.x you can set `enable_jit_config` to `false` to avoid a breaking change when having your own AMI. | `bool` | `null` | no | | [enable\_job\_queued\_check](#input\_enable\_job\_queued\_check) | Only scale if the job event received by the scale up lambda is in the queued state. By default enabled for non ephemeral runners and disabled for ephemeral. Set this variable to overwrite the default behavior. | `bool` | `null` | no | diff --git a/lambdas/functions/control-plane/src/scale-runners/scale-up.ts b/lambdas/functions/control-plane/src/scale-runners/scale-up.ts index f299a124c2..bc40f5a47a 100644 --- a/lambdas/functions/control-plane/src/scale-runners/scale-up.ts +++ b/lambdas/functions/control-plane/src/scale-runners/scale-up.ts @@ -251,7 +251,6 @@ export async function createRunners( ghClient: Octokit, ): Promise { const instances = await createRunner({ - environment: ec2RunnerConfig.environment, runnerType: githubRunnerConfig.runnerType, runnerOwner: githubRunnerConfig.runnerOwner, numberOfRunners, @@ -291,29 +290,9 @@ export async function scaleUp(payloads: ActionRequestMessageSQS[]): Promise label.startsWith('ghr-ec2-'))?.replace('ghr-ec2-', ''); - - if (dynamicEc2TypesEnabled && requestedInstanceType) { - logger.info(`Dynamic EC2 instance type requested: ${requestedInstanceType}`); - } - - // Store the requested instance type for use in createRunners - const ec2Config = { - ...payload, - requestedInstanceType: dynamicEc2TypesEnabled ? requestedInstanceType : undefined, - }; - const enableOrgLevel = yn(process.env.ENABLE_ORGANIZATION_RUNNERS, { default: true }); const maximumRunners = parseInt(process.env.RUNNERS_MAXIMUM_COUNT || '3'); - - // Combine configured runner labels with dynamic EC2 instance type label if present - let runnerLabels = process.env.RUNNER_LABELS || ''; - if (dynamicEc2TypesEnabled && requestedInstanceType) { - const ec2Label = `ghr-ec2-${requestedInstanceType}`; - runnerLabels = runnerLabels ? `${runnerLabels},${ec2Label}` : ec2Label; - logger.debug(`Added dynamic EC2 instance type label: ${ec2Label} to runner config.`); - } + const runnerLabels = process.env.RUNNER_LABELS || ''; const runnerGroup = process.env.RUNNER_GROUP_NAME || 'Default'; const environment = process.env.ENVIRONMENT; @@ -322,6 +301,7 @@ export async function scaleUp(payloads: ActionRequestMessageSQS[]): Promise(); const rejectedMessageIds = new Set(); for (const payload of payloads) { @@ -367,41 +346,6 @@ export async function scaleUp(payloads: ActionRequestMessageSQS[]): Promise>>>>>> 44737379 (feat: Add feature to enable dynamic instance types via workflow labels) ); rejectedMessageIds.add(messageId); diff --git a/main.tf b/main.tf index 4c6037314b..82e02c92a6 100644 --- a/main.tf +++ b/main.tf @@ -185,7 +185,7 @@ module "runners" { github_app_parameters = local.github_app_parameters enable_organization_runners = var.enable_organization_runners enable_ephemeral_runners = var.enable_ephemeral_runners - enable_dynamic_ec2_configuration = var.enable_dynamic_ec2_configuration + enable_dynamic_ec2_config = var.enable_dynamic_ec2_config enable_job_queued_check = var.enable_job_queued_check enable_jit_config = var.enable_jit_config enable_on_demand_failover_for_errors = var.enable_runner_on_demand_failover_for_errors diff --git a/modules/multi-runner/variables.tf b/modules/multi-runner/variables.tf index debda5a44a..aeaef79290 100644 --- a/modules/multi-runner/variables.tf +++ b/modules/multi-runner/variables.tf @@ -77,7 +77,7 @@ variable "multi_runner_config" { disable_runner_autoupdate = optional(bool, false) ebs_optimized = optional(bool, false) enable_ephemeral_runners = optional(bool, false) - enable_dynamic_ec2_configuration = optional(bool, false) + enable_dynamic_ec2_config = optional(bool, false) enable_job_queued_check = optional(bool, null) enable_on_demand_failover_for_errors = optional(list(string), []) scale_errors = optional(list(string), [ @@ -208,7 +208,7 @@ variable "multi_runner_config" { 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/)" ebs_optimized: "The EC2 EBS optimized configuration." enable_ephemeral_runners: "Enable ephemeral runners, runners will only be used once." - enable_dynamic_ec2_configuration: "Enable dynamic EC2 configs based on workflow job labels. When enabled, jobs can request specific configs via the 'gh-ec2-:' label (e.g., 'gh-ec2-instance-type:t3.large')." + enable_dynamic_ec2_config: "Enable dynamic EC2 configs based on workflow job labels. When enabled, jobs can request specific configs via the 'gh-ec2-:' label (e.g., 'gh-ec2-instance-type:t3.large')." enable_job_queued_check: "(Optional) Only scale if the job event received by the scale up lambda is is in the state queued. By default enabled for non ephemeral runners and disabled for ephemeral. Set this variable to overwrite the default behavior." enable_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." scale_errors: "List of aws error codes that should trigger retry during scale up. This list will replace the default errors defined in the variable `defaultScaleErrors` in https://github.com/github-aws-runners/terraform-aws-github-runner/blob/main/lambdas/functions/control-plane/src/aws/runners.ts" diff --git a/modules/runners/README.md b/modules/runners/README.md index 6a27276624..bbd0ca6567 100644 --- a/modules/runners/README.md +++ b/modules/runners/README.md @@ -149,6 +149,7 @@ yarn run dist | [ebs\_optimized](#input\_ebs\_optimized) | The EC2 EBS optimized configuration. | `bool` | `false` | no | | [egress\_rules](#input\_egress\_rules) | List of egress rules for the GitHub runner instances. | 
list(object({
    cidr_blocks      = list(string)
    ipv6_cidr_blocks = list(string)
    prefix_list_ids  = list(string)
    from_port        = number
    protocol         = string
    security_groups  = list(string)
    self             = bool
    to_port          = number
    description      = string
  }))
| 
[
  {
    "cidr_blocks": [
      "0.0.0.0/0"
    ],
    "description": null,
    "from_port": 0,
    "ipv6_cidr_blocks": [
      "::/0"
    ],
    "prefix_list_ids": null,
    "protocol": "-1",
    "security_groups": null,
    "self": null,
    "to_port": 0
  }
]
| no | | [enable\_cloudwatch\_agent](#input\_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\_dynamic\_ec2\_types](#input\_enable\_dynamic\_ec2\_types) | Enable dynamic EC2 instance types based on workflow job labels. When enabled, jobs can request specific instance types via the 'gh:ec2:instance-type' label. | `bool` | `false` | no | | [enable\_ephemeral\_runners](#input\_enable\_ephemeral\_runners) | Enable ephemeral runners, runners will only be used once. | `bool` | `false` | no | | [enable\_jit\_config](#input\_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 available. In case you are upgrading from 3.x to 4.x you can set `enable_jit_config` to `false` to avoid a breaking change when having your own AMI. | `bool` | `null` | no | | [enable\_job\_queued\_check](#input\_enable\_job\_queued\_check) | Only scale if the job event received by the scale up lambda is is in the state queued. By default enabled for non ephemeral runners and disabled for ephemeral. Set this variable to overwrite the default behavior. | `bool` | `null` | no | diff --git a/modules/runners/scale-up.tf b/modules/runners/scale-up.tf index 4cadcb13e2..97afcd6ad3 100644 --- a/modules/runners/scale-up.tf +++ b/modules/runners/scale-up.tf @@ -28,7 +28,7 @@ resource "aws_lambda_function" "scale_up" { AMI_ID_SSM_PARAMETER_NAME = local.ami_id_ssm_parameter_name DISABLE_RUNNER_AUTOUPDATE = var.disable_runner_autoupdate ENABLE_EPHEMERAL_RUNNERS = var.enable_ephemeral_runners - ENABLE_DYNAMIC_EC2_CONFIGURATION = var.enable_dynamic_ec2_configuration + ENABLE_DYNAMIC_EC2_CONFIG = var.enable_dynamic_ec2_config ENABLE_JIT_CONFIG = var.enable_jit_config ENABLE_JOB_QUEUED_CHECK = local.enable_job_queued_check ENABLE_METRIC_GITHUB_APP_RATE_LIMIT = var.metrics.enable && var.metrics.metric.enable_github_app_rate_limit diff --git a/modules/runners/variables.tf b/modules/runners/variables.tf index 20c3cec7dd..9bcbc65437 100644 --- a/modules/runners/variables.tf +++ b/modules/runners/variables.tf @@ -532,7 +532,7 @@ variable "enable_ephemeral_runners" { default = false } -variable "enable_dynamic_ec2_configuration" { +variable "enable_dynamic_ec2_config" { description = "Enable dynamic EC2 instance types based on workflow job labels. When enabled, jobs can request specific instance types via the 'gh:ec2:instance-type' label." type = bool default = false diff --git a/variables.tf b/variables.tf index b479c85b78..72cc193f2b 100644 --- a/variables.tf +++ b/variables.tf @@ -673,7 +673,7 @@ variable "enable_ephemeral_runners" { default = false } -variable "enable_dynamic_ec2_configuration" { +variable "enable_dynamic_ec2_config" { description = "Enable dynamic EC2 configs based on workflow job labels. When enabled, jobs can request specific configs via the 'gh-ec2-:' label (e.g., 'gh-ec2-instance-type:t3.large')." type = bool default = false From 4c1f2faef94cb13194d15d783cbe04964b7c23e6 Mon Sep 17 00:00:00 2001 From: edersonbrilhante Date: Mon, 19 Jan 2026 17:07:10 +0100 Subject: [PATCH 03/34] feat: allow to use dynamic instance type in multiple events --- .../src/scale-runners/scale-up.ts | 43 +++++++++++++++++-- 1 file changed, 39 insertions(+), 4 deletions(-) diff --git a/lambdas/functions/control-plane/src/scale-runners/scale-up.ts b/lambdas/functions/control-plane/src/scale-runners/scale-up.ts index bc40f5a47a..89587b535b 100644 --- a/lambdas/functions/control-plane/src/scale-runners/scale-up.ts +++ b/lambdas/functions/control-plane/src/scale-runners/scale-up.ts @@ -293,12 +293,11 @@ export async function scaleUp(payloads: ActionRequestMessageSQS[]): Promise(); const rejectedMessageIds = new Set(); for (const payload of payloads) { - const { eventType, messageId, repositoryName, repositoryOwner } = payload; + const { eventType, messageId, repositoryName, repositoryOwner, labels } = payload; if (ephemeralEnabled && eventType !== 'workflow_job') { logger.warn( 'Event is not supported in combination with ephemeral runners. Please ensure you have enabled workflow_job events.', @@ -365,7 +364,19 @@ export async function scaleUp(payloads: ActionRequestMessageSQS[]): Promise l.startsWith('ghr-ec2-')) + ?.slice('ghr-ec2-'.length); + + if (requestedDynamicEc2Config) { + const ec2Hash = ec2LabelsHash(labels); + key = `${key}/${ec2Hash}`; + } + } + let entry = validMessages.get(key); @@ -405,6 +416,12 @@ export async function scaleUp(payloads: ActionRequestMessageSQS[]): Promise 0 && dynamicEc2ConfigEnabled) { + const requestedInstanceType = messages[0].labels?.find(label => label.startsWith('ghr-ec2-instance-type'))?.replace('ghr-ec2-instance-type', ''); + instanceTypes = requestedInstanceType ? [requestedInstanceType] : instanceTypes; + } + + for (const message of messages) { const messageLogger = logger.createChild({ persistentKeys: { @@ -412,6 +429,7 @@ export async function scaleUp(payloads: ActionRequestMessageSQS[]): Promise l.startsWith(prefix)) + .sort() // ensure deterministic hash + .join('|'); + + let hash = 0; + for (let i = 0; i < input.length; i++) { + hash = (hash << 5) - hash + input.charCodeAt(i); + hash |= 0; // force 32-bit integer + } + + return Math.abs(hash).toString(36); +} From e485239a2b52e20c3f038117e62ec6ff2bce16cc Mon Sep 17 00:00:00 2001 From: edersonbrilhante Date: Mon, 19 Jan 2026 17:16:22 +0100 Subject: [PATCH 04/34] style: fix format --- .../control-plane/src/scale-runners/scale-up.ts | 16 +++++++--------- .../functions/webhook/src/runners/dispatch.ts | 2 +- 2 files changed, 8 insertions(+), 10 deletions(-) diff --git a/lambdas/functions/control-plane/src/scale-runners/scale-up.ts b/lambdas/functions/control-plane/src/scale-runners/scale-up.ts index 89587b535b..fa9976b919 100644 --- a/lambdas/functions/control-plane/src/scale-runners/scale-up.ts +++ b/lambdas/functions/control-plane/src/scale-runners/scale-up.ts @@ -367,9 +367,7 @@ export async function scaleUp(payloads: ActionRequestMessageSQS[]): Promise l.startsWith('ghr-ec2-')) - ?.slice('ghr-ec2-'.length); + const requestedDynamicEc2Config = labels.find((l) => l.startsWith('ghr-ec2-'))?.slice('ghr-ec2-'.length); if (requestedDynamicEc2Config) { const ec2Hash = ec2LabelsHash(labels); @@ -377,7 +375,6 @@ export async function scaleUp(payloads: ActionRequestMessageSQS[]): Promise 0 && dynamicEc2ConfigEnabled) { - const requestedInstanceType = messages[0].labels?.find(label => label.startsWith('ghr-ec2-instance-type'))?.replace('ghr-ec2-instance-type', ''); + const requestedInstanceType = messages[0].labels + ?.find((label) => label.startsWith('ghr-ec2-instance-type')) + ?.replace('ghr-ec2-instance-type', ''); instanceTypes = requestedInstanceType ? [requestedInstanceType] : instanceTypes; - } - + } for (const message of messages) { const messageLogger = logger.createChild({ @@ -725,8 +723,8 @@ function ec2LabelsHash(labels: string[]): string { const prefix = 'ghr-ec2-'; const input = labels - .filter(l => l.startsWith(prefix)) - .sort() // ensure deterministic hash + .filter((l) => l.startsWith(prefix)) + .sort() // ensure deterministic hash .join('|'); let hash = 0; diff --git a/lambdas/functions/webhook/src/runners/dispatch.ts b/lambdas/functions/webhook/src/runners/dispatch.ts index 1887ef30b1..3649f64759 100644 --- a/lambdas/functions/webhook/src/runners/dispatch.ts +++ b/lambdas/functions/webhook/src/runners/dispatch.ts @@ -82,7 +82,7 @@ export function canRunJob( workflowLabelCheckAll: boolean, ): boolean { // Filter out ghr-ec2- labels as they are handled by the dynamic EC2 instance type feature - const filteredLabels = workflowJobLabels.filter(label => !label.startsWith('ghr-ec2-')); + const filteredLabels = workflowJobLabels.filter((label) => !label.startsWith('ghr-ec2-')); runnerLabelsMatchers = runnerLabelsMatchers.map((runnerLabel) => { return runnerLabel.map((label) => label.toLowerCase()); From 2c2ec39d6c2fafc499631a9f235953ace7b5317d Mon Sep 17 00:00:00 2001 From: edersonbrilhante Date: Mon, 19 Jan 2026 18:49:51 +0100 Subject: [PATCH 05/34] fix: add dynamic labels as runner labels --- .../src/scale-runners/scale-up.ts | 24 +++++++++++++++---- 1 file changed, 19 insertions(+), 5 deletions(-) diff --git a/lambdas/functions/control-plane/src/scale-runners/scale-up.ts b/lambdas/functions/control-plane/src/scale-runners/scale-up.ts index fa9976b919..4622cf5a34 100644 --- a/lambdas/functions/control-plane/src/scale-runners/scale-up.ts +++ b/lambdas/functions/control-plane/src/scale-runners/scale-up.ts @@ -292,7 +292,7 @@ export async function scaleUp(payloads: ActionRequestMessageSQS[]): Promise 0 && dynamicEc2ConfigEnabled) { - const requestedInstanceType = messages[0].labels - ?.find((label) => label.startsWith('ghr-ec2-instance-type')) - ?.replace('ghr-ec2-instance-type', ''); - instanceTypes = requestedInstanceType ? [requestedInstanceType] : instanceTypes; + const ec2Labels = + messages[0].labels?.filter(l => l.startsWith('ghr-ec2-')) ?? []; + + if (ec2Labels.length > 0) { + // Append all EC2 labels to runnerLabels + runnerLabels = runnerLabels + ? `${runnerLabels},${ec2Labels.join(',')}` + : ec2Labels.join(','); + + // Extract instance type from EC2 labels + const requestedInstanceType = ec2Labels + .find(l => l.startsWith('ghr-ec2-instance-type:')) + ?.replace('ghr-ec2-instance-type:', ''); + + if (requestedInstanceType) { + instanceTypes = [requestedInstanceType]; + } + } } for (const message of messages) { From 886412f317474989e0823741140e71cd0f53960e Mon Sep 17 00:00:00 2001 From: edersonbrilhante Date: Mon, 19 Jan 2026 19:32:04 +0100 Subject: [PATCH 06/34] test: add tests for dynamic labels --- .../src/scale-runners/scale-up.test.ts | 186 ++++++++++++++++++ .../src/scale-runners/scale-up.ts | 14 ++ 2 files changed, 200 insertions(+) diff --git a/lambdas/functions/control-plane/src/scale-runners/scale-up.test.ts b/lambdas/functions/control-plane/src/scale-runners/scale-up.test.ts index 458d89763e..67eb166091 100644 --- a/lambdas/functions/control-plane/src/scale-runners/scale-up.test.ts +++ b/lambdas/functions/control-plane/src/scale-runners/scale-up.test.ts @@ -571,6 +571,192 @@ describe('scaleUp with GHES', () => { 10000, ); }); + + describe('Dynamic EC2 Configuration', () => { + beforeEach(() => { + process.env.ENABLE_ORGANIZATION_RUNNERS = 'true'; + process.env.ENABLE_DYNAMIC_EC2_CONFIG = 'true'; + process.env.ENABLE_EPHEMERAL_RUNNERS = 'true'; + process.env.ENABLE_JOB_QUEUED_CHECK = 'false'; + process.env.RUNNER_LABELS = 'base-label'; + process.env.INSTANCE_TYPES = 't3.medium,t3.large'; + process.env.RUNNER_NAME_PREFIX = 'unit-test'; + expectedRunnerParams = { ...EXPECTED_RUNNER_PARAMS }; + mockSSMClient.reset(); + }); + + it('appends EC2 labels to existing runner labels when EC2 labels are present', async () => { + const testDataWithEc2Labels = [ + { + ...TEST_DATA_SINGLE, + labels: ['ghr-ec2-instance-type:c5.2xlarge', 'ghr-ec2-custom:value'], + messageId: 'test-1', + }, + ]; + + await scaleUpModule.scaleUp(testDataWithEc2Labels); + + // Verify createRunner was called with EC2 instance type extracted from labels + expect(createRunner).toBeCalledWith( + expect.objectContaining({ + ec2instanceCriteria: expect.objectContaining({ + instanceTypes: ['c5.2xlarge'], + }), + }), + ); + }); + + it('extracts instance type from EC2 labels and overrides default instance types', async () => { + const testDataWithEc2Labels = [ + { + ...TEST_DATA_SINGLE, + labels: ['ghr-ec2-instance-type:m5.xlarge', 'ghr-ec2-disk:100'], + messageId: 'test-2', + }, + ]; + + await scaleUpModule.scaleUp(testDataWithEc2Labels); + + expect(createRunner).toBeCalledWith( + expect.objectContaining({ + ec2instanceCriteria: expect.objectContaining({ + instanceTypes: ['m5.xlarge'], + }), + }), + ); + }); + + it('uses default instance types when no instance type EC2 label is provided', async () => { + const testDataWithEc2Labels = [ + { + ...TEST_DATA_SINGLE, + labels: ['ghr-ec2-custom:value'], + messageId: 'test-3', + }, + ]; + + await scaleUpModule.scaleUp(testDataWithEc2Labels); + + // Should use the default INSTANCE_TYPES from environment + expect(createRunner).toBeCalledWith( + expect.objectContaining({ + ec2instanceCriteria: expect.objectContaining({ + instanceTypes: ['t3.medium', 't3.large'], + }), + }), + ); + }); + + it('does not modify labels when EC2 labels are not present', async () => { + const testDataWithoutEc2Labels = [ + { + ...TEST_DATA_SINGLE, + labels: ['regular-label', 'another-label'], + messageId: 'test-4', + }, + ]; + + await scaleUpModule.scaleUp(testDataWithoutEc2Labels); + + // Should use default instance types + expect(createRunner).toBeCalledWith( + expect.objectContaining({ + ec2instanceCriteria: expect.objectContaining({ + instanceTypes: ['t3.medium', 't3.large'], + }), + }), + ); + }); + + it('handles messages with no labels gracefully', async () => { + const testDataWithNoLabels = [ + { + ...TEST_DATA_SINGLE, + labels: undefined, + messageId: 'test-5', + }, + ]; + + await scaleUpModule.scaleUp(testDataWithNoLabels); + + expect(createRunner).toBeCalledWith( + expect.objectContaining({ + ec2instanceCriteria: expect.objectContaining({ + instanceTypes: ['t3.medium', 't3.large'], + }), + }), + ); + }); + + it('handles empty labels array', async () => { + const testDataWithEmptyLabels = [ + { + ...TEST_DATA_SINGLE, + labels: [], + messageId: 'test-6', + }, + ]; + + await scaleUpModule.scaleUp(testDataWithEmptyLabels); + + expect(createRunner).toBeCalledWith( + expect.objectContaining({ + ec2instanceCriteria: expect.objectContaining({ + instanceTypes: ['t3.medium', 't3.large'], + }), + }), + ); + }); + + it('does not process EC2 labels when ENABLE_DYNAMIC_EC2_CONFIG is disabled', async () => { + process.env.ENABLE_DYNAMIC_EC2_CONFIG = 'false'; + + const testDataWithEc2Labels = [ + { + ...TEST_DATA_SINGLE, + labels: ['ghr-ec2-instance-type:c5.4xlarge'], + messageId: 'test-7', + }, + ]; + + await scaleUpModule.scaleUp(testDataWithEc2Labels); + + // Should ignore EC2 labels and use default instance types + expect(createRunner).toBeCalledWith( + expect.objectContaining({ + ec2instanceCriteria: expect.objectContaining({ + instanceTypes: ['t3.medium', 't3.large'], + }), + }), + ); + }); + + it('handles multiple EC2 labels correctly', async () => { + const testDataWithMultipleEc2Labels = [ + { + ...TEST_DATA_SINGLE, + labels: [ + 'regular-label', + 'ghr-ec2-instance-type:r5.2xlarge', + 'ghr-ec2-ami:custom-ami', + 'ghr-ec2-disk:200', + ], + messageId: 'test-8', + }, + ]; + + await scaleUpModule.scaleUp(testDataWithMultipleEc2Labels); + + expect(createRunner).toBeCalledWith( + expect.objectContaining({ + ec2instanceCriteria: expect.objectContaining({ + instanceTypes: ['r5.2xlarge'], + }), + }), + ); + }); + }); + describe('on repo level', () => { beforeEach(() => { process.env.ENABLE_ORGANIZATION_RUNNERS = 'false'; diff --git a/lambdas/functions/control-plane/src/scale-runners/scale-up.ts b/lambdas/functions/control-plane/src/scale-runners/scale-up.ts index 4622cf5a34..9f6310e98c 100644 --- a/lambdas/functions/control-plane/src/scale-runners/scale-up.ts +++ b/lambdas/functions/control-plane/src/scale-runners/scale-up.ts @@ -414,15 +414,21 @@ export async function scaleUp(payloads: ActionRequestMessageSQS[]): Promise 0 && dynamicEc2ConfigEnabled) { + logger.info('Dynamic EC2 config enabled, processing labels'); + const ec2Labels = messages[0].labels?.filter(l => l.startsWith('ghr-ec2-')) ?? []; + logger.info('EC2 labels detected', { ec2Labels }); + if (ec2Labels.length > 0) { // Append all EC2 labels to runnerLabels runnerLabels = runnerLabels ? `${runnerLabels},${ec2Labels.join(',')}` : ec2Labels.join(','); + logger.info('Updated runner labels', { runnerLabels }); + // Extract instance type from EC2 labels const requestedInstanceType = ec2Labels .find(l => l.startsWith('ghr-ec2-instance-type:')) @@ -430,10 +436,18 @@ export async function scaleUp(payloads: ActionRequestMessageSQS[]): Promise Date: Mon, 19 Jan 2026 19:38:04 +0100 Subject: [PATCH 07/34] fix: wire enable_dynamic_ec2_config --- modules/multi-runner/runners.tf | 1 + 1 file changed, 1 insertion(+) diff --git a/modules/multi-runner/runners.tf b/modules/multi-runner/runners.tf index 59b6307aa0..a54b4aafeb 100644 --- a/modules/multi-runner/runners.tf +++ b/modules/multi-runner/runners.tf @@ -35,6 +35,7 @@ module "runners" { scale_errors = each.value.runner_config.scale_errors enable_organization_runners = each.value.runner_config.enable_organization_runners enable_ephemeral_runners = each.value.runner_config.enable_ephemeral_runners + enable_dynamic_ec2_config = each.value.runner_config.enable_dynamic_ec2_config enable_jit_config = each.value.runner_config.enable_jit_config enable_job_queued_check = each.value.runner_config.enable_job_queued_check disable_runner_autoupdate = each.value.runner_config.disable_runner_autoupdate From 5f56ef9f4d9764f8e515146dfa78eaf78ea06765 Mon Sep 17 00:00:00 2001 From: edersonbrilhante Date: Mon, 19 Jan 2026 20:54:13 +0100 Subject: [PATCH 08/34] fix: fix runner owner logic --- .../control-plane/src/scale-runners/scale-up.ts | 17 +++++++++++------ .../webhook/src/runners/dispatch.test.ts | 2 ++ .../functions/webhook/src/runners/dispatch.ts | 1 + 3 files changed, 14 insertions(+), 6 deletions(-) diff --git a/lambdas/functions/control-plane/src/scale-runners/scale-up.ts b/lambdas/functions/control-plane/src/scale-runners/scale-up.ts index 9f6310e98c..b64e825834 100644 --- a/lambdas/functions/control-plane/src/scale-runners/scale-up.ts +++ b/lambdas/functions/control-plane/src/scale-runners/scale-up.ts @@ -335,6 +335,7 @@ export async function scaleUp(payloads: ActionRequestMessageSQS[]): Promise(); @@ -364,8 +365,9 @@ export async function scaleUp(payloads: ActionRequestMessageSQS[]): Promise l.startsWith('ghr-ec2-'))?.slice('ghr-ec2-'.length); @@ -387,6 +389,7 @@ export async function scaleUp(payloads: ActionRequestMessageSQS[]): Promise 0 && dynamicEc2ConfigEnabled) { - logger.info('Dynamic EC2 config enabled, processing labels'); + logger.info('Dynamic EC2 config enabled, processing labels', {labels: messages[0].labels}); const ec2Labels = - messages[0].labels?.filter(l => l.startsWith('ghr-ec2-')) ?? []; + messages[0].labels + ?.map(l => l.trim()) + .filter(l => l.startsWith('ghr-ec2-')) ?? []; logger.info('EC2 labels detected', { ec2Labels }); @@ -477,7 +482,7 @@ export async function scaleUp(payloads: ActionRequestMessageSQS[]): Promise { installationId: 0, queueId: runnerConfig[0].id, repoOwnerType: 'Organization', + labels: ['self-hosted', 'Test'] }); }); @@ -150,6 +151,7 @@ describe('Dispatcher', () => { installationId: 0, queueId: 'match', repoOwnerType: 'Organization', + labels: ['self-hosted', 'match'], }); }); diff --git a/lambdas/functions/webhook/src/runners/dispatch.ts b/lambdas/functions/webhook/src/runners/dispatch.ts index 3649f64759..8427f94453 100644 --- a/lambdas/functions/webhook/src/runners/dispatch.ts +++ b/lambdas/functions/webhook/src/runners/dispatch.ts @@ -56,6 +56,7 @@ async function handleWorkflowJob( installationId: body.installation?.id ?? 0, queueId: queue.id, repoOwnerType: body.repository.owner.type, + labels: body.workflow_job.labels, }); logger.info( `Successfully dispatched job for ${body.repository.full_name} to the queue ${queue.id} - ` + From 0c026d7c2d8598e99e9f27400dffac6133f46096 Mon Sep 17 00:00:00 2001 From: edersonbrilhante Date: Mon, 19 Jan 2026 21:22:03 +0100 Subject: [PATCH 09/34] chore: decrease log level for some logs --- .../src/scale-runners/scale-up.ts | 22 +++++++++---------- 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/lambdas/functions/control-plane/src/scale-runners/scale-up.ts b/lambdas/functions/control-plane/src/scale-runners/scale-up.ts index b64e825834..5588a8f355 100644 --- a/lambdas/functions/control-plane/src/scale-runners/scale-up.ts +++ b/lambdas/functions/control-plane/src/scale-runners/scale-up.ts @@ -417,38 +417,36 @@ export async function scaleUp(payloads: ActionRequestMessageSQS[]): Promise 0 && dynamicEc2ConfigEnabled) { - logger.info('Dynamic EC2 config enabled, processing labels', {labels: messages[0].labels}); + logger.debug('Dynamic EC2 config enabled, processing labels', {labels: messages[0].labels}); - const ec2Labels = + const dynamicEC2Labels = messages[0].labels ?.map(l => l.trim()) .filter(l => l.startsWith('ghr-ec2-')) ?? []; - logger.info('EC2 labels detected', { ec2Labels }); - - if (ec2Labels.length > 0) { + if (dynamicEC2Labels.length > 0) { // Append all EC2 labels to runnerLabels runnerLabels = runnerLabels - ? `${runnerLabels},${ec2Labels.join(',')}` - : ec2Labels.join(','); + ? `${runnerLabels},${dynamicEC2Labels.join(',')}` + : dynamicEC2Labels.join(','); - logger.info('Updated runner labels', { runnerLabels }); + logger.debug('Updated runner labels', { runnerLabels }); // Extract instance type from EC2 labels - const requestedInstanceType = ec2Labels + const requestedInstanceType = dynamicEC2Labels .find(l => l.startsWith('ghr-ec2-instance-type:')) ?.replace('ghr-ec2-instance-type:', ''); if (requestedInstanceType) { instanceTypes = [requestedInstanceType]; - logger.info('EC2 instance type requested', { + logger.debug('EC2 instance type requested', { instanceType: requestedInstanceType, }); } else { - logger.info('No EC2 instance type label found'); + logger.debug('No dynamic EC2 instance type label found'); } } else { - logger.info('No EC2 labels found on message'); + logger.debug('No dynamic EC2 labels found on message'); } } From e93e296054c05a6669e80312ba2a6820a728adf7 Mon Sep 17 00:00:00 2001 From: edersonbrilhante Date: Mon, 19 Jan 2026 21:33:34 +0100 Subject: [PATCH 10/34] style: fix format issues --- .../src/scale-runners/scale-up.test.ts | 7 +------ .../src/scale-runners/scale-up.ts | 18 +++++++----------- .../webhook/src/runners/dispatch.test.ts | 2 +- 3 files changed, 9 insertions(+), 18 deletions(-) diff --git a/lambdas/functions/control-plane/src/scale-runners/scale-up.test.ts b/lambdas/functions/control-plane/src/scale-runners/scale-up.test.ts index 67eb166091..aa780193cd 100644 --- a/lambdas/functions/control-plane/src/scale-runners/scale-up.test.ts +++ b/lambdas/functions/control-plane/src/scale-runners/scale-up.test.ts @@ -735,12 +735,7 @@ describe('scaleUp with GHES', () => { const testDataWithMultipleEc2Labels = [ { ...TEST_DATA_SINGLE, - labels: [ - 'regular-label', - 'ghr-ec2-instance-type:r5.2xlarge', - 'ghr-ec2-ami:custom-ami', - 'ghr-ec2-disk:200', - ], + labels: ['regular-label', 'ghr-ec2-instance-type:r5.2xlarge', 'ghr-ec2-ami:custom-ami', 'ghr-ec2-disk:200'], messageId: 'test-8', }, ]; diff --git a/lambdas/functions/control-plane/src/scale-runners/scale-up.ts b/lambdas/functions/control-plane/src/scale-runners/scale-up.ts index 5588a8f355..efcf2299e9 100644 --- a/lambdas/functions/control-plane/src/scale-runners/scale-up.ts +++ b/lambdas/functions/control-plane/src/scale-runners/scale-up.ts @@ -365,7 +365,9 @@ export async function scaleUp(payloads: ActionRequestMessageSQS[]): Promise 0 && dynamicEc2ConfigEnabled) { - logger.debug('Dynamic EC2 config enabled, processing labels', {labels: messages[0].labels}); + logger.debug('Dynamic EC2 config enabled, processing labels', { labels: messages[0].labels }); - const dynamicEC2Labels = - messages[0].labels - ?.map(l => l.trim()) - .filter(l => l.startsWith('ghr-ec2-')) ?? []; + const dynamicEC2Labels = messages[0].labels?.map((l) => l.trim()).filter((l) => l.startsWith('ghr-ec2-')) ?? []; if (dynamicEC2Labels.length > 0) { // Append all EC2 labels to runnerLabels - runnerLabels = runnerLabels - ? `${runnerLabels},${dynamicEC2Labels.join(',')}` - : dynamicEC2Labels.join(','); + runnerLabels = runnerLabels ? `${runnerLabels},${dynamicEC2Labels.join(',')}` : dynamicEC2Labels.join(','); logger.debug('Updated runner labels', { runnerLabels }); // Extract instance type from EC2 labels const requestedInstanceType = dynamicEC2Labels - .find(l => l.startsWith('ghr-ec2-instance-type:')) + .find((l) => l.startsWith('ghr-ec2-instance-type:')) ?.replace('ghr-ec2-instance-type:', ''); if (requestedInstanceType) { @@ -450,7 +447,6 @@ export async function scaleUp(payloads: ActionRequestMessageSQS[]): Promise { installationId: 0, queueId: runnerConfig[0].id, repoOwnerType: 'Organization', - labels: ['self-hosted', 'Test'] + labels: ['self-hosted', 'Test'], }); }); From 079eceeca9c2091b5d88266808bd645c0bc05e2d Mon Sep 17 00:00:00 2001 From: edersonbrilhante Date: Tue, 20 Jan 2026 12:54:17 +0100 Subject: [PATCH 11/34] feat: add support for all fields in FleetLaunchTemplateOverridesRequest --- .../control-plane/src/aws/runners.d.ts | 17 +- .../control-plane/src/aws/runners.test.ts | 209 ++++++++++++ .../control-plane/src/aws/runners.ts | 15 +- .../src/scale-runners/scale-up.test.ts | 271 ++++++++++++--- .../src/scale-runners/scale-up.ts | 319 +++++++++++++++++- 5 files changed, 771 insertions(+), 60 deletions(-) diff --git a/lambdas/functions/control-plane/src/aws/runners.d.ts b/lambdas/functions/control-plane/src/aws/runners.d.ts index 7e9bf0fbba..4acdd69be7 100644 --- a/lambdas/functions/control-plane/src/aws/runners.d.ts +++ b/lambdas/functions/control-plane/src/aws/runners.d.ts @@ -1,4 +1,4 @@ -import { DefaultTargetCapacityType, SpotAllocationStrategy } from '@aws-sdk/client-ec2'; +import { DefaultTargetCapacityType, InstanceRequirementsRequest, SpotAllocationStrategy, _InstanceType, Placement, FleetBlockDeviceMappingRequest } from '@aws-sdk/client-ec2'; export type RunnerType = 'Org' | 'Repo'; @@ -29,6 +29,20 @@ export interface ListRunnerFilters { statuses?: string[]; } +export interface Ec2OverrideConfig { + InstanceType?: _InstanceType + MaxPrice?: string + SubnetId?: string + AvailabilityZone?: string + WeightedCapacity?: number + Priority?: number + Placement?: Placement + BlockDeviceMappings?: FleetBlockDeviceMappingRequest[] + InstanceRequirements?: InstanceRequirementsRequest + ImageId?: string + AvailabilityZoneId?: string +} + export interface RunnerInputParameters { environment: string; runnerType: RunnerType; @@ -41,6 +55,7 @@ export interface RunnerInputParameters { maxSpotPrice?: string; instanceAllocationStrategy: SpotAllocationStrategy; }; + ec2OverrideConfig?: Ec2OverrideConfig; numberOfRunners: number; amiIdSsmParameterName?: string; tracingEnabled?: boolean; diff --git a/lambdas/functions/control-plane/src/aws/runners.test.ts b/lambdas/functions/control-plane/src/aws/runners.test.ts index 63f1412dd0..21a10005bb 100644 --- a/lambdas/functions/control-plane/src/aws/runners.test.ts +++ b/lambdas/functions/control-plane/src/aws/runners.test.ts @@ -425,6 +425,215 @@ describe('create runner', () => { }), }); }); + + it('overrides SubnetId when specified in ec2OverrideConfig', async () => { + await createRunner({ + ...createRunnerConfig(defaultRunnerConfig), + ec2OverrideConfig: { + SubnetId: 'subnet-override', + }, + }); + + expect(mockEC2Client).toHaveReceivedCommandWith(CreateFleetCommand, { + LaunchTemplateConfigs: [ + { + LaunchTemplateSpecification: { + LaunchTemplateName: 'lt-1', + Version: '$Default', + }, + Overrides: [ + { + InstanceType: 'm5.large', + SubnetId: 'subnet-override', + }, + { + InstanceType: 'c5.large', + SubnetId: 'subnet-override', + }, + ], + }, + ], + SpotOptions: { + AllocationStrategy: SpotAllocationStrategy.CAPACITY_OPTIMIZED, + }, + TagSpecifications: expect.any(Array), + TargetCapacitySpecification: { + DefaultTargetCapacityType: 'spot', + TotalTargetCapacity: 1, + }, + Type: 'instant', + }); + }); + + it('overrides InstanceType when specified in ec2OverrideConfig', async () => { + await createRunner({ + ...createRunnerConfig(defaultRunnerConfig), + ec2OverrideConfig: { + InstanceType: 't3.xlarge', + }, + }); + + expect(mockEC2Client).toHaveReceivedCommandWith(CreateFleetCommand, { + LaunchTemplateConfigs: [ + { + LaunchTemplateSpecification: { + LaunchTemplateName: 'lt-1', + Version: '$Default', + }, + Overrides: [ + { + InstanceType: 't3.xlarge', + SubnetId: 'subnet-123', + }, + { + InstanceType: 't3.xlarge', + SubnetId: 'subnet-456', + }, + ], + }, + ], + SpotOptions: { + AllocationStrategy: SpotAllocationStrategy.CAPACITY_OPTIMIZED, + }, + TagSpecifications: expect.any(Array), + TargetCapacitySpecification: { + DefaultTargetCapacityType: 'spot', + TotalTargetCapacity: 1, + }, + Type: 'instant', + }); + }); + + it('overrides ImageId when specified in ec2OverrideConfig', async () => { + await createRunner({ + ...createRunnerConfig(defaultRunnerConfig), + ec2OverrideConfig: { + ImageId: 'ami-override-123', + }, + }); + + expect(mockEC2Client).toHaveReceivedCommandWith(CreateFleetCommand, { + LaunchTemplateConfigs: [ + { + LaunchTemplateSpecification: { + LaunchTemplateName: 'lt-1', + Version: '$Default', + }, + Overrides: [ + { + InstanceType: 'm5.large', + SubnetId: 'subnet-123', + ImageId: 'ami-override-123', + }, + { + InstanceType: 'c5.large', + SubnetId: 'subnet-123', + ImageId: 'ami-override-123', + }, + { + InstanceType: 'm5.large', + SubnetId: 'subnet-456', + ImageId: 'ami-override-123', + }, + { + InstanceType: 'c5.large', + SubnetId: 'subnet-456', + ImageId: 'ami-override-123', + }, + ], + }, + ], + SpotOptions: { + AllocationStrategy: SpotAllocationStrategy.CAPACITY_OPTIMIZED, + }, + TagSpecifications: expect.any(Array), + TargetCapacitySpecification: { + DefaultTargetCapacityType: 'spot', + TotalTargetCapacity: 1, + }, + Type: 'instant', + }); + }); + + it('overrides all three fields (SubnetId, InstanceType, ImageId) when specified in ec2OverrideConfig', async () => { + await createRunner({ + ...createRunnerConfig(defaultRunnerConfig), + ec2OverrideConfig: { + SubnetId: 'subnet-custom', + InstanceType: 'c5.2xlarge', + ImageId: 'ami-custom-456', + }, + }); + + expect(mockEC2Client).toHaveReceivedCommandWith(CreateFleetCommand, { + LaunchTemplateConfigs: [ + { + LaunchTemplateSpecification: { + LaunchTemplateName: 'lt-1', + Version: '$Default', + }, + Overrides: [ + { + InstanceType: 'c5.2xlarge', + SubnetId: 'subnet-custom', + ImageId: 'ami-custom-456', + }, + ], + }, + ], + SpotOptions: { + AllocationStrategy: SpotAllocationStrategy.CAPACITY_OPTIMIZED, + }, + TagSpecifications: expect.any(Array), + TargetCapacitySpecification: { + DefaultTargetCapacityType: 'spot', + TotalTargetCapacity: 1, + }, + Type: 'instant', + }); + }); + + it('spreads additional ec2OverrideConfig properties to Overrides', async () => { + await createRunner({ + ...createRunnerConfig(defaultRunnerConfig), + ec2OverrideConfig: { + SubnetId: 'subnet-override', + InstanceType: 't3.medium', + MaxPrice: '0.05', + Priority: 1.5, + WeightedCapacity: 2.0, + }, + }); + + expect(mockEC2Client).toHaveReceivedCommandWith(CreateFleetCommand, { + LaunchTemplateConfigs: [ + { + LaunchTemplateSpecification: { + LaunchTemplateName: 'lt-1', + Version: '$Default', + }, + Overrides: [ + { + InstanceType: 't3.medium', + SubnetId: 'subnet-override', + MaxPrice: '0.05', + Priority: 1.5, + WeightedCapacity: 2.0, + }, + ], + }, + ], + SpotOptions: { + AllocationStrategy: SpotAllocationStrategy.CAPACITY_OPTIMIZED, + }, + TagSpecifications: expect.any(Array), + TargetCapacitySpecification: { + DefaultTargetCapacityType: 'spot', + TotalTargetCapacity: 1, + }, + Type: 'instant', + }); + }); }); describe('create runner with errors', () => { diff --git a/lambdas/functions/control-plane/src/aws/runners.ts b/lambdas/functions/control-plane/src/aws/runners.ts index 7f7f5750bf..8f4040cc9a 100644 --- a/lambdas/functions/control-plane/src/aws/runners.ts +++ b/lambdas/functions/control-plane/src/aws/runners.ts @@ -125,14 +125,22 @@ function generateFleetOverrides( subnetIds: string[], instancesTypes: string[], amiId?: string, + ec2OverrideConfig?: Runners.Ec2OverrideConfig, ): FleetLaunchTemplateOverridesRequest[] { const result: FleetLaunchTemplateOverridesRequest[] = []; - subnetIds.forEach((s) => { - instancesTypes.forEach((i) => { + + // Use override values if available, otherwise use parameter arrays + const subnetsToUse = ec2OverrideConfig?.SubnetId ? [ec2OverrideConfig.SubnetId] : subnetIds; + const instanceTypesToUse = ec2OverrideConfig?.InstanceType ? [ec2OverrideConfig.InstanceType] : instancesTypes; + const amiIdToUse = ec2OverrideConfig?.ImageId ?? amiId; + + subnetsToUse.forEach((s) => { + instanceTypesToUse.forEach((i) => { const item: FleetLaunchTemplateOverridesRequest = { SubnetId: s, InstanceType: i as _InstanceType, - ImageId: amiId, + ImageId: amiIdToUse, + ...ec2OverrideConfig, }; result.push(item); }); @@ -265,6 +273,7 @@ async function createInstances( runnerParameters.subnets, runnerParameters.ec2instanceCriteria.instanceTypes, amiIdOverride, + runnerParameters.ec2OverrideConfig, ), }, ], diff --git a/lambdas/functions/control-plane/src/scale-runners/scale-up.test.ts b/lambdas/functions/control-plane/src/scale-runners/scale-up.test.ts index aa780193cd..547cc4cb49 100644 --- a/lambdas/functions/control-plane/src/scale-runners/scale-up.test.ts +++ b/lambdas/functions/control-plane/src/scale-runners/scale-up.test.ts @@ -596,31 +596,14 @@ describe('scaleUp with GHES', () => { await scaleUpModule.scaleUp(testDataWithEc2Labels); - // Verify createRunner was called with EC2 instance type extracted from labels + // Verify createRunner was called with EC2 instance type in override config expect(createRunner).toBeCalledWith( expect.objectContaining({ ec2instanceCriteria: expect.objectContaining({ - instanceTypes: ['c5.2xlarge'], + instanceTypes: ['t3.medium', 't3.large'], }), - }), - ); - }); - - it('extracts instance type from EC2 labels and overrides default instance types', async () => { - const testDataWithEc2Labels = [ - { - ...TEST_DATA_SINGLE, - labels: ['ghr-ec2-instance-type:m5.xlarge', 'ghr-ec2-disk:100'], - messageId: 'test-2', - }, - ]; - - await scaleUpModule.scaleUp(testDataWithEc2Labels); - - expect(createRunner).toBeCalledWith( - expect.objectContaining({ - ec2instanceCriteria: expect.objectContaining({ - instanceTypes: ['m5.xlarge'], + ec2OverrideConfig: expect.objectContaining({ + InstanceType: 'c5.2xlarge', }), }), ); @@ -647,27 +630,6 @@ describe('scaleUp with GHES', () => { ); }); - it('does not modify labels when EC2 labels are not present', async () => { - const testDataWithoutEc2Labels = [ - { - ...TEST_DATA_SINGLE, - labels: ['regular-label', 'another-label'], - messageId: 'test-4', - }, - ]; - - await scaleUpModule.scaleUp(testDataWithoutEc2Labels); - - // Should use default instance types - expect(createRunner).toBeCalledWith( - expect.objectContaining({ - ec2instanceCriteria: expect.objectContaining({ - instanceTypes: ['t3.medium', 't3.large'], - }), - }), - ); - }); - it('handles messages with no labels gracefully', async () => { const testDataWithNoLabels = [ { @@ -745,7 +707,230 @@ describe('scaleUp with GHES', () => { expect(createRunner).toBeCalledWith( expect.objectContaining({ ec2instanceCriteria: expect.objectContaining({ - instanceTypes: ['r5.2xlarge'], + instanceTypes: ['t3.medium', 't3.large'], + }), + ec2OverrideConfig: expect.objectContaining({ + InstanceType: 'r5.2xlarge', + }), + }), + ); + }); + + it('includes ec2OverrideConfig with VCpuCount requirements when specified', async () => { + const testDataWithVCpuLabels = [ + { + ...TEST_DATA_SINGLE, + labels: ['self-hosted', 'ghr-ec2-vcpu-count-min:4', 'ghr-ec2-vcpu-count-max:16'], + messageId: 'test-9', + }, + ]; + + await scaleUpModule.scaleUp(testDataWithVCpuLabels); + + expect(createRunner).toBeCalledWith( + expect.objectContaining({ + ec2OverrideConfig: expect.objectContaining({ + InstanceRequirements: expect.objectContaining({ + VCpuCount: { + Min: 4, + Max: 16, + }, + }), + }), + }), + ); + }); + + it('includes ec2OverrideConfig with MemoryMiB requirements when specified', async () => { + const testDataWithMemoryLabels = [ + { + ...TEST_DATA_SINGLE, + labels: ['self-hosted', 'ghr-ec2-memory-mib-min:8192', 'ghr-ec2-memory-mib-max:32768'], + messageId: 'test-10', + }, + ]; + + await scaleUpModule.scaleUp(testDataWithMemoryLabels); + + expect(createRunner).toBeCalledWith( + expect.objectContaining({ + ec2OverrideConfig: expect.objectContaining({ + InstanceRequirements: expect.objectContaining({ + MemoryMiB: { + Min: 8192, + Max: 32768, + }, + }), + }), + }), + ); + }); + + it('includes ec2OverrideConfig with CPU manufacturers when specified', async () => { + const testDataWithCpuLabels = [ + { + ...TEST_DATA_SINGLE, + labels: ['self-hosted', 'ghr-ec2-cpu-manufacturers:intel,amd'], + messageId: 'test-11', + }, + ]; + + await scaleUpModule.scaleUp(testDataWithCpuLabels); + + expect(createRunner).toBeCalledWith( + expect.objectContaining({ + ec2OverrideConfig: expect.objectContaining({ + InstanceRequirements: expect.objectContaining({ + CpuManufacturers: ['intel', 'amd'], + }), + }), + }), + ); + }); + + it('includes ec2OverrideConfig with instance generations when specified', async () => { + const testDataWithGenerationLabels = [ + { + ...TEST_DATA_SINGLE, + labels: ['self-hosted', 'ghr-ec2-instance-generations:current'], + messageId: 'test-12', + }, + ]; + + await scaleUpModule.scaleUp(testDataWithGenerationLabels); + + expect(createRunner).toBeCalledWith( + expect.objectContaining({ + ec2OverrideConfig: expect.objectContaining({ + InstanceRequirements: expect.objectContaining({ + InstanceGenerations: ['current'], + }), + }), + }), + ); + }); + + it('includes ec2OverrideConfig with accelerator requirements when specified', async () => { + const testDataWithAcceleratorLabels = [ + { + ...TEST_DATA_SINGLE, + labels: ['self-hosted', 'ghr-ec2-accelerator-count-min:1', 'ghr-ec2-accelerator-types:gpu'], + messageId: 'test-13', + }, + ]; + + await scaleUpModule.scaleUp(testDataWithAcceleratorLabels); + + expect(createRunner).toBeCalledWith( + expect.objectContaining({ + ec2OverrideConfig: expect.objectContaining({ + InstanceRequirements: expect.objectContaining({ + AcceleratorCount: { + Min: 1, + }, + AcceleratorTypes: ['gpu'], + }), + }), + }), + ); + }); + + it('includes ec2OverrideConfig with max price when specified', async () => { + const testDataWithMaxPrice = [ + { + ...TEST_DATA_SINGLE, + labels: ['self-hosted', 'ghr-ec2-max-price:0.50'], + messageId: 'test-14', + }, + ]; + + await scaleUpModule.scaleUp(testDataWithMaxPrice); + + expect(createRunner).toBeCalledWith( + expect.objectContaining({ + ec2OverrideConfig: expect.objectContaining({ + MaxPrice: '0.50', + }), + }), + ); + }); + + it('includes ec2OverrideConfig with priority and weighted capacity when specified', async () => { + const testDataWithPriorityWeight = [ + { + ...TEST_DATA_SINGLE, + labels: ['self-hosted', 'ghr-ec2-priority:1', 'ghr-ec2-weighted-capacity:2'], + messageId: 'test-15', + }, + ]; + + await scaleUpModule.scaleUp(testDataWithPriorityWeight); + + expect(createRunner).toBeCalledWith( + expect.objectContaining({ + ec2OverrideConfig: expect.objectContaining({ + Priority: 1, + WeightedCapacity: 2, + }), + }), + ); + }); + + it('includes ec2OverrideConfig with combined requirements', async () => { + const testDataWithCombinedLabels = [ + { + ...TEST_DATA_SINGLE, + labels: [ + 'self-hosted', + 'linux', + 'ghr-ec2-vcpu-count-min:8', + 'ghr-ec2-memory-mib-min:16384', + 'ghr-ec2-cpu-manufacturers:intel', + 'ghr-ec2-instance-generations:current', + 'ghr-ec2-max-price:1.00', + ], + messageId: 'test-16', + }, + ]; + + await scaleUpModule.scaleUp(testDataWithCombinedLabels); + + expect(createRunner).toBeCalledWith( + expect.objectContaining({ + ec2OverrideConfig: expect.objectContaining({ + InstanceRequirements: expect.objectContaining({ + VCpuCount: { Min: 8 }, + MemoryMiB: { Min: 16384 }, + CpuManufacturers: ['intel'], + InstanceGenerations: ['current'], + }), + MaxPrice: '1.00', + }), + }), + ); + }); + + it('includes both instance type and ec2OverrideConfig when both specified', async () => { + const testDataWithBoth = [ + { + ...TEST_DATA_SINGLE, + labels: ['self-hosted', 'ghr-ec2-instance-type:c5.xlarge', 'ghr-ec2-vcpu-count-min:4'], + messageId: 'test-18', + }, + ]; + + await scaleUpModule.scaleUp(testDataWithBoth); + + expect(createRunner).toBeCalledWith( + expect.objectContaining({ + ec2instanceCriteria: expect.objectContaining({ + instanceTypes: ['t3.medium', 't3.large'], + }), + ec2OverrideConfig: expect.objectContaining({ + InstanceType: 'c5.xlarge', + InstanceRequirements: expect.objectContaining({ + VCpuCount: { Min: 4 }, + }), }), }), ); diff --git a/lambdas/functions/control-plane/src/scale-runners/scale-up.ts b/lambdas/functions/control-plane/src/scale-runners/scale-up.ts index efcf2299e9..9691bedab5 100644 --- a/lambdas/functions/control-plane/src/scale-runners/scale-up.ts +++ b/lambdas/functions/control-plane/src/scale-runners/scale-up.ts @@ -5,7 +5,7 @@ import yn from 'yn'; import { createGithubAppAuth, createGithubInstallationAuth, createOctokitClient } from '../github/auth'; import { createRunner, listEC2Runners, tag, terminateRunner } from './../aws/runners'; -import { RunnerInputParameters } from './../aws/runners.d'; +import { Ec2OverrideConfig, RunnerInputParameters } from './../aws/runners.d'; import { metricGitHubAppRateLimit } from '../github/rate-limit'; import { publishRetryMessage } from './job-retry'; @@ -61,6 +61,7 @@ interface CreateEC2RunnerConfig { subnets: string[]; launchTemplateName: string; ec2instanceCriteria: RunnerInputParameters['ec2instanceCriteria']; + ec2OverrideConfig?: RunnerInputParameters['ec2OverrideConfig']; numberOfRunners?: number; amiIdSsmParameterName?: string; tracingEnabled?: boolean; @@ -418,6 +419,8 @@ export async function scaleUp(payloads: ActionRequestMessageSQS[]): Promise 0 && dynamicEc2ConfigEnabled) { logger.debug('Dynamic EC2 config enabled, processing labels', { labels: messages[0].labels }); @@ -429,18 +432,12 @@ export async function scaleUp(payloads: ActionRequestMessageSQS[]): Promise l.startsWith('ghr-ec2-instance-type:')) - ?.replace('ghr-ec2-instance-type:', ''); - - if (requestedInstanceType) { - instanceTypes = [requestedInstanceType]; - logger.debug('EC2 instance type requested', { - instanceType: requestedInstanceType, - }); - } else { - logger.debug('No dynamic EC2 instance type label found'); + // Parse EC2 override configuration from labels + ec2OverrideConfig = parseEc2OverrideConfig(dynamicEC2Labels); + if (ec2OverrideConfig) { + logger.debug('EC2 override config parsed from labels', { + ec2OverrideConfig, + }); } } else { logger.debug('No dynamic EC2 labels found on message'); @@ -543,6 +540,7 @@ export async function scaleUp(payloads: ActionRequestMessageSQS[]): Promise - Set specific instance type (e.g., c5.xlarge) + * - ghr-ec2-max-price: - Set maximum spot price + * - ghr-ec2-subnet-id: - Set subnet ID + * - ghr-ec2-availability-zone: - Set availability zone + * - ghr-ec2-availability-zone-id: - Set availability zone ID + * - ghr-ec2-weighted-capacity: - Set weighted capacity + * - ghr-ec2-priority: - Set launch priority + * - ghr-ec2-image-id: - Override AMI ID + * + * Instance Requirements (vCPU & Memory): + * - ghr-ec2-vcpu-count-min: - Set minimum vCPU count + * - ghr-ec2-vcpu-count-max: - Set maximum vCPU count + * - ghr-ec2-memory-mib-min: - Set minimum memory in MiB + * - ghr-ec2-memory-mib-max: - Set maximum memory in MiB + * - ghr-ec2-memory-gib-per-vcpu-min: - Set min memory per vCPU ratio + * - ghr-ec2-memory-gib-per-vcpu-max: - Set max memory per vCPU ratio + * + * Instance Requirements (CPU & Performance): + * - ghr-ec2-cpu-manufacturers: - CPU manufacturers (comma-separated: intel,amd,amazon-web-services) + * - ghr-ec2-instance-generations: - Instance generations (comma-separated: current,previous) + * - ghr-ec2-excluded-instance-types: - Exclude instance types (comma-separated) + * - ghr-ec2-allowed-instance-types: - Allow only specific instance types (comma-separated) + * - ghr-ec2-burstable-performance: - Burstable performance (included,excluded,required) + * - ghr-ec2-bare-metal: - Bare metal (included,excluded,required) + * + * Instance Requirements (Accelerators/GPU): + * - ghr-ec2-accelerator-types: - Accelerator types (comma-separated: gpu,fpga,inference) + * - ghr-ec2-accelerator-count-min: - Set minimum accelerator count + * - ghr-ec2-accelerator-count-max: - Set maximum accelerator count + * - ghr-ec2-accelerator-manufacturers: - Accelerator manufacturers (comma-separated: nvidia,amd,amazon-web-services,xilinx) + * - ghr-ec2-accelerator-names: - Specific accelerator names (comma-separated) + * - ghr-ec2-accelerator-memory-mib-min: - Min accelerator total memory in MiB + * - ghr-ec2-accelerator-memory-mib-max: - Max accelerator total memory in MiB + * + * Instance Requirements (Network & Storage): + * - ghr-ec2-network-interface-count-min: - Min network interfaces + * - ghr-ec2-network-interface-count-max: - Max network interfaces + * - ghr-ec2-network-bandwidth-gbps-min: - Min network bandwidth in Gbps + * - ghr-ec2-network-bandwidth-gbps-max: - Max network bandwidth in Gbps + * - ghr-ec2-local-storage: - Local storage (included,excluded,required) + * - ghr-ec2-local-storage-types: - Local storage types (comma-separated: hdd,ssd) + * - ghr-ec2-total-local-storage-gb-min: - Min total local storage in GB + * - ghr-ec2-total-local-storage-gb-max: - Max total local storage in GB + * - ghr-ec2-baseline-ebs-bandwidth-mbps-min: - Min baseline EBS bandwidth in Mbps + * - ghr-ec2-baseline-ebs-bandwidth-mbps-max: - Max baseline EBS bandwidth in Mbps + * + * Placement: + * - ghr-ec2-placement-group: - Placement group name + * - ghr-ec2-placement-tenancy: - Tenancy (default,dedicated,host) + * - ghr-ec2-placement-host-id: - Dedicated host ID + * - ghr-ec2-placement-affinity: - Affinity (default,host) + * - ghr-ec2-placement-partition-number: - Partition number + * - ghr-ec2-placement-availability-zone: - Placement availability zone + * - ghr-ec2-placement-spread-domain: - Spread domain + * - ghr-ec2-placement-host-resource-group-arn: - Host resource group ARN + * + * Block Device Mappings: + * - ghr-ec2-ebs-volume-size: - EBS volume size in GB + * - ghr-ec2-ebs-volume-type: - EBS volume type (gp2,gp3,io1,io2,st1,sc1) + * - ghr-ec2-ebs-iops: - EBS IOPS + * - ghr-ec2-ebs-throughput: - EBS throughput in MB/s (gp3 only) + * - ghr-ec2-ebs-encrypted: - EBS encryption (true,false) + * - ghr-ec2-ebs-kms-key-id: - KMS key ID for encryption + * - ghr-ec2-ebs-delete-on-termination: - Delete on termination (true,false) + * - ghr-ec2-ebs-snapshot-id: - Snapshot ID for EBS volume + * - ghr-ec2-block-device-virtual-name: - Virtual device name (ephemeral storage) + * - ghr-ec2-block-device-no-device: - Suppresses device mapping + * + * Pricing: + * - ghr-ec2-spot-max-price-percentage: - Spot max price as % over lowest price + * - ghr-ec2-on-demand-max-price-percentage: - On-demand max price as % over lowest price + * - ghr-ec2-max-spot-price-percentage-optimal: - Max spot price as % of optimal on-demand + * - ghr-ec2-require-hibernate-support: - Require hibernate support (true,false) + * - ghr-ec2-require-encryption-in-transit: - Require encryption in-transit (true,false) + * - ghr-ec2-baseline-performance-cpu-family: - CPU baseline performance family + * + * Example: + * runs-on: [self-hosted, linux, ghr-ec2-vcpu-count-min:4, ghr-ec2-memory-mib-min:16384, ghr-ec2-accelerator-types:gpu] + * + * @param labels - Array of GitHub workflow job labels + * @returns EC2 override configuration object or undefined if no valid config found + */ +function parseEc2OverrideConfig(labels: string[]): Ec2OverrideConfig | undefined { + const ec2Labels = labels.filter((l) => l.startsWith('ghr-ec2-')); + const config: Partial = {}; + + for (const label of ec2Labels) { + const [key, ...valueParts] = label.replace('ghr-ec2-', '').split(':'); + const value = valueParts.join(':'); + + if (!value) continue; + + // Basic Fleet Overrides + if (key === 'instance-type') { + config.InstanceType = value; + } else if (key === 'subnet-id') { + config.SubnetId = value; + } else if (key === 'availability-zone') { + config.AvailabilityZone = value; + } else if (key === 'availability-zone-id') { + config.AvailabilityZoneId = value; + } else if (key === 'max-price') { + config.MaxPrice = value; + } else if (key === 'priority') { + config.Priority = parseFloat(value); + } else if (key === 'weighted-capacity') { + config.WeightedCapacity = parseFloat(value); + } else if (key === 'image-id') { + config.ImageId = value; + } + + // Placement + else if (key.startsWith('placement-')) { + config.Placement = config.Placement || {}; + const placementKey = key.replace('placement-', ''); + if (placementKey === 'group') { + config.Placement.GroupName = value; + } else if (placementKey === 'tenancy') { + config.Placement.Tenancy = value; + } else if (placementKey === 'host-id') { + config.Placement.HostId = value; + } else if (placementKey === 'affinity') { + config.Placement.Affinity = value; + } else if (placementKey === 'partition-number') { + config.Placement.PartitionNumber = parseInt(value, 10); + } else if (placementKey === 'availability-zone') { + config.Placement.AvailabilityZone = value; + } else if (placementKey === 'spread-domain') { + config.Placement.SpreadDomain = value; + } else if (placementKey === 'host-resource-group-arn') { + config.Placement.HostResourceGroupArn = value; + } + } + + // Block Device Mappings (EBS) + else if (key.startsWith('ebs-')) { + config.BlockDeviceMappings = config.BlockDeviceMappings || [{ DeviceName: '/dev/sda1', Ebs: {} }]; + const ebsKey = key.replace('ebs-', ''); + const ebs = config.BlockDeviceMappings[0].Ebs; + + if (ebsKey === 'volume-size') { + ebs.VolumeSize = parseInt(value, 10); + } else if (ebsKey === 'volume-type') { + ebs.VolumeType = value; + } else if (ebsKey === 'iops') { + ebs.Iops = parseInt(value, 10); + } else if (ebsKey === 'throughput') { + ebs.Throughput = parseInt(value, 10); + } else if (ebsKey === 'encrypted') { + ebs.Encrypted = value.toLowerCase() === 'true'; + } else if (ebsKey === 'kms-key-id') { + ebs.KmsKeyId = value; + } else if (ebsKey === 'delete-on-termination') { + ebs.DeleteOnTermination = value.toLowerCase() === 'true'; + } else if (ebsKey === 'snapshot-id') { + ebs.SnapshotId = value; + } + } + + // Block Device Mappings (Non-EBS) + else if (key === 'block-device-virtual-name') { + config.BlockDeviceMappings = config.BlockDeviceMappings || [{ DeviceName: '/dev/sda1', Ebs: {} }]; + config.BlockDeviceMappings[0].VirtualName = value; + } else if (key === 'block-device-no-device') { + config.BlockDeviceMappings = config.BlockDeviceMappings || [{ DeviceName: '/dev/sda1', Ebs: {} }]; + config.BlockDeviceMappings[0].NoDevice = value; + } + + // Instance Requirements - vCPU & Memory + else if (key.startsWith('vcpu-count-')) { + config.InstanceRequirements = config.InstanceRequirements || {}; + config.InstanceRequirements.VCpuCount = config.InstanceRequirements.VCpuCount || {}; + const subKey = key.replace('vcpu-count-', ''); + config.InstanceRequirements.VCpuCount[subKey === 'min' ? 'Min' : 'Max'] = parseInt(value, 10); + } else if (key.startsWith('memory-mib-')) { + config.InstanceRequirements = config.InstanceRequirements || {}; + config.InstanceRequirements.MemoryMiB = config.InstanceRequirements.MemoryMiB || {}; + const subKey = key.replace('memory-mib-', ''); + config.InstanceRequirements.MemoryMiB[subKey === 'min' ? 'Min' : 'Max'] = parseInt(value, 10); + } else if (key.startsWith('memory-gib-per-vcpu-')) { + config.InstanceRequirements = config.InstanceRequirements || {}; + config.InstanceRequirements.MemoryGiBPerVCpu = config.InstanceRequirements.MemoryGiBPerVCpu || {}; + const subKey = key.replace('memory-gib-per-vcpu-', ''); + config.InstanceRequirements.MemoryGiBPerVCpu[subKey === 'min' ? 'Min' : 'Max'] = parseFloat(value); + } + + // Instance Requirements - CPU & Performance + else if (key === 'cpu-manufacturers') { + config.InstanceRequirements = config.InstanceRequirements || {}; + config.InstanceRequirements.CpuManufacturers = value.split(','); + } else if (key === 'instance-generations') { + config.InstanceRequirements = config.InstanceRequirements || {}; + config.InstanceRequirements.InstanceGenerations = value.split(','); + } else if (key === 'excluded-instance-types') { + config.InstanceRequirements = config.InstanceRequirements || {}; + config.InstanceRequirements.ExcludedInstanceTypes = value.split(','); + } else if (key === 'allowed-instance-types') { + config.InstanceRequirements = config.InstanceRequirements || {}; + config.InstanceRequirements.AllowedInstanceTypes = value.split(','); + } else if (key === 'burstable-performance') { + config.InstanceRequirements = config.InstanceRequirements || {}; + config.InstanceRequirements.BurstablePerformance = value; + } else if (key === 'bare-metal') { + config.InstanceRequirements = config.InstanceRequirements || {}; + config.InstanceRequirements.BareMetal = value; + } + + // Instance Requirements - Accelerators + else if (key.startsWith('accelerator-count-')) { + config.InstanceRequirements = config.InstanceRequirements || {}; + config.InstanceRequirements.AcceleratorCount = config.InstanceRequirements.AcceleratorCount || {}; + const subKey = key.replace('accelerator-count-', ''); + config.InstanceRequirements.AcceleratorCount[subKey === 'min' ? 'Min' : 'Max'] = parseInt(value, 10); + } else if (key === 'accelerator-types') { + config.InstanceRequirements = config.InstanceRequirements || {}; + config.InstanceRequirements.AcceleratorTypes = value.split(','); + } else if (key === 'accelerator-manufacturers') { + config.InstanceRequirements = config.InstanceRequirements || {}; + config.InstanceRequirements.AcceleratorManufacturers = value.split(','); + } else if (key === 'accelerator-names') { + config.InstanceRequirements = config.InstanceRequirements || {}; + config.InstanceRequirements.AcceleratorNames = value.split(','); + } else if (key.startsWith('accelerator-memory-mib-')) { + config.InstanceRequirements = config.InstanceRequirements || {}; + config.InstanceRequirements.AcceleratorTotalMemoryMiB = + config.InstanceRequirements.AcceleratorTotalMemoryMiB || {}; + const subKey = key.replace('accelerator-memory-mib-', ''); + config.InstanceRequirements.AcceleratorTotalMemoryMiB[subKey === 'min' ? 'Min' : 'Max'] = parseInt(value, 10); + } + + // Instance Requirements - Network + else if (key.startsWith('network-interface-count-')) { + config.InstanceRequirements = config.InstanceRequirements || {}; + config.InstanceRequirements.NetworkInterfaceCount = config.InstanceRequirements.NetworkInterfaceCount || {}; + const subKey = key.replace('network-interface-count-', ''); + config.InstanceRequirements.NetworkInterfaceCount[subKey === 'min' ? 'Min' : 'Max'] = parseInt(value, 10); + } else if (key.startsWith('network-bandwidth-gbps-')) { + config.InstanceRequirements = config.InstanceRequirements || {}; + config.InstanceRequirements.NetworkBandwidthGbps = config.InstanceRequirements.NetworkBandwidthGbps || {}; + const subKey = key.replace('network-bandwidth-gbps-', ''); + config.InstanceRequirements.NetworkBandwidthGbps[subKey === 'min' ? 'Min' : 'Max'] = parseFloat(value); + } + + // Instance Requirements - Storage + else if (key === 'local-storage') { + config.InstanceRequirements = config.InstanceRequirements || {}; + config.InstanceRequirements.LocalStorage = value; + } else if (key === 'local-storage-types') { + config.InstanceRequirements = config.InstanceRequirements || {}; + config.InstanceRequirements.LocalStorageTypes = value.split(','); + } else if (key.startsWith('total-local-storage-gb-')) { + config.InstanceRequirements = config.InstanceRequirements || {}; + config.InstanceRequirements.TotalLocalStorageGB = config.InstanceRequirements.TotalLocalStorageGB || {}; + const subKey = key.replace('total-local-storage-gb-', ''); + config.InstanceRequirements.TotalLocalStorageGB[subKey === 'min' ? 'Min' : 'Max'] = parseFloat(value); + } else if (key.startsWith('baseline-ebs-bandwidth-mbps-')) { + config.InstanceRequirements = config.InstanceRequirements || {}; + config.InstanceRequirements.BaselineEbsBandwidthMbps = config.InstanceRequirements.BaselineEbsBandwidthMbps || {}; + const subKey = key.replace('baseline-ebs-bandwidth-mbps-', ''); + config.InstanceRequirements.BaselineEbsBandwidthMbps[subKey === 'min' ? 'Min' : 'Max'] = parseInt(value, 10); + } + + // Instance Requirements - Pricing & Other + else if (key === 'spot-max-price-percentage') { + config.InstanceRequirements = config.InstanceRequirements || {}; + config.InstanceRequirements.SpotMaxPricePercentageOverLowestPrice = parseInt(value, 10); + } else if (key === 'on-demand-max-price-percentage') { + config.InstanceRequirements = config.InstanceRequirements || {}; + config.InstanceRequirements.OnDemandMaxPricePercentageOverLowestPrice = parseInt(value, 10); + } else if (key === 'max-spot-price-percentage-optimal') { + config.InstanceRequirements = config.InstanceRequirements || {}; + config.InstanceRequirements.MaxSpotPriceAsPercentageOfOptimalOnDemandPrice = parseInt(value, 10); + } else if (key === 'require-hibernate-support') { + config.InstanceRequirements = config.InstanceRequirements || {}; + config.InstanceRequirements.RequireHibernateSupport = value.toLowerCase() === 'true'; + } else if (key === 'require-encryption-in-transit') { + config.InstanceRequirements = config.InstanceRequirements || {}; + config.InstanceRequirements.RequireEncryptionInTransit = value.toLowerCase() === 'true'; + } else if (key === 'baseline-performance-cpu-family') { + config.InstanceRequirements = config.InstanceRequirements || {}; + config.InstanceRequirements.BaselinePerformanceFactors = config.InstanceRequirements.BaselinePerformanceFactors || {}; + config.InstanceRequirements.BaselinePerformanceFactors.Cpu = config.InstanceRequirements.BaselinePerformanceFactors.Cpu || {}; + config.InstanceRequirements.BaselinePerformanceFactors.Cpu.References = [{ InstanceFamily: value }]; + } + } + + return Object.keys(config).length > 0 ? config : undefined; +} + function ec2LabelsHash(labels: string[]): string { const prefix = 'ghr-ec2-'; From d47887056a6817369d76c05396f640e60ca649ac Mon Sep 17 00:00:00 2001 From: edersonbrilhante Date: Tue, 20 Jan 2026 12:56:08 +0100 Subject: [PATCH 12/34] style: fix formatting issues --- .../control-plane/src/aws/runners.d.ts | 31 ++++++++++++------- .../control-plane/src/aws/runners.ts | 4 +-- .../src/scale-runners/scale-up.ts | 10 +++--- 3 files changed, 27 insertions(+), 18 deletions(-) diff --git a/lambdas/functions/control-plane/src/aws/runners.d.ts b/lambdas/functions/control-plane/src/aws/runners.d.ts index 4acdd69be7..ab7604f7ff 100644 --- a/lambdas/functions/control-plane/src/aws/runners.d.ts +++ b/lambdas/functions/control-plane/src/aws/runners.d.ts @@ -1,4 +1,11 @@ -import { DefaultTargetCapacityType, InstanceRequirementsRequest, SpotAllocationStrategy, _InstanceType, Placement, FleetBlockDeviceMappingRequest } from '@aws-sdk/client-ec2'; +import { + DefaultTargetCapacityType, + InstanceRequirementsRequest, + SpotAllocationStrategy, + _InstanceType, + Placement, + FleetBlockDeviceMappingRequest, +} from '@aws-sdk/client-ec2'; export type RunnerType = 'Org' | 'Repo'; @@ -30,17 +37,17 @@ export interface ListRunnerFilters { } export interface Ec2OverrideConfig { - InstanceType?: _InstanceType - MaxPrice?: string - SubnetId?: string - AvailabilityZone?: string - WeightedCapacity?: number - Priority?: number - Placement?: Placement - BlockDeviceMappings?: FleetBlockDeviceMappingRequest[] - InstanceRequirements?: InstanceRequirementsRequest - ImageId?: string - AvailabilityZoneId?: string + InstanceType?: _InstanceType; + MaxPrice?: string; + SubnetId?: string; + AvailabilityZone?: string; + WeightedCapacity?: number; + Priority?: number; + Placement?: Placement; + BlockDeviceMappings?: FleetBlockDeviceMappingRequest[]; + InstanceRequirements?: InstanceRequirementsRequest; + ImageId?: string; + AvailabilityZoneId?: string; } export interface RunnerInputParameters { diff --git a/lambdas/functions/control-plane/src/aws/runners.ts b/lambdas/functions/control-plane/src/aws/runners.ts index 8f4040cc9a..b7825a0314 100644 --- a/lambdas/functions/control-plane/src/aws/runners.ts +++ b/lambdas/functions/control-plane/src/aws/runners.ts @@ -128,12 +128,12 @@ function generateFleetOverrides( ec2OverrideConfig?: Runners.Ec2OverrideConfig, ): FleetLaunchTemplateOverridesRequest[] { const result: FleetLaunchTemplateOverridesRequest[] = []; - + // Use override values if available, otherwise use parameter arrays const subnetsToUse = ec2OverrideConfig?.SubnetId ? [ec2OverrideConfig.SubnetId] : subnetIds; const instanceTypesToUse = ec2OverrideConfig?.InstanceType ? [ec2OverrideConfig.InstanceType] : instancesTypes; const amiIdToUse = ec2OverrideConfig?.ImageId ?? amiId; - + subnetsToUse.forEach((s) => { instanceTypesToUse.forEach((i) => { const item: FleetLaunchTemplateOverridesRequest = { diff --git a/lambdas/functions/control-plane/src/scale-runners/scale-up.ts b/lambdas/functions/control-plane/src/scale-runners/scale-up.ts index 9691bedab5..7f03c49f1d 100644 --- a/lambdas/functions/control-plane/src/scale-runners/scale-up.ts +++ b/lambdas/functions/control-plane/src/scale-runners/scale-up.ts @@ -437,7 +437,7 @@ export async function scaleUp(payloads: ActionRequestMessageSQS[]): Promise Date: Tue, 20 Jan 2026 13:18:09 +0100 Subject: [PATCH 13/34] fix: convert instanceTypes to constant --- lambdas/functions/control-plane/src/scale-runners/scale-up.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lambdas/functions/control-plane/src/scale-runners/scale-up.ts b/lambdas/functions/control-plane/src/scale-runners/scale-up.ts index 7f03c49f1d..91e0027d24 100644 --- a/lambdas/functions/control-plane/src/scale-runners/scale-up.ts +++ b/lambdas/functions/control-plane/src/scale-runners/scale-up.ts @@ -298,7 +298,7 @@ export async function scaleUp(payloads: ActionRequestMessageSQS[]): Promise Date: Tue, 20 Jan 2026 14:33:51 +0100 Subject: [PATCH 14/34] test: fix test cases --- .../control-plane/src/aws/runners.test.ts | 2 + .../src/scale-runners/ScaleError.test.ts | 40 +- .../src/scale-runners/scale-up.test.ts | 698 ++++++++++++++++++ .../src/scale-runners/scale-up.ts | 185 +++-- 4 files changed, 850 insertions(+), 75 deletions(-) diff --git a/lambdas/functions/control-plane/src/aws/runners.test.ts b/lambdas/functions/control-plane/src/aws/runners.test.ts index 21a10005bb..911af2d70d 100644 --- a/lambdas/functions/control-plane/src/aws/runners.test.ts +++ b/lambdas/functions/control-plane/src/aws/runners.test.ts @@ -318,6 +318,7 @@ describe('create runner', () => { allocationStrategy: SpotAllocationStrategy.CAPACITY_OPTIMIZED, capacityType: 'spot', type: 'Org', + scaleErrors: ['UnfulfillableCapacity', 'MaxSpotInstanceCountExceeded'], }; const defaultExpectedFleetRequestValues: ExpectedFleetRequestValues = { @@ -755,6 +756,7 @@ describe('create runner with errors fail over to OnDemand', () => { capacityType: 'spot', type: 'Repo', onDemandFailoverOnError: ['InsufficientInstanceCapacity'], + scaleErrors: ['UnfulfillableCapacity', 'MaxSpotInstanceCountExceeded'], }; const defaultExpectedFleetRequestValues: ExpectedFleetRequestValues = { type: 'Repo', diff --git a/lambdas/functions/control-plane/src/scale-runners/ScaleError.test.ts b/lambdas/functions/control-plane/src/scale-runners/ScaleError.test.ts index 0a7478c12f..8490a80447 100644 --- a/lambdas/functions/control-plane/src/scale-runners/ScaleError.test.ts +++ b/lambdas/functions/control-plane/src/scale-runners/ScaleError.test.ts @@ -23,10 +23,42 @@ describe('ScaleError', () => { describe('toBatchItemFailures', () => { const mockMessages: ActionRequestMessageSQS[] = [ - { messageId: 'msg-1', id: 1, eventType: 'workflow_job' }, - { messageId: 'msg-2', id: 2, eventType: 'workflow_job' }, - { messageId: 'msg-3', id: 3, eventType: 'workflow_job' }, - { messageId: 'msg-4', id: 4, eventType: 'workflow_job' }, + { + messageId: 'msg-1', + id: 1, + eventType: 'workflow_job', + repositoryName: 'repo', + repositoryOwner: 'owner', + installationId: 123, + repoOwnerType: 'Organization', + }, + { + messageId: 'msg-2', + id: 2, + eventType: 'workflow_job', + repositoryName: 'repo', + repositoryOwner: 'owner', + installationId: 123, + repoOwnerType: 'Organization', + }, + { + messageId: 'msg-3', + id: 3, + eventType: 'workflow_job', + repositoryName: 'repo', + repositoryOwner: 'owner', + installationId: 123, + repoOwnerType: 'Organization', + }, + { + messageId: 'msg-4', + id: 4, + eventType: 'workflow_job', + repositoryName: 'repo', + repositoryOwner: 'owner', + installationId: 123, + repoOwnerType: 'Organization', + }, ]; it.each([ diff --git a/lambdas/functions/control-plane/src/scale-runners/scale-up.test.ts b/lambdas/functions/control-plane/src/scale-runners/scale-up.test.ts index 547cc4cb49..c89ae8cb4e 100644 --- a/lambdas/functions/control-plane/src/scale-runners/scale-up.test.ts +++ b/lambdas/functions/control-plane/src/scale-runners/scale-up.test.ts @@ -2219,6 +2219,7 @@ describe('scaleUp with Github Data Residency', () => { }); }); +<<<<<<< HEAD describe('Retry mechanism tests', () => { beforeEach(() => { process.env.ENABLE_ORGANIZATION_RUNNERS = 'true'; @@ -2360,10 +2361,509 @@ describe('Retry mechanism tests', () => { id: msg.id, messageId: msg.messageId, }), +======= +describe('parseEc2OverrideConfig', () => { + describe('Basic Fleet Overrides', () => { + it('should parse instance-type label', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-instance-type:c5.xlarge']); + expect(result?.InstanceType).toBe('c5.xlarge'); + }); + + it('should parse subnet-id label', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-subnet-id:subnet-123456']); + expect(result?.SubnetId).toBe('subnet-123456'); + }); + + it('should parse availability-zone label', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-availability-zone:us-east-1a']); + expect(result?.AvailabilityZone).toBe('us-east-1a'); + }); + + it('should parse availability-zone-id label', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-availability-zone-id:use1-az1']); + expect(result?.AvailabilityZoneId).toBe('use1-az1'); + }); + + it('should parse max-price label', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-max-price:0.50']); + expect(result?.MaxPrice).toBe('0.50'); + }); + + it('should parse priority label as number', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-priority:1']); + expect(result?.Priority).toBe(1); + }); + + it('should parse weighted-capacity label as number', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-weighted-capacity:2']); + expect(result?.WeightedCapacity).toBe(2); + }); + + it('should parse image-id label', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-image-id:ami-12345678']); + expect(result?.ImageId).toBe('ami-12345678'); + }); + + it('should parse multiple basic fleet overrides', () => { + const result = scaleUpModule.parseEc2OverrideConfig([ + 'ghr-ec2-instance-type:r5.2xlarge', + 'ghr-ec2-max-price:1.00', + 'ghr-ec2-priority:2', + ]); + expect(result?.InstanceType).toBe('r5.2xlarge'); + expect(result?.MaxPrice).toBe('1.00'); + expect(result?.Priority).toBe(2); + }); + }); + + describe('Placement', () => { + it('should parse placement-group label', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-placement-group:my-placement-group']); + expect(result?.Placement?.GroupName).toBe('my-placement-group'); + }); + + it('should parse placement-tenancy label', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-placement-tenancy:dedicated']); + expect(result?.Placement?.Tenancy).toBe('dedicated'); + }); + + it('should parse placement-host-id label', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-placement-host-id:h-1234567890abcdef']); + expect(result?.Placement?.HostId).toBe('h-1234567890abcdef'); + }); + + it('should parse placement-affinity label', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-placement-affinity:host']); + expect(result?.Placement?.Affinity).toBe('host'); + }); + + it('should parse placement-partition-number label as number', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-placement-partition-number:3']); + expect(result?.Placement?.PartitionNumber).toBe(3); + }); + + it('should parse placement-availability-zone label', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-placement-availability-zone:us-west-2b']); + expect(result?.Placement?.AvailabilityZone).toBe('us-west-2b'); + }); + + it('should parse placement-spread-domain label', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-placement-spread-domain:my-spread-domain']); + expect(result?.Placement?.SpreadDomain).toBe('my-spread-domain'); + }); + + it('should parse placement-host-resource-group-arn label', () => { + const result = scaleUpModule.parseEc2OverrideConfig([ + 'ghr-ec2-placement-host-resource-group-arn:arn:aws:ec2:us-east-1:123456789012:host-resource-group/hrg-1234', + ]); + expect(result?.Placement?.HostResourceGroupArn).toBe( + 'arn:aws:ec2:us-east-1:123456789012:host-resource-group/hrg-1234', ); }); + + it('should parse multiple placement labels', () => { + const result = scaleUpModule.parseEc2OverrideConfig([ + 'ghr-ec2-placement-group:group-1', + 'ghr-ec2-placement-tenancy:dedicated', + 'ghr-ec2-placement-availability-zone:us-east-1b', + ]); + expect(result?.Placement?.GroupName).toBe('group-1'); + expect(result?.Placement?.Tenancy).toBe('dedicated'); + expect(result?.Placement?.AvailabilityZone).toBe('us-east-1b'); + }); + }); + + describe('Block Device Mappings', () => { + it('should parse ebs-volume-size label as number', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-ebs-volume-size:100']); + expect(result?.BlockDeviceMappings?.[0]?.Ebs?.VolumeSize).toBe(100); + }); + + it('should parse ebs-volume-type label', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-ebs-volume-type:gp3']); + expect(result?.BlockDeviceMappings?.[0]?.Ebs?.VolumeType).toBe('gp3'); + }); + + it('should parse ebs-iops label as number', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-ebs-iops:3000']); + expect(result?.BlockDeviceMappings?.[0]?.Ebs?.Iops).toBe(3000); + }); + + it('should parse ebs-throughput label as number', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-ebs-throughput:250']); + expect(result?.BlockDeviceMappings?.[0]?.Ebs?.Throughput).toBe(250); + }); + + it('should parse ebs-encrypted label as boolean true', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-ebs-encrypted:true']); + expect(result?.BlockDeviceMappings?.[0]?.Ebs?.Encrypted).toBe(true); + }); + + it('should parse ebs-encrypted label as boolean false', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-ebs-encrypted:false']); + expect(result?.BlockDeviceMappings?.[0]?.Ebs?.Encrypted).toBe(false); + }); + + it('should parse ebs-kms-key-id label', () => { + const result = scaleUpModule.parseEc2OverrideConfig([ + 'ghr-ec2-ebs-kms-key-id:arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012', + ]); + expect(result?.BlockDeviceMappings?.[0]?.Ebs?.KmsKeyId).toBe( + 'arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012', + ); + }); + + it('should parse ebs-delete-on-termination label as boolean true', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-ebs-delete-on-termination:true']); + expect(result?.BlockDeviceMappings?.[0]?.Ebs?.DeleteOnTermination).toBe(true); + }); + + it('should parse ebs-delete-on-termination label as boolean false', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-ebs-delete-on-termination:false']); + expect(result?.BlockDeviceMappings?.[0]?.Ebs?.DeleteOnTermination).toBe(false); + }); + + it('should parse ebs-snapshot-id label', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-ebs-snapshot-id:snap-1234567890abcdef']); + expect(result?.BlockDeviceMappings?.[0]?.Ebs?.SnapshotId).toBe('snap-1234567890abcdef'); + }); + + it('should parse block-device-virtual-name label', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-block-device-virtual-name:ephemeral0']); + expect(result?.BlockDeviceMappings?.[0]?.VirtualName).toBe('ephemeral0'); + }); + + it('should parse block-device-no-device label', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-block-device-no-device:true']); + expect(result?.BlockDeviceMappings?.[0]?.NoDevice).toBe('true'); + }); + + it('should parse multiple block device mapping labels', () => { + const result = scaleUpModule.parseEc2OverrideConfig([ + 'ghr-ec2-ebs-volume-size:200', + 'ghr-ec2-ebs-volume-type:gp3', + 'ghr-ec2-ebs-iops:5000', + 'ghr-ec2-ebs-encrypted:true', + ]); + expect(result?.BlockDeviceMappings?.[0]?.Ebs?.VolumeSize).toBe(200); + expect(result?.BlockDeviceMappings?.[0]?.Ebs?.VolumeType).toBe('gp3'); + expect(result?.BlockDeviceMappings?.[0]?.Ebs?.Iops).toBe(5000); + expect(result?.BlockDeviceMappings?.[0]?.Ebs?.Encrypted).toBe(true); + }); + + it('should initialize BlockDeviceMappings when not present', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-ebs-volume-size:50']); + expect(result?.BlockDeviceMappings).toBeDefined(); + // expect(result?.BlockDeviceMappings?.[0]?.DeviceName).toBe('/dev/sda1'); + }); }); + describe('Instance Requirements - vCPU and Memory', () => { + it('should parse vcpu-count-min label', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-vcpu-count-min:4']); + expect(result?.InstanceRequirements?.VCpuCount?.Min).toBe(4); + }); + + it('should parse vcpu-count-max label', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-vcpu-count-max:16']); + expect(result?.InstanceRequirements?.VCpuCount?.Max).toBe(16); + }); + + it('should parse both vcpu-count-min and vcpu-count-max labels', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-vcpu-count-min:2', 'ghr-ec2-vcpu-count-max:8']); + expect(result?.InstanceRequirements?.VCpuCount?.Min).toBe(2); + expect(result?.InstanceRequirements?.VCpuCount?.Max).toBe(8); + }); + + it('should parse memory-mib-min label', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-memory-mib-min:8192']); + expect(result?.InstanceRequirements?.MemoryMiB?.Min).toBe(8192); + }); + + it('should parse memory-mib-max label', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-memory-mib-max:32768']); + expect(result?.InstanceRequirements?.MemoryMiB?.Max).toBe(32768); + }); + + it('should parse both memory-mib-min and memory-mib-max labels', () => { + const result = scaleUpModule.parseEc2OverrideConfig([ + 'ghr-ec2-memory-mib-min:16384', + 'ghr-ec2-memory-mib-max:65536', + ]); + expect(result?.InstanceRequirements?.MemoryMiB?.Min).toBe(16384); + expect(result?.InstanceRequirements?.MemoryMiB?.Max).toBe(65536); + }); + + it('should parse memory-gib-per-vcpu-min label', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-memory-gib-per-vcpu-min:2']); + expect(result?.InstanceRequirements?.MemoryGiBPerVCpu?.Min).toBe(2); + }); + + it('should parse memory-gib-per-vcpu-max label', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-memory-gib-per-vcpu-max:8']); + expect(result?.InstanceRequirements?.MemoryGiBPerVCpu?.Max).toBe(8); + }); + + it('should parse combined vCPU and memory requirements', () => { + const result = scaleUpModule.parseEc2OverrideConfig([ + 'ghr-ec2-vcpu-count-min:8', + 'ghr-ec2-vcpu-count-max:32', + 'ghr-ec2-memory-mib-min:32768', + 'ghr-ec2-memory-mib-max:131072', + ]); + expect(result?.InstanceRequirements?.VCpuCount?.Min).toBe(8); + expect(result?.InstanceRequirements?.VCpuCount?.Max).toBe(32); + expect(result?.InstanceRequirements?.MemoryMiB?.Min).toBe(32768); + expect(result?.InstanceRequirements?.MemoryMiB?.Max).toBe(131072); + }); + }); + + describe('Instance Requirements - CPU and Performance', () => { + it('should parse cpu-manufacturers as single value', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-cpu-manufacturers:intel']); + expect(result?.InstanceRequirements?.CpuManufacturers).toEqual(['intel']); + }); + + it('should parse cpu-manufacturers as comma-separated list', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-cpu-manufacturers:intel,amd']); + expect(result?.InstanceRequirements?.CpuManufacturers).toEqual(['intel', 'amd']); + }); + + it('should parse instance-generations as single value', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-instance-generations:current']); + expect(result?.InstanceRequirements?.InstanceGenerations).toEqual(['current']); + }); + + it('should parse instance-generations as comma-separated list', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-instance-generations:current,previous']); + expect(result?.InstanceRequirements?.InstanceGenerations).toEqual(['current', 'previous']); + }); + + it('should parse excluded-instance-types as single value', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-excluded-instance-types:t2.micro']); + expect(result?.InstanceRequirements?.ExcludedInstanceTypes).toEqual(['t2.micro']); + }); + + it('should parse excluded-instance-types as comma-separated list', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-excluded-instance-types:t2.micro,t2.small']); + expect(result?.InstanceRequirements?.ExcludedInstanceTypes).toEqual(['t2.micro', 't2.small']); + }); + + it('should parse allowed-instance-types as single value', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-allowed-instance-types:c5.xlarge']); + expect(result?.InstanceRequirements?.AllowedInstanceTypes).toEqual(['c5.xlarge']); + }); + + it('should parse allowed-instance-types as comma-separated list', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-allowed-instance-types:c5.xlarge,c5.2xlarge']); + expect(result?.InstanceRequirements?.AllowedInstanceTypes).toEqual(['c5.xlarge', 'c5.2xlarge']); + }); + + it('should parse burstable-performance label', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-burstable-performance:included']); + expect(result?.InstanceRequirements?.BurstablePerformance).toBe('included'); + }); + + it('should parse bare-metal label', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-bare-metal:excluded']); + expect(result?.InstanceRequirements?.BareMetal).toBe('excluded'); + }); + }); + + describe('Instance Requirements - Accelerators', () => { + it('should parse accelerator-count-min label', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-accelerator-count-min:1']); + expect(result?.InstanceRequirements?.AcceleratorCount?.Min).toBe(1); + }); + + it('should parse accelerator-count-max label', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-accelerator-count-max:4']); + expect(result?.InstanceRequirements?.AcceleratorCount?.Max).toBe(4); + }); + + it('should parse both accelerator-count-min and accelerator-count-max', () => { + const result = scaleUpModule.parseEc2OverrideConfig([ + 'ghr-ec2-accelerator-count-min:1', + 'ghr-ec2-accelerator-count-max:2', + ]); + expect(result?.InstanceRequirements?.AcceleratorCount?.Min).toBe(1); + expect(result?.InstanceRequirements?.AcceleratorCount?.Max).toBe(2); + }); + + it('should parse accelerator-types as single value', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-accelerator-types:gpu']); + expect(result?.InstanceRequirements?.AcceleratorTypes).toEqual(['gpu']); + }); + + it('should parse accelerator-types as comma-separated list', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-accelerator-types:gpu,fpga']); + expect(result?.InstanceRequirements?.AcceleratorTypes).toEqual(['gpu', 'fpga']); + }); + + it('should parse accelerator-manufacturers as single value', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-accelerator-manufacturers:nvidia']); + expect(result?.InstanceRequirements?.AcceleratorManufacturers).toEqual(['nvidia']); + }); + + it('should parse accelerator-manufacturers as comma-separated list', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-accelerator-manufacturers:nvidia,amd']); + expect(result?.InstanceRequirements?.AcceleratorManufacturers).toEqual(['nvidia', 'amd']); + }); + + it('should parse accelerator-names as single value', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-accelerator-names:a100']); + expect(result?.InstanceRequirements?.AcceleratorNames).toEqual(['a100']); + }); + + it('should parse accelerator-names as comma-separated list', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-accelerator-names:a100,v100']); + expect(result?.InstanceRequirements?.AcceleratorNames).toEqual(['a100', 'v100']); + }); + + it('should parse accelerator-total-memory-mib-min label', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-accelerator-total-memory-mib-min:8192']); + expect(result?.InstanceRequirements?.AcceleratorTotalMemoryMiB?.Min).toBe(8192); + }); + + it('should parse accelerator-total-memory-mib-max label', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-accelerator-total-memory-mib-max:40960']); + expect(result?.InstanceRequirements?.AcceleratorTotalMemoryMiB?.Max).toBe(40960); + }); + + it('should parse combined accelerator requirements', () => { + const result = scaleUpModule.parseEc2OverrideConfig([ + 'ghr-ec2-accelerator-count-min:1', + 'ghr-ec2-accelerator-count-max:2', + 'ghr-ec2-accelerator-types:gpu', + 'ghr-ec2-accelerator-manufacturers:nvidia', + ]); + expect(result?.InstanceRequirements?.AcceleratorCount?.Min).toBe(1); + expect(result?.InstanceRequirements?.AcceleratorCount?.Max).toBe(2); + expect(result?.InstanceRequirements?.AcceleratorTypes).toEqual(['gpu']); + expect(result?.InstanceRequirements?.AcceleratorManufacturers).toEqual(['nvidia']); + }); + }); + + describe('Instance Requirements - Network and Storage', () => { + it('should parse network-interface-count-min label', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-network-interface-count-min:2']); + expect(result?.InstanceRequirements?.NetworkInterfaceCount?.Min).toBe(2); + }); + + it('should parse network-interface-count-max label', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-network-interface-count-max:4']); + expect(result?.InstanceRequirements?.NetworkInterfaceCount?.Max).toBe(4); + }); + + it('should parse network-bandwidth-gbps-min label', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-network-bandwidth-gbps-min:5']); + expect(result?.InstanceRequirements?.NetworkBandwidthGbps?.Min).toBe(5); + }); + + it('should parse network-bandwidth-gbps-max label', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-network-bandwidth-gbps-max:25']); + expect(result?.InstanceRequirements?.NetworkBandwidthGbps?.Max).toBe(25); + }); + + it('should parse local-storage label', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-local-storage:included']); + expect(result?.InstanceRequirements?.LocalStorage).toBe('included'); + }); + + it('should parse local-storage-types as single value', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-local-storage-types:ssd']); + expect(result?.InstanceRequirements?.LocalStorageTypes).toEqual(['ssd']); + }); + + it('should parse local-storage-types as comma-separated list', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-local-storage-types:hdd,ssd']); + expect(result?.InstanceRequirements?.LocalStorageTypes).toEqual(['hdd', 'ssd']); + }); + + it('should parse total-local-storage-gb-min label', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-total-local-storage-gb-min:100']); + expect(result?.InstanceRequirements?.TotalLocalStorageGB?.Min).toBe(100); + }); + + it('should parse total-local-storage-gb-max label', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-total-local-storage-gb-max:1000']); + expect(result?.InstanceRequirements?.TotalLocalStorageGB?.Max).toBe(1000); + }); + + it('should parse baseline-ebs-bandwidth-mbps-min label', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-baseline-ebs-bandwidth-mbps-min:500']); + expect(result?.InstanceRequirements?.BaselineEbsBandwidthMbps?.Min).toBe(500); + }); + + it('should parse baseline-ebs-bandwidth-mbps-max label', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-baseline-ebs-bandwidth-mbps-max:2000']); + expect(result?.InstanceRequirements?.BaselineEbsBandwidthMbps?.Max).toBe(2000); + }); + }); + + describe('Instance Requirements - Pricing and Other', () => { + it('should parse spot-max-price-percentage-over-lowest-price label', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-spot-max-price-percentage-over-lowest-price:50']); + expect(result?.InstanceRequirements?.SpotMaxPricePercentageOverLowestPrice).toBe(50); + }); + + it('should parse on-demand-max-price-percentage-over-lowest-price label', () => { + const result = scaleUpModule.parseEc2OverrideConfig([ + 'ghr-ec2-on-demand-max-price-percentage-over-lowest-price:75', + ]); + expect(result?.InstanceRequirements?.OnDemandMaxPricePercentageOverLowestPrice).toBe(75); + }); + + it('should parse max-spot-price-as-percentage-of-optimal-on-demand-price label', () => { + const result = scaleUpModule.parseEc2OverrideConfig([ + 'ghr-ec2-max-spot-price-as-percentage-of-optimal-on-demand-price:60', + ]); + expect(result?.InstanceRequirements?.MaxSpotPriceAsPercentageOfOptimalOnDemandPrice).toBe(60); + }); + + it('should parse require-hibernate-support label as boolean true', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-require-hibernate-support:true']); + expect(result?.InstanceRequirements?.RequireHibernateSupport).toBe(true); + }); + + it('should parse require-hibernate-support label as boolean false', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-require-hibernate-support:false']); + expect(result?.InstanceRequirements?.RequireHibernateSupport).toBe(false); + }); + + it('should parse require-encryption-in-transit label as boolean true', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-require-encryption-in-transit:true']); + expect(result?.InstanceRequirements?.RequireEncryptionInTransit).toBe(true); + }); + + it('should parse require-encryption-in-transit label as boolean false', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-require-encryption-in-transit:false']); + expect(result?.InstanceRequirements?.RequireEncryptionInTransit).toBe(false); + }); + + it('should parse baseline-performance-factors-cpu-reference-families label', () => { + const result = scaleUpModule.parseEc2OverrideConfig([ + 'ghr-ec2-baseline-performance-factors-cpu-reference-families:intel', + ]); + expect(result?.InstanceRequirements?.BaselinePerformanceFactors?.Cpu?.References?.[0]?.InstanceFamily).toBe( + 'intel', + ); + }); + it('should parse baseline-performance-factors-cpu-reference-families list label', () => { + const result = scaleUpModule.parseEc2OverrideConfig([ + 'ghr-ec2-baseline-performance-factors-cpu-reference-families:intel,amd', + ]); + expect(result?.InstanceRequirements?.BaselinePerformanceFactors?.Cpu?.References?.[0]?.InstanceFamily).toBe( + 'intel', + ); + expect(result?.InstanceRequirements?.BaselinePerformanceFactors?.Cpu?.References?.[1]?.InstanceFamily).toBe( + 'amd', +>>>>>>> 44df86d7 (test: fix test cases) + ); + }); + }); + +<<<<<<< HEAD it('calls publishRetryMessage after runner creation', async () => { const messages = createTestMessages(1); mockCreateRunner.mockResolvedValue(['i-12345']); // Create the requested runner @@ -2381,6 +2881,204 @@ describe('Retry mechanism tests', () => { await scaleUpModule.scaleUp(messages); expect(callOrder).toEqual(['createRunner', 'publishRetryMessage']); +======= + describe('Edge Cases', () => { + it('should return undefined when empty array is provided', () => { + const result = scaleUpModule.parseEc2OverrideConfig([]); + expect(result).toBeUndefined(); + }); + + it('should return undefined when no ghr-ec2 labels are provided', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['self-hosted', 'linux', 'x64']); + expect(result).toBeUndefined(); + }); + + it('should ignore non-ghr-ec2 labels and only parse ghr-ec2 labels', () => { + const result = scaleUpModule.parseEc2OverrideConfig([ + 'self-hosted', + 'ghr-ec2-instance-type:m5.large', + 'linux', + 'ghr-ec2-max-price:0.30', + ]); + expect(result?.InstanceType).toBe('m5.large'); + expect(result?.MaxPrice).toBe('0.30'); + }); + + it('should handle labels with colons in values (ARNs)', () => { + const result = scaleUpModule.parseEc2OverrideConfig([ + 'ghr-ec2-ebs-kms-key-id:arn:aws:kms:us-east-1:123456789012:key/abc-def-ghi', + ]); + expect(result?.BlockDeviceMappings?.[0]?.Ebs?.KmsKeyId).toBe( + 'arn:aws:kms:us-east-1:123456789012:key/abc-def-ghi', + ); + }); + + it('should handle labels with colons in placement ARNs', () => { + const result = scaleUpModule.parseEc2OverrideConfig([ + 'ghr-ec2-placement-host-resource-group-arn:arn:aws:ec2:us-west-2:123456789012:host-resource-group/hrg-abc123', + ]); + expect(result?.Placement?.HostResourceGroupArn).toBe( + 'arn:aws:ec2:us-west-2:123456789012:host-resource-group/hrg-abc123', + ); + }); + + it('should handle labels without values gracefully', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-instance-type:', 'ghr-ec2-max-price:0.50']); + expect(result?.InstanceType).toBeUndefined(); + expect(result?.MaxPrice).toBe('0.50'); + }); + + it('should handle malformed labels (no colon) gracefully', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-instance-type-m5-large', 'ghr-ec2-max-price:0.50']); + expect(result?.MaxPrice).toBe('0.50'); + expect(result?.InstanceType).toBeUndefined(); + }); + + it('should handle numeric strings correctly for number fields', () => { + const result = scaleUpModule.parseEc2OverrideConfig([ + 'ghr-ec2-priority:5', + 'ghr-ec2-weighted-capacity:10', + 'ghr-ec2-vcpu-count-min:4', + ]); + expect(result?.Priority).toBe(5); + expect(result?.WeightedCapacity).toBe(10); + expect(result?.InstanceRequirements?.VCpuCount?.Min).toBe(4); + }); + + it('should handle boolean strings correctly for boolean fields', () => { + const result = scaleUpModule.parseEc2OverrideConfig([ + 'ghr-ec2-ebs-encrypted:true', + 'ghr-ec2-ebs-delete-on-termination:false', + 'ghr-ec2-require-hibernate-support:true', + ]); + expect(result?.BlockDeviceMappings?.[0]?.Ebs?.Encrypted).toBe(true); + expect(result?.BlockDeviceMappings?.[0]?.Ebs?.DeleteOnTermination).toBe(false); + expect(result?.InstanceRequirements?.RequireHibernateSupport).toBe(true); + }); + + it('should handle floating point numbers in max-price', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-max-price:0.12345']); + expect(result?.MaxPrice).toBe('0.12345'); + }); + + it('should handle whitespace in comma-separated lists', () => { + const result = scaleUpModule.parseEc2OverrideConfig(['ghr-ec2-cpu-manufacturers: intel , amd ']); + expect(result?.InstanceRequirements?.CpuManufacturers).toEqual([' intel ', ' amd ']); + }); + + it('should return config with all parsed labels', () => { + const result = scaleUpModule.parseEc2OverrideConfig([ + 'ghr-ec2-instance-type:c5.xlarge', + 'ghr-ec2-vcpu-count-min:4', + 'ghr-ec2-memory-mib-min:8192', + 'ghr-ec2-placement-tenancy:dedicated', + 'ghr-ec2-ebs-volume-size:100', + ]); + expect(result?.InstanceType).toBe('c5.xlarge'); + expect(result?.InstanceRequirements?.VCpuCount?.Min).toBe(4); + expect(result?.InstanceRequirements?.MemoryMiB?.Min).toBe(8192); + expect(result?.Placement?.Tenancy).toBe('dedicated'); + expect(result?.BlockDeviceMappings?.[0]?.Ebs?.VolumeSize).toBe(100); + }); + }); + + describe('Complex Scenarios', () => { + it('should handle comprehensive EC2 configuration with all categories', () => { + const result = scaleUpModule.parseEc2OverrideConfig([ + // Basic Fleet + 'ghr-ec2-instance-type:r5.2xlarge', + 'ghr-ec2-max-price:0.75', + 'ghr-ec2-priority:1', + // Placement + 'ghr-ec2-placement-group:my-group', + 'ghr-ec2-placement-tenancy:dedicated', + // Block Device + 'ghr-ec2-ebs-volume-size:200', + 'ghr-ec2-ebs-volume-type:gp3', + 'ghr-ec2-ebs-encrypted:true', + // Instance Requirements + 'ghr-ec2-vcpu-count-min:8', + 'ghr-ec2-vcpu-count-max:32', + 'ghr-ec2-memory-mib-min:32768', + 'ghr-ec2-cpu-manufacturers:intel,amd', + 'ghr-ec2-instance-generations:current', + ]); + + expect(result?.InstanceType).toBe('r5.2xlarge'); + expect(result?.MaxPrice).toBe('0.75'); + expect(result?.Priority).toBe(1); + expect(result?.Placement?.GroupName).toBe('my-group'); + expect(result?.Placement?.Tenancy).toBe('dedicated'); + expect(result?.BlockDeviceMappings?.[0]?.Ebs?.VolumeSize).toBe(200); + expect(result?.BlockDeviceMappings?.[0]?.Ebs?.VolumeType).toBe('gp3'); + expect(result?.BlockDeviceMappings?.[0]?.Ebs?.Encrypted).toBe(true); + expect(result?.InstanceRequirements?.VCpuCount?.Min).toBe(8); + expect(result?.InstanceRequirements?.VCpuCount?.Max).toBe(32); + expect(result?.InstanceRequirements?.MemoryMiB?.Min).toBe(32768); + expect(result?.InstanceRequirements?.CpuManufacturers).toEqual(['intel', 'amd']); + expect(result?.InstanceRequirements?.InstanceGenerations).toEqual(['current']); + }); + + it('should handle GPU instance configuration', () => { + const result = scaleUpModule.parseEc2OverrideConfig([ + 'ghr-ec2-accelerator-count-min:1', + 'ghr-ec2-accelerator-count-max:4', + 'ghr-ec2-accelerator-types:gpu', + 'ghr-ec2-accelerator-manufacturers:nvidia', + 'ghr-ec2-accelerator-names:a100,v100', + 'ghr-ec2-accelerator-total-memory-mib-min:16384', + ]); + + expect(result?.InstanceRequirements?.AcceleratorCount?.Min).toBe(1); + expect(result?.InstanceRequirements?.AcceleratorCount?.Max).toBe(4); + expect(result?.InstanceRequirements?.AcceleratorTypes).toEqual(['gpu']); + expect(result?.InstanceRequirements?.AcceleratorManufacturers).toEqual(['nvidia']); + expect(result?.InstanceRequirements?.AcceleratorNames).toEqual(['a100', 'v100']); + expect(result?.InstanceRequirements?.AcceleratorTotalMemoryMiB?.Min).toBe(16384); + }); + + it('should handle network-optimized instance configuration', () => { + const result = scaleUpModule.parseEc2OverrideConfig([ + 'ghr-ec2-network-interface-count-min:2', + 'ghr-ec2-network-interface-count-max:8', + 'ghr-ec2-network-bandwidth-gbps-min:10', + 'ghr-ec2-network-bandwidth-gbps-max:100', + 'ghr-ec2-baseline-ebs-bandwidth-mbps-min:1000', + ]); + + expect(result?.InstanceRequirements?.NetworkInterfaceCount?.Min).toBe(2); + expect(result?.InstanceRequirements?.NetworkInterfaceCount?.Max).toBe(8); + expect(result?.InstanceRequirements?.NetworkBandwidthGbps?.Min).toBe(10); + expect(result?.InstanceRequirements?.NetworkBandwidthGbps?.Max).toBe(100); + expect(result?.InstanceRequirements?.BaselineEbsBandwidthMbps?.Min).toBe(1000); + }); + + it('should handle storage-optimized instance configuration', () => { + const result = scaleUpModule.parseEc2OverrideConfig([ + 'ghr-ec2-local-storage:included', + 'ghr-ec2-local-storage-types:ssd', + 'ghr-ec2-total-local-storage-gb-min:500', + 'ghr-ec2-total-local-storage-gb-max:2000', + ]); + + expect(result?.InstanceRequirements?.LocalStorage).toBe('included'); + expect(result?.InstanceRequirements?.LocalStorageTypes).toEqual(['ssd']); + expect(result?.InstanceRequirements?.TotalLocalStorageGB?.Min).toBe(500); + expect(result?.InstanceRequirements?.TotalLocalStorageGB?.Max).toBe(2000); + }); + + it('should handle spot instance configuration with pricing', () => { + const result = scaleUpModule.parseEc2OverrideConfig([ + 'ghr-ec2-max-price:0.50', + 'ghr-ec2-spot-max-price-percentage-over-lowest-price:100', + 'ghr-ec2-on-demand-max-price-percentage-over-lowest-price:150', + ]); + + expect(result?.MaxPrice).toBe('0.50'); + expect(result?.InstanceRequirements?.SpotMaxPricePercentageOverLowestPrice).toBe(100); + expect(result?.InstanceRequirements?.OnDemandMaxPricePercentageOverLowestPrice).toBe(150); + }); +>>>>>>> 44df86d7 (test: fix test cases) }); }); diff --git a/lambdas/functions/control-plane/src/scale-runners/scale-up.ts b/lambdas/functions/control-plane/src/scale-runners/scale-up.ts index 91e0027d24..d7b597e906 100644 --- a/lambdas/functions/control-plane/src/scale-runners/scale-up.ts +++ b/lambdas/functions/control-plane/src/scale-runners/scale-up.ts @@ -7,7 +7,41 @@ import { createGithubAppAuth, createGithubInstallationAuth, createOctokitClient import { createRunner, listEC2Runners, tag, terminateRunner } from './../aws/runners'; import { Ec2OverrideConfig, RunnerInputParameters } from './../aws/runners.d'; import { metricGitHubAppRateLimit } from '../github/rate-limit'; +<<<<<<< HEAD import { publishRetryMessage } from './job-retry'; +======= +import { + _InstanceType, + Affinity, + Tenancy, + VolumeType, + CpuManufacturer, + InstanceGeneration, + BurstablePerformance, + BareMetal, + AcceleratorType, + AcceleratorManufacturer, + AcceleratorName, + LocalStorage, + LocalStorageType, + type Placement, + type BaselinePerformanceFactorsRequest, + type FleetEbsBlockDeviceRequest, + type CpuPerformanceFactorRequest, + type PerformanceFactorReferenceRequest, + type FleetBlockDeviceMappingRequest, + type InstanceRequirementsRequest, + type VCpuCountRangeRequest, + type MemoryMiBRequest, + type MemoryGiBPerVCpuRequest, + type AcceleratorCountRequest, + type AcceleratorTotalMemoryMiBRequest, + type NetworkInterfaceCountRequest, + type NetworkBandwidthGbpsRequest, + type TotalLocalStorageGBRequest, + type BaselineEbsBandwidthMbpsRequest, +} from '@aws-sdk/client-ec2'; +>>>>>>> 44df86d7 (test: fix test cases) const logger = createChildLogger('scale-up'); @@ -832,7 +866,7 @@ async function createJitConfig( * @param labels - Array of GitHub workflow job labels * @returns EC2 override configuration object or undefined if no valid config found */ -function parseEc2OverrideConfig(labels: string[]): Ec2OverrideConfig | undefined { +export function parseEc2OverrideConfig(labels: string[]): Ec2OverrideConfig | undefined { const ec2Labels = labels.filter((l) => l.startsWith('ghr-ec2-')); const config: Partial = {}; @@ -844,7 +878,7 @@ function parseEc2OverrideConfig(labels: string[]): Ec2OverrideConfig | undefined // Basic Fleet Overrides if (key === 'instance-type') { - config.InstanceType = value; + config.InstanceType = value as _InstanceType; } else if (key === 'subnet-id') { config.SubnetId = value; } else if (key === 'availability-zone') { @@ -863,12 +897,12 @@ function parseEc2OverrideConfig(labels: string[]): Ec2OverrideConfig | undefined // Placement else if (key.startsWith('placement-')) { - config.Placement = config.Placement || {}; + config.Placement = config.Placement || ({} as Placement); const placementKey = key.replace('placement-', ''); if (placementKey === 'group') { config.Placement.GroupName = value; } else if (placementKey === 'tenancy') { - config.Placement.Tenancy = value; + config.Placement.Tenancy = value as Tenancy; } else if (placementKey === 'host-id') { config.Placement.HostId = value; } else if (placementKey === 'affinity') { @@ -886,14 +920,15 @@ function parseEc2OverrideConfig(labels: string[]): Ec2OverrideConfig | undefined // Block Device Mappings (EBS) else if (key.startsWith('ebs-')) { - config.BlockDeviceMappings = config.BlockDeviceMappings || [{ DeviceName: '/dev/sda1', Ebs: {} }]; + config.BlockDeviceMappings = config.BlockDeviceMappings || ([{}] as FleetBlockDeviceMappingRequest[]); const ebsKey = key.replace('ebs-', ''); - const ebs = config.BlockDeviceMappings[0].Ebs; + const ebs = + config.BlockDeviceMappings[0].Ebs || (config.BlockDeviceMappings[0].Ebs = {} as FleetEbsBlockDeviceRequest); if (ebsKey === 'volume-size') { ebs.VolumeSize = parseInt(value, 10); } else if (ebsKey === 'volume-type') { - ebs.VolumeType = value; + ebs.VolumeType = value as VolumeType; } else if (ebsKey === 'iops') { ebs.Iops = parseInt(value, 10); } else if (ebsKey === 'throughput') { @@ -911,130 +946,138 @@ function parseEc2OverrideConfig(labels: string[]): Ec2OverrideConfig | undefined // Block Device Mappings (Non-EBS) else if (key === 'block-device-virtual-name') { - config.BlockDeviceMappings = config.BlockDeviceMappings || [{ DeviceName: '/dev/sda1', Ebs: {} }]; + config.BlockDeviceMappings = config.BlockDeviceMappings || ([{}] as FleetBlockDeviceMappingRequest[]); config.BlockDeviceMappings[0].VirtualName = value; } else if (key === 'block-device-no-device') { - config.BlockDeviceMappings = config.BlockDeviceMappings || [{ DeviceName: '/dev/sda1', Ebs: {} }]; + config.BlockDeviceMappings = config.BlockDeviceMappings || ([{}] as FleetBlockDeviceMappingRequest[]); config.BlockDeviceMappings[0].NoDevice = value; } // Instance Requirements - vCPU & Memory else if (key.startsWith('vcpu-count-')) { - config.InstanceRequirements = config.InstanceRequirements || {}; - config.InstanceRequirements.VCpuCount = config.InstanceRequirements.VCpuCount || {}; + config.InstanceRequirements = config.InstanceRequirements || ({} as InstanceRequirementsRequest); + config.InstanceRequirements.VCpuCount = config.InstanceRequirements.VCpuCount || ({} as VCpuCountRangeRequest); const subKey = key.replace('vcpu-count-', ''); - config.InstanceRequirements.VCpuCount[subKey === 'min' ? 'Min' : 'Max'] = parseInt(value, 10); + config.InstanceRequirements.VCpuCount![subKey === 'min' ? 'Min' : 'Max'] = parseInt(value, 10); } else if (key.startsWith('memory-mib-')) { - config.InstanceRequirements = config.InstanceRequirements || {}; - config.InstanceRequirements.MemoryMiB = config.InstanceRequirements.MemoryMiB || {}; + config.InstanceRequirements = config.InstanceRequirements || ({} as InstanceRequirementsRequest); + config.InstanceRequirements.MemoryMiB = config.InstanceRequirements.MemoryMiB || ({} as MemoryMiBRequest); const subKey = key.replace('memory-mib-', ''); - config.InstanceRequirements.MemoryMiB[subKey === 'min' ? 'Min' : 'Max'] = parseInt(value, 10); + config.InstanceRequirements.MemoryMiB![subKey === 'min' ? 'Min' : 'Max'] = parseInt(value, 10); } else if (key.startsWith('memory-gib-per-vcpu-')) { - config.InstanceRequirements = config.InstanceRequirements || {}; - config.InstanceRequirements.MemoryGiBPerVCpu = config.InstanceRequirements.MemoryGiBPerVCpu || {}; + config.InstanceRequirements = config.InstanceRequirements || ({} as InstanceRequirementsRequest); + config.InstanceRequirements.MemoryGiBPerVCpu = + config.InstanceRequirements.MemoryGiBPerVCpu || ({} as MemoryGiBPerVCpuRequest); const subKey = key.replace('memory-gib-per-vcpu-', ''); - config.InstanceRequirements.MemoryGiBPerVCpu[subKey === 'min' ? 'Min' : 'Max'] = parseFloat(value); + config.InstanceRequirements.MemoryGiBPerVCpu![subKey === 'min' ? 'Min' : 'Max'] = parseFloat(value); } // Instance Requirements - CPU & Performance else if (key === 'cpu-manufacturers') { - config.InstanceRequirements = config.InstanceRequirements || {}; - config.InstanceRequirements.CpuManufacturers = value.split(','); + config.InstanceRequirements = config.InstanceRequirements || ({} as InstanceRequirementsRequest); + config.InstanceRequirements.CpuManufacturers = value.split(',') as CpuManufacturer[]; } else if (key === 'instance-generations') { - config.InstanceRequirements = config.InstanceRequirements || {}; - config.InstanceRequirements.InstanceGenerations = value.split(','); + config.InstanceRequirements = config.InstanceRequirements || ({} as InstanceRequirementsRequest); + config.InstanceRequirements.InstanceGenerations = value.split(',') as InstanceGeneration[]; } else if (key === 'excluded-instance-types') { - config.InstanceRequirements = config.InstanceRequirements || {}; + config.InstanceRequirements = config.InstanceRequirements || ({} as InstanceRequirementsRequest); config.InstanceRequirements.ExcludedInstanceTypes = value.split(','); } else if (key === 'allowed-instance-types') { - config.InstanceRequirements = config.InstanceRequirements || {}; + config.InstanceRequirements = config.InstanceRequirements || ({} as InstanceRequirementsRequest); config.InstanceRequirements.AllowedInstanceTypes = value.split(','); } else if (key === 'burstable-performance') { - config.InstanceRequirements = config.InstanceRequirements || {}; - config.InstanceRequirements.BurstablePerformance = value; + config.InstanceRequirements = config.InstanceRequirements || ({} as InstanceRequirementsRequest); + config.InstanceRequirements.BurstablePerformance = value as BurstablePerformance; } else if (key === 'bare-metal') { - config.InstanceRequirements = config.InstanceRequirements || {}; - config.InstanceRequirements.BareMetal = value; + config.InstanceRequirements = config.InstanceRequirements || ({} as InstanceRequirementsRequest); + config.InstanceRequirements.BareMetal = value as BareMetal; } // Instance Requirements - Accelerators else if (key.startsWith('accelerator-count-')) { - config.InstanceRequirements = config.InstanceRequirements || {}; - config.InstanceRequirements.AcceleratorCount = config.InstanceRequirements.AcceleratorCount || {}; + config.InstanceRequirements = config.InstanceRequirements || ({} as InstanceRequirementsRequest); + config.InstanceRequirements.AcceleratorCount = + config.InstanceRequirements.AcceleratorCount || ({} as AcceleratorCountRequest); const subKey = key.replace('accelerator-count-', ''); - config.InstanceRequirements.AcceleratorCount[subKey === 'min' ? 'Min' : 'Max'] = parseInt(value, 10); + config.InstanceRequirements.AcceleratorCount![subKey === 'min' ? 'Min' : 'Max'] = parseInt(value, 10); } else if (key === 'accelerator-types') { - config.InstanceRequirements = config.InstanceRequirements || {}; - config.InstanceRequirements.AcceleratorTypes = value.split(','); + config.InstanceRequirements = config.InstanceRequirements || ({} as InstanceRequirementsRequest); + config.InstanceRequirements.AcceleratorTypes = value.split(',') as AcceleratorType[]; } else if (key === 'accelerator-manufacturers') { - config.InstanceRequirements = config.InstanceRequirements || {}; - config.InstanceRequirements.AcceleratorManufacturers = value.split(','); + config.InstanceRequirements = config.InstanceRequirements || ({} as InstanceRequirementsRequest); + config.InstanceRequirements.AcceleratorManufacturers = value.split(',') as AcceleratorManufacturer[]; } else if (key === 'accelerator-names') { - config.InstanceRequirements = config.InstanceRequirements || {}; - config.InstanceRequirements.AcceleratorNames = value.split(','); - } else if (key.startsWith('accelerator-memory-mib-')) { - config.InstanceRequirements = config.InstanceRequirements || {}; + config.InstanceRequirements = config.InstanceRequirements || ({} as InstanceRequirementsRequest); + config.InstanceRequirements.AcceleratorNames = value.split(',') as AcceleratorName[]; + } else if (key.startsWith('accelerator-total-memory-mib-')) { + config.InstanceRequirements = config.InstanceRequirements || ({} as InstanceRequirementsRequest); config.InstanceRequirements.AcceleratorTotalMemoryMiB = - config.InstanceRequirements.AcceleratorTotalMemoryMiB || {}; - const subKey = key.replace('accelerator-memory-mib-', ''); - config.InstanceRequirements.AcceleratorTotalMemoryMiB[subKey === 'min' ? 'Min' : 'Max'] = parseInt(value, 10); + config.InstanceRequirements.AcceleratorTotalMemoryMiB || ({} as AcceleratorTotalMemoryMiBRequest); + const subKey = key.replace('accelerator-total-memory-mib-', ''); + config.InstanceRequirements.AcceleratorTotalMemoryMiB![subKey === 'min' ? 'Min' : 'Max'] = parseInt(value, 10); } // Instance Requirements - Network else if (key.startsWith('network-interface-count-')) { - config.InstanceRequirements = config.InstanceRequirements || {}; - config.InstanceRequirements.NetworkInterfaceCount = config.InstanceRequirements.NetworkInterfaceCount || {}; + config.InstanceRequirements = config.InstanceRequirements || ({} as InstanceRequirementsRequest); + config.InstanceRequirements.NetworkInterfaceCount = + config.InstanceRequirements.NetworkInterfaceCount || ({} as NetworkInterfaceCountRequest); const subKey = key.replace('network-interface-count-', ''); - config.InstanceRequirements.NetworkInterfaceCount[subKey === 'min' ? 'Min' : 'Max'] = parseInt(value, 10); + config.InstanceRequirements.NetworkInterfaceCount![subKey === 'min' ? 'Min' : 'Max'] = parseInt(value, 10); } else if (key.startsWith('network-bandwidth-gbps-')) { - config.InstanceRequirements = config.InstanceRequirements || {}; - config.InstanceRequirements.NetworkBandwidthGbps = config.InstanceRequirements.NetworkBandwidthGbps || {}; + config.InstanceRequirements = config.InstanceRequirements || ({} as InstanceRequirementsRequest); + config.InstanceRequirements.NetworkBandwidthGbps = + config.InstanceRequirements.NetworkBandwidthGbps || ({} as NetworkBandwidthGbpsRequest); const subKey = key.replace('network-bandwidth-gbps-', ''); - config.InstanceRequirements.NetworkBandwidthGbps[subKey === 'min' ? 'Min' : 'Max'] = parseFloat(value); + config.InstanceRequirements.NetworkBandwidthGbps![subKey === 'min' ? 'Min' : 'Max'] = parseFloat(value); } // Instance Requirements - Storage else if (key === 'local-storage') { - config.InstanceRequirements = config.InstanceRequirements || {}; - config.InstanceRequirements.LocalStorage = value; + config.InstanceRequirements = config.InstanceRequirements || ({} as InstanceRequirementsRequest); + config.InstanceRequirements.LocalStorage = value as LocalStorage; } else if (key === 'local-storage-types') { - config.InstanceRequirements = config.InstanceRequirements || {}; - config.InstanceRequirements.LocalStorageTypes = value.split(','); + config.InstanceRequirements = config.InstanceRequirements || ({} as InstanceRequirementsRequest); + config.InstanceRequirements.LocalStorageTypes = value.split(',') as LocalStorageType[]; } else if (key.startsWith('total-local-storage-gb-')) { - config.InstanceRequirements = config.InstanceRequirements || {}; - config.InstanceRequirements.TotalLocalStorageGB = config.InstanceRequirements.TotalLocalStorageGB || {}; + config.InstanceRequirements = config.InstanceRequirements || ({} as InstanceRequirementsRequest); + config.InstanceRequirements.TotalLocalStorageGB = + config.InstanceRequirements.TotalLocalStorageGB || ({} as TotalLocalStorageGBRequest); const subKey = key.replace('total-local-storage-gb-', ''); - config.InstanceRequirements.TotalLocalStorageGB[subKey === 'min' ? 'Min' : 'Max'] = parseFloat(value); + config.InstanceRequirements.TotalLocalStorageGB![subKey === 'min' ? 'Min' : 'Max'] = parseFloat(value); } else if (key.startsWith('baseline-ebs-bandwidth-mbps-')) { - config.InstanceRequirements = config.InstanceRequirements || {}; - config.InstanceRequirements.BaselineEbsBandwidthMbps = config.InstanceRequirements.BaselineEbsBandwidthMbps || {}; + config.InstanceRequirements = config.InstanceRequirements || ({} as InstanceRequirementsRequest); + config.InstanceRequirements.BaselineEbsBandwidthMbps = + config.InstanceRequirements.BaselineEbsBandwidthMbps || ({} as BaselineEbsBandwidthMbpsRequest); const subKey = key.replace('baseline-ebs-bandwidth-mbps-', ''); - config.InstanceRequirements.BaselineEbsBandwidthMbps[subKey === 'min' ? 'Min' : 'Max'] = parseInt(value, 10); + config.InstanceRequirements.BaselineEbsBandwidthMbps![subKey === 'min' ? 'Min' : 'Max'] = parseInt(value, 10); } // Instance Requirements - Pricing & Other - else if (key === 'spot-max-price-percentage') { - config.InstanceRequirements = config.InstanceRequirements || {}; + else if (key === 'spot-max-price-percentage-over-lowest-price') { + config.InstanceRequirements = config.InstanceRequirements || ({} as InstanceRequirementsRequest); config.InstanceRequirements.SpotMaxPricePercentageOverLowestPrice = parseInt(value, 10); - } else if (key === 'on-demand-max-price-percentage') { - config.InstanceRequirements = config.InstanceRequirements || {}; + } else if (key === 'on-demand-max-price-percentage-over-lowest-price') { + config.InstanceRequirements = config.InstanceRequirements || ({} as InstanceRequirementsRequest); config.InstanceRequirements.OnDemandMaxPricePercentageOverLowestPrice = parseInt(value, 10); - } else if (key === 'max-spot-price-percentage-optimal') { - config.InstanceRequirements = config.InstanceRequirements || {}; + } else if (key === 'max-spot-price-as-percentage-of-optimal-on-demand-price') { + config.InstanceRequirements = config.InstanceRequirements || ({} as InstanceRequirementsRequest); config.InstanceRequirements.MaxSpotPriceAsPercentageOfOptimalOnDemandPrice = parseInt(value, 10); } else if (key === 'require-hibernate-support') { - config.InstanceRequirements = config.InstanceRequirements || {}; + config.InstanceRequirements = config.InstanceRequirements || ({} as InstanceRequirementsRequest); config.InstanceRequirements.RequireHibernateSupport = value.toLowerCase() === 'true'; } else if (key === 'require-encryption-in-transit') { - config.InstanceRequirements = config.InstanceRequirements || {}; + config.InstanceRequirements = config.InstanceRequirements || ({} as InstanceRequirementsRequest); config.InstanceRequirements.RequireEncryptionInTransit = value.toLowerCase() === 'true'; - } else if (key === 'baseline-performance-cpu-family') { - config.InstanceRequirements = config.InstanceRequirements || {}; + } else if (key === 'baseline-performance-factors-cpu-reference-families') { + config.InstanceRequirements = config.InstanceRequirements || ({} as InstanceRequirementsRequest); config.InstanceRequirements.BaselinePerformanceFactors = - config.InstanceRequirements.BaselinePerformanceFactors || {}; + config.InstanceRequirements.BaselinePerformanceFactors || ({} as BaselinePerformanceFactorsRequest); config.InstanceRequirements.BaselinePerformanceFactors.Cpu = - config.InstanceRequirements.BaselinePerformanceFactors.Cpu || {}; - config.InstanceRequirements.BaselinePerformanceFactors.Cpu.References = [{ InstanceFamily: value }]; + config.InstanceRequirements.BaselinePerformanceFactors.Cpu || ({} as CpuPerformanceFactorRequest); + config.InstanceRequirements.BaselinePerformanceFactors.Cpu.References = value + .split(',') + .map((family) => ({ InstanceFamily: family })) as PerformanceFactorReferenceRequest[]; } } From 1460582d858ccdb45ef5ed2add973ad9eccc91fe Mon Sep 17 00:00:00 2001 From: edersonbrilhante Date: Tue, 20 Jan 2026 14:46:18 +0100 Subject: [PATCH 15/34] fix: fix imports --- .../src/scale-runners/scale-up.ts | 35 +++++++++---------- 1 file changed, 17 insertions(+), 18 deletions(-) diff --git a/lambdas/functions/control-plane/src/scale-runners/scale-up.ts b/lambdas/functions/control-plane/src/scale-runners/scale-up.ts index d7b597e906..2f042f55f9 100644 --- a/lambdas/functions/control-plane/src/scale-runners/scale-up.ts +++ b/lambdas/functions/control-plane/src/scale-runners/scale-up.ts @@ -12,7 +12,6 @@ import { publishRetryMessage } from './job-retry'; ======= import { _InstanceType, - Affinity, Tenancy, VolumeType, CpuManufacturer, @@ -24,22 +23,22 @@ import { AcceleratorName, LocalStorage, LocalStorageType, - type Placement, - type BaselinePerformanceFactorsRequest, - type FleetEbsBlockDeviceRequest, - type CpuPerformanceFactorRequest, - type PerformanceFactorReferenceRequest, - type FleetBlockDeviceMappingRequest, - type InstanceRequirementsRequest, - type VCpuCountRangeRequest, - type MemoryMiBRequest, - type MemoryGiBPerVCpuRequest, - type AcceleratorCountRequest, - type AcceleratorTotalMemoryMiBRequest, - type NetworkInterfaceCountRequest, - type NetworkBandwidthGbpsRequest, - type TotalLocalStorageGBRequest, - type BaselineEbsBandwidthMbpsRequest, + Placement, + BaselinePerformanceFactorsRequest, + FleetEbsBlockDeviceRequest, + CpuPerformanceFactorRequest, + PerformanceFactorReferenceRequest, + FleetBlockDeviceMappingRequest, + InstanceRequirementsRequest, + VCpuCountRangeRequest, + MemoryMiBRequest, + MemoryGiBPerVCpuRequest, + AcceleratorCountRequest, + AcceleratorTotalMemoryMiBRequest, + NetworkInterfaceCountRequest, + NetworkBandwidthGbpsRequest, + TotalLocalStorageGBRequest, + BaselineEbsBandwidthMbpsRequest, } from '@aws-sdk/client-ec2'; >>>>>>> 44df86d7 (test: fix test cases) @@ -868,7 +867,7 @@ async function createJitConfig( */ export function parseEc2OverrideConfig(labels: string[]): Ec2OverrideConfig | undefined { const ec2Labels = labels.filter((l) => l.startsWith('ghr-ec2-')); - const config: Partial = {}; + const config: Ec2OverrideConfig = {}; for (const label of ec2Labels) { const [key, ...valueParts] = label.replace('ghr-ec2-', '').split(':'); From 3c4a197f6414d7775a6fd2ddf98863686c055481 Mon Sep 17 00:00:00 2001 From: edersonbrilhante Date: Tue, 20 Jan 2026 16:24:15 +0100 Subject: [PATCH 16/34] docs: update function docs for parseEc2OverrideConfig --- .../control-plane/src/scale-runners/scale-up.ts | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/lambdas/functions/control-plane/src/scale-runners/scale-up.ts b/lambdas/functions/control-plane/src/scale-runners/scale-up.ts index 2f042f55f9..c83418a207 100644 --- a/lambdas/functions/control-plane/src/scale-runners/scale-up.ts +++ b/lambdas/functions/control-plane/src/scale-runners/scale-up.ts @@ -851,13 +851,13 @@ async function createJitConfig( * - ghr-ec2-block-device-virtual-name: - Virtual device name (ephemeral storage) * - ghr-ec2-block-device-no-device: - Suppresses device mapping * - * Pricing: - * - ghr-ec2-spot-max-price-percentage: - Spot max price as % over lowest price - * - ghr-ec2-on-demand-max-price-percentage: - On-demand max price as % over lowest price - * - ghr-ec2-max-spot-price-percentage-optimal: - Max spot price as % of optimal on-demand + * Pricing & Advanced: + * - ghr-ec2-spot-max-price-percentage-over-lowest-price: - Spot max price as % over lowest price + * - ghr-ec2-on-demand-max-price-percentage-over-lowest-price: - On-demand max price as % over lowest price + * - ghr-ec2-max-spot-price-as-percentage-of-optimal-on-demand-price: - Max spot price as % of optimal on-demand * - ghr-ec2-require-hibernate-support: - Require hibernate support (true,false) * - ghr-ec2-require-encryption-in-transit: - Require encryption in-transit (true,false) - * - ghr-ec2-baseline-performance-cpu-family: - CPU baseline performance family + * - ghr-ec2-baseline-performance-factors-cpu-reference-families: - CPU baseline performance reference families (comma-separated) * * Example: * runs-on: [self-hosted, linux, ghr-ec2-vcpu-count-min:4, ghr-ec2-memory-mib-min:16384, ghr-ec2-accelerator-types:gpu] From c65665f5236d0b9c4304b80c9bee53fe122451da Mon Sep 17 00:00:00 2001 From: edersonbrilhante Date: Fri, 30 Jan 2026 16:36:12 +0100 Subject: [PATCH 17/34] feat: allow use any dynamic label with prefix ghr- --- .../src/scale-runners/scale-up.test.ts | 53 ++++++++++--------- .../src/scale-runners/scale-up.ts | 43 ++++++++------- lambdas/functions/webhook/src/ConfigLoader.ts | 4 ++ lambdas/functions/webhook/src/modules.d.ts | 1 + .../webhook/src/runners/dispatch.test.ts | 28 +++++++--- .../functions/webhook/src/runners/dispatch.ts | 12 +++-- main.tf | 3 +- modules/multi-runner/runners.tf | 2 +- modules/multi-runner/variables.tf | 9 +++- modules/multi-runner/webhook.tf | 2 + modules/runners/scale-up.tf | 2 +- modules/runners/variables.tf | 4 +- modules/webhook/direct/variables.tf | 1 + modules/webhook/direct/webhook.tf | 1 + modules/webhook/eventbridge/variables.tf | 3 +- modules/webhook/eventbridge/webhook.tf | 1 + modules/webhook/variables.tf | 6 +++ modules/webhook/webhook.tf | 4 +- variables.tf | 2 +- 19 files changed, 111 insertions(+), 70 deletions(-) diff --git a/lambdas/functions/control-plane/src/scale-runners/scale-up.test.ts b/lambdas/functions/control-plane/src/scale-runners/scale-up.test.ts index c89ae8cb4e..edfbff5e4b 100644 --- a/lambdas/functions/control-plane/src/scale-runners/scale-up.test.ts +++ b/lambdas/functions/control-plane/src/scale-runners/scale-up.test.ts @@ -575,7 +575,7 @@ describe('scaleUp with GHES', () => { describe('Dynamic EC2 Configuration', () => { beforeEach(() => { process.env.ENABLE_ORGANIZATION_RUNNERS = 'true'; - process.env.ENABLE_DYNAMIC_EC2_CONFIG = 'true'; + process.env.ENABLE_DYNAMIC_LABELS = 'true'; process.env.ENABLE_EPHEMERAL_RUNNERS = 'true'; process.env.ENABLE_JOB_QUEUED_CHECK = 'false'; process.env.RUNNER_LABELS = 'base-label'; @@ -670,8 +670,8 @@ describe('scaleUp with GHES', () => { ); }); - it('does not process EC2 labels when ENABLE_DYNAMIC_EC2_CONFIG is disabled', async () => { - process.env.ENABLE_DYNAMIC_EC2_CONFIG = 'false'; + it('does not process EC2 labels when ENABLE_DYNAMIC_LABELS is disabled', async () => { + process.env.ENABLE_DYNAMIC_LABELS = 'false'; const testDataWithEc2Labels = [ { @@ -2219,7 +2219,6 @@ describe('scaleUp with Github Data Residency', () => { }); }); -<<<<<<< HEAD describe('Retry mechanism tests', () => { beforeEach(() => { process.env.ENABLE_ORGANIZATION_RUNNERS = 'true'; @@ -2361,7 +2360,30 @@ describe('Retry mechanism tests', () => { id: msg.id, messageId: msg.messageId, }), -======= + ); + }); + }); + + it('calls publishRetryMessage after runner creation', async () => { + const messages = createTestMessages(1); + mockCreateRunner.mockResolvedValue(['i-12345']); // Create the requested runner + + const callOrder: string[] = []; + mockPublishRetryMessage.mockImplementation(() => { + callOrder.push('publishRetryMessage'); + return Promise.resolve(); + }); + mockCreateRunner.mockImplementation(async () => { + callOrder.push('createRunner'); + return ['i-12345']; + }); + + await scaleUpModule.scaleUp(messages); + + expect(callOrder).toEqual(['createRunner', 'publishRetryMessage']); + }); +}); + describe('parseEc2OverrideConfig', () => { describe('Basic Fleet Overrides', () => { it('should parse instance-type label', () => { @@ -2858,30 +2880,10 @@ describe('parseEc2OverrideConfig', () => { ); expect(result?.InstanceRequirements?.BaselinePerformanceFactors?.Cpu?.References?.[1]?.InstanceFamily).toBe( 'amd', ->>>>>>> 44df86d7 (test: fix test cases) ); }); }); -<<<<<<< HEAD - it('calls publishRetryMessage after runner creation', async () => { - const messages = createTestMessages(1); - mockCreateRunner.mockResolvedValue(['i-12345']); // Create the requested runner - - const callOrder: string[] = []; - mockPublishRetryMessage.mockImplementation(() => { - callOrder.push('publishRetryMessage'); - return Promise.resolve(); - }); - mockCreateRunner.mockImplementation(async () => { - callOrder.push('createRunner'); - return ['i-12345']; - }); - - await scaleUpModule.scaleUp(messages); - - expect(callOrder).toEqual(['createRunner', 'publishRetryMessage']); -======= describe('Edge Cases', () => { it('should return undefined when empty array is provided', () => { const result = scaleUpModule.parseEc2OverrideConfig([]); @@ -3078,7 +3080,6 @@ describe('parseEc2OverrideConfig', () => { expect(result?.InstanceRequirements?.SpotMaxPricePercentageOverLowestPrice).toBe(100); expect(result?.InstanceRequirements?.OnDemandMaxPricePercentageOverLowestPrice).toBe(150); }); ->>>>>>> 44df86d7 (test: fix test cases) }); }); diff --git a/lambdas/functions/control-plane/src/scale-runners/scale-up.ts b/lambdas/functions/control-plane/src/scale-runners/scale-up.ts index c83418a207..992ee4e26e 100644 --- a/lambdas/functions/control-plane/src/scale-runners/scale-up.ts +++ b/lambdas/functions/control-plane/src/scale-runners/scale-up.ts @@ -7,9 +7,7 @@ import { createGithubAppAuth, createGithubInstallationAuth, createOctokitClient import { createRunner, listEC2Runners, tag, terminateRunner } from './../aws/runners'; import { Ec2OverrideConfig, RunnerInputParameters } from './../aws/runners.d'; import { metricGitHubAppRateLimit } from '../github/rate-limit'; -<<<<<<< HEAD import { publishRetryMessage } from './job-retry'; -======= import { _InstanceType, Tenancy, @@ -40,7 +38,6 @@ import { TotalLocalStorageGBRequest, BaselineEbsBandwidthMbpsRequest, } from '@aws-sdk/client-ec2'; ->>>>>>> 44df86d7 (test: fix test cases) const logger = createChildLogger('scale-up'); @@ -334,7 +331,7 @@ export async function scaleUp(payloads: ActionRequestMessageSQS[]): Promise l.startsWith('ghr-ec2-'))?.slice('ghr-ec2-'.length); + if (dynamicLabelsEnabled && labels?.length) { + const dynamicLabels = labels.find((l) => l.startsWith('ghr-'))?.slice('ghr-'.length); - if (requestedDynamicEc2Config) { - const ec2Hash = ec2LabelsHash(labels); - key = `${key}/${ec2Hash}`; + if (dynamicLabels) { + const dynamicLabelsHash = labelsHash(labels); + key = `${key}/${dynamicLabelsHash}`; } } @@ -454,26 +451,28 @@ export async function scaleUp(payloads: ActionRequestMessageSQS[]): Promise 0 && dynamicEc2ConfigEnabled) { + if (messages.length > 0 && dynamicLabelsEnabled) { logger.debug('Dynamic EC2 config enabled, processing labels', { labels: messages[0].labels }); const dynamicEC2Labels = messages[0].labels?.map((l) => l.trim()).filter((l) => l.startsWith('ghr-ec2-')) ?? []; + const allDynamicLabels = messages[0].labels?.map((l) => l.trim()).filter((l) => l.startsWith('ghr-')) ?? []; - if (dynamicEC2Labels.length > 0) { - // Append all EC2 labels to runnerLabels - runnerLabels = runnerLabels ? `${runnerLabels},${dynamicEC2Labels.join(',')}` : dynamicEC2Labels.join(','); + if (allDynamicLabels.length > 0) { + runnerLabels = runnerLabels ? `${runnerLabels},${allDynamicLabels.join(',')}` : allDynamicLabels.join(','); logger.debug('Updated runner labels', { runnerLabels }); - // Parse EC2 override configuration from labels - ec2OverrideConfig = parseEc2OverrideConfig(dynamicEC2Labels); - if (ec2OverrideConfig) { - logger.debug('EC2 override config parsed from labels', { - ec2OverrideConfig, - }); + if (dynamicEC2Labels.length > 0) { + + ec2OverrideConfig = parseEc2OverrideConfig(dynamicEC2Labels); + if (ec2OverrideConfig) { + logger.debug('EC2 override config parsed from labels', { + ec2OverrideConfig, + }); + } } } else { - logger.debug('No dynamic EC2 labels found on message'); + logger.debug('No dynamic labels found on message'); } } @@ -1083,8 +1082,8 @@ export function parseEc2OverrideConfig(labels: string[]): Ec2OverrideConfig | un return Object.keys(config).length > 0 ? config : undefined; } -function ec2LabelsHash(labels: string[]): string { - const prefix = 'ghr-ec2-'; +function labelsHash(labels: string[]): string { + const prefix = 'ghr-'; const input = labels .filter((l) => l.startsWith(prefix)) diff --git a/lambdas/functions/webhook/src/ConfigLoader.ts b/lambdas/functions/webhook/src/ConfigLoader.ts index e77a92b16e..df7b159495 100644 --- a/lambdas/functions/webhook/src/ConfigLoader.ts +++ b/lambdas/functions/webhook/src/ConfigLoader.ts @@ -130,9 +130,11 @@ export class ConfigWebhook extends MatcherAwareConfig { repositoryAllowList: string[] = []; webhookSecret: string = ''; workflowJobEventSecondaryQueue: string = ''; + enableDynamicLabels: boolean = false; async loadConfig(): Promise { this.loadEnvVar(process.env.REPOSITORY_ALLOW_LIST, 'repositoryAllowList', []); + this.loadEnvVar(process.env.ENABLE_DYNAMIC_LABELS, 'enableDynamicLabels', false); await Promise.all([ this.loadMatcherConfig(process.env.PARAMETER_RUNNER_MATCHER_CONFIG_PATH), @@ -162,9 +164,11 @@ export class ConfigWebhookEventBridge extends BaseConfig { export class ConfigDispatcher extends MatcherAwareConfig { repositoryAllowList: string[] = []; workflowJobEventSecondaryQueue: string = ''; // Deprecated + enableDynamicLabels: boolean = false; async loadConfig(): Promise { this.loadEnvVar(process.env.REPOSITORY_ALLOW_LIST, 'repositoryAllowList', []); + this.loadEnvVar(process.env.ENABLE_DYNAMIC_LABELS, 'enableDynamicLabels', false); await this.loadMatcherConfig(process.env.PARAMETER_RUNNER_MATCHER_CONFIG_PATH); validateRunnerMatcherConfig(this); diff --git a/lambdas/functions/webhook/src/modules.d.ts b/lambdas/functions/webhook/src/modules.d.ts index 76a72660c0..cb30686389 100644 --- a/lambdas/functions/webhook/src/modules.d.ts +++ b/lambdas/functions/webhook/src/modules.d.ts @@ -5,6 +5,7 @@ declare namespace NodeJS { PARAMETER_GITHUB_APP_WEBHOOK_SECRET: string; PARAMETER_RUNNER_MATCHER_CONFIG_PATH: string; REPOSITORY_ALLOW_LIST: string; + ENABLE_DYNAMIC_LABELS: string RUNNER_LABELS: string; ACCEPT_EVENTS: string; } diff --git a/lambdas/functions/webhook/src/runners/dispatch.test.ts b/lambdas/functions/webhook/src/runners/dispatch.test.ts index 16195da1f8..79e156a896 100644 --- a/lambdas/functions/webhook/src/runners/dispatch.test.ts +++ b/lambdas/functions/webhook/src/runners/dispatch.test.ts @@ -183,49 +183,61 @@ describe('Dispatcher', () => { it('should accept job with an exact match and identical labels.', () => { const workflowLabels = ['self-hosted', 'linux', 'x64', 'ubuntu-latest']; const runnerLabels = [['self-hosted', 'linux', 'x64', 'ubuntu-latest']]; - expect(canRunJob(workflowLabels, runnerLabels, true)).toBe(true); + expect(canRunJob(workflowLabels, runnerLabels, true, false)).toBe(true); }); it('should accept job with an exact match and identical labels, ignoring cases.', () => { const workflowLabels = ['self-Hosted', 'Linux', 'X64', 'ubuntu-Latest']; const runnerLabels = [['self-hosted', 'linux', 'x64', 'ubuntu-latest']]; - expect(canRunJob(workflowLabels, runnerLabels, true)).toBe(true); + expect(canRunJob(workflowLabels, runnerLabels, true, false)).toBe(true); }); it('should accept job with an exact match and runner supports requested capabilities.', () => { const workflowLabels = ['self-hosted', 'linux', 'x64']; const runnerLabels = [['self-hosted', 'linux', 'x64', 'ubuntu-latest']]; - expect(canRunJob(workflowLabels, runnerLabels, true)).toBe(true); + expect(canRunJob(workflowLabels, runnerLabels, true, false)).toBe(true); }); it('should NOT accept job with an exact match and runner not matching requested capabilities.', () => { const workflowLabels = ['self-hosted', 'linux', 'x64', 'ubuntu-latest']; const runnerLabels = [['self-hosted', 'linux', 'x64']]; - expect(canRunJob(workflowLabels, runnerLabels, true)).toBe(false); + expect(canRunJob(workflowLabels, runnerLabels, true, false)).toBe(false); }); it('should accept job with for a non exact match. Any label that matches will accept the job.', () => { const workflowLabels = ['self-hosted', 'linux', 'x64', 'ubuntu-latest', 'gpu']; const runnerLabels = [['gpu']]; - expect(canRunJob(workflowLabels, runnerLabels, false)).toBe(true); + expect(canRunJob(workflowLabels, runnerLabels, false, false)).toBe(true); }); it('should NOT accept job with for an exact match. Not all requested capabilities are supported.', () => { const workflowLabels = ['self-hosted', 'linux', 'x64', 'ubuntu-latest', 'gpu']; const runnerLabels = [['gpu']]; - expect(canRunJob(workflowLabels, runnerLabels, true)).toBe(false); + expect(canRunJob(workflowLabels, runnerLabels, true, false)).toBe(false); }); it('should not accept jobs not providing labels if exact match is.', () => { const workflowLabels: string[] = []; const runnerLabels = [['self-hosted', 'linux', 'x64']]; - expect(canRunJob(workflowLabels, runnerLabels, true)).toBe(false); + expect(canRunJob(workflowLabels, runnerLabels, true, false)).toBe(false); }); it('should accept jobs not providing labels and exact match is set to false.', () => { const workflowLabels: string[] = []; const runnerLabels = [['self-hosted', 'linux', 'x64']]; - expect(canRunJob(workflowLabels, runnerLabels, false)).toBe(true); + expect(canRunJob(workflowLabels, runnerLabels, false, false)).toBe(true); + }); + + it('should filter out ghr- and ghr-run- labels when enableDynamicLabels is true.', () => { + const workflowLabels = ['self-hosted', 'linux', 'x64', 'ghr-ec2-instance-type:t3.large', 'ghr-run-id:12345']; + const runnerLabels = [['self-hosted', 'linux', 'x64']]; + expect(canRunJob(workflowLabels, runnerLabels, true, true)).toBe(true); + }); + + it('should NOT filter out ghr- and ghr-run- labels when enableDynamicLabels is false.', () => { + const workflowLabels = ['self-hosted', 'linux', 'x64', 'ghr-ec2-instance-type:t3.large']; + const runnerLabels = [['self-hosted', 'linux', 'x64']]; + expect(canRunJob(workflowLabels, runnerLabels, true, false)).toBe(false); }); }); }); diff --git a/lambdas/functions/webhook/src/runners/dispatch.ts b/lambdas/functions/webhook/src/runners/dispatch.ts index 8427f94453..e8cbdce827 100644 --- a/lambdas/functions/webhook/src/runners/dispatch.ts +++ b/lambdas/functions/webhook/src/runners/dispatch.ts @@ -15,7 +15,7 @@ export async function dispatch( ): Promise { validateRepoInAllowList(event, config); - return await handleWorkflowJob(event, eventType, config.matcherConfig!); + return await handleWorkflowJob(event, eventType, config.matcherConfig!, config.enableDynamicLabels); } function validateRepoInAllowList(event: WorkflowJobEvent, config: ConfigDispatcher) { @@ -29,6 +29,7 @@ async function handleWorkflowJob( body: WorkflowJobEvent, githubEvent: string, matcherConfig: Array, + enableDynamicLabels: boolean, ): Promise { if (body.action !== 'queued') { return { @@ -47,7 +48,7 @@ async function handleWorkflowJob( return a.matcherConfig.exactMatch === b.matcherConfig.exactMatch ? 0 : a.matcherConfig.exactMatch ? -1 : 1; }); for (const queue of matcherConfig) { - if (canRunJob(body.workflow_job.labels, queue.matcherConfig.labelMatchers, queue.matcherConfig.exactMatch)) { + if (canRunJob(body.workflow_job.labels, queue.matcherConfig.labelMatchers, queue.matcherConfig.exactMatch, enableDynamicLabels)) { await sendActionRequest({ id: body.workflow_job.id, repositoryName: body.repository.name, @@ -81,9 +82,12 @@ export function canRunJob( workflowJobLabels: string[], runnerLabelsMatchers: string[][], workflowLabelCheckAll: boolean, + enableDynamicLabels: boolean, ): boolean { - // Filter out ghr-ec2- labels as they are handled by the dynamic EC2 instance type feature - const filteredLabels = workflowJobLabels.filter((label) => !label.startsWith('ghr-ec2-')); + // Filter out ghr- and ghr-run- labels only if dynamic labels config is enabled + const filteredLabels = enableDynamicLabels + ? workflowJobLabels.filter((label) => !label.startsWith('ghr-')) + : workflowJobLabels; runnerLabelsMatchers = runnerLabelsMatchers.map((runnerLabel) => { return runnerLabel.map((label) => label.toLowerCase()); diff --git a/main.tf b/main.tf index 82e02c92a6..63b5725d06 100644 --- a/main.tf +++ b/main.tf @@ -137,6 +137,7 @@ module "webhook" { logging_retention_in_days = var.logging_retention_in_days logging_kms_key_id = var.logging_kms_key_id log_class = var.log_class + enable_dynamic_labels = var.enable_dynamic_labels role_path = var.role_path role_permissions_boundary = var.role_permissions_boundary @@ -185,7 +186,7 @@ module "runners" { github_app_parameters = local.github_app_parameters enable_organization_runners = var.enable_organization_runners enable_ephemeral_runners = var.enable_ephemeral_runners - enable_dynamic_ec2_config = var.enable_dynamic_ec2_config + enable_dynamic_labels = var.enable_dynamic_labels enable_job_queued_check = var.enable_job_queued_check enable_jit_config = var.enable_jit_config enable_on_demand_failover_for_errors = var.enable_runner_on_demand_failover_for_errors diff --git a/modules/multi-runner/runners.tf b/modules/multi-runner/runners.tf index a54b4aafeb..497b278a99 100644 --- a/modules/multi-runner/runners.tf +++ b/modules/multi-runner/runners.tf @@ -35,7 +35,7 @@ module "runners" { scale_errors = each.value.runner_config.scale_errors enable_organization_runners = each.value.runner_config.enable_organization_runners enable_ephemeral_runners = each.value.runner_config.enable_ephemeral_runners - enable_dynamic_ec2_config = each.value.runner_config.enable_dynamic_ec2_config + enable_dynamic_labels = each.value.runner_config.enable_dynamic_labels enable_jit_config = each.value.runner_config.enable_jit_config enable_job_queued_check = each.value.runner_config.enable_job_queued_check disable_runner_autoupdate = each.value.runner_config.disable_runner_autoupdate diff --git a/modules/multi-runner/variables.tf b/modules/multi-runner/variables.tf index aeaef79290..70a741ef3e 100644 --- a/modules/multi-runner/variables.tf +++ b/modules/multi-runner/variables.tf @@ -77,7 +77,6 @@ variable "multi_runner_config" { disable_runner_autoupdate = optional(bool, false) ebs_optimized = optional(bool, false) enable_ephemeral_runners = optional(bool, false) - enable_dynamic_ec2_config = optional(bool, false) enable_job_queued_check = optional(bool, null) enable_on_demand_failover_for_errors = optional(list(string), []) scale_errors = optional(list(string), [ @@ -208,7 +207,7 @@ variable "multi_runner_config" { 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/)" ebs_optimized: "The EC2 EBS optimized configuration." enable_ephemeral_runners: "Enable ephemeral runners, runners will only be used once." - enable_dynamic_ec2_config: "Enable dynamic EC2 configs based on workflow job labels. When enabled, jobs can request specific configs via the 'gh-ec2-:' label (e.g., 'gh-ec2-instance-type:t3.large')." + enable_dynamic_labels: "Enable dynamic labels with 'ghr-' prefix. When enabled, jobs can use 'ghr-ec2-:' labels to dynamically configure EC2 instances (e.g., 'ghr-ec2-instance-type:t3.large') and 'ghr-run-