Skip to content

feat(helm/gha-runner-scale-set-experimental): add $extra field passthrough for runner container in dind and kubernetes modes #4477

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

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

feat(helm/gha-runner-scale-set-experimental): add $extra field passthrough for runner container in dind and kubernetes modes #4477

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6033b2c
feat(helm): add $extra field passthrough for runner container in dind…
stokkie90 Apr 30, 2026
a0f8fa9
docs(helm/values): document runner.container extra field passthrough
stokkie90 Apr 30, 2026
4c5dcbb
refactor(helm): extract runner.container validation into shared helper
stokkie90 Apr 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 24 additions & 1 deletion charts/gha-runner-scale-set-experimental/templates/_mode_dind.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,23 @@
{{- define "runner-mode-dind.runner-container" -}}
{{- $container := (.Values.runner.container | default dict) -}}
{{- if and (hasKey .Values.runner "container") (not (kindIs "map" $container)) -}}
Comment thread
stokkie90 marked this conversation as resolved.
Outdated
{{- fail "runner.container must be a map/object" -}}
{{- end -}}
{{- if and (hasKey $container "env") (not (kindIs "slice" $container.env)) -}}
{{- fail "runner.container.env must be a list" -}}
{{- end -}}
{{- if and (hasKey $container "volumeMounts") (not (kindIs "slice" $container.volumeMounts)) -}}
{{- fail "runner.container.volumeMounts must be a list" -}}
{{- end -}}
{{- if hasKey $container "volumes" -}}
{{- fail "runner.container.volumes is not supported; use runner.pod.spec.volumes" -}}
{{- end -}}
{{- if and (hasKey $container "args") (not (kindIs "slice" $container.args)) -}}
{{- fail "runner.container.args must be a list" -}}
{{- end -}}
{{- if and (hasKey $container "securityContext") (not (kindIs "map" $container.securityContext)) -}}
{{- fail "runner.container.securityContext must be a map/object" -}}
{{- end -}}
name: runner
image: {{ include "runner.image" . | quote }}
command: {{ include "runner.command" . }}
Expand All @@ -15,7 +34,11 @@ volumeMounts:
mountPath: /home/runner/_work
- name: dind-sock
mountPath: {{ include "runner-mode-dind.sock-mount-dir" . | quote }}
{{ include "githubServerTLS.volumeMountItem" (dict "root" $ "existingVolumeMounts" (list)) | nindent 2 }}
{{ include "githubServerTLS.volumeMountItem" (dict "root" $ "existingVolumeMounts" (list)) | nindent 2 -}}
{{- $extra := omit $container "name" "image" "command" "env" "volumeMounts" -}}
{{- if not (empty $extra) }}
{{ toYaml $extra -}}
{{- end -}}
{{- end }}

{{- define "runner-mode-dind.dind-container" -}}
Expand Down
25 changes: 24 additions & 1 deletion charts/gha-runner-scale-set-experimental/templates/_mode_kubernetes.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,24 @@
{{- define "runner-mode-kubernetes.runner-container" -}}
{{- $runner := (.Values.runner | default dict) -}}
{{- $container := (.Values.runner.container | default dict) -}}
{{- if and (hasKey $runner "container") (not (kindIs "map" $container)) -}}
{{- fail "runner.container must be a map/object" -}}
{{- end -}}
{{- if and (hasKey $container "env") (not (kindIs "slice" $container.env)) -}}
{{- fail "runner.container.env must be a list" -}}
{{- end -}}
{{- if and (hasKey $container "volumeMounts") (not (kindIs "slice" $container.volumeMounts)) -}}
{{- fail "runner.container.volumeMounts must be a list" -}}
{{- end -}}
{{- if hasKey $container "volumes" -}}
{{- fail "runner.container.volumes is not supported; use runner.pod.spec.volumes" -}}
{{- end -}}
{{- if and (hasKey $container "args") (not (kindIs "slice" $container.args)) -}}
{{- fail "runner.container.args must be a list" -}}
{{- end -}}
{{- if and (hasKey $container "securityContext") (not (kindIs "map" $container.securityContext)) -}}
{{- fail "runner.container.securityContext must be a map/object" -}}
{{- end -}}
Comment thread
stokkie90 marked this conversation as resolved.
Outdated
{{- $kubeMode := (index $runner "kubernetesMode" | default dict) -}}
{{- $hookPath := (index $kubeMode "hookPath" | default "/home/runner/k8s/index.js") -}}
{{- $extensionRef := (index $kubeMode "extensionRef" | default "") -}}
Expand Down Expand Up @@ -82,7 +101,11 @@ volumeMounts:
subPath: extension
readOnly: true
{{- end }}
{{ include "githubServerTLS.volumeMountItem" (dict "root" $ "existingVolumeMounts" (list)) | nindent 2 }}
{{ include "githubServerTLS.volumeMountItem" (dict "root" $ "existingVolumeMounts" (list)) | nindent 2 -}}
{{- $extra := omit $container "name" "image" "command" "env" "volumeMounts" -}}
{{- if not (empty $extra) }}
{{ toYaml $extra -}}
{{- end -}}
{{- end }}

