### Initialize Terraform

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/docs/usage.md

Run this command in your project directory to download and install the necessary Terraform providers and modules.

```sh
terraform init
```

--------------------------------

### Build Ubuntu AMI with Docker

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/packer_images/README.md

Use this command to build an Ubuntu AMI with Docker installed. The `docker_registry_mirror` argument is optional.

```bash
packer build -var 'vpc_id=your_vpc_id' -var 'subnet_id=your_subnet_id' -var 'docker_registry_mirror=docker-registry-url' ubuntu-docker.json
```

--------------------------------

### Configure Runner Installation Inputs

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/README.md

Defines the configuration for installing the GitLab Runner, including options for ECR credential helper, Docker Machine download URL and version, pre/post install scripts, start script, and yum update.

```terraform
object({
    amazon_ecr_credential_helper = optional(bool, false)
    docker_machine_download_url  = optional(string, "")
    docker_machine_version       = optional(string, "0.16.2-gitlab.19-cki.5")
    pre_install_script           = optional(string, "")
    post_install_script          = optional(string, "")
    start_script                 = optional(string, "")
    yum_update                   = optional(bool, true)
  })
```

--------------------------------

### Full Example with Lifecycle Hook Enabled

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/modules/terminate-agent-hook/README.md

Demonstrates using the parent module with the lifecycle hook enabled. Pay attention to the `asg_terminate_lifecycle_hook_*` variables.

```terraform
module "runner" {
  source  = "cattle-ops/gitlab-runner/aws"
  
  environment                   = "runners-test"

  vpc_id    = module.vpc.vpc_id
  subnet_id = data.aws_subnet.runner.id

  runner_gitlab = {
    url = "https://gitlab.com"
    access_token_secure_parameter_store_name = aws_ssm_parameter.gitlab_registration_token.value
  }

  runner_instance = {
    name       = "runners-test"
    max_lifetime_seconds = 604800
  }

  runner_worker_docker_machine_instance = {
    types = ["t3.large"]
  }

  runner_worker_docker_machine_instance_spot = {
    enable = false
  }

  runner_worker_docker_machine_role = {
    profile_name = foo-gitlab-runner-profile
    policy_arns  = [data.aws_iam_policy.sas_full_rights.arn]
  }
  
  runner_worker_docker_machine_autoscaling_options = var.runners_machine_autoscaling

  runner_worker_cache = {
    shared = true
    bucket_prefix = var.environment
    expiration_days = 90
  }

  runner_gitlab_registration_config = {
    type               = "instance" # or "group" or "project"
    # group_id           = 1234 # for "group"
    # project_id         = 5678 # for "project"
    tag_list           = "docker"
    description        = "runner default"
    locked_to_project  = "true"
    run_untagged       = "false"
    maximum_timeout    = "3600"
  }

  # Refer to https://docs.docker.com/machine/drivers/aws/#options
  # for 'docker_machine_options' settings with the AWS driver
  runner_worker_docker_options = var.docker_machine_options
  
  tags = local.common_tags
}

```

--------------------------------

### Build Amazon Linux 2023 AMI with Docker

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/packer_images/README.md

Use this command to build an Amazon Linux 2023 AMI with Docker installed. The `docker_registry_mirror` argument is optional.

```bash
packer build -var 'vpc_id=your_vpc_id' -var 'subnet_id=your_subnet_id' -var 'docker_registry_mirror=docker_registry_url' amz-linux-docker.json
```

--------------------------------

### Multi-Region GitLab Runner Deployment

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/docs/usage.md

Configure for multi-region deployments by using prefixes to avoid name clashes for global AWS resources. This example sets a region-specific prefix for IAM objects and the cache bucket.

