Multi-runner scale-set example

This example combines ordinary webhook-managed lanes with one experimental GitHub Actions runner scale-set lane. It demonstrates that v2 keeps the deployment-wide defaults in global_config* and places orchestration and compute-provider settings inside each multi_runner_config lane.

The source example is available at examples/multi-runner-scale-set. Read its README before applying: the GitHub App values are sensitive, the scale-set controller image must be supplied explicitly, and the GitHub scale set/runner group must be authorized for the selected GitHub scope.

Multi-runner scale-set example

This example demonstrates the experimental multi-runner v2 interface. Shared defaults are configured with global_config* variables, while each runner lane uses multi_runner_config for its matcher, runner lifecycle, and compute-provider settings.

The example creates four lanes from one deployment:

• Linux ARM64 Amazon Linux runners.
• Ephemeral Linux x64 Amazon Linux runners with job retry enabled.
• Linux x64 runners managed by a GitHub Actions scale set.
• Windows x64 Server Core 2022 runners.

The v2 interface keeps provider-owned settings inside the selected provider configuration. For example, VPC and subnet settings are under global_config_compute_provider.aws.ec2, while the per-lane instance types and AMI filter are under each lane's compute provider block.

The scale-set lane uses orchestration_provider.scale_set. Its controller network is configured under the global scale-set block and its GitHub installation ID is provided by var.github_app.

Configure the GitHub App variables before applying:

terraform init
terraform apply \
  -var='github_app={id="123456",key_base64="...",installation_id="123456789"}' \
  -var='github={runner_owner="example",registration_level="organization"}' \
  -var='scale_set={name="linux-scale-set",container={image="ghcr.io/github-aws-runners/terraform-aws-github-runner-scale-set-service@sha256:<release-digest>"}}'

The github_app value is sensitive and should be supplied through a secure variable source in real deployments rather than committed to configuration. The GitHub App must be installed for the configured GitHub account.

Requirements

Providers

Modules

Resources

Inputs

map(object({
    filter = optional(map(list(string)), { state = ["available"] })
    owners = optional(list(string), ["amazon"])
    id_ssm_parameter = optional(object({
      arn = string
    }), null)
    kms_key = optional(object({
      arn = string
    }), null)
  }))

object({
    url                = optional(string, null)
    ssl_verify         = optional(bool, true)
    runner_owner       = optional(string, null)
    registration_level = optional(string, "organization")
  })

object({
    id              = string
    key_base64      = string
    installation_id = optional(string, null)
  })

object({
    name              = string
    runner_group_name = optional(string, "Default")
    min_runners       = optional(number, 0)
    container = optional(object({
      image = optional(string, null)
    }), {})
  })

Outputs