fixremove deprecated terraform variables

Author: npalm

examples/default/outputs.tf

@@ -12,9 +12,3 @@ output "webhook_secret" {
   sensitive = true
   value     = random_id.random.hex
 }
-
-output "deprecated_variables_warning" {
-  value = join("", [
-    module.runners.deprecated_variables_warning,
-  ])
-}

examples/ephemeral/main.tf

@@ -83,8 +83,10 @@ module "runners" {
 
   # configure your pre-built AMI
   # enable_userdata = false
-  # ami_filter      = { name = ["github-runner-al2023-x86_64-*"], state = ["available"] }
-  # ami_owners      = [data.aws_caller_identity.current.account_id]
+  # ami = {
+  #   filter = { name = ["github-runner-al2023-x86_64-*"], state = ["available"] }
+  #   owners = [data.aws_caller_identity.current.account_id]
+  # }
 
   # or use the default AMI
   # enable_userdata = true

examples/multi-runner/outputs.tf

@@ -6,9 +6,3 @@ output "webhook_secret" {
   sensitive = true
   value     = random_id.random.hex
 }
-
-output "deprecated_variables_warning" {
-  value = join("", [
-    module.runners.deprecated_variables_warning,
-  ])
-}

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

examples/prebuilt/README.md

@@ -33,9 +33,11 @@ Assuming you have built the `linux-al2023` image which has a pre-defined AMI nam
 module "runners" {
   ...
   # set the name of the ami to use
-  ami_filter        = { name = ["github-runner-al2023-x86_64-2023*"], state = ["available"] }
-  # provide the owner id of
-  ami_owners        = ["<your owner id>"]
+  ami = {
+    filter = { name = ["github-runner-al2023-x86_64-2023*"], state = ["available"] }
+    # provide the owner id of
+    owners = ["<your owner id>"]
+  }
 
   enable_userdata = false
   ...
@@ -49,7 +51,10 @@ data "aws_caller_identity" "current" {}
 
 module "runners" {
   ...
-  ami_owners       = [data.aws_caller_identity.current.account_id]
+  ami = {
+    filter = { name = ["github-runner-al2023-x86_64-2023*"], state = ["available"] }
+    owners = [data.aws_caller_identity.current.account_id]
+  }
   ...
 }
 ```

examples/prebuilt/main.tf

@@ -45,8 +45,10 @@ module "runners" {
 
   # configure your pre-built AMI
   enable_userdata = false
-  ami_filter      = { name = [var.ami_name_filter], state = ["available"] }
-  ami_owners      = [data.aws_caller_identity.current.account_id]
+  ami = {
+    filter = { name = [var.ami_name_filter], state = ["available"] }
+    owners = [data.aws_caller_identity.current.account_id]
+  }
 
   # disable binary syncer since github agent is already installed in the AMI.
   enable_runner_binaries_syncer = false

main.tf

@@ -177,12 +177,8 @@ module "runners" {
   instance_max_spot_price       = var.instance_max_spot_price
   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_name = var.ami_id_ssm_parameter_name
-  ami_kms_key_arn           = var.ami_kms_key_arn
+  runner_architecture = var.runner_architecture
+  ami                 = var.ami
 
   sqs_build_queue                      = aws_sqs_queue.queued_builds
   github_app_parameters                = local.github_app_parameters

modules/multi-runner/outputs.tf

@@ -67,23 +67,3 @@ output "instance_termination_handler" {
     lambda_role      = module.instance_termination_watcher[0].spot_termination_handler.lambda_role
   } : null
 }
-
-output "deprecated_variables_warning" {
-  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 : (
-      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/runners.tf

@@ -27,9 +27,6 @@ module "runners" {
 
   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_kms_key_arn     = each.value.runner_config.ami_kms_key_arn
 
   sqs_build_queue                      = { "arn" : each.value.arn, "url" : each.value.url }
   github_app_parameters                = local.github_app_parameters

modules/multi-runner/variables.tf

@@ -70,12 +70,7 @@ variable "multi_runner_config" {
         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"])
-      ami_id_ssm_parameter_name               = optional(string, null)
-      ami_kms_key_arn                         = optional(string, "")
+      }), null)
       create_service_linked_role_spot         = optional(bool, false)
       credit_specification                    = optional(string, null)
       delay_webhook_event                     = optional(number, 30)
@@ -183,8 +178,6 @@ variable "multi_runner_config" {
         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.
         credit_specification: "(Optional) The credit specification of the runner instance_type. Can be unset, `standard` or `unlimited`.
         delay_webhook_event: "The number of seconds the event accepted by the webhook is invisible on the queue before the scale up lambda will receive the event."