```hcl
module "runner" {
  # https://registry.terraform.io/modules/cattle-ops/gitlab-runner/aws/
  source  = "cattle-ops/gitlab-runner/aws"

  environment = "multi-region-1"
  iam_object_prefix = "<region-specific-prefix>-gitlab-runner-iam"

  vpc_id    = module.vpc.vpc_id
  subnet_id = element(module.vpc.private_subnets, 0)

  runner_gitlab = {
    url = "https://gitlab.com"

    preregistered_runner_token_ssm_parameter_name = "my-gitlab-runner-token-ssm-parameter-name"
  }

   runner_worker_cache = {
     bucket_prefix = "<region-specific-prefix>"
   }

   runner_worker_docker_machine_instance = {
     subnet_ids = module.vpc.private_subnets
   }
}
```

--------------------------------

### Terraform Module Usage

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/modules/terminate-agent-hook/README.md

Example of how to interact with the terminate-agent-hook module via the parent module's input variables. Ensure `asg_terminate_lifecycle_hook_create` is set to true to enable the hook.

```terraform
module "runner" {
  source  = "cattle-ops/gitlab-runner/aws"

  asg_terminate_lifecycle_hook_create         = true

  ...

```

--------------------------------

### Basic Cache Module Usage

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/modules/cache/README.md

Example of how to include the cache module in your Terraform configuration. This creates a dedicated S3 bucket for caching.

```hcl
module "cache" {
  source      = "https://github.com/cattle-ops/terraform-gitlab-runner/tree/move-cache-to-moudle/cache"
  environment = "cache"
}
```

--------------------------------

### Pipeline before_script for Certificates

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/examples/runner-certificates/README.md

Add a `before_script` section to your GitLab CI/CD pipeline configuration to install and trust custom CA certificates within the user image. This approach requires manual addition to each pipeline file.

```yaml
default:
  before_script:
    # Install certificates into user image
    - apt-get install -y ca-certificates
    - cp /etc/gitlab-runner/certs/* /usr/local/share/ca-certificates/
    - update-ca-certificates

```

--------------------------------

### Runner Pre-build Script for Certificates

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/examples/runner-certificates/README.md

Configure the `runners_pre_build_script` variable in your Terraform module to automatically execute commands for installing and trusting custom CA certificates in user images. This centralizes the configuration and avoids repetition in pipeline files, assuming a consistent OS across user images.

```terraform
module "runner" {
  # ...

  runner_worker_gitlab_pipeline = {
    pre_build_script = <<EOT
    '''
    apt-get install -y ca-certificates
    cp /etc/gitlab-runner/certs/* /usr/local/share/ca-certificates/
    update-ca-certificates
    '''
    EOT
  }
  # ...
}
```

--------------------------------

### Custom User Image Dockerfile

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/examples/runner-certificates/README.md

Build a custom Docker image for your user jobs that includes commands to install and trust custom CA certificates. This ensures that processes within the user image can securely communicate with internal services.

```dockerfile
FROM python:3 # Some base image

RUN apt-get -y update
RUN apt-get -y upgrade

RUN apt-get install -y ca-certificates
RUN cp /etc/gitlab-runner/certs/* /usr/local/share/ca-certificates/
RUN update-ca-certificates
...

```

--------------------------------

### Plan Terraform Apply

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/docs/usage.md

Execute this command to preview the infrastructure changes that will be made before applying them. It helps in verifying the resources to be created.

```sh
terraform plan
```

--------------------------------

### Build Windows Server 2022 AMI

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/packer_images/README.md

Use this command to build a Windows Server 2022 AMI. The `runner_version` argument is optional.

```bash
packer build -var 'runner_version=your_runner_version' windows-server-2022.hcl
```

--------------------------------

### Apply Terraform Configuration

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/docs/usage.md

Use this command to create the GitLab Runner infrastructure as defined in your Terraform configuration files. This will provision the necessary AWS resources.

```sh
terraform apply
```

--------------------------------

### Basic GitLab Runner Deployment

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/docs/usage.md

This snippet shows a basic configuration for deploying a GitLab Runner. Ensure your GitLab instance version is 16.0.0 or higher.

