banigoden / deployment-a-GitHub-Runner

This repository facilitates the deployment of a GitHub Runner/Admin instance into preferred Linux VMs.It sets up a Poetry environment for managing dependencies related to Terraform and Ansible.

Deploy GitHub Runner/Admin with Terraform and Ansible

Description

This repository facilitates the deployment of a GitHub Runner/Admin instance into preferred Linux VMs.It sets up a Poetry environment for managing dependencies related to Terraform and Ansible. Additionally, it incorporates pre-commit hooks defined in .pre-commit-config.yaml and installs cz for committing changes with conventional commit messages. The deployment process involves deploying a VM using Terraform and installing the GitHub Runner using Ansible. This typically includes creating a user and home directory, installing the GitHub Runner agent either manually or through Ansible, and creating a systemd unit using a Jinja2 template.

Requirements

• Terraform >= 1.0.4
• Ansible core >= 2.0
• Poetry

How to

1. Poetry Environment Setup

• Create a Poetry environment:

  poetry env create

2. Pre-commit Hooks

• Install pre-commit hooks:

  pre-commit install

3. Conventional Commit Messages

• Install cz for conventional commit messages:

  npm install -g commitizen

4. Terraform Deployment

• Deploy VM using Terraform (ensure correct environment variables in the .env file):

  terraform apply

5. Ansible Installation of GitHub Runner

• Create User and Home Directory (Ansible Role)

• Execute the following command:

  ansible-playbook playbook.yml --tags install_github_runner

• Install GitHub Runner Agent

• Manual Installation:

• Follow the manual instructions provided by GitHub.

• Ansible Installation:

• Execute the following command:

  ansible-playbook playbook.yml --tags install_github_runner

Terraform Variables

• Region:

• eu: eu-central-1

• Image:

• Amazon Linux 2024-x64: ami-0f7204385566b32d0

• Debian 12-x86: ami-042e6fdb154c830c5

GitHub Actions Secrets

• GITHUB_REPO_TOKEN: GitHub repository token required for GitHub Runner.

License

This project is licensed under the GNU GPL v3.