This role will deploy/redeploy/uninstall and register/unregister local GitHub Actions Runner.
It supports both, Organization and Repository Runners.
-
System must have access to the GitHub.
-
The role require Personal Access Token to access the GitHub. The token has to be a value of
PERSONAL_ACCESS_TOKEN
variable. Export the token to the local host environment.
The token must have the
repo
scope (when creating a repo runner) or theadmin:org
scope (when creating a runner for an organization). Personal Access Token for GitHub account can be created here.
โ ๏ธ Never store you personal access token in the GitHub repository. Use GitHub Secrets or some different secrets service.
-
Runner user has to be pre-created. Recommended role:
monolithprojects.user_management
-
CentOS systems require EPEL repository. Recommended role:
robertdebock.epel
- ARM, ARM64 (dependencies installation is not covered by this role)
- AMD64, x86_64
-
CentOS/RHEL 7,8
-
Debian 9,10
-
Fedora 32,33
-
Ubuntu 16,18,20
Note: Fedora 32+ and Ubuntu 20 must use Ansible 2.9.8+. Other distros/releases will work also with older 2.8.0+ Ansible.
This is a copy from defaults/main.yml
# Runner user - user under which is the local runner service running
runner_user: "{{ lookup('env','USER') }}"
# Directory where the local runner will be installed
runner_dir: /opt/actions-runner
# Directory where the runner package will be dowloaded
runner_pkg_tempdir: /tmp/gh_actions_runner
# Version of the GitHub Actions Runner
runner_version: "latest"
# State in which the runner service will be after the role is done (started, stopped, absent)
runner_state: "started"
# If found on the server, delete already existing runner service and install it again
reinstall_runner: no
# Do not show Ansible logs which may contain sensitive data (registration token)
hide_sensitive_logs: yes
# GitHub address
github_url: "https://github.com"
# GitHub API
github_api_url: "https://api.github.com"
# Personal Access Token for your GitHub account
access_token: "{{ lookup('env', 'PERSONAL_ACCESS_TOKEN') }}"
# Is it the runner for organization or not?
runner_org: no
# Name to assign to this runner in GitHub (System hostname as default)
runner_name: "{{ ansible_hostname }}"
# Custom service name when usign Github Enterprise server
# service_name: actions.runner._services.{{ runner_name }}.service
# GitHub Repository user or Organization owner used for Runner registration
# github_account: "youruser"
# GitHub repository owner name (if other than github_account)
# github_owner: "yourorg"
# Github repository name
# github_repo: "yourrepo"
In this example the Ansible role will install (or update) the GitHub Actions Runner service (latest available version). The runner will be registered for my_awesome_repo GitHub repo. Runner service will be stated and will run under the same user as the Ansible is using for ssh connection (ansible).
---
- name: Install GitHub Actions Runner
hosts: all
user: ansible
become: yes
vars:
- github_account: github-access-user
- github_repo: my_awesome_repo
roles:
- role: monolithprojects.github_actions_runner
Same example as above, but runner will be added to an organization.
---
- name: Install GitHub Actions Runner
hosts: all
user: ansible
become: yes
vars:
- github_account: my_awesome_org
- runner_org: true
roles:
- role: monolithprojects.github_actions_runner
In this example the Ansible role will deploy (or update) the GitHub Actions runner service (version 2.165.2) and register the runner for the GitHub repo. Runner service will run under the user runner-user
.
The runner service will be stopped.
---
- name: Stop GitHub Actions Runner
hosts: all
become: yes
vars:
- runner_version: "2.165.2"
- runner_user: runner-user
- github_account: github-access-user
- github_repo: my_awesome_repo
- runner_state: "stopped"
roles:
- role: monolithprojects.github_actions_runner
In this example the Ansible role will uninstall the runner service and unregister it from the GitHub Repository.
---
- name: Uninstall GitHub Actions Runner
hosts: all
become: yes
vars:
- github_account: github-access-user
- github_repo: my_awesome_repo
- runner_state: "absent"
roles:
- role: monolithprojects.github_actions_runner
MIT
Created in 2020 by Michal Muransky