https://github.com/infraspecdev/terraform-aws-gitlab-shell-runner

Terraform module which provisions EC2 instances as Shell Runners for Gitlab Projects
https://github.com/infraspecdev/terraform-aws-gitlab-shell-runner

Last synced: 3 days ago
JSON representation

Terraform module which provisions EC2 instances as Shell Runners for Gitlab Projects

• Host: GitHub
• URL: https://github.com/infraspecdev/terraform-aws-gitlab-shell-runner
• Owner: infraspecdev
• Created: 2023-01-23T05:48:00.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-26T17:00:13.000Z (about 1 month ago)
• Last Synced: 2024-11-26T17:46:14.297Z (about 1 month ago)
• Language: HCL
• Homepage:
• Size: 18.6 KB
• Stars: 1
• Watchers: 5
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# gitlab-shell-runner

This Terraform module provisions an AWS EC2 instance and configures it as a GitLab Runner with Shell executor, allowing it to run CI/CD jobs for your GitLab projects. The module can be used to deploy multiple runners and can be customized to your specific needs.

## Usage

```hcl

module "gitlab_shell_runner" {

  source = "https://github.com/infraspecdev/terraform-aws-gitlab-shell-runner"

  ami_id                    = "ami-0addfae420fd47aab"

  instance_type             = "t2.micro"

  instance_count            = 2

  vpc_security_group_ids    = ["sg-0b0b0b0b0b0b0b0b0"]

  subnet_id                 = "subnet-0b0e1c4b5b1b1b1b1"

  gitlab_url                = "https://gitlab.example.com"

  runner_registration_token = "runner-registration-token-here"

  ssh_public_key            = "ssh-public-key-here"

}

```

## Examples

[Example](examples/gitlab-shell-runner-setup)

## Requirements

| Name | Version |

|------|---------|

|  [terraform](#requirement\_terraform) | ~> 1.3.0 |

|  [aws](#requirement\_aws) | >= 4.49.0 |

## Providers

| Name | Version |

|------|---------|

|  [aws](#provider\_aws) | 4.51.0 |

## Modules

No modules.

## Resources

| Name | Type |

|------|------|

| [aws_instance.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/instance) | resource |

| [aws_key_pair.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/key_pair) | resource |

## Inputs

| Name | Description | Type | Default | Required |

|------|-------------|------|---------|:--------:|

|  [additional\_tags](#input\_additional\_tags) | Additional tags to apply to the resources | `map(string)` | `{}` | no |

|  [ami\_id](#input\_ami\_id) | AMI to use for the instance | `string` | `"ami-0addfae420fd47aab"` | no |

|  [gitlab\_url](#input\_gitlab\_url) | URL of your Gitlab instance | `string` | n/a | yes |

|  [instance\_count](#input\_instance\_count) | Number of instances to provision | `number` | n/a | yes |

|  [instance\_type](#input\_instance\_type) | Type of instance to provision | `string` | n/a | yes |

|  [run\_untagged\_jobs](#input\_run\_untagged\_jobs) | Should run untagged jobs or not | `bool` | `true` | no |

|  [runner\_description](#input\_runner\_description) | Description for Gitlab Runners | `string` | `"Shell Runner"` | no |

|  [runner\_locked](#input\_runner\_locked) | Should Lock the runners or not | `bool` | `false` | no |

|  [runner\_registration\_token](#input\_runner\_registration\_token) | Registration token for Gitlab Runners | `string` | n/a | yes |

|  [runner\_tags](#input\_runner\_tags) | Tags for Gitlab Runners for filtering | `list(string)` | 
[
  "shell",
  "aws"
]
 | no |

|  [ssh\_public\_key](#input\_ssh\_public\_key) | Existing SSH public key to use for the key pair | `string` | `null` | no |

|  [subnet\_id](#input\_subnet\_id) | VPC Subnet ID to launch in | `string` | n/a | yes |

|  [vpc\_security\_group\_ids](#input\_vpc\_security\_group\_ids) | List of security group IDs to associate | `list(string)` | n/a | yes |


## Outputs

No outputs.

## Authors

Module maintained by [Infraspec](https://github.com/infraspecdev).