Skip to content

Latest commit

 

History

History
136 lines (94 loc) · 5.22 KB

QuickStartGuide.md

File metadata and controls

136 lines (94 loc) · 5.22 KB

Introduction

GitHub Actions can be run in GitHub-hosted cloud or self hosted environments. Self-hosted runners offer more control of hardware, operating system, and software tools than GitHub-hosted runners provide.

With just a few steps, you can set up your kubernetes (K8s) cluster to be a self-hosted environment. In this guide, we will setup prerequistes, deploy Actions Runner controller (ARC) and then target that cluster to run GitHub Action workflows.

Setup your K8s cluster

Create a K8s cluster, if not available. If you don't have a K8s cluster, you can install a local environment using minikube. For more information, see "[Installing minikube](https://minikube.sigs.k8s.io/docs/start/)." 
 "[Using workflows](/actions/using-workflows)."

1️⃣ Install cert-manager in your cluster. For more information, see "cert-manager."

kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.8.2/cert-manager.yaml

*note:- This command uses v1.8.2. Please replace with a later version, if available.

You may also install cert-manager using Helm. For instructions, see "Installing with Helm."

2️⃣ Next, Generate a Personal Access Token (PAT) for ARC to authenticate with GitHub.

Deploy and Configure ARC

1️⃣ Deploy and configure ARC on your K8s cluster. You may use Helm or Kubectl.

Helm deployment
Add repository
helm repo add actions-runner-controller https://actions-runner-controller.github.io/actions-runner-controller
Install Helm chart
helm upgrade --install --namespace actions-runner-system --create-namespace\
  --set=authSecret.create=true\
  --set=authSecret.github_token="REPLACE_YOUR_TOKEN_HERE"\
  --wait actions-runner-controller actions-runner-controller/actions-runner-controller

*note:- Replace REPLACE_YOUR_TOKEN_HERE with your PAT that was generated in Step 1

Kubectl deployment
Deploy ARC
kubectl apply -f \
https://github.com/actions-runner-controller/actions-runner-controller/\
releases/download/v0.22.0/actions-runner-controller.yaml

*note:- Replace "v0.22.0" with the version you wish to deploy

Configure Personal Access Token
kubectl create secret generic controller-manager \
    -n actions-runner-system \
    --from-literal=github_token=REPLACE_YOUR_TOKEN_HERE

*note:- Replace REPLACE_YOUR_TOKEN_HERE with your PAT that was generated in Step 1.

2️⃣ Create the GitHub self hosted runners and configure to run against your repository.

Create a runnerdeployment.yaml file containing..

apiVersion: actions.summerwind.dev/v1alpha1
kind: RunnerDeployment
metadata:
  name: example-runnerdeploy
spec:
  replicas: 1
  template:
    spec:
      repository: mumoshu/actions-runner-controller-ci

*note:- Replace mumoshu/actions-runner-controller-ci with the full path to your github repository.

Apply this file to your K8s cluster.

kubectl apply -f runnerdeployment.yaml

🎉 We are done - now we should have self hosted runners running in K8s configured to your repository. 🎉

Up Next - lets verify and execute some workflows.

Verify and execute workflows

1️⃣ Verify your setup is successful with..

$ kubectl get runners
NAME                             REPOSITORY                             STATUS
example-runnerdeploy2475h595fr   mumoshu/actions-runner-controller-ci   Running

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

Also, this runner has been registered directly to the specified repository, you can see it in repository settings. For more information, see "settings."

2️⃣ You are ready to execute workflows against this self hosted runner. GitHub documentation lists the steps to target Actions against self hosted runners. For more information, see "Using self-hosted runners in a workflow - GitHub Docs."

There's also has a quick start guide to get started on Actions, For more information, see "Quick start Guide to GitHub Actions."

Next steps

ARC provides several interesting features and capabilities. For more information, see "readme."