{{- define "runner-mode-kubernetes.pod-volumes" -}}
Expand Down
165 changes: 165 additions & 0 deletions ...s/gha-runner-scale-set-experimental/tests/autoscaling_runner_set_dind_mode_spec_test.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -400,6 +400,171 @@ tests:
name: cache
mountPath: /cache

- it: should pass extra fields from runner.container to the runner container in dind mode
set:
scaleset.name: "test"
auth.url: "https://github.com/org"
auth.githubToken: "gh_token12345"
controllerServiceAccount.name: "arc"
controllerServiceAccount.namespace: "arc-system"
runner:
mode: "dind"
container:
securityContext:
runAsUser: 1000
resources:
limits:
cpu: "250m"
memory: "64Mi"
imagePullPolicy: Always
release:
name: "test-name"
namespace: "test-namespace"
asserts:
- equal:
path: spec.template.spec.containers[0].name
value: runner
- equal:
path: spec.template.spec.containers[0].securityContext.runAsUser
value: 1000
- equal:
path: spec.template.spec.containers[0].resources.limits.cpu
value: 250m
- equal:
path: spec.template.spec.containers[0].resources.limits.memory
value: 64Mi
- equal:
path: spec.template.spec.containers[0].imagePullPolicy
value: Always

- it: should silently ignore runner.container.name in dind mode
set:
scaleset.name: "test"
auth.url: "https://github.com/org"
auth.githubToken: "gh_token12345"
controllerServiceAccount.name: "arc"
controllerServiceAccount.namespace: "arc-system"
runner:
mode: "dind"
container:
name: not-runner
release:
name: "test-name"
namespace: "test-namespace"
asserts:
- equal:
path: spec.template.spec.containers[0].name
value: runner

- it: should fail when runner.container is not a map in dind mode
set:
scaleset.name: "test"
auth.url: "https://github.com/org"
auth.githubToken: "gh_token12345"
controllerServiceAccount.name: "arc"
controllerServiceAccount.namespace: "arc-system"
runner:
mode: "dind"
container: "invalid"
release:
name: "test-name"
namespace: "test-namespace"
asserts:
- failedTemplate:
errorMessage: runner.container must be a map/object

- it: should fail when runner.container.env is not a list in dind mode
set:
scaleset.name: "test"
auth.url: "https://github.com/org"
auth.githubToken: "gh_token12345"
controllerServiceAccount.name: "arc"
controllerServiceAccount.namespace: "arc-system"
runner:
mode: "dind"
container:
env: "not-a-list"
release:
name: "test-name"
namespace: "test-namespace"
asserts:
- failedTemplate:
errorMessage: runner.container.env must be a list

- it: should fail when runner.container.volumeMounts is not a list in dind mode
set:
scaleset.name: "test"
auth.url: "https://github.com/org"
auth.githubToken: "gh_token12345"
controllerServiceAccount.name: "arc"
controllerServiceAccount.namespace: "arc-system"
runner:
mode: "dind"
container:
volumeMounts: "not-a-list"
release:
name: "test-name"
namespace: "test-namespace"
asserts:
- failedTemplate:
errorMessage: runner.container.volumeMounts must be a list

- it: should fail when runner.container.volumes is set in dind mode
set:
scaleset.name: "test"
auth.url: "https://github.com/org"
auth.githubToken: "gh_token12345"
controllerServiceAccount.name: "arc"
controllerServiceAccount.namespace: "arc-system"
runner:
mode: "dind"
container:
volumes:
- name: cache
emptyDir: {}
release:
name: "test-name"
namespace: "test-namespace"
asserts:
- failedTemplate:
errorMessage: runner.container.volumes is not supported; use runner.pod.spec.volumes

- it: should fail when runner.container.args is not a list in dind mode
set:
scaleset.name: "test"
auth.url: "https://github.com/org"
auth.githubToken: "gh_token12345"
controllerServiceAccount.name: "arc"
controllerServiceAccount.namespace: "arc-system"
runner:
mode: "dind"
container:
args: "not-a-list"
release:
name: "test-name"
namespace: "test-namespace"
asserts:
- failedTemplate:
errorMessage: runner.container.args must be a list

- it: should fail when runner.container.securityContext is not a map in dind mode
set:
scaleset.name: "test"
auth.url: "https://github.com/org"
auth.githubToken: "gh_token12345"
controllerServiceAccount.name: "arc"
controllerServiceAccount.namespace: "arc-system"
runner:
mode: "dind"
container:
securityContext: "not-a-map"
release:
name: "test-name"
namespace: "test-namespace"
asserts:
- failedTemplate:
errorMessage: runner.container.securityContext must be a map/object

- it: should fail when runner.dind.container.volumes is provided
set:
scaleset.name: "test"
Expand Down
Loading