cleanup

Author: npalm

examples/multi-runner/main.tf

@@ -53,12 +53,12 @@ locals {
           {
             subnet_ids = lookup(v.runner_config, "subnet_ids", null) != null ? [module.base.vpc.private_subnets[0]] : null
             vpc_id     = lookup(v.runner_config, "vpc_id", null) != null ? module.base.vpc.vpc_id : null
-            ami = merge(
+            ami = contains(keys(v.runner_config), "ami") ? merge(
               v.runner_config.ami,
               {
                 id_ssm_parameter_arn = lookup(local.ssm_ami_arns, k, null) != null ? local.ssm_ami_arns[k] : null
               }
-            )
+            ) : null
           }
         )
       }

examples/multi-runner/templates/runner-configs/windows-x64.yaml

@@ -15,9 +15,8 @@ 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

examples/prebuilt/main.tf

@@ -45,10 +45,6 @@ module "runners" {
   ami_filter      = { name = [var.ami_name_filter], state = ["available"] }
   ami_owners      = [data.aws_caller_identity.current.account_id]
 
-  # Look up runner AMI ID from an AWS SSM parameter (overrides ami_filter at instance launch time)
-  # NOTE: the parameter must be managed outside of this module (e.g. in a runner AMI build workflow)
-  # ami_id_ssm_parameter_name = "my-runner-ami-id"
-
   # disable binary syncer since github agent is already installed in the AMI.
   enable_runner_binaries_syncer = false
 

modules/multi-runner/outputs.tf

@@ -69,12 +69,21 @@ output "instance_termination_handler" {
 }
 
 output "deprecated_variables_warning" {
-  description = "Warning for deprecated variables usage"
+  description = "Warning for deprecated variables usage. These variables will be removed in a future release. Please migrate to using the consolidated 'ami' object in each runner configuration."
   value = join("", [
     for key, runner_config in var.multi_runner_config : (
-      try(runner_config.ami_id_ssm_parameter_name, null) != null ?
-      "DEPRECATION WARNING: The variable 'ami_id_ssm_parameter_name' in runner '${key}' is deprecated and will be removed in a future version. Please use 'ami.id_ssm_parameter_arn' instead.\n" :
-      ""
+      join("", [
+        # Show object migration warning only when ami is null and old variables are used
+        try(runner_config.runner_config.ami, null) == null ? (
+          (try(runner_config.runner_config.ami_filter, { state = ["available"] }) != { state = ["available"] } ||
+            try(runner_config.runner_config.ami_owners, ["amazon"]) != ["amazon"] ||
+          try(runner_config.runner_config.ami_kms_key_arn, "") != "") ?
+          "DEPRECATION WARNING: Runner '${key}' is using deprecated AMI variables (ami_filter, ami_owners, ami_kms_key_arn). These variables will be removed in a future version. Please migrate to using the consolidated 'ami' object.\n" : ""
+        ) : "",
+        # Always show warning for ami_id_ssm_parameter_name to migrate to ami_id_ssm_parameter_arn
+        try(runner_config.runner_config.ami_id_ssm_parameter_name, null) != null ?
+        "DEPRECATION WARNING: Runner '${key}' is using deprecated variable 'ami_id_ssm_parameter_name'. Please use 'ami.id_ssm_parameter_arn' instead.\n" : ""
+      ])
     )
   ])
 }

modules/multi-runner/variables.tf

@@ -66,20 +66,11 @@ variable "multi_runner_config" {
         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)
+        filter               = optional(map(list(string)), { state = ["available"] })
+        owners               = optional(list(string), ["amazon"])
+        id_ssm_parameter_arn = optional(string, null)
+        kms_key_arn          = optional(string, null)
+      }), null) # Defaults to null, in which case the module falls back to individual AMI variables (deprecated)
       # Deprecated: Use ami object instead
       ami_filter                              = optional(map(list(string)), { state = ["available"] })
       ami_owners                              = optional(list(string), ["amazon"])
