Deploy runner with Kubernetes

Feature Availability: Self-Hosted Runner is available in the Enterprise Plan only.

Pre-requisites

• A running Kubernetes cluster

• Helm installed locally

• Kubectl installed locally

Brainboard provides a Helm chart to deploy the runner in your existing Kubernetes cluster.

Please contact support to get your customer token (CUSTOMER_TOKEN) to access the charts.

helm registry login ghcr.io --username brainboard --password $CUSTOMER_TOKEN

To see the charts values and documentation, you can use the following commands:

helm show values oci://ghcr.io/brainboard/helm/brainboard-runner
helm show readme oci://ghcr.io/brainboard/helm/brainboard-runner

Installation

For the runner to enrol with your organization, you will need to provide the private self-hosted runner token you generated from the Brainboard settings page.

You can install the runner with the following command:

helm install runner oci://ghcr.io/brainboard/helm/brainboard-runner --set config.credentials.token="your-runner-token"

You can view all available configuration options using the commands above.

Usage

To open a terminal inside the runner container, use the following command:

POD_NAME=$(kubectl get po -l app.kubernetes.io/name=brainboard-runner -o=name)
kubectl exec -ti ${POD_NAME} -c runner -- sh

If you want to see the logs, you can run this command:

kubectl logs -l app.kubernetes.io/name=brainboard-runner -c runner