refactor to ami ojbject

npalm · npalm · commit 89f5e962085f · 2025-04-04T16:04:58.000+02:00
diff --git a/examples/multi-runner/templates/runner-configs/linux-arm64.yaml b/examples/multi-runner/templates/runner-configs/linux-arm64.yaml
@@ -15,7 +15,8 @@ runner_config:
   instance_types:
     - t4g.large
     - c6g.large
-  ami_id_ssm_parameter_arn: ${ami_id_ssm_parameter_arn}
+  ami:
+    id_ssm_parameter_arn: ${ami_id_ssm_parameter_arn}
   runners_maximum_count: 1
   delay_webhook_event: 0
   scale_down_schedule_expression: cron(* * * * ? *)
diff --git a/examples/multi-runner/templates/runner-configs/linux-x64-ubuntu.yaml b/examples/multi-runner/templates/runner-configs/linux-x64-ubuntu.yaml
@@ -22,13 +22,14 @@ runner_config:
   delay_webhook_event: 0
   scale_down_schedule_expression: cron(* * * * ? *)
   userdata_template: ./templates/user-data.sh
-  ami_owners:
-    - "099720109477" # Canonical's Amazon account ID
-  ami_filter:
-    name:
-      - ubuntu/images/hvm-ssd/ubuntu-jammy-22.04-amd64-server-*
-    state:
-      - available
+  ami:
+    owners:
+      - "099720109477" # Canonical's Amazon account ID
+    filter:
+      name:
+        - ubuntu/images/hvm-ssd/ubuntu-jammy-22.04-amd64-server-*
+      state:
+        - available
   block_device_mappings:
     - device_name: /dev/sda1
       delete_on_termination: true
diff --git a/examples/multi-runner/templates/runner-configs/linux-x64.yaml b/examples/multi-runner/templates/runner-configs/linux-x64.yaml
@@ -14,7 +14,8 @@ runner_config:
   instance_types:
     - m5ad.large
     - m5a.large
-  ami_id_ssm_parameter_arn: ${ami_id_ssm_parameter_arn}
+  ami:
+    id_ssm_parameter_arn: ${ami_id_ssm_parameter_arn}
   runners_maximum_count: 1
   enable_ephemeral_runners: true
   enable_on_demand_failover_for_errors: ['InsufficientInstanceCapacity']
diff --git a/examples/multi-runner/templates/runner-configs/windows-x64.yaml b/examples/multi-runner/templates/runner-configs/windows-x64.yaml
@@ -15,8 +15,9 @@ runner_config:
   delay_webhook_event: 5
   scale_down_schedule_expression: cron(* * * * ? *)
   runner_boot_time_in_minutes: 20
-  ami_filter:
-    name:
-      - Windows_Server-2022-English-Full-ECS_Optimized-*
-    state:
-      - available
+  ami:
+    filter:
+      name:
+        - Windows_Server-2022-English-Full-ECS_Optimized-*
+      state:
+        - available
diff --git a/main.tf b/main.tf
@@ -178,6 +178,7 @@ module "runners" {
   block_device_mappings         = var.block_device_mappings
 
   runner_architecture       = var.runner_architecture
+  ami                      = var.ami
   ami_filter                = var.ami_filter
   ami_owners                = var.ami_owners
   ami_id_ssm_parameter_arn  = var.ami_id_ssm_parameter_arn
diff --git a/modules/multi-runner/runners.tf b/modules/multi-runner/runners.tf
@@ -26,6 +26,7 @@ module "runners" {
   block_device_mappings         = each.value.runner_config.block_device_mappings
 
   runner_architecture       = each.value.runner_config.runner_architecture
+  ami                      = each.value.runner_config.ami
   ami_filter                = each.value.runner_config.ami_filter
   ami_owners                = each.value.runner_config.ami_owners
   ami_id_ssm_parameter_arn  = each.value.runner_config.ami_id_ssm_parameter_arn
diff --git a/modules/multi-runner/variables.tf b/modules/multi-runner/variables.tf
@@ -65,6 +65,22 @@ variable "multi_runner_config" {
         http_tokens                 = "required"
         http_put_response_hop_limit = 1
       })
+      ami = optional(object({
+        filter                   = optional(map(list(string)), { state = ["available"] })
+        owners                   = optional(list(string), ["amazon"])
+        id_ssm_parameter_name    = optional(string, null)
+        id_ssm_parameter_arn     = optional(string, null)
+        kms_key_arn             = optional(string, null)
+      }), null)
+      # Deprecated: Use ami object instead
+      ami = optional(object({
+        filter                   = optional(map(list(string)), { state = ["available"] })
+        owners                   = optional(list(string), ["amazon"])
+        id_ssm_parameter_name    = optional(string, null)
+        id_ssm_parameter_arn     = optional(string, null)
+        kms_key_arn             = optional(string, null)
+      }), null)
+      # Deprecated: Use ami object instead
       ami_filter                              = optional(map(list(string)), { state = ["available"] })
       ami_owners                              = optional(list(string), ["amazon"])
       ami_id_ssm_parameter_arn                = optional(string, null)
diff --git a/modules/runners/main.tf b/modules/runners/main.tf
@@ -37,9 +37,17 @@ locals {
     "linux"   = "${path.module}/templates/start-runner.sh"
   }
 
-  ami_kms_key_arn           = var.ami_kms_key_arn != null ? var.ami_kms_key_arn : ""
-  ami_filter                = merge(local.default_ami[var.runner_os], var.ami_filter)
-  ami_id_ssm_module_managed = var.ami_id_ssm_parameter_arn == null
+  # Handle AMI configuration from either the new object or old variables
+  ami_config = var.ami != null ? var.ami : {
+    filter                = var.ami_filter
+    owners                = var.ami_owners
+    id_ssm_parameter_name = var.ami_id_ssm_parameter_name
+    id_ssm_parameter_arn  = var.ami_id_ssm_parameter_arn
+    kms_key_arn          = var.ami_kms_key_arn
+  }
+  ami_kms_key_arn           = local.ami_config.kms_key_arn != null ? local.ami_config.kms_key_arn : ""
+  ami_filter                = merge(local.default_ami[var.runner_os], local.ami_config.filter)
+  ami_id_ssm_module_managed = local.ami_config.id_ssm_parameter_arn == null
 
   enable_job_queued_check = var.enable_job_queued_check == null ? !var.enable_ephemeral_runners : var.enable_job_queued_check
 
@@ -82,7 +90,7 @@ data "aws_ami" "runner" {
     }
   }
 
-  owners = var.ami_owners
+  owners = local.ami_config.owners
 }
 
 resource "aws_ssm_parameter" "runner_ami_id" {
diff --git a/modules/runners/variables.tf b/modules/runners/variables.tf
@@ -1,3 +1,15 @@
+variable "ami" {
+  description = "AMI configuration for the action runner instances"
+  type = object({
+    filter                   = optional(map(list(string)), { state = ["available"] })
+    owners                   = optional(list(string), ["amazon"])
+    id_ssm_parameter_name    = optional(string, null)
+    id_ssm_parameter_arn     = optional(string, null)
+    kms_key_arn             = optional(string, null)
+  })
+  default = null
+}
+
 variable "aws_region" {
   description = "AWS region."
   type        = string
@@ -114,7 +126,7 @@ variable "instance_types" {
 }
 
 variable "ami_filter" {
-  description = "Map of lists used to create the AMI filter for the action runner AMI."
+  description = "[DEPRECATED: Use ami.filter] Map of lists used to create the AMI filter for the action runner AMI."
   type        = map(list(string))
   default     = { state = ["available"] }
   validation {
@@ -125,25 +137,25 @@ variable "ami_filter" {
 }
 
 variable "ami_owners" {
-  description = "The list of owners used to select the AMI of action runner instances."
+  description = "[DEPRECATED: Use ami.owners] The list of owners used to select the AMI of action runner instances."
   type        = list(string)
   default     = ["amazon"]
 }
 
 variable "ami_id_ssm_parameter_arn" {
-  description = "ARN of the SSM parameter (of data type aws:ec2:image) that contains the AMI ID to launch runner instances from. Overrides ami_filter"
+  description = "[DEPRECATED: Use ami.id_ssm_parameter_arn] ARN of the SSM parameter (of data type aws:ec2:image) that contains the AMI ID to launch runner instances from. Overrides ami_filter"
   type        = string
   default     = null
 }
 
 variable "ami_id_ssm_parameter_name" {
-  description = "Externally managed SSM parameter (of data type aws:ec2:image) that contains the AMI ID to launch runner instances from. Overrides ami_filter"
+  description = "[DEPRECATED: Use ami.id_ssm_parameter_name] Externally managed SSM parameter (of data type aws:ec2:image) that contains the AMI ID to launch runner instances from. Overrides ami_filter"
   type        = string
   default     = null
 }
 
 variable "ami_kms_key_arn" {
-  description = "Optional CMK Key ARN to be used to launch an instance from a shared encrypted AMI"
+  description = "[DEPRECATED: Use ami.kms_key_arn] Optional CMK Key ARN to be used to launch an instance from a shared encrypted AMI"
   type        = string
   default     = null
 }
diff --git a/variables.tf b/variables.tf
@@ -366,37 +366,49 @@ variable "block_device_mappings" {
   }]
 }
 
+variable "ami" {
+  description = "AMI configuration for the action runner instances"
+  type = object({
+    filter                   = optional(map(list(string)), { state = ["available"] })
+    owners                   = optional(list(string), ["amazon"])
+    id_ssm_parameter_name    = optional(string, null)
+    id_ssm_parameter_arn     = optional(string, null)
+    kms_key_arn             = optional(string, null)
+  })
+  default = null
+}
+
 variable "ami_filter" {
-  description = "Map of lists used to create the AMI filter for the action runner AMI."
+  description = "[DEPRECATED: Use ami.filter] Map of lists used to create the AMI filter for the action runner AMI."
   type        = map(list(string))
   default     = { state = ["available"] }
   validation {
     # check the availability of the AMI
     condition     = contains(keys(var.ami_filter), "state")
-    error_message = "The \"ami_filter\" variable must contain the \"state\" key with the value \"available\"."
+    error_message = "The AMI filter must contain the state filter."
   }
 }
 
 variable "ami_owners" {
-  description = "The list of owners used to select the AMI of action runner instances."
+  description = "[DEPRECATED: Use ami.owners] The list of owners that should be used to find the AMI."
   type        = list(string)
   default     = ["amazon"]
 }
 
-variable "ami_id_ssm_parameter_arn" {
-  description = "ARN of the SSM parameter (of data type aws:ec2:image) that contains the AMI ID to launch runner instances from. Overrides ami_filter"
+variable "ami_id_ssm_parameter_name" {
+  description = "[DEPRECATED: Use ami.id_ssm_parameter_name] String used to construct the SSM parameter name used to resolve the latest AMI ID for the runner instances. The SSM parameter should be of type String and contain a valid AMI ID. The default behavior is to use the latest Ubuntu 22.04 AMI."
   type        = string
   default     = null
 }
 
-variable "ami_id_ssm_parameter_name" {
-  description = "(DEPRECATED) Variable is replaced by `ami_id_ssm_parameter_arn` Externally managed SSM parameter (of data type aws:ec2:image) that contains the AMI ID to launch runner instances from. Overrides ami_filter"
+variable "ami_id_ssm_parameter_arn" {
+  description = "[DEPRECATED: Use ami.id_ssm_parameter_arn] Arn of the SSM parameter used to resolve the AMI ID for the runner instances. The SSM parameter should be of type String and contain a valid AMI ID."
   type        = string
   default     = null
 }
 
 variable "ami_kms_key_arn" {
-  description = "Optional CMK Key ARN to be used to launch an instance from a shared encrypted AMI"
+  description = "[DEPRECATED: Use ami.kms_key_arn] Optional CMK Key ARN to be used to launch an instance from a shared encrypted AMI"
   type        = string
   default     = null
 }

Original file line number	Diff line number	Diff line change
`@@ -37,9 +37,17 @@ locals {`
`37`	`37`	`"linux" = "${path.module}/templates/start-runner.sh"`
`38`	`38`	`}`
`39`	`39`
`40`		`- ami_kms_key_arn = var.ami_kms_key_arn != null ? var.ami_kms_key_arn : ""`
`41`		`- ami_filter = merge(local.default_ami[var.runner_os], var.ami_filter)`
`42`		`- ami_id_ssm_module_managed = var.ami_id_ssm_parameter_arn == null`
	`40`	`+ # Handle AMI configuration from either the new object or old variables`
	`41`	`+ ami_config = var.ami != null ? var.ami : {`
	`42`	`+ filter = var.ami_filter`
	`43`	`+ owners = var.ami_owners`
	`44`	`+ id_ssm_parameter_name = var.ami_id_ssm_parameter_name`
	`45`	`+ id_ssm_parameter_arn = var.ami_id_ssm_parameter_arn`
	`46`	`+ kms_key_arn = var.ami_kms_key_arn`
	`47`	`+ }`
	`48`	`+ ami_kms_key_arn = local.ami_config.kms_key_arn != null ? local.ami_config.kms_key_arn : ""`
	`49`	`+ ami_filter = merge(local.default_ami[var.runner_os], local.ami_config.filter)`
	`50`	`+ ami_id_ssm_module_managed = local.ami_config.id_ssm_parameter_arn == null`
`43`	`51`
`44`	`52`	`enable_job_queued_check = var.enable_job_queued_check == null ? !var.enable_ephemeral_runners : var.enable_job_queued_check`
`45`	`53`
`@@ -82,7 +90,7 @@ data "aws_ami" "runner" {`
`82`	`90`	`}`
`83`	`91`	`}`
`84`	`92`
`85`		`- owners = var.ami_owners`
	`93`	`+ owners = local.ami_config.owners`
`86`	`94`	`}`
`87`	`95`
`88`	`96`	`resource "aws_ssm_parameter" "runner_ami_id" {`