Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Extend Helm Chart with HookTemplate #3495

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Extend Helm Chart with HookTemplate #3495

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f8391c5
add hook template
timmjd May 2, 2024
cca5403
undo
timmjd May 2, 2024
a94b879
add test
timmjd May 2, 2024
585e1b6
typos
timmjd May 2, 2024
bc35ad6
Merge branch 'master' into hookTemplate
timmjd May 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
21 changes: 21 additions & 0 deletions charts/gha-runner-scale-set/templates/_helpers.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,10 @@ app.kubernetes.io/instance: {{ include "gha-runner-scale-set.scale-set-name" . }
{{- end }}
{{- end }}

{{- define "gha-runner-scale-set.hookTemplate" -}}
{{- include "gha-runner-scale-set.fullname" . }}-hook-template
{{- end }}

{{- define "gha-runner-scale-set.noPermissionServiceAccountName" -}}
{{- include "gha-runner-scale-set.fullname" . }}-no-permission
{{- end }}
Expand Down Expand Up @@ -170,6 +174,12 @@ volumeMounts:
{{- end }}
{{- end }}

{{- define "gha-runner-scale-set.hook-template-volume" -}}
- name: hook-template
configMap:
name: {{ include "gha-runner-scale-set.hookTemplate" . }}
{{- end }}

{{- define "gha-runner-scale-set.non-runner-containers" -}}
{{- range $i, $container := .Values.template.spec.containers }}
{{- if ne $container.name "runner" }}
Expand Down Expand Up @@ -277,6 +287,7 @@ volumeMounts:

{{- define "gha-runner-scale-set.kubernetes-mode-runner-container" -}}
{{- $tlsConfig := (default (dict) .Values.githubServerTLS) }}
{{- $hookTemplate := .Values.hookTemplate }}
{{- range $i, $container := .Values.template.spec.containers }}
{{- if eq $container.name "runner" }}
{{- range $key, $val := $container }}
Expand Down Expand Up @@ -341,6 +352,10 @@ env:
{{- if $tlsConfig.runnerMountPath }}
{{- $mountGitHubServerTLS = 1 }}
{{- end }}
{{- if $hookTemplate }}
- name: ACTIONS_RUNNER_CONTAINER_HOOK_TEMPLATE
value: /home/runner/hookTemplate.yaml
{{- end }}
volumeMounts:
{{- with $container.volumeMounts }}
{{- range $i, $volMount := . }}
Expand All @@ -362,6 +377,12 @@ volumeMounts:
mountPath: {{ clean (print $tlsConfig.runnerMountPath "/" $tlsConfig.certificateFrom.configMapKeyRef.key) }}
subPath: {{ $tlsConfig.certificateFrom.configMapKeyRef.key }}
{{- end }}
{{- if $hookTemplate }}
- name: hook-template
mountPath: /home/runner/hookTemplate.yaml
subPath: hookTemplate.yaml
readOnly: true
{{- end }}
{{- end }}
{{- end }}
{{- end }}
Expand Down
1 change: 1 addition & 0 deletions charts/gha-runner-scale-set/templates/autoscalingrunnerset.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,7 @@ spec:
{{- else if eq $containerMode.type "kubernetes" }}
{{- include "gha-runner-scale-set.kubernetes-mode-work-volume" . | nindent 6 }}
{{- include "gha-runner-scale-set.non-work-volumes" . | nindent 6 }}
{{- include "gha-runner-scale-set.hook-template-volume" . | nindent 6 }}
{{- else }}
{{- with .Values.template.spec.volumes }}
{{- toYaml . | nindent 6 }}
Expand Down
14 changes: 14 additions & 0 deletions charts/gha-runner-scale-set/templates/kube_mode_pod_template.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{{- if (.Values.hookTemplate) }}
apiVersion: v1
kind: ConfigMap
metadata:
name: {{ include "gha-runner-scale-set.hookTemplate" . }}
namespace: {{ .Release.Namespace }}
labels:
{{- include "gha-runner-scale-set.labels" . | nindent 4 }}
finalizers:
- actions.github.com/cleanup-protection
data:
hookTemplate.yaml: |
{{- .Values.hookTemplate | toYaml | nindent 4 -}}
{{- end}}
15 changes: 15 additions & 0 deletions charts/gha-runner-scale-set/tests/values_extra_hook_template.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
githubConfigUrl: https://github.com/actions/actions-runner-controller
githubConfigSecret:
github_token: test
hookTemplate:
apiVersion: v1
kind: PodTemplate
spec:
containers:
- name: $job
resources:
requests:
cpu: 1
memory: 1Gi
containerMode:
type: kubernetes
13 changes: 13 additions & 0 deletions charts/gha-runner-scale-set/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,19 @@ template:
image: ghcr.io/actions/actions-runner:latest
command: ["/home/runner/run.sh"]

## hookTemplate is the podTemplate definition of the worker in containerMode.type=kubernetes
## For reference: https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-template-v1/#PodTemplate
# hookTemplate:
# apiVersion: v1
# kind: PodTemplate
# spec:
# containers:
# - name: $job
# resources:
# requests:
# cpu: 32
# memory: 32Gi

## Optional controller service account that needs to have required Role and RoleBinding
## to operate this gha-runner-scale-set installation.
## The helm chart will try to find the controller deployment and its service account at installation time.
Expand Down