Skip to content
GitHub no longer supports this web browser. Learn more about the browsers we support.
Kubernetes controller for GitHub Actions self-hosted runnners
Go Makefile Dockerfile Shell
Branch: master
Clone or download
Cannot retrieve the latest commit at this time.
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/workflows Do not run build workflow when .github changed Feb 3, 2020
api/v1alpha1 Add additional printer columns Feb 3, 2020
config Add additional printer columns Feb 3, 2020
controllers Implement finalizer Feb 3, 2020
hack
runner Fix tag name Feb 3, 2020
.gitignore Update .gitignore Feb 3, 2020
Dockerfile Initial commit Jan 28, 2020
LICENSE Add LICENSE Jan 30, 2020
Makefile Set container image version properly in the release task Feb 3, 2020
PROJECT Initial commit Jan 28, 2020
README.md Update README Feb 3, 2020
go.mod
go.sum Implement runner controller Jan 28, 2020
main.go Add '-github-token' flag Feb 3, 2020

README.md

actions-runner-controller

This controller operates self-hosted runners for GitHub Actions on your Kubernetes cluster.

Motivation

GitHub Actions is very useful as a tool for automating development. GitHub Actions job is run in the cloud by default, but you may want to run your jobs in your environment. Self-hosted runner can be used for such use cases, but requires the provision of a virtual machine instance and configuration. If you already have a Kubernetes cluster, you'll want to run the self-hosted runner on top of it.

actions-runner-controller makes that possible. Just create a Runner resource on your Kubernetes, and it will run and operate the self-hosted runner of the specified repository. Combined with Kubernetes RBAC, you can also build simple Self-hosted runners as a Service.

Installation

First, install actions-runner-controller with a manifest file. This will create a actions-runner-system namespace in your Kubernetes and deploy the required resources.

$ kubectl apply -f https://github.com/summerwind/actions-runner-controller/releases/latest/download/actions-runner-controller.yaml

Set your access token of GitHub to the secret. ${GITHUB_TOKEN} is the value you must replace with your access token. This token is used to register Self-hosted runner by actions-runner-controller.

$ kubectl create secret generic controller-manager --from-literal=github_token=${GITHUB_TOKEN} -n actions-runner-system

Usage

To launch Self-hosted runner, you need to create a manifest file includes Runner resource as follows. This example launches a self-hosted runner with name example-runner for the summerwind/actions-runner-controller repository.

# runner.yaml
apiVersion: actions.summerwind.dev/v1alpha1
kind: Runner
metadata:
  name: example-runner
spec:
  repository: summerwind/actions-runner-controller

Apply the created manifest file to your Kubernetes.

$ kubectl apply -f runner.yaml
runner.actions.summerwind.dev/example-runner created

You can see that the Runner resource has been created.

$ kubectl get runners
NAME             REPOSITORY                             STATUS
example-runner   summerwind/actions-runner-controller   Running

You can also see that the runner pod has been running.

$ kubectl get pods
NAME           READY   STATUS    RESTARTS   AGE
example-runner 2/2     Running   0          1m

The runner you created has been registerd to your repository.

Actions tab in your repository settings

Now your can use your self-hosted runner. See the official documentation on how to run a job with it.

You can’t perform that action at this time.