Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/amartingarcia/github-runner-aws-ec2

POC to integrate Github Actions and AWS EC2 with Github OIDC
https://github.com/amartingarcia/github-runner-aws-ec2

aws-ec2 github-actions github-oidc

Last synced: 23 days ago
JSON representation

POC to integrate Github Actions and AWS EC2 with Github OIDC

Host: GitHub
URL: https://github.com/amartingarcia/github-runner-aws-ec2
Owner: amartingarcia
Created: 2024-07-31T13:07:01.000Z (4 months ago)
Default Branch: main
Last Pushed: 2024-07-31T14:28:48.000Z (4 months ago)
Last Synced: 2024-10-12T23:43:13.420Z (about 1 month ago)
Topics: aws-ec2, github-actions, github-oidc
Language: HCL
Homepage:
Size: 2.09 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# github-runner-aws-ec2

This repository allows you to configure an AWS account and a GitHub repository to create an AWS EC2 Instance and use it as a GitHub runner during the execution of the Workflow, using the action [aws-actions/configure-aws-credentials](https://github.com/aws-actions/configure-aws-credentials):

This demo covers two cases: authentication with AWS via Access Key and Secret Key, and authentication with OIDC.

In both cases, you will first need a GitHub PAT with full `repo` permissions.

Next, create a `terraform.tfvars` file in the `terraform` directory with the following details:
```bash
region = "" # AWS region
access_key = "" # Access key of an admin user in AWS
secret_key = "" # Secret key of an admin user in AWS
github_repository = "" # Name of the GitHub repository
github_token = "" # PAT for your repository with repo scope
aws_subnet_id = "" # Subnet ID where you will deploy your runners
vpc_id = "" # VPC ID where you want to deploy your runners
```

The links I used as a reference are as follows:
* Access key and secret key -> https://github.com/marketplace/actions/on-demand-self-hosted-aws-ec2-runner-for-github-actions
* OIDC -> https://aws.amazon.com/blogs/security/use-iam-roles-to-connect-github-actions-to-actions-in-aws/

Check the files:
* [runner-ec2.yaml](.github/workflows/runner-ec2.yml) to understand this scenario.
* [runner-oidc.yaml](.github/workflows/runner-oidc.yml) to understand this scenario.

Also, review the Terraform files. Afterward, run terraform apply.

Once applied, add the changes to your repository and check that both pipelines are running correctly.

## Access key y Secret key
### Start instance
![](./images/ec2_start_instance.png)

### Ec2 console
![](./images/ec2_console.png)

### Run command
![](./images/ec2_run_command.png)

### Stop instance
![](./images/ec2_stop_instance.png)

## Con OIDC
### Start instance
![](./images/oidc_start_instance.png)

### Ec2 console
![](./images/oidc_console.png)

### Run command
![](./images/oidc_run_command.png)

### Stop instance
![](./images/oidc_stop_instance.png)