fix variables

Author: kayman-mk

main.tf

@@ -110,6 +110,7 @@ module "runner" {
   docker_machine_ami_id = data.aws_ami.docker_machine_by_filter[0].id
   docker_machine_fleet_launch_template_name = var.runner_worker_docker_machine_fleet.enable == true ? aws_launch_template.fleet_gitlab_runner[0].name : ""
   docker_machine_tags = local.runner_tags_merged
+  docker_machine_instance = var.runner_worker_docker_machine_instance
 }
 
 # ignores: Autoscaling Groups Supply Tags --> we use a "dynamic" block to create the tags

modules/runner-config/locals.tf

@@ -1,4 +1,4 @@
-locals {
+  locals {
   template_runner_worker_config = templatefile("${path.module}/template/runner-worker-config.tftpl",
     {
       aws_region       = data.aws_region.current.name
@@ -57,37 +57,37 @@ locals {
 
   template_runner_docker_machine = templatefile("${path.module}/template/runner-docker-machine-config.tftpl",
     {
-      runners_idle_count     = var.runner_worker_docker_machine_instance.idle_count
-      runners_idle_time      = var.runner_worker_docker_machine_instance.idle_time
+      runners_idle_count     = var.docker_machine_instance.idle_count
+      runners_idle_time      = var.docker_machine_instance.idle_time
       runners_max_builds     = local.runners_max_builds_string
       docker_machine_name    = format("%s-%s", var.docker_machine_runner_name, "%s") # the last %s is always needed
-      runners_instance_types = var.runner_worker_docker_machine_instance.types
+      runners_instance_types = var.docker_machine_instance.types
       aws_region             = data.aws_region.current.name
       runners_aws_zone       = var.docker_machine_availability_zone_name
-      runners_userdata       = var.runner_worker_docker_machine_instance.start_script
+      runners_userdata       = var.docker_machine_instance.start_script
 
       runners_vpc_id           = var.vpc_id
       runners_subnet_id        = var.subnet_id
-      runners_subnet_ids       = length(var.runner_worker_docker_machine_instance.subnet_ids) > 0 ? var.runner_worker_docker_machine_instance.subnet_ids : [var.subnet_id]
+      runners_subnet_ids       = length(var.docker_machine_instance.subnet_ids) > 0 ? var.runner_worker_docker_machine_instance.subnet_ids : [var.subnet_id]
       runners_instance_profile = var.docker_machine_availability_zone_name
 
-      runners_use_private_address_only = var.runner_worker_docker_machine_instance.private_address_only
-      runners_use_private_address      = !var.runner_worker_docker_machine_instance.private_address_only
-      runners_request_spot_instance    = var.runner_worker_docker_machine_instance_spot.enable
-      runners_spot_price_bid           = var.runner_worker_docker_machine_instance_spot.max_price == "on-demand-price" || var.runner_worker_docker_machine_instance_spot.max_price == null ? "" : var.runner_worker_docker_machine_instance_spot.max_price
+      runners_use_private_address_only = var.docker_machine_instance.private_address_only
+      runners_use_private_address      = !var.docker_machine_instance.private_address_only
+      runners_request_spot_instance    = var.docker_machine_instance_spot.enable
+      runners_spot_price_bid           = var.docker_machine_instance_spot.max_price == "on-demand-price" || var.runner_worker_docker_machine_instance_spot.max_price == null ? "" : var.runner_worker_docker_machine_instance_spot.max_price
       runners_security_group_name      = var.docker_machine_security_group_name
 
       runners_tags                      = replace(replace(local.runner_tags_string, ",,", ","), "/,$/", "")
-      runners_ebs_optimized             = var.runner_worker_docker_machine_instance.ebs_optimized
-      runners_monitoring                = var.runner_worker_docker_machine_instance.monitoring
-      runners_iam_instance_profile_name = var.runner_worker_docker_machine_role.profile_name
-      runners_root_size                 = var.runner_worker_docker_machine_instance.root_size
-      runners_volume_type               = var.runner_worker_docker_machine_instance.volume_type
+      runners_ebs_optimized             = var.docker_machine_instance.ebs_optimized
+      runners_monitoring                = var.docker_machine_instance.monitoring
+      runners_iam_instance_profile_name = var.docker_machine_role.profile_name
+      runners_root_size                 = var.docker_machine_instance.root_size
+      runners_volume_type               = var.docker_machine_instance.volume_type
       runners_ami                       = var.runner_worker.type == "docker+machine" ? (length(var.runner_worker_docker_machine_ami_id) > 0 ? var.runner_worker_docker_machine_ami_id : var.docker_machine_ami_id) : ""
-      use_fleet                         = var.runner_worker_docker_machine_fleet.enable
+      use_fleet                         = var.docker_machine_fleet.enable
       launch_template                   = var.docker_machine_fleet_launch_template_name
       docker_machine_options            = length(local.docker_machine_options_string) == 1 ? "" : local.docker_machine_options_string
-      runners_max_growth_rate           = var.runner_worker_docker_machine_instance.max_growth_rate
+      runners_max_growth_rate           = var.docker_machine_instance.max_growth_rate
       runners_volume_kms_key            = var.kms_key_arn
     })
 

modules/runner-config/variables.tf

@@ -47,3 +47,63 @@ variable "kms_key_arn" {
     description = "The ARN of the KMS key to use for encrypting everything."
     type        = string
 }
+
+variable "docker_machine_instance" {
+    description = <<-EOT
+    For detailed documentation check https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runnersmachine-section
+
+    docker_registry_mirror_url = The URL of the Docker registry mirror to use for the Runner Worker.
+    destroy_after_max_builds = Destroy the instance after the maximum number of builds has been reached.
+    ebs_optimized = Enable EBS optimization for the Runner Worker.
+    idle_count = Number of idle Runner Worker instances (not working for the Docker Runner Worker) (IdleCount).
+    idle_time = Idle time of the Runner Worker before they are destroyed (not working for the Docker Runner Worker) (IdleTime).
+    max_growth_rate = The maximum number of machines that can be added to the runner in parallel.
+    monitoring = Enable detailed monitoring for the Runner Worker.
+    name_prefix = Set the name prefix and override the `Name` tag for the Runner Worker.
+    private_address_only = Restrict Runner Worker to the use of a private IP address. If `runner_instance.use_private_address_only` is set to `true` (default), `runner_worker_docker_machine_instance.private_address_only` will also apply for the Runner.
+    root_device_name = The name of the root volume for the Runner Worker.
+    root_size = The size of the root volume for the Runner Worker.
+    start_script = Cloud-init user data that will be passed to the Runner Worker. Should not be base64 encrypted.
+    subnet_ids = The list of subnet IDs to use for the Runner Worker when the fleet mode is enabled.
+    types = The type of instance to use for the Runner Worker. In case of fleet mode, multiple instance types are supported.
+    volume_type = The type of volume to use for the Runner Worker. `gp2`, `gp3`, `io1` or `io2` are supported.
+    volume_throughput = Throughput in MB/s for the volume. Only supported when using `gp3` as `volume_type`.
+    volume_iops = Guaranteed IOPS for the volume. Only supported when using `gp3`, `io1` or `io2` as `volume_type`. Works for fleeting only. See `runner_worker_docker_machine_fleet`.
+  EOT
+    type = object({
+        destroy_after_max_builds   = optional(number, 0)
+        docker_registry_mirror_url = optional(string, "")
+        ebs_optimized              = optional(bool, true)
+        idle_count                 = optional(number, 0)
+        idle_time                  = optional(number, 600)
+        max_growth_rate            = optional(number, 0)
+        monitoring                 = optional(bool, false)
+        name_prefix                = optional(string, "")
+        private_address_only       = optional(bool, true)
+        root_device_name           = optional(string, "/dev/sda1")
+        root_size                  = optional(number, 8)
+        start_script               = optional(string, "")
+        subnet_ids                 = optional(list(string), [])
+        types                      = optional(list(string), ["m5.large"])
+        volume_type                = optional(string, "gp2")
+        volume_throughput          = optional(number, 125)
+        volume_iops                = optional(number, 3000)
+    })
+    default = {
+    }
+
+    validation {
+        condition     = length(var.docker_machine_instance.name_prefix) <= 28
+        error_message = "Maximum length for docker+machine executor name is 28 characters!"
+    }
+
+    validation {
+        condition     = var.docker_machine_instance.name_prefix == "" || can(regex("^[a-zA-Z0-9\\.-]+$", var.docker_machine_instance.name_prefix))
+        error_message = "Valid characters for the docker+machine executor name are: [a-zA-Z0-9\\.-]."
+    }
+
+    validation {
+        condition     = contains(["gp2", "gp3", "io1", "io2"], var.docker_machine_instance.volume_type)
+        error_message = "Supported volume types: gp2, gp3, io1 and io2"
+    }
+}