```hcl
module "runner" {
  # https://registry.terraform.io/modules/cattle-ops/gitlab-runner/aws/
  source  = "cattle-ops/gitlab-runner/aws"

  environment = "spot-runners"

  vpc_id    = module.vpc.vpc_id
  subnet_id = element(module.vpc.private_subnets, 0)

  runner_instance = {
    name       = "docker-default"
  }

  runner_gitlab = {
    url = "https://gitlab.com"

    preregistered_runner_token_ssm_parameter_name = "my-gitlab-runner-token-ssm-parameter-name"
  }
}
```

--------------------------------

### Configure Docker Machine Instance for GitLab Runner

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/README.md

Defines the configuration for a Docker machine instance used by a GitLab Runner. Includes settings for instance lifecycle, Docker registry, EBS optimization, idle counts, monitoring, naming, private networking, root volume, and startup scripts.

```HCL
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)
  })
```

--------------------------------

### Configure Runner Helper CA Bundle

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/examples/runner-certificates/README.md

Add your custom CA and intermediary certificates to a PEM-encoded file to be used by the runner-helper image. This ensures trust in your internal certificate hierarchy.

```hcl
module {
  # ...
  # Other public certs relating to my company.
  runner_gitlab = {
    ca_certificate = file("${path.module}/my_company_ca_cert_bundle.crt")
  }
  # ...
}
```

--------------------------------

### Configure GitLab Runner Inputs

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/README.md

Defines the input object for configuring GitLab Runner settings. Includes options for certificates, runner version, GitLab instance URLs, and secure parameter store names for tokens. Note that `registration_token` and `access_token_secure_parameter_store_name` are deprecated.

```terraform
object({
    ca_certificate                                = optional(string, "")
    certificate                                   = optional(string, "")
    registration_token                            = optional(string, "__REPLACED_BY_USER_DATA__") # deprecated, do not use, will be removed
    runner_version                                = optional(string, "16.0.3")
    url                                           = optional(string, "")
    url_clone                                     = optional(string, "")
    access_token_secure_parameter_store_name      = optional(string, "gitlab-runner-access-token") # deprecated, do not use, will be removed
    preregistered_runner_token_ssm_parameter_name = optional(string, "")
  })
```

--------------------------------

### Spot Fleet Configuration for GitLab Runner

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/docs/usage.md

This configuration enables Spot Fleet for GitLab Runners, allowing AWS to select available instance types and AZs to ensure capacity. It also adjusts the instance type to 't3.small' due to increased RAM consumption with Spot Fleets.

```hcl
module "runner" {
  # https://registry.terraform.io/modules/cattle-ops/gitlab-runner/aws/
  source  = "cattle-ops/gitlab-runner/aws"

  environment = "spot-fleet"

  vpc_id    = module.vpc.vpc_id
  subnet_id = element(module.vpc.private_subnets, 0)

  runner_gitlab = {
    url = "https://gitlab.com"

    preregistered_runner_token_ssm_parameter_name = "my-gitlab-runner-token-ssm-parameter-name"
 }

  runner_worker = {
    type = "docker+machine"
  }

  runner_worker_docker_machine_fleet = {
    enable = true
  }

  runner_worker_docker_machine_instance = {
    types = ["t3a.medium", "t3.medium", "t2.medium"]
    subnet_ids = module.vpc.private_subnets
  }
}
```

--------------------------------

### Configure Runner Worker Docker Autoscaler

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/README.md

Sets up the autoscaler for runner worker Docker instances. This includes specifying the fleeting plugin version, connection details, instance capacity, and commands to ensure instance readiness.

```HCL
object({
    fleeting_plugin_version        = optional(string, "1.0.0")
    connector_config_user          = optional(string, "ec2-user")
    key_pair_name                  = optional(string, "runner-worker-key")
    capacity_per_instance          = optional(number, 1)
    max_use_count                  = optional(number, 100)
    update_interval                = optional(string, "1m")
    update_interval_when_expecting = optional(string, "2s")
    instance_ready_command         = optional(string, "")
  })
```

--------------------------------

### Configure Runner Instance Inputs

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/README.md

