feat: ability to create runner templates

Added new field: runnerTemplates

Added ability to link pool to runner template using
runnerInstallTemplate field

Author: igrikus

templates/configmap-init-pools.yaml

@@ -60,6 +60,9 @@ data:
       {{- if .extraSpec }}
       --extra-specs '{{ .extraSpec | toJson }}' \
       {{- end }}
+      {{- if .runnerInstallTemplate }}
+      --runner-install-template "{{ .runnerInstallTemplate }}" \
+      {{- end }}
       --enabled
     {{- end }}
     {{- end }}

templates/configmap-init-templates-content.yaml

@@ -0,0 +1,17 @@
+{{- if .Values.runnerTemplates }}
+{{- range .Values.runnerTemplates }}
+{{- if not .path }}
+{{- fail (printf "runnerTemplate %q is missing a 'path' attribute." .name) }}
+{{- end }}
+---
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: "{{ include "garm.fullname" $ }}-template-content-{{ .name }}"
+  labels:
+    {{- include "garm.labels" $ | nindent 4 }}
+data:
+  template: |-
+{{ $.Files.Get .path | indent 4 }}
+{{- end }}
+{{- end }}

templates/configmap-init-templates-script.yaml

@@ -0,0 +1,31 @@
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: "{{ include "garm.fullname" . }}-init-templates-script"
+  labels:
+    {{- include "garm.labels" . | nindent 4 }}
+data:
+  init-templates.sh: |-
+    #!/bin/sh
+    set -e
+    echo "Configuring GARM templates"
+
+    {{- if .Values.runnerTemplates }}
+    {{- range .Values.runnerTemplates }}
+    TEMPLATE_NAME="{{ .name }}"
+    if ! garm-cli template list | grep -wq "${TEMPLATE_NAME}"; then
+      echo "Creating template ${TEMPLATE_NAME}"
+      garm-cli template create \
+        --name "{{ .name }}" \
+        --forge-type "{{ .forgeType }}" \
+        --os-type "{{ .osType }}" \
+        {{- if .description }}
+        --description "{{ .description }}" \
+        {{- end }}
+        --path "/garm-templates/{{ .name }}/template"
+    else
+      echo "Template ${TEMPLATE_NAME} already exists."
+    fi
+    {{- end }}
+    {{- end }}
+

templates/job-operator.yaml

@@ -37,6 +37,10 @@ spec:
           configMap:
             name: "{{ include "garm.fullname" . }}-init-pools-script"
             defaultMode: 0755
+        - name: init-templates-script
+          configMap:
+            name: "{{ include "garm.fullname" . }}-init-templates-script"
+            defaultMode: 0755
         {{- if .Values.forges.gitea.credentials }}
         {{- range .Values.forges.gitea.credentials }}
         - name: gitea-secret-{{ .name }}
@@ -51,6 +55,13 @@ spec:
             secretName: {{ .secretName }}
         {{- end }}
         {{- end }}
+        {{- if .Values.runnerTemplates }}
+        {{- range .Values.runnerTemplates }}
+        - name: template-content-{{ .name }}
+          configMap:
+            name: "{{ include "garm.fullname" $ }}-template-content-{{ .name }}"
+        {{- end }}
+        {{- end }}
       initContainers:
         - name: garm-profile-setup
           image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
@@ -78,6 +89,28 @@ spec:
               mountPath: /init/init-profile.sh
               subPath: init-profile.sh
 
+        - name: garm-templates
+          image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
+          imagePullPolicy: {{ .Values.image.pullPolicy }}
+          command: ["/init/init-templates.sh"]
+          {{- with .Values.resources.configInit }}
+          resources:
+            {{- toYaml . | nindent 12 }}
+          {{- end }}
+          volumeMounts:
+            - name: garm-cli-auth
+              mountPath: /root/.local/share/garm-cli
+            - name: init-templates-script
+              mountPath: /init/init-templates.sh
+              subPath: init-templates.sh
+            {{- if .Values.runnerTemplates }}
+            {{- range .Values.runnerTemplates }}
+            - name: template-content-{{ .name }}
+              mountPath: /garm-templates/{{ .name }}
+              readOnly: true
+            {{- end }}
+            {{- end }}
+
         - name: garm-credentials
           image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
           imagePullPolicy: {{ .Values.image.pullPolicy }}

values.yaml

@@ -156,6 +156,20 @@ persistence:
   ## -- The size of the PVC.
   size: 1Gi
 
+## -- A list of runner templates to create.
+## -- NOTE: If you deploy templates and then remove this field then templates will NOT be deleted from GARM server.
+## -- This is because templates might be in use by runner pools and tracking all dependencies is not feasible.
+runnerTemplates: []
+  ## -- NOTE: The name must be a valid RFC 1123 subdomain name (e.g., 'my-template').
+  ## -- It can only contain lowercase letters, numbers, and hyphens (-).
+  ## -- Underscores (_) are not allowed as the name is used for Kubernetes resources.
+  # - name: "linux_cache_server"
+  #   description: "Configuring external cache server before runner is started"
+  #   forgeType: "gitea" # or github
+  #   osType: "linux"
+  #   ## -- Path to the file with the template content, relative to the chart root.
+  #   path: "resources/runner-template.sh.tpl"
+
 ## -- Configuration for different git forges.
 forges:
   ## -- Gitea server configurations.
@@ -176,6 +190,8 @@ forges:
       #   credName: "my-gitea"
 
     ## -- A list of Gitea runner pools to create.
+    ## -- Pools are re-created on every deployment (e.g helm upgrade) to always match the configuration.
+    ## -- NOTE: Before re-deploying make sure that this pool does not have any runners, otherwise you will get an error.
     pools: []
       ## -- Reference to organization from the 'organizations' list above.
       # - orgName: "MyGiteaOrg"
@@ -194,6 +210,8 @@ forges:
       #     custom_labels:
       #       my-custom-label: "my-value"
       #     disable_updates: true
+      #   ## -- The name or ID of the runner install template to use for this pool.
+      #   runnerInstallTemplate: ""
 
   ## -- GitHub server configurations.
   github: