Skip to content

WIP: Implement validation PoC using Helm templates & fail function #3165

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

WIP: Implement validation PoC using Helm templates & fail function #3165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
86 changes: 86 additions & 0 deletions chart/templates/_validation.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
{{/*
This template has no output, only side-effects.
*/}}
{{ define "validate-config" -}}
{{ $ctx := . -}}
{{- /* Strip any custom type info from values. */}}
{{- /* Functions like dig require a plain map. */}}
{{ $current := (fromYaml ($ctx.Values | toYaml)) -}}
{{ $release := $ctx.Release -}}

{{ $existing := dict -}}
{{ $secretName := printf "vc-config-%s" $release.Name -}}
{{ $secret := lookup "v1" "Secret" $release.Namespace $secretName -}}
{{ with dig "data" "config.yaml" (b64enc "{}") $secret -}}
{{ $decoded := b64dec . -}}
{{ $existing = (fromYaml $decoded) -}}
{{ end -}}

{{ include "validate-private-nodes" (dict "existing" $existing "new" $current) }}

{{- /*
Enforce rules for changes that would be destructive
*/}}
{{/* sync.fromHost.nodes.enabled cannot change */}}
{{ $oldFromHostNodes := (dig "sync" "fromHost" "nodes" "enabled" false $existing) -}}
{{ $newFromHostNodes := (dig "sync" "fromHost" "nodes" "enabled" false $current) -}}
{{ if (ne $oldFromHostNodes $newFromHostNodes) -}}
{{ fail (printf "sync.fromHost.nodes.enabled cannot be changed (existing: %t, new: %t)" $oldFromHostNodes $newFromHostNodes) }}
{{ end -}}

{{/* sync.toHost.persistentVolumes.enabled cannot change */}}
{{ $oldToHostPVs := (dig "sync" "toHost" "persistentVolumes" "enabled" false $existing) -}}
{{ $newToHostPVs := (dig "sync" "toHost" "persistentVolumes" "enabled" false $current) -}}
{{ if (ne $oldToHostPVs $newToHostPVs) -}}
{{ fail (printf "sync.toHost.persistentVolumes.enabled cannot be changed (existing: %t, new: %t)" $oldToHostPVs $newToHostPVs) }}
{{ end -}}

{{/* sync.toHost.namespaces.enabled cannot change */}}
{{ $oldToHostNamespaces := (dig "sync" "toHost" "namespaces" "enabled" false $existing) -}}
{{ $newToHostNamespaces := (dig "sync" "toHost" "namespaces" "enabled" false $current) -}}
{{ if (ne $oldToHostNamespaces $newToHostNamespaces) -}}
{{ fail (printf "sync.toHost.namespaces.enabled cannot be changed (existing: %t, new: %t)" $oldToHostNamespaces $newToHostNamespaces) }}
{{ end -}}

{{/* networking.advanced.clusterDomain cannot change */}}
{{ $oldClusterDomain := (dig "networking" "advanced" "clusterDomain" "cluster.local" $existing) -}}
{{ $newClusterDomain := (dig "networking" "advanced" "clusterDomain" "cluster.local" $current) -}}
{{ if (ne $oldClusterDomain $newClusterDomain) -}}
{{ fail (printf "networking.advanced.clusterDomain cannot be changed (existing: %s, new: %s)" $oldClusterDomain $newClusterDomain) }}
{{ end -}}

{{/* networking.podCIDR cannot change */}}
{{ $oldPrivateNodes := (dig "privateNodes" "enabled" false $existing) -}}
{{ $oldPodCIDR := (dig "networking" "podCIDR" "10.244.0.0/16" $existing) -}}
{{ $newPodCIDR := (dig "networking" "podCIDR" "10.244.0.0/16" $current) -}}
{{ if and $oldPrivateNodes (ne $oldPodCIDR $newPodCIDR) -}}
{{ fail (printf "networking.podCIDR cannot be changed (existing: %s, new: %s)" $oldPodCIDR $newPodCIDR) }}
{{ end -}}

{{/* networking.serviceCIDR cannot change */}}
{{ $oldPrivateNodes := (dig "privateNodes" "enabled" false $existing) -}}
{{ $oldPodCIDR := (dig "networking" "serviceCIDR" "10.96.0.0/12" $existing) -}}
{{ $newPodCIDR := (dig "networking" "serviceCIDR" "10.96.0.0/12" $current) -}}
{{ if and $oldPrivateNodes (ne $oldPodCIDR $newPodCIDR) -}}
{{ fail (printf "networking.serviceCIDR cannot be changed (existing: %s, new: %s)" $oldPodCIDR $newPodCIDR) }}
{{ end -}}

{{/* controlPlane.proxy.port cannot change */}}
{{ $oldProxyPort := (dig "controlPlane" "proxy" "port" 8443 $existing) -}}
{{ $newProxyPort := (dig "controlPlane" "proxy" "port" 8443 $current) -}}
{{ if (ne (int $oldProxyPort) (int $newProxyPort)) -}}
{{ fail (printf "controlPlane.proxy.port cannot be changed (existing: %v, new: %v)" $oldProxyPort $newProxyPort) }}
{{ end -}}

{{/* controlPlane.distro: only allow k3s -> k8s, forbid other changes */}}
{{ $oldK8s := (dig "controlPlane" "distro" "k8s" "enabled" true $existing) -}}
{{ $oldK3s := (dig "controlPlane" "distro" "k3s" "enabled" false $existing) -}}
{{ $newK8s := (dig "controlPlane" "distro" "k8s" "enabled" true $current) -}}
{{ $newK3s := (dig "controlPlane" "distro" "k3s" "enabled" false $current) -}}
{{ if and $newK3s $newK8s -}}
{{ fail "cannot enable both k8s and k3s control plane at once" }}
{{ end -}}
{{ if and $oldK8s $newK3s -}}
{{ fail "cannot change control plane from k3s to k8s" }}
{{ end -}}
{{ end -}}
13 changes: 13 additions & 0 deletions chart/templates/_validation/_private-nodes.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{{/*
This template has no output, only side-effects.
*/}}
{{ define "validate-private-nodes" -}}
{{ $existing := .existing -}}
{{ $new := .new -}}

{{ $oldPrivateNodes := (dig "privateNodes" "enabled" false $existing) -}}
{{ $newPrivateNodes := (dig "privateNodes" "enabled" false $new) -}}
{{ if ne $oldPrivateNodes $newPrivateNodes -}}
{{ fail (printf "privateNodes.enabled cannot be changed (existing: %t, new: %t)" $oldPrivateNodes $newPrivateNodes) }}
{{ end -}}
{{ end -}}
1 change: 1 addition & 0 deletions chart/templates/config-secret.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
{{- if include "validate-config" . -}}{{ end -}}
apiVersion: v1
kind: Secret
metadata:
Expand Down
Loading