Specifies the configuration for a GitLab Runner instance, including additional tags, autoscaling metrics collection, EBS optimization, maximum lifetime, monitoring, name, private address restriction, root device configuration, spot price, SSM access, instance type, and EIP assignment.

```terraform
object({
    additional_tags             = optional(map(string))
    collect_autoscaling_metrics = optional(list(string), null)
    ebs_optimized               = optional(bool, true)
    max_lifetime_seconds        = optional(number, null)
    monitoring                  = optional(bool, true)
    name                        = string
    name_prefix                 = optional(string)
    private_address_only        = optional(bool, true)
    root_device_config          = optional(map(string), {})
    spot_price                  = optional(string, null)
    ssm_access                  = optional(bool, false)
    type                        = optional(string, "t3.micro")
    use_eip                     = optional(bool, false)
  })
```

--------------------------------

### Configure Spot Instances for GitLab Runner Worker

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/README.md

Enables or disables the use of AWS Spot Instances for GitLab Runner workers and sets the maximum price. Defaults to enabling spot instances with the price capped at the on-demand rate.

```HCL
object({
    enable    = optional(bool, true)
    max_price = optional(string, "on-demand-price")
  })
```

--------------------------------

### Runner Metadata Options Object

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/README.md

Configures the Runner instance metadata service, with IMDSv2 enabled by default. Specifies endpoint, token requirements, hop limits, and tag settings.

```hcl
object({
    http_endpoint               = string
    http_tokens                 = string
    http_put_response_hop_limit = number
    instance_metadata_tags      = string
  })
```

```json
{
  "http_endpoint": "enabled",
  "http_put_response_hop_limit": 2,
  "http_tokens": "required",
  "instance_metadata_tags": "disabled"
}
```

--------------------------------

### Integrating Cache Module with Runner Module

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/modules/cache/README.md

Demonstrates how to configure the main GitLab Runner module to use a cache bucket created by the separate cache module. Ensure the cache module is defined before the runner module if referencing its outputs.

```hcl
module "runner" {
  source  = "cattle-ops/gitlab-runner/aws"

  ...

  cache_bucket = {
    create = false
    policy = "${module.cache.policy_arn}"
    bucket = "${module.cache.bucket}"
  }

}
```

--------------------------------

### Configure Runner Registration Token and GitLab URL

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/docs/usage.md

Define the SSM parameter name for the runner registration token and the URL of your GitLab instance in a terraform.tfvars file. This is essential for the runner to register with your GitLab project.

```hcl
preregistered_runner_token_ssm_parameter_name = "my-gitlab-runner-token-ssm-parameter-name"
gitlab_url   = "https://my.gitlab.instance/"
```

--------------------------------

### Create IAM Service Linked Roles

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/docs/usage.md

Defines IAM service-linked roles for Spot and Auto Scaling. Ensure these roles exist if `allow_iam_service_linked_role_creation` is set to false.

```hcl
resource "aws_iam_service_linked_role" "spot" {
  aws_service_name = "spot.amazonaws.com"
}

resource "aws_iam_service_linked_role" "autoscaling" {
  aws_service_name = "autoscaling.amazonaws.com"
}
```

--------------------------------

### Mount Certificates in User Images

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/examples/runner-certificates/README.md

Configure the runner module to mount certificates from the EC2 host into Docker user images. This makes the certificates available within the user's execution environment.

```terraform
module "runner" {
  # ...

  # Mount EC2 host certs in docker so all user docker images can reference them.
  runner_worker_docker_options = {
    volumes = ["/etc/gitlab-runner/certs/:/etc/gitlab-runner/certs:ro"]
  }

  # ...
}
```

--------------------------------

### Enable Docker-in-Docker Volumes for Runner Worker

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/README.md

Enables the addition of certificates and the docker.sock to volumes, which is necessary for supporting Docker-in-Docker (dind) functionality within the runner worker.

```HCL
bool
```

--------------------------------

### Configure Graceful Termination Lambda

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/docs/usage.md

