jlab-cluster/helm-charts
3
0 Fork 0
Code Issues 15 Pull Requests 3 Actions Packages Wiki Activity

Merge pull request #98 from jk-cluster/feat/values-schema-patchmon

Browse Source 
patchmon: strict values.schema.json + Ingress-Gate + Null-Absicherung (Welle 1, #68/#93/#99)
This commit is contained in:
jklein authored and GitHub committed 2026-08-23 18:21:46 +00:00
2 parents db319b916d 03c9fd6467
commit 907cb16d6a
6 files changed
+453 -12
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

patchmon/Chart.yaml
+1 -1
View File
@@ -5,7 +5,7 @@ icon: https://raw.githubusercontent.com/PatchMon/PatchMon/main/frontend/public/a
type: application
version: 5.2.0+up2.1.3
version: 6.0.0+up2.1.3
appVersion: "2.1.3"
maintainers:
patchmon/templates/_helpers.tpl
+207
View File
@@ -114,3 +114,210 @@ template-chart is the reference implementation.
1
{{- end -}}
{{- end -}}
{{/*
Merge a user-supplied values sub-tree onto a dict of chart defaults so that a
null / empty override falls back to the defaults instead of erasing them.
Input: dict "defaults" <dict> "given" <dict|nil> "path" <string, optional
values path used in error messages>. Output: YAML of the merged dict (consume
it with fromYaml).
Why this exists (issue #99): Helm merges values maps recursively, but an
override key written without children — e.g. a leftover
securityContext:
after deleting its last remaining sub-key — is YAML null and replaces the
whole default sub-tree. The container then renders with "securityContext:
null": no readOnlyRootFilesystem, no dropped capabilities, no
allowPrivilegeEscalation: false. The workload starts and reports healthy while
being unhardened, so nothing points at the mistake. The same shape erases a
probe (it disappears) or the resources block (no requests, no computed
limits). This helper defines the opposite semantics: an empty block means
"chart defaults apply".
Rules:
- a nil "given" is treated as an empty dict (all defaults apply).
- a key whose override value is null keeps the default (nulls never delete).
- a key present in both as a map is merged recursively, so a partially
filled block only overrides the keys it actually sets.
- a scalar override for a key the defaults define as a map is rejected with
a message naming the values path, instead of failing later with a template
field error.
- any other set value wins as given, including an explicit false or 0 —
Helm's "default" and sprig's "mergeOverwrite" would both swallow those
zero values, hence the explicit kindIs "invalid" nil check.
- keys only present in the override are passed through unchanged.
NOTE: like the helpers above, this is duplicated into every chart's
templates/_helpers.tpl with the chart's name as define prefix, because charts
in this repo deliberately have no dependencies.
*/}}
{{- define "patchmon.defaultedDict" -}}
{{- $defaults := .defaults | default dict -}}
{{- $given := .given -}}
{{- $path := .path | default "value" -}}
{{- if kindIs "invalid" $given -}}
{{- $given = dict -}}
{{- end -}}
{{- if not (kindIs "map" $given) -}}
{{- fail (printf "%s must be a mapping or null, got %s (%v)" $path (kindOf $given) $given) -}}
{{- end -}}
{{- $out := deepCopy $defaults -}}
{{- range $key, $value := $given -}}
{{- if not (kindIs "invalid" $value) -}}
{{- $default := index $defaults $key -}}
{{- if and (kindIs "map" $value) (kindIs "map" $default) -}}
{{- $_ := set $out $key (fromYaml (include "patchmon.defaultedDict" (dict "defaults" $default "given" $value "path" (printf "%s.%s" $path $key)))) -}}
{{- else if kindIs "map" $default -}}
{{- fail (printf "%s.%s must be a mapping or null, got %s (%v)" $path $key (kindOf $value) $value) -}}
{{- else -}}
{{- $_ := set $out $key $value -}}
{{- end -}}
{{- end -}}
{{- end -}}
{{- toYaml $out -}}
{{- end -}}
{{/*
Pick one sub-block out of a values block that may itself be null.
Input: dict "block" <dict|nil> "key" <string> "path" <string>.
Returns YAML of dict "value" <the sub-block, may be nil>, after rejecting a
non-mapping block with a message that names the values path. Needed because
".Values.patchmon.<workload>.securityContext" can itself be erased.
*/}}
{{- define "patchmon.subBlock" -}}
{{- $block := .block -}}
{{- if kindIs "invalid" $block -}}
{{- $block = dict -}}
{{- end -}}
{{- if not (kindIs "map" $block) -}}
{{- fail (printf "%s must be a mapping or null, got %s (%v)" .path (kindOf $block) $block) -}}
{{- end -}}
{{- toYaml (dict "value" (index $block .key)) -}}
{{- end -}}
{{/*
The effective security contexts, probes and resources of both workloads
(issue #99).
The defaults below MUST stay in sync with the corresponding blocks in
values.yaml, which stays the documented, user-facing place for them; this copy
is only the fallback for the case where an override has erased the block.
The server probes carry a Host header, because the 2.x server rejects requests
whose Host is neither loopback nor a CORS_ORIGIN host. The default is built
from .Values.ingress.domain via the passed-in root context, so the probe
helpers take dict "given" <block|nil> "root" $.
*/}}
{{- define "patchmon.server.podSecurityContext" -}}
{{- $given := (fromYaml (include "patchmon.subBlock" (dict "block" . "key" "pod" "path" "patchmon.server.securityContext"))).value -}}
{{- $defaults := dict
"runAsNonRoot" true
"runAsUser" 65532
"runAsGroup" 65532 -}}
{{- include "patchmon.defaultedDict" (dict "defaults" $defaults "given" $given "path" "patchmon.server.securityContext.pod") -}}
{{- end -}}
{{- define "patchmon.server.containerSecurityContext" -}}
{{- $given := (fromYaml (include "patchmon.subBlock" (dict "block" . "key" "container" "path" "patchmon.server.securityContext"))).value -}}
{{- $defaults := dict
"allowPrivilegeEscalation" false
"readOnlyRootFilesystem" true
"runAsNonRoot" true
"capabilities" (dict "drop" (list "ALL")) -}}
{{- include "patchmon.defaultedDict" (dict "defaults" $defaults "given" $given "path" "patchmon.server.securityContext.container") -}}
{{- end -}}
{{- define "patchmon.guacd.containerSecurityContext" -}}
{{- $given := (fromYaml (include "patchmon.subBlock" (dict "block" . "key" "container" "path" "patchmon.guacd.securityContext"))).value -}}
{{- $defaults := dict
"allowPrivilegeEscalation" false
"readOnlyRootFilesystem" true
"runAsNonRoot" true
"runAsUser" 1000
"runAsGroup" 1000
"capabilities" (dict "drop" (list "ALL")) -}}
{{- include "patchmon.defaultedDict" (dict "defaults" $defaults "given" $given "path" "patchmon.guacd.securityContext.container") -}}
{{- end -}}
{{- define "patchmon.server.httpGet" -}}
{{- dict "path" "/health" "port" 3000 "httpHeaders" (list (dict "name" "Host" "value" (.root.Values.ingress.domain | default ""))) | toYaml -}}
{{- end -}}
{{- define "patchmon.server.livenessProbe" -}}
{{- $defaults := dict
"httpGet" (fromYaml (include "patchmon.server.httpGet" .))
"periodSeconds" 10
"timeoutSeconds" 5
"failureThreshold" 3 -}}
{{- include "patchmon.defaultedDict" (dict "defaults" $defaults "given" .given "path" "patchmon.server.livenessProbe") -}}
{{- end -}}
{{- define "patchmon.server.readinessProbe" -}}
{{- $defaults := dict
"httpGet" (fromYaml (include "patchmon.server.httpGet" .))
"periodSeconds" 10
"timeoutSeconds" 5
"failureThreshold" 3 -}}
{{- include "patchmon.defaultedDict" (dict "defaults" $defaults "given" .given "path" "patchmon.server.readinessProbe") -}}
{{- end -}}
{{- define "patchmon.server.startupProbe" -}}
{{- $defaults := dict
"httpGet" (fromYaml (include "patchmon.server.httpGet" .))
"periodSeconds" 10
"timeoutSeconds" 5
"failureThreshold" 60 -}}
{{- include "patchmon.defaultedDict" (dict "defaults" $defaults "given" .given "path" "patchmon.server.startupProbe") -}}
{{- end -}}
{{- define "patchmon.guacd.livenessProbe" -}}
{{- $defaults := dict
"tcpSocket" (dict "port" 4822)
"periodSeconds" 10
"timeoutSeconds" 5
"failureThreshold" 3 -}}
{{- include "patchmon.defaultedDict" (dict "defaults" $defaults "given" . "path" "patchmon.guacd.livenessProbe") -}}
{{- end -}}
{{- define "patchmon.guacd.readinessProbe" -}}
{{- $defaults := dict
"tcpSocket" (dict "port" 4822)
"periodSeconds" 10
"timeoutSeconds" 5
"failureThreshold" 3 -}}
{{- include "patchmon.defaultedDict" (dict "defaults" $defaults "given" . "path" "patchmon.guacd.readinessProbe") -}}
{{- end -}}
{{- define "patchmon.guacd.startupProbe" -}}
{{- $defaults := dict
"tcpSocket" (dict "port" 4822)
"periodSeconds" 5
"timeoutSeconds" 5
"failureThreshold" 30 -}}
{{- include "patchmon.defaultedDict" (dict "defaults" $defaults "given" . "path" "patchmon.guacd.startupProbe") -}}
{{- end -}}
{{/*
The effective resources blocks, fed into the resources helper above so that an
erased "resources:" still yields the chart's requests and computed limits
instead of a container without any resource accounting.
*/}}
{{- define "patchmon.server.effectiveResources" -}}
{{- $defaults := dict
"limitFactor" 3
"requests" (dict "cpu" 0.1 "memory" "256Mi" "ephemeral-storage" "10Mi") -}}
{{- $merged := fromYaml (include "patchmon.defaultedDict" (dict "defaults" $defaults "given" . "path" "patchmon.server.resources")) -}}
{{- include "patchmon.resources" $merged -}}
{{- end -}}
{{- define "patchmon.guacd.effectiveResources" -}}
{{- $defaults := dict
"limitFactor" 3
"requests" (dict "cpu" 0.05 "memory" "64Mi" "ephemeral-storage" "10Mi") -}}
{{- $merged := fromYaml (include "patchmon.defaultedDict" (dict "defaults" $defaults "given" . "path" "patchmon.guacd.resources")) -}}
{{- include "patchmon.resources" $merged -}}
{{- end -}}
patchmon/templates/patchmon.deployment.yaml
+11 -11
View File
@@ -23,13 +23,13 @@ spec:
# for the same reason).
hostname: {{ .Release.Name }}-{{ .Chart.Name }}-server
securityContext:
{{- toYaml .Values.patchmon.server.securityContext.pod | nindent 8 }}
{{- include "patchmon.server.podSecurityContext" .Values.patchmon.server.securityContext | nindent 8 }}
containers:
- name: {{ .Release.Name }}-{{ .Chart.Name }}-server
image: "ghcr.io/patchmon/patchmon-server:{{ .Chart.AppVersion }}"
imagePullPolicy: IfNotPresent
securityContext:
{{- toYaml .Values.patchmon.server.securityContext.container | nindent 12 }}
{{- include "patchmon.server.containerSecurityContext" .Values.patchmon.server.securityContext | nindent 12 }}
ports:
- containerPort: 3000
protocol: TCP
@@ -166,13 +166,13 @@ spec:
# Probe values are rendered through tpl (see values.yaml for the
# defaults and why the probes send a Host header).
livenessProbe:
{{- tpl (toYaml .Values.patchmon.server.livenessProbe) . | nindent 12 }}
{{- tpl (include "patchmon.server.livenessProbe" (dict "given" .Values.patchmon.server.livenessProbe "root" $)) . | nindent 12 }}
readinessProbe:
{{- tpl (toYaml .Values.patchmon.server.readinessProbe) . | nindent 12 }}
{{- tpl (include "patchmon.server.readinessProbe" (dict "given" .Values.patchmon.server.readinessProbe "root" $)) . | nindent 12 }}
startupProbe:
{{- tpl (toYaml .Values.patchmon.server.startupProbe) . | nindent 12 }}
{{- tpl (include "patchmon.server.startupProbe" (dict "given" .Values.patchmon.server.startupProbe "root" $)) . | nindent 12 }}
resources:
{{- include "patchmon.resources" .Values.patchmon.server.resources | nindent 12 }}
{{- include "patchmon.server.effectiveResources" .Values.patchmon.server.resources | nindent 12 }}
volumeMounts:
# The image is stateless, but the Go server needs a writable /tmp
# for scratch files with a read-only root filesystem.
@@ -206,19 +206,19 @@ spec:
{{- end }}
{{- end }}
securityContext:
{{- toYaml .Values.patchmon.guacd.securityContext.container | nindent 12 }}
{{- include "patchmon.guacd.containerSecurityContext" .Values.patchmon.guacd.securityContext | nindent 12 }}
ports:
- containerPort: 4822
protocol: TCP
name: guacd
livenessProbe:
{{- tpl (toYaml .Values.patchmon.guacd.livenessProbe) . | nindent 12 }}
{{- tpl (include "patchmon.guacd.livenessProbe" .Values.patchmon.guacd.livenessProbe) . | nindent 12 }}
readinessProbe:
{{- tpl (toYaml .Values.patchmon.guacd.readinessProbe) . | nindent 12 }}
{{- tpl (include "patchmon.guacd.readinessProbe" .Values.patchmon.guacd.readinessProbe) . | nindent 12 }}
startupProbe:
{{- tpl (toYaml .Values.patchmon.guacd.startupProbe) . | nindent 12 }}
{{- tpl (include "patchmon.guacd.startupProbe" .Values.patchmon.guacd.startupProbe) . | nindent 12 }}
resources:
{{- include "patchmon.resources" .Values.patchmon.guacd.resources | nindent 12 }}
{{- include "patchmon.guacd.effectiveResources" .Values.patchmon.guacd.resources | nindent 12 }}
volumeMounts:
- name: guacd-tmp
mountPath: /tmp
patchmon/templates/patchmon.ingress.yaml
+2
View File
@@ -1,3 +1,4 @@
{{- if .Values.ingress.enabled }}
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
@@ -26,3 +27,4 @@ spec:
- hosts:
- {{ required "A Domain/Host must be provided" .Values.ingress.domain }}
secretName: tls-{{ .Release.Name }}-{{ .Chart.Name }}-ingress
{{- end }}
patchmon/values.schema.json
+228
View File
@@ -0,0 +1,228 @@
{
"$schema": "https://json-schema.org/draft-07/schema#",
"title": "patchmon values",
"description": "Strict values schema (issue #68). additionalProperties is false on every chart-owned object level, so a key that the chart does not read is rejected at render time instead of being silently ignored. The only objects that stay open are the ones passed verbatim into the Kubernetes pod spec (probes, security contexts, global) - the chart does not interpret their contents, so it cannot judge which keys are meaningful.",
"type": "object",
"additionalProperties": false,
"properties": {
"global": {
"description": "Helm's conventional cross-chart values. Unused by this chart, kept open so an umbrella install cannot break on it.",
"type": "object"
},
"scaleDown": {
"type": "boolean"
},
"patchmon": {
"type": "object",
"additionalProperties": false,
"properties": {
"server": {
"type": "object",
"additionalProperties": false,
"properties": {
"replicas": {
"description": "The server registers itself under a stable identity (the pinned pod hostname); more than one replica is not supported by this chart.",
"type": "integer",
"minimum": 0
},
"securityContext": {
"$ref": "#/definitions/securityContext"
},
"livenessProbe": {
"$ref": "#/definitions/probe"
},
"readinessProbe": {
"$ref": "#/definitions/probe"
},
"startupProbe": {
"$ref": "#/definitions/probe"
},
"env": {
"$ref": "#/definitions/env"
},
"resources": {
"$ref": "#/definitions/resources"
}
}
},
"guacd": {
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"image": {
"description": "guacd is an independent upstream application, so its image is pinned here instead of following the chart's appVersion.",
"type": "string"
},
"securityContext": {
"description": "guacd is a sidecar in the server pod, so only a container context applies - the pod context is the server's. May be null / empty: the chart then falls back to its hardening defaults (issue #99).",
"type": ["object", "null"],
"additionalProperties": false,
"properties": {
"container": {
"description": "Merged onto the chart's container hardening defaults and rendered as the container's securityContext; kept open because the chart does not interpret the individual fields.",
"type": ["object", "null"]
}
}
},
"livenessProbe": {
"$ref": "#/definitions/probe"
},
"readinessProbe": {
"$ref": "#/definitions/probe"
},
"startupProbe": {
"$ref": "#/definitions/probe"
},
"env": {
"$ref": "#/definitions/env"
},
"resources": {
"$ref": "#/definitions/resources"
}
}
}
}
},
"ingress": {
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Gates the whole Ingress template (issue #93). false omits the Ingress, and the required domain/clusterIssuer values are then not needed either.",
"type": "boolean"
},
"clusterIssuer": {
"type": ["string", "null"]
},
"domain": {
"type": ["string", "null"]
},
"className": {
"type": ["string", "null"]
},
"annotations": {
"description": "Extra Ingress annotations, merged with the cert-manager annotation the chart always sets. Free-form keys by nature.",
"type": "object"
}
}
},
"secrets": {
"type": "object",
"additionalProperties": false,
"properties": {
"redisSecretRef": {
"type": ["string", "null"]
},
"postgresSecretRef": {
"type": ["string", "null"]
},
"oidcSecretRef": {
"type": ["string", "null"]
},
"patchmonSecretRef": {
"type": ["string", "null"]
}
}
}
},
"definitions": {
"resources": {
"description": "May be null / empty: the chart then falls back to its default requests and computed limits (issue #99) instead of rendering a container without resource accounting.",
"type": ["object", "null"],
"additionalProperties": false,
"properties": {
"limitFactor": {
"type": "number",
"exclusiveMinimum": 0
},
"requests": {
"$ref": "#/definitions/resourceList"
},
"limits": {
"$ref": "#/definitions/resourceList"
}
}
},
"resourceList": {
"type": ["object", "null"],
"additionalProperties": false,
"properties": {
"cpu": {
"type": ["string", "number", "null"]
},
"memory": {
"type": ["string", "number", "null"]
},
"ephemeral-storage": {
"type": ["string", "number", "null"]
},
"ephemeralStorage": {
"type": ["string", "number", "null"]
}
}
},
"env": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": ["name"],
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"valueFrom": {
"type": "object",
"additionalProperties": false,
"properties": {
"secretKeyRef": {
"$ref": "#/definitions/keyRef"
},
"configMapKeyRef": {
"$ref": "#/definitions/keyRef"
}
}
}
}
}
},
"keyRef": {
"type": "object",
"additionalProperties": false,
"required": ["name", "key"],
"properties": {
"name": {
"type": "string"
},
"key": {
"type": "string"
}
}
},
"securityContext": {
"description": "May be null / empty at any level: the chart then falls back to its hardening defaults (issue #99) instead of rendering an unhardened workload.",
"type": ["object", "null"],
"additionalProperties": false,
"properties": {
"pod": {
"description": "Merged onto the chart's pod hardening defaults and rendered as the pod's securityContext; kept open because the chart does not interpret the individual fields.",
"type": ["object", "null"]
},
"container": {
"description": "Merged onto the chart's container hardening defaults and rendered as the container's securityContext; kept open because the chart does not interpret the individual fields.",
"type": ["object", "null"]
}
}
},
"probe": {
"description": "Merged onto the chart's probe defaults and rendered as a container probe; kept open because the chart does not interpret the individual fields. May be null / empty, which means the defaults apply (issue #99) rather than the probe disappearing.",
"type": ["object", "null"]
}
}
}
patchmon/values.yaml
+4
View File
@@ -136,6 +136,10 @@ patchmon:
env: []
ingress:
# Set to false to omit the Ingress entirely (the required domain and
# clusterIssuer values are then not needed either, because they are only
# read inside the Ingress template).
enabled: true
clusterIssuer: null
domain: null
className: nginx