Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
SanderKnape committed Jun 8, 2020
1 parent 697b4ee commit 6f0184c
Showing 1 changed file with 28 additions and 3 deletions.
31 changes: 28 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,32 @@
# Github self-hosted runner Dockerfile and Kubernetes configuration
This repository contains a Dockerfile that builds a Docker image suitable for running a [self-hosted GitHub runner](https://help.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners). A Kubernetes Deployment file is also included that you can use to deploy this container to your Kubernetes cluster.

This repository contains a Dockerfile that builds a Docker image suitable for running a [self-hosted GitHub runner](https://sanderknape.com/2020/03/self-hosted-github-actions-runner-kubernetes/). A Kubernetes Deployment file is also included that you can use as an example on how to deploy this container to a Kubernetes cluster.

You can build this image yourself, or use the Docker image from the [Docker Hub](https://hub.docker.com/repository/docker/sanderknape/github-runner/general).

More information can be found in my blog post: [Running self-hosted GitHub Actions runners in your Kubernetes cluster
](https://sanderknape.com/2020/03/self-hosted-github-actions-runner-kubernetes/)
## Building the container

`docker build -t github-runner .`

## Features

* Repository runners
* Organizational runners
* Labels
* Graceful shutdown

## Examples

Register a runner to a repository.

`docker run -e GITHUB_OWNER=username-or-organization -e GITHUB_REPOSITORY=my-repository -e GITHUB_PAT=[PAT] github-runner`

Create an organization-wide runner.

`docker run -e GITHUB_OWNER=username-or-organization -e GITHUB_PAT=[PAT] github-runner`

Set labels on the runner.

`docker run -e GITHUB_OWNER=username-or-organization -e GITHUB_REPOSITORY=my-repository -e GITHUB_PAT=[PAT] -e RUNNER_LABELS=comma,separated,labels github-runner`


0 comments on commit 6f0184c

Please sign in to comment.