Sets environment variables, egress rules, handler, and layer ARNs for the Lambda function used in graceful termination. The `old_handler` variable is automatically replaced.

```hcl
module "runner" {
  # ...
   runner_terminate_ec2_environment_variables = {
     variable1    = "here"
     variable2    = "are"
     old_handler = "{HANDLER}" # automatically replaced by the correct value
   }
   runner_terminate_ec2_lambda_egress_rules = {
      # ... whatever you need, IPv4/IPv6 port 443 is the default
   }
   runner_terminate_ec2_lambda_handler = "instrumented_handler.from.a.layer"
   runner_terminate_ec2_lambda_layer_arns = ["arn:aws:lambda:us-east-1:123456789012:layer:instrumented_handler:1"]
}
```

--------------------------------

### Configure Runner Helper Certificate

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/examples/runner-certificates/README.md

Provide the public certificate of your GitLab server instance to the runner-helper image. This is necessary for the runner to securely communicate with your GitLab instance.

```hcl
module {
  # ...
  # Public cert of my company's gitlab instance
  runner_gitlab = {
    certificate = file("${path.module}/my_gitlab_instance_cert.crt")
  }
  # ...
}
```

--------------------------------

### Docker Autoscaler Configuration for GitLab Runner

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/docs/usage.md

This snippet configures the GitLab Runner to use Docker autoscaler, replacing the unmaintained Docker machine. It specifies AMI filters, owners, and autoscaler settings for the Auto Scaling Group and the autoscaler itself.

```hcl
module "runner" {
  source = "cattle-ops/gitlab-runner/aws"

  vpc_id = module.vpc.vpc_id
  subnet_id = element(module.vpc.private_subnets, 0)

  runner_gitlab = {
    url      = "https://gitlab.com"
    preregistered_runner_token_ssm_parameter_name = "my-gitlab-runner-token-ssm-parameter-name"
  }

  runner_ami_filter = {
    name = ["amazon-linux-2-x86"]
  }

  runner_ami_owners = ["amazon"]
  
  runner_worker = {
    max_jobs            = 5
    request_concurrency = 5
    type                = "docker-autoscaler"
  }

  runner_worker_docker_autoscaler_asg = {
    on_demand_percentage_above_base_capacity = 0
    enable_mixed_instances_policy            = true
    subnet_ids                               = module.vpc.private_subnets
    types = ["t3a.medium", "t3.medium"]
  }

  runner_worker_docker_autoscaler = {
    connector_config_user = "ubuntu" # this user id is used to connect to the instance via SSH
  }

  runner_worker_docker_autoscaler_ami_filter = {
    name = ["ubuntu-server-22-lts-x86-*"]
  }

  runner_worker_docker_autoscaler_ami_owners = ["099720109477"] # Canonical
}
```

--------------------------------

### Configure Runner Worker Cache Bucket

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/README.md

Defines the configuration for the cache bucket used by the runner worker. Allows control over bucket creation, access logging, and object expiration. Defaults to creating a shared cache bucket.

```HCL
object({
    access_log_bucket_id                     = optional(string, null)
    access_log_bucket_prefix                 = optional(string, null)
    authentication_type                      = optional(string, "iam")
    bucket                                   = optional(string, "")
    bucket_prefix                            = optional(string, "")
    create                                   = optional(bool, true)
    create_aws_s3_bucket_public_access_block = optional(bool, true)
    expiration_days                          = optional(number, 1)
    include_account_id                       = optional(bool, true)
    policy                                   = optional(string, "")
    random_suffix                            = optional(bool, false)
    shared                                   = optional(bool, false)
    versioning                               = optional(bool, false)
  })
```

--------------------------------

### Runner Networking Configuration Object

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/README.md

Manages network settings for the Runner, including options to allow ICMP ping and specify associated security group IDs. Also includes descriptions for security groups.

