public_git
/
actions-runner-controller
mirror of https://github.com/actions-runner-controller/actions-runner-controller.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add health and readiness probes to controller manager (#4459)

This commit is contained in:
Junya Okabe 2026-04-30 01:08:46 +09:00 committed by GitHub
parent 13a03302c8
commit 053b8f9ae5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
8 changed files with 96 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
charts/actions-runner-controller/templates/deployment.yaml
View File

@ -73,6 +73,9 @@ spec:
{{- if .Values.dockerGID }}
- "--docker-gid={{ .Values.dockerGID }}"
{{- end }}
{{- with .Values.healthProbeBindAddress }}
- "--health-probe-bind-address={{ . }}"
{{- end }}
command:
- "/manager"
env:
@ -144,6 +147,20 @@ spec:
name: metrics-port
protocol: TCP
{{- end }}
{{- with .Values.healthProbeBindAddress }}
livenessProbe:
httpGet:
path: /healthz
port: {{ regexFind "[0-9]+$" . }}
initialDelaySeconds: 15
periodSeconds: 20
readinessProbe:
httpGet:
path: /readyz
port: {{ regexFind "[0-9]+$" . }}
initialDelaySeconds: 5
periodSeconds: 10
{{- end }}
resources:
{{- toYaml .Values.resources | nindent 12 }}
securityContext:

4
charts/actions-runner-controller/values.yaml
View File

@ -190,6 +190,10 @@ admissionWebHooks:
# There may be alternatives to setting `hostNetwork: true`, see
# https://github.com/actions/actions-runner-controller/issues/1005#issuecomment-993097155
# The address the health probe endpoint binds to. Disabled if empty.
# When set, liveness and readiness probes are added to the controller pod.
#healthProbeBindAddress: ":8081"
#hostNetwork: true
# If you use `hostNetwork: true`, then you need dnsPolicy: ClusterFirstWithHostNet

17
charts/gha-runner-scale-set-controller-experimental/templates/_controller_template.tpl
View File

@ -73,6 +73,9 @@ args:
{{- with .Values.controller.manager.config.k8sClientRateLimiterBurst }}
- "--k8s-client-rate-limiter-burst={{ . }}"
{{- end }}
{{- with .Values.controller.manager.config.healthProbeBindAddress }}
- "--health-probe-bind-address={{ . }}"
{{- end }}
{{- with .Values.controller.manager.container.extraArgs }}
{{- range . }}
- "{{ . }}"
@ -92,6 +95,20 @@ args:
ports:
{{- toYaml $ports | nindent 2 }}
{{- end }}
{{- with .Values.controller.manager.config.healthProbeBindAddress }}
livenessProbe:
httpGet:
path: /healthz
port: {{ regexFind "[0-9]+$" . }}
initialDelaySeconds: 15
periodSeconds: 20
readinessProbe:
httpGet:
path: /readyz
port: {{ regexFind "[0-9]+$" . }}
initialDelaySeconds: 5
periodSeconds: 10
{{- end }}
env:
- name: CONTROLLER_MANAGER_CONTAINER_IMAGE
value: "{{ .Values.controller.manager.container.image }}"

4
charts/gha-runner-scale-set-controller-experimental/values.yaml
View File

@ -44,6 +44,10 @@ controller:
k8sClientRateLimiterQPS: null
k8sClientRateLimiterBurst: null
# The address the health probe endpoint binds to. Disabled if empty/null.
# When set, liveness and readiness probes are added to the controller pod.
# healthProbeBindAddress: ":8081"
container:
image: "ghcr.io/actions/gha-runner-scale-set-controller:latest"
pullPolicy: IfNotPresent

17
charts/gha-runner-scale-set-controller/templates/deployment.yaml
View File

