From 875953af5c2f41f3ffc7dad27c045478f58da717 Mon Sep 17 00:00:00 2001
From: Simon Cornet <simon@simoncor.net>
Date: Tue, 10 Jun 2025 16:34:08 +0200
Subject: [PATCH] feat: improve readiblity

---
 docs/gitlab/runner-config-ocp.md | 33 ++++++++++++++++++++++----------
 1 file changed, 23 insertions(+), 10 deletions(-)

diff --git a/docs/gitlab/runner-config-ocp.md b/docs/gitlab/runner-config-ocp.md
index d2ecd3a..7d19c01 100644
--- a/docs/gitlab/runner-config-ocp.md
+++ b/docs/gitlab/runner-config-ocp.md
@@ -1,10 +1,11 @@
 # Gitlab Runner on OCP
 
-A quick and dirty guide for making the Gitlab Runner work on OCP.
-I know this is not production ready!
+A quick and dirty guide for making the Gitlab Runner work on OCP. This is probably not what you want for you prodcution
+environment...
+
+## Step 1 Setup namespace and RBAC
 
 ```shell
-# 1. Setup namespace and RBAC
 oc new-project gitlab-runner
 oc apply -f - <<EOF
 apiVersion: v1
@@ -37,15 +38,31 @@ roleRef:
   name: gitlab-runner
   apiGroup: rbac.authorization.k8s.io
 EOF
+```
 
+## Step 2 Create secrets
+
+[!warning] REPLACE YOUR TOKEN!
+
+```shell
 # 2. Create secret (REPLACE TOKEN!)
-oc create secret generic gitlab-runner-secret --from-literal=runner-registration-token=YOUR_REGISTRATION_TOKEN -n gitlab-runner
+oc create secret generic gitlab-runner-secret \
+    --from-literal=runner-registration-token=YOUR_REGISTRATION_TOKEN \
+    -n gitlab-runner
+```
 
-# 3. Apply SCCs
+## 3. Apply SCCs
+
+```shell
 oc adm policy add-scc-to-user anyuid -z gitlab-runner -n gitlab-runner
 oc adm policy add-scc-to-user privileged -z gitlab-runner -n gitlab-runner
+```
 
-# 4. Deploy runner (REPLACE TOKEN IN YAML!)
+## 4. Deploy runner (REPLACE TOKEN IN YAML!)
+
+[!warning] REPLACE YOUR TOKEN!
+
+```shell
 oc apply -f - <<EOF
 apiVersion: apps/v1
 kind: Deployment
@@ -100,8 +117,4 @@ spec:
       - name: config
         emptyDir: {}
 EOF
-
-# 5. Verify
-oc get pods -n gitlab-runner
-oc logs -l app=gitlab-runner -n gitlab-runner
 ```