```hcl
object({
    allow_incoming_ping                    = optional(bool, false)
    allow_incoming_ping_security_group_ids = optional(list(string), [])
    security_group_description             = optional(string, "A security group containing gitlab-runner agent instances")
    security_group_ids                     = optional(list(string), [])
  })
```

--------------------------------

### Runner Sentry Secure Parameter Store Name String

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/README.md

Specifies the name of the Secure Parameter Store where the Sentry DSN is stored for the Runner.

```hcl
string
```

```json
"sentry-dsn"
```

--------------------------------

### Default Runner Instance Name

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/README.md

Sets the default name for the GitLab Runner instance to 'gitlab-runner'.

```json
{
  "name": "gitlab-runner"
}
```

--------------------------------

### Runner Role Configuration Object

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/README.md

Defines the IAM role configuration for the Runner, including additional tags, service-linked role creation, assume role policy, and policy ARNs. Allows for custom role profile names.

```hcl
object({
    additional_tags                        = optional(map(string))
    allow_iam_service_linked_role_creation = optional(bool, true)
    assume_role_policy_json                = optional(string, "")
    create_role_profile                    = optional(bool, true)
    policy_arns                            = optional(list(string), [])
    role_profile_name                      = optional(string)
  })
```

--------------------------------

### Deprecated GitLab Runner Registration Configuration

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/README.md

Specifies deprecated input object for GitLab Runner registration configuration. This object is replaced by `runner_gitlab.preregistered_runner_token_ssm_parameter_name` and should not be used.

```terraform
object({
    registration_token = optional(string, "__GITLAB_REGISTRATION_TOKEN_FROM_SSM__") # deprecated, do not use, will be removed
    tag_list           = optional(string, "")                                       # deprecated, do not use, will be removed
    description        = optional(string, "")                                       # deprecated, do not use, will be removed
    type               = optional(string, "")                                       # deprecated, do not use, will be removed
    group_id           = optional(string, "")                                       # deprecated, do not use, will be removed
    project_id         = optional(string, "")                                       # deprecated, do not use, will be removed
    locked_to_project  = optional(string, "")                                       # deprecated, do not use, will be removed
    run_untagged       = optional(string, "")                                       # deprecated, do not use, will be removed
    maximum_timeout    = optional(string, "")                                       # deprecated, do not use, will be removed
    access_level       = optional(string, "not_protected")                          # deprecated, do not use, will be removed
  })
```

--------------------------------

### Destroy Terraform Resources

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/docs/usage.md

Run this command to remove all the AWS resources provisioned by the Terraform module, effectively tearing down the GitLab Runner infrastructure.

```sh
terraform destroy
```

--------------------------------

### Runner Manager Configuration Object

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/README.md

Defines the configuration for the GitLab Runner manager, including job checking intervals, maximum concurrent jobs, Prometheus metrics address, Sentry DSN, and connection age.

```hcl
object({
    gitlab_check_interval     = optional(number, 3)
    maximum_concurrent_jobs   = optional(number, 10)
    prometheus_listen_address = optional(string, "")
    sentry_dsn                = optional(string, "__SENTRY_DSN_REPLACED_BY_USER_DATA__")
    connection_max_age        = optional(string, "15m")
  })
```

--------------------------------

### Runner Schedule Configuration Map

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/README.md

Configures the auto-scaling group schedule for the Runner, specifying counts and recurrence for scale-in and scale-out operations, along with time zones.

```hcl
map(any)
```

```json
{
  "scale_in_count": 0,
  "scale_in_recurrence": "0 18 * * 1-5",
  "scale_in_time_zone": "Etc/UTC",
  "scale_out_count": 1,
  "scale_out_recurrence": "0 8 * * 1-5",
  "scale_out_time_zone": "Etc/UTC"
}
```

--------------------------------

### Configure Auto Scaling Group Scheduled Scaling

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/docs/usage.md

Enables and configures scheduled scaling actions for the Auto Scaling Group. Define recurrence patterns and counts for scale-out and scale-in events.