@ -101,6 +101,9 @@ spec:
- "--workqueue-rate-limiter={{ . }}"
{{- end }}
{{- end }}
{{- with .Values.flags.healthProbeBindAddress }}
- "--health-probe-bind-address={{ . }}"
{{- end }}
command:
- "/manager"
{{- if or .Values.metrics .Values.pprof.addr }}
@ -116,6 +119,20 @@ spec:
protocol: TCP
name: pprof
{{- end }}
{{- with .Values.flags.healthProbeBindAddress }}
livenessProbe:
httpGet:
path: /healthz
port: {{ regexFind "[0-9]+$" . }}
initialDelaySeconds: 15
periodSeconds: 20
readinessProbe:
httpGet:
path: /readyz
port: {{ regexFind "[0-9]+$" . }}
initialDelaySeconds: 5
periodSeconds: 10
{{- end }}
env:
- name: CONTROLLER_MANAGER_CONTAINER_IMAGE
value: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"

4
charts/gha-runner-scale-set-controller/values.yaml
View File

@ -150,6 +150,10 @@ flags:
# Overrides the default `.Release.Namespace` for all resources in this chart.
namespaceOverride: ""
## The address the health probe endpoint binds to. Disabled if empty.
## When set, liveness and readiness probes are added to the controller pod.
# healthProbeBindAddress: ":8081"
## Defines the K8s client rate limiter parameters.
# k8sClientRateLimiterQPS: 20
# k8sClientRateLimiterBurst: 30

14
config/manager/manager.yaml
View File

@ -56,6 +56,20 @@ spec:
valueFrom:
fieldRef:
fieldPath: metadata.namespace
# To enable health probes, uncomment the following and add
# "--health-probe-bind-address=:8081" to the container args.
# livenessProbe:
# httpGet:
# path: /healthz
# port: 8081
# initialDelaySeconds: 15
# periodSeconds: 20
# readinessProbe:
# httpGet:
# path: /readyz
# port: 8081
# initialDelaySeconds: 5
# periodSeconds: 10
volumeMounts:
- name: controller-manager
mountPath: "/etc/actions-runner-controller"

23
main.go
View File

@ -43,6 +43,7 @@ import (
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/cache"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/healthz"
metricsserver "sigs.k8s.io/controller-runtime/pkg/metrics/server"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
"sigs.k8s.io/controller-runtime/pkg/webhook"
@ -86,6 +87,7 @@ func main() {
metricsAddr string
pprofAddr string
probeAddr string
autoScalingRunnerSetOnly bool
enableLeaderElection bool
disableAdmissionWebhook bool
@ -127,6 +129,7 @@ func main() {
flag.StringVar(&listenerMetricsEndpoint, "listener-metrics-endpoint", "/metrics", "The AutoscalingListener metrics server endpoint from which the metrics are collected")
flag.StringVar(&metricsAddr, "metrics-addr", ":8080", "The address the metric endpoint binds to.")
flag.StringVar(&pprofAddr, "pprof-addr", "", "The address the pprof endpoint binds to.")
flag.StringVar(&probeAddr, "health-probe-bind-address", "", "The address the health probe endpoint binds to. Disabled if empty.")
flag.BoolVar(&enableLeaderElection, "enable-leader-election", false,
"Enable leader election for controller manager. Enabling this will ensure there is only one active controller manager.")
flag.StringVar(&leaderElectionID, "leader-election-id", "actions-runner-controller", "Controller id for leader election.")
@ -246,10 +249,11 @@ func main() {
SyncPeriod: &syncPeriod,
DefaultNamespaces: defaultNamespaces,
},
PprofBindAddress: pprofAddr,
WebhookServer: webhookServer,
LeaderElection: enableLeaderElection,
LeaderElectionID: leaderElectionID,
PprofBindAddress: pprofAddr,
WebhookServer: webhookServer,
HealthProbeBindAddress: probeAddr,
LeaderElection: enableLeaderElection,
LeaderElectionID: leaderElectionID,
Client: client.Options{
Cache: &client.CacheOptions{
DisableFor: []client.Object{
@ -264,6 +268,17 @@ func main() {
os.Exit(1)
}
if probeAddr != "" {
if err := mgr.AddHealthzCheck("healthz", healthz.Ping); err != nil {
log.Error(err, "unable to set up health check")
os.Exit(1)
}
if err := mgr.AddReadyzCheck("readyz", healthz.Ping); err != nil {
log.Error(err, "unable to set up ready check")
os.Exit(1)
}
}
if autoScalingRunnerSetOnly {
if err := actionsgithubcom.SetupIndexers(mgr); err != nil {
log.Error(err, "unable to setup indexers")