readme updates

marcel-dempers · Feb 22, 2024 · 166de72 · 166de72
1 parent 6c55e69
commit 166de72
Show file tree

Hide file tree

Showing 2 changed files with 85 additions and 31 deletions.
diff --git a/github/actions/kubernetes/README.md b/github/actions/kubernetes/README.md
@@ -12,14 +12,6 @@ cd github/actions/kubernetes
 kind create cluster --name demo --image kindest/node:v1.28.0
 ```
 
-Test the cluster:
-```
-kubectl get nodes
-NAME                 STATUS   ROLES           AGE   VERSION
-demo-control-plane   Ready    control-plane   59s   v1.28.0
-
-```
-
 Next up, I will be running a small container where I will be doing all the work from:
 You can skip this part if you already have `kubectl` and `helm` on your machine.
 
@@ -47,6 +39,19 @@ mv /tmp/linux-amd64/helm /usr/local/bin/helm
 chmod +x /usr/local/bin/helm
 ```
 
+Now we have `helm` and `kubectl` and we can test our cluster access:
+
+```
+kubectl get nodes
+
+NAME                 STATUS   ROLES           AGE     VERSION
+demo-control-plane   Ready    control-plane   4m12s   v1.28.0
+```
+
+## Deploy the Github Action Runner Controller
+
+The runner controller is the core controller that manages the entire runner ecosystem. </br>
+Its uses the Kubernetes Operator pattern so you can deploy runners. </br>
 
 Let's go to the [Quickstart Guide](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/quickstart-for-actions-runner-controller) </br>
 
@@ -66,21 +71,22 @@ Once chart is deployed, we can see the controller running in the `github` namesp
 
 ```
 kubectl -n github get pods
+NAME                                     READY   STATUS    RESTARTS   AGE
+arc-gha-rs-controller-7bf474df55-v7vm9   1/1     Running   0          16s
 ```
 
-Now this pod will not do anything, since its not authenticated with any Github organisation or repository </br>
-We can check the logs to see what it's doing: 
-
+Now this pod will not do anything, other than allowing us to deploy runner scale sets. </br>
+We can check its logs: 
 ```
 kubectl -n github logs -l app.kubernetes.io/name=gha-rs-controller
 ```
 
-To make it useful, we need to add it to our repo or organisation by [Authenticating to Github](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/authenticating-to-the-github-api)
+## Deploy Github Action Runner scale sets
 
+To make it useful, we need to add it to our repo or organisation by [Authenticating to Github](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/authenticating-to-the-github-api)
 
 Create a new [Github App](https://docs.github.com/en/apps/using-github-apps/installing-your-own-github-app) for your account or organization.  
 
-
 Once we have created our Github App, we need to configure its authentication by creating a kubernetes secret with the authentication details of the app. </br>
 
 ```
@@ -91,20 +97,6 @@ kubectl create secret generic github-app-secret \
    --from-file=github_app_private_key='github.pem'
 
 ```
-Now we can upgrade our chart to apply the authentication changes
-
-```
-VERSION=0.8.2
-NAMESPACE="github"
-helm upgrade arc \
-    --namespace "${NAMESPACE}" \
-    --create-namespace \
-    --version ${VERSION} \
-    --values values.yaml \
-    oci://ghcr.io/actions/actions-runner-controller-charts/gha-runner-scale-set-controller
-```
-
-## Create your own runner
 
 The [documentation](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/deploying-runner-scale-sets-with-actions-runner-controller#configuring-the-runner-image) showcases how to customise the runner with the helm values file 
 
@@ -116,7 +108,7 @@ template:
   spec:
     containers:
       - name: runner
-        image: "custom-registry.io/actions-runner:latest"
+        image: "ghcr.io/actions/actions-runner:latest"
         imagePullPolicy: Always
         command: ["/home/runner/run.sh"]
 ```
@@ -142,5 +134,48 @@ helm install "${INSTALLATION_NAME}" \
     --values scaleset-values.yaml \
     --set githubConfigUrl="${GITHUB_CONFIG_URL}" \
     oci://ghcr.io/actions/actions-runner-controller-charts/gha-runner-scale-set
+```
+
+Now this will deploy a listener which will listen to jobs for the organisation or github repo \ account :
+
+```
+kubectl -n github get pods
+NAME                                     READY   STATUS    RESTARTS   AGE
+arc-gha-rs-controller-7bf474df55-v7vm9   1/1     Running   0          14m
+marcels-runner-9d8dc86f-listener         1/1     Running   0          10s
+```
+
+If we look at the logs again we can see the controller created a listener
+
+```
+kubectl -n github logs -l app.kubernetes.io/name=gha-rs-controller
+kubectl -n github logs -l app.kubernetes.io/component=runner-scale-set-listener
+```
+
+It's important to check both logs to ensure all your authentication is setup correctly and there are no problems. </br>
+
+### Customise the runner image
+
+Now when we run our GitHub action, it fails because there is no `docker` command  and no `docker` daemon running in the runner. </br>
+To add docker there are a number of things we can do, we can setup docker in the container or make use of docker on the host or run docker as a sidecar container and leverage the `docker-in-docker` image. </br>
+
+This approach is also explained in the [documentation](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/deploying-runner-scale-sets-with-actions-runner-controller#using-docker-in-docker-mode)
+
+```
+template:
+```
+
+To update, we simply use the `helm upgrade` command
+
+```
+INSTALLATION_NAME="arc-runner-set"
+NAMESPACE="github"
+GITHUB_CONFIG_URL="https://github.com/marcel-dempers/docker-development-youtube-series"
+
+helm upgrade "${INSTALLATION_NAME}" \
+    --namespace "${NAMESPACE}" \
+    --values scaleset-values.yaml \
+    --set githubConfigUrl="${GITHUB_CONFIG_URL}" \
+    oci://ghcr.io/actions/actions-runner-controller-charts/gha-runner-scale-set
+```
 
-```
diff --git a/github/actions/kubernetes/scaleset-values.yaml b/github/actions/kubernetes/scaleset-values.yaml
@@ -4,6 +4,25 @@ template:
   spec:
     containers:
       - name: runner
-        image: "ghcr.io/actions/actions-runner:latest"
+        image: ghcr.io/actions/actions-runner:latest
         imagePullPolicy: Always
-        command: ["/home/runner/run.sh"]
+        command: ["/home/runner/run.sh"]
+        env:
+          - name: DOCKER_HOST
+            value: tcp://localhost:2375
+        volumeMounts:
+          - name: work
+            mountPath: /home/runner/_work
+      - name: dind
+        image: docker:24.0.7-dind
+        env:
+          - name: DOCKER_TLS_CERTDIR
+            value: ""
+        securityContext:
+          privileged: true
+        volumeMounts:
+          - name: work
+            mountPath: /home/runner/_work
+    volumes:
+      - name: work
+        emptyDir: {}