```hcl
module "runner" {
  # ...
  runner_schedule_enable = true
  runner_schedule_config = {
    # Configure optional scale_out scheduled action
    scale_out_recurrence = "0 8 * * 1-5"
    scale_out_count      = 1 # Default for min_size, desired_capacity and max_size
    # Override using: scale_out_min_size, scale_out_desired_capacity, scale_out_max_size

    # Configure optional scale_in scheduled action
    scale_in_recurrence  = "0 18 * * 1-5"
    scale_in_count       = 0 # Default for min_size, desired_capacity and max_size
    # Override using: scale_out_min_size, scale_out_desired_capacity, scale_out_max_size
  }
}
```

--------------------------------

### Enable Runner Auto Scaling Schedule Boolean

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/README.md

A boolean flag to enable or disable the auto-scaling group schedule for the Runner.

```hcl
bool
```

```json
false
```

--------------------------------

### Deprecated GitLab Runner Registration Token SSM Parameter Name

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/README.md

Input for the name of the SSM parameter storing the GitLab Runner registration token. This is deprecated and replaced by `runner_gitlab.preregistered_runner_token_ssm_parameter_name`.

```terraform
string
```

--------------------------------

### Configure Ingress Rules for Runner Manager Security Group

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/README.md

Defines a map of ingress rules for the Runner Manager's security group. Each rule specifies ports, protocol, description, and CIDR blocks or other network sources.

```terraform
map(object({
    from_port       = optional(number, null)
    to_port         = optional(number, null)
    protocol        = string
    description     = string
    cidr_block      = optional(string, null)
    ipv6_cidr_block = optional(string, null)
    prefix_list_id  = optional(string, null)
    security_group  = optional(string, null)
  }))
```

--------------------------------

### Configure IAM Role for GitLab Runner Worker

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/README.md

Defines IAM role configurations for GitLab Runner workers, including additional tags, assume role policy, attached IAM policies, and the IAM profile name.

```HCL
object({
    additional_tags         = optional(map(string), {})
    assume_role_policy_json = optional(string, "")
    policy_arns             = optional(list(string), [])
    profile_name            = optional(string, "")
  })
```

--------------------------------

### S3 Bucket Policy for Access Logging

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/docs/usage.md

When enabling access logging for the S3 cache bucket, this JSON statement must be added to your S3 logging bucket policy to allow access logging.

```json
{
    "Sid": "Allow access logging",
    "Effect": "Allow",
    "Principal": {
        "Service": "logging.s3.amazonaws.com"
    },
    "Action": "s3:PutObject",
    "Resource": "<s3-arn>/*"
}
```

--------------------------------

### Terraform Error: Invalid count argument with Shared Cache Bucket

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/docs/pitfalls.md

When managing the S3 cache bucket yourself, apply the cache resources first using `terraform apply -target=module.cache` before applying the entire module.

```text
Error: Invalid count argument
on .terraform/modules/gitlab_runner/main.tf line 400, in resource "aws_iam_role_policy_attachment" "docker_machine_cache_instance":
  count = var.cache_bucket["create"] || length(lookup(var.cache_bucket, "policy", "")) > 0 ? 1 : 0
The "count" value depends on resource attributes that cannot be determined until apply, so Terraform cannot predict how many
instances will be created. To work around this, use the -target argument to first apply only the resources that the count
depends on.
```

--------------------------------

### Setting GitLab Runner Instance Name

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/docs/pitfalls.md

Use the `runner_instance.name` variable to set the EC2 instance name. Setting the `Name` tag in `additional_tags` does not affect the instance name.

```hcl
# working
runner_instance = {
  name  = "my-gitlab-runner-name"
}

# not working
runner_instance = {
  additional_tags = {
    Name = "my-gitlab-runner-name"
  }
}
```

--------------------------------

### Define Security Group Description for Runner Worker

Source: https://github.com/cattle-ops/terraform-aws-gitlab-runner/blob/main/README.md

Sets a descriptive string for the security group associated with GitLab Runner worker instances.

```HCL
"A security group containing Runner Worker instances"
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.