@@ -187,6 +178,7 @@ variable "multi_runner_config" {
         runner_os: "The EC2 Operating System type to use for action runner instances (linux,windows)."
         runner_architecture: "The platform architecture of the runner instance_type."
         runner_metadata_options: "(Optional) Metadata options for the ec2 runner instances."
+        ami: "(Optional) AMI configuration for the action runner instances. This object allows you to specify all AMI-related settings in one place."
         ami_filter: "(Optional) List of maps used to create the AMI filter for the action runner AMI. By default amazon linux 2 is used."
         ami_owners: "(Optional) The list of owners used to select the AMI of action runner instances."
         create_service_linked_role_spot: (Optional) create the serviced linked role for spot instances that is required by the scale-up lambda.

modules/runners/main.tf

@@ -39,11 +39,10 @@ locals {
 
   # 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  = null
-    kms_key_arn           = var.ami_kms_key_arn
+    filter               = var.ami_filter
+    owners               = var.ami_owners
+    id_ssm_parameter_arn = null
+    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)

modules/runners/variables.tf

@@ -1,11 +1,21 @@
 variable "ami" {
-  description = "AMI configuration for the action runner instances"
+  description = <<EOT
+AMI configuration for the action runner instances. This object allows you to specify all AMI-related settings in one place.
+
+Parameters:
+- `filter`: Map of lists to filter AMIs by various criteria (e.g., { name = ["ubuntu/images/hvm-ssd/ubuntu-jammy-22.04-amd64-*"], state = ["available"] })
+- `owners`: List of AMI owners to limit the search. Common values: ["amazon"], ["self"], or specific AWS account IDs
+- `id_ssm_parameter_name`: Name of an SSM parameter containing the AMI ID. If specified, this overrides the AMI filter
+- `id_ssm_parameter_arn`: ARN of an SSM parameter containing the AMI ID. If specified, this overrides both AMI filter and parameter name
+- `kms_key_arn`: Optional KMS key ARN if the AMI is encrypted with a customer managed key
+
+Defaults to null, in which case the module falls back to individual AMI variables (deprecated).
+EOT
   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)
+    filter               = optional(map(list(string)), { state = ["available"] })
+    owners               = optional(list(string), ["amazon"])
+    id_ssm_parameter_arn = optional(string, null)
+    kms_key_arn          = optional(string, null)
   })
   default = null
 }

outputs.tf

@@ -77,8 +77,14 @@ output "instance_termination_handler" {
 }
 
 output "deprecated_variables_warning" {
-  description = "Warning for deprecated variables usage"
+  description = "Warning for deprecated variables usage. These variables will be removed in a future release. Please migrate to using the consolidated 'ami' object."
   value = join("", [
-    var.ami_id_ssm_parameter_name != null ? "DEPRECATION WARNING: The variable 'ami_id_ssm_parameter_name' is deprecated and will be removed in a future version. Please use 'ami.id_ssm_parameter_arn' instead.\n" : "",
+    # Show object migration warning only when ami is null and old variables are used
+    var.ami == null ? join("", [
+      (var.ami_filter != { state = ["available"] } || var.ami_owners != ["amazon"] || var.ami_kms_key_arn != null) ?
+      "DEPRECATION WARNING: You are using the deprecated AMI variables (ami_filter, ami_owners, ami_kms_key_arn). These variables will be removed in a future version. Please migrate to using the consolidated 'ami' object.\n" : "",
+    ]) : "",
+    # Always show warning for ami_id_ssm_parameter_name to migrate to ami_id_ssm_parameter_arn
+    var.ami_id_ssm_parameter_name != null ? "DEPRECATION WARNING: The variable 'ami_id_ssm_parameter_name' is deprecated and will be removed in a future version. Please use 'ami.id_ssm_parameter_arn' instead.\n" : ""
   ])
 }

variables.tf

@@ -367,13 +367,23 @@ variable "block_device_mappings" {
 }
 
 variable "ami" {
-  description = "AMI configuration for the action runner instances"
+  description = <<EOT
+AMI configuration for the action runner instances. This object allows you to specify all AMI-related settings in one place.
+
+Parameters:
+- `filter`: Map of lists to filter AMIs by various criteria (e.g., { name = ["ubuntu/images/hvm-ssd/ubuntu-jammy-22.04-amd64-*"], state = ["available"] })
+- `owners`: List of AMI owners to limit the search. Common values: ["amazon"], ["self"], or specific AWS account IDs
+- `id_ssm_parameter_name`: Name of an SSM parameter containing the AMI ID. If specified, this overrides the AMI filter
+- `id_ssm_parameter_arn`: ARN of an SSM parameter containing the AMI ID. If specified, this overrides both AMI filter and parameter name
+- `kms_key_arn`: Optional KMS key ARN if the AMI is encrypted with a customer managed key
+
+Defaults to null, in which case the module falls back to individual AMI variables (deprecated).
+EOT
   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)
+    filter               = optional(map(list(string)), { state = ["available"] })
+    owners               = optional(list(string), ["amazon"])
+    id_ssm_parameter_arn = optional(string, null)
+    kms_key_arn          = optional(string, null)
   })
   default = null
 }