Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/peter-murray/github-actions-runner-container
Bare bones container for GitHub Actions Runner
https://github.com/peter-murray/github-actions-runner-container
Last synced: 25 days ago
JSON representation
Bare bones container for GitHub Actions Runner
- Host: GitHub
- URL: https://github.com/peter-murray/github-actions-runner-container
- Owner: peter-murray
- License: mit
- Created: 2020-09-03T08:26:43.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-04-10T12:04:24.000Z (over 2 years ago)
- Last Synced: 2024-08-01T18:28:50.219Z (3 months ago)
- Language: Dockerfile
- Homepage:
- Size: 85.9 KB
- Stars: 24
- Watchers: 4
- Forks: 16
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-runners - peter-murray/github-actions-runner-container - murray/github-actions-runner-container.svg)](https://github.com/peter-murray/github-actions-runner-container/blob/master/LICENSE) [](https://github.com/peter-murray/github-actions-runner-container/graphs/contributors/) [](https://github.com/peter-murray/github-actions-runner-container/stargazers/) [](https://GitHub.com/peter-murray/github-actions-runner-container/issues/) [](https://GitHub.com/peter-murray/github-actions-runner-container/issues?q=is%3Aissue+is%3Aclosed) | Docker | ❌ | Enterprise, Org, Repo, Labels, RunnerGroups | ❌ | ❌ | x86 | ✅ | yes | yes | no | no | no | no | no | (The matrix (might be better readable on [GitHub pages](https://jonico.github.io/awesome-runners/)) / A word about self-hosted action runner images / virtual environments and how to test locally)
README
# Docker Container for GitHub Actions Runner
[](https://github.com/jonico/awesome-runners)
This project will build a Docker container with the specified version of the GitHub Actions Runner installed into it. It is built off of CentOS 8 as a base by default.
## Building Container
You can build this container using the following command:
```bash
$ docker build -f [centos-actions-runner|ubuntu-actions-runner]/Dockerfile -t .
```
There are some configurable Build Arguments that you can pass in to modify the container build:
* `BASE`: default value `centos:8` or `ubuntu-20.04` depending on the variant, but can be modified to specify an alternative base container image to start from
* `GH_RUNNER_VERSION`: default value '2.273.0' but can be used to specify an alternative version of the GitHub Actions runner
The Dockerfile has two lines that are hardcoded to use `yum` so you will have to ensure that you use a base container that supports yum if you change it.
The GitHub Actions Runner will update itself to the latest version when it gets the first job sent to it if it is running an out of date version. The purpose of this parameter is to be able to set it to a value to test this upgrade scenario.
A future version of this will access the releases endpoint to get the latest version and use that.
## Running the Container
The container image supports a number of environment variables that you can pass to the container to control the registration of the self hosted runner with GitHub.
When registering the runner you have three options for the type of runner that you are wanting to create, enterprise, organization or repository self-hosted runner.
You need to provide one of the following environment variable URLs which allow the runner to be registered:
* `RUNNER_ENTERPRISE_URL`: The url for enterprise when registering a enterprise runner; e.g. https://github.com/enterprises/
* `RUNNER_ORGANIZATION_URL`: The url for organization when registering an organization runner; e.g. https://github.com/octodemo
* `RUNNER_REPOSITORY_URL`: The url for the repository when registering a repository; e.g. https://github.com/peter-murray/node-hue-api
A GitHub Personal Access Token is required so that it can be used to obtain a short lived access token for the runner to register with GitHub. The permissions required on the Personal Access Token will depend upon to the use case of the token;
* enterprise runner: `admin:enterprise`
* organization runner: `admin:org`
* repository runner: `repo`
The token needs to be provided as the environment variable `GITHUB_TOKEN`.
Optional environment variables:
* `GITHUB_SERVER`: The url for GHES server (if not connecting to `github.com`)
* `RUNNER_NAME`: The name for the runner, must be unique if not specified will use the hostname of the container.
* `RUNNER_LABELS`: A comma separated list of labels to associate with the runner over the default values. e.g. `tester,container-runner,production`
* `RUNNER_GROUP`: A runner group to associate the runner with in the organization or enterprise. If not specified will use the `default` group.
### Running using Docker commandline examples
1. Registering an Enterprise Runner;
```bash
$ docker run -d \
-e RUNNER_ENTERPRISE_URL=https://github.com/enterprises/octodemo \
-e GITHUB_TOKEN= \
```
1. Registering an Organization Runner;
```bash
$ docker run -d \
-e RUNNER_ORGANIZATION_URL=https://github.com/octodemo \
-e GITHUB_TOKEN= \
```
1. Registering an Repository Runner;
```bash
$ docker run -d \
-e RUNNER_REPOSITORY_URL=https://github.com/octodemo/demo-repo \
-e GITHUB_TOKEN= \
```