From acf760b9180f0b6ed2f0eef03558c2a6f6183d51 Mon Sep 17 00:00:00 2001 From: Taylor Mutch Date: Tue, 17 Nov 2026 22:31:20 -0800 Subject: [PATCH] fix(helm): normalize app version labels Signed-off-by: Taylor Mutch --- deploy/helm/openshell/templates/_helpers.tpl | 2 +- .../openshell/tests/version_labels_test.yaml | 126 ++++++++++++++++++ skills/debug-openshell-cluster/SKILL.md | 8 +- 3 files changed, 134 insertions(+), 2 deletions(-) create mode 100644 deploy/helm/openshell/tests/version_labels_test.yaml diff --git a/deploy/helm/openshell/templates/_helpers.tpl b/deploy/helm/openshell/templates/_helpers.tpl index 5177348ae2..1b77eb4a8e 100644 --- a/deploy/helm/openshell/templates/_helpers.tpl +++ b/deploy/helm/openshell/templates/_helpers.tpl @@ -46,7 +46,7 @@ Common labels helm.sh/chart: {{ include "openshell.chart" . }} {{ include "openshell.selectorLabels" . }} {{- if .Chart.AppVersion }} -app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +app.kubernetes.io/version: {{ .Chart.AppVersion | replace "+" "_" | trunc 63 | trimAll "-_." | quote }} {{- end }} app.kubernetes.io/managed-by: {{ .Release.Service }} {{- end }} diff --git a/deploy/helm/openshell/tests/version_labels_test.yaml b/deploy/helm/openshell/tests/version_labels_test.yaml new file mode 100644 index 0000000000..57ff5d469a --- /dev/null +++ b/deploy/helm/openshell/tests/version_labels_test.yaml @@ -0,0 +1,126 @@ +# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. +# SPDX-License-Identifier: Apache-2.0 + +suite: app version labels +templates: + - templates/statefulset.yaml + - templates/service.yaml + - templates/certgen.yaml + - templates/gateway-config.yaml +chart: + appVersion: 0.1.9+build.1 +set: + agentSandbox.preflight.enabled: false + +tests: + - it: normalizes build metadata on gateway workload + template: templates/statefulset.yaml + asserts: + - equal: + path: metadata.labels["app.kubernetes.io/version"] + value: 0.1.9_build.1 + + - it: normalizes build metadata on gateway Service + template: templates/service.yaml + asserts: + - equal: + path: metadata.labels["app.kubernetes.io/version"] + value: 0.1.9_build.1 + + - it: normalizes build metadata on certgen hook resources + template: templates/certgen.yaml + asserts: + - equal: + path: metadata.labels["app.kubernetes.io/version"] + value: 0.1.9_build.1 + + - it: preserves version 0.1.9 + template: templates/statefulset.yaml + chart: + appVersion: 0.1.9 + asserts: + - equal: + path: metadata.labels["app.kubernetes.io/version"] + value: 0.1.9 + + - it: preserves version 0.1.9-rc.1 + template: templates/statefulset.yaml + chart: + appVersion: 0.1.9-rc.1 + asserts: + - equal: + path: metadata.labels["app.kubernetes.io/version"] + value: 0.1.9-rc.1 + + - it: trims trailing hyphens after truncation + template: templates/statefulset.yaml + chart: + appVersion: 0.1.9+aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-tail + asserts: + - equal: + path: metadata.labels["app.kubernetes.io/version"] + value: 0.1.9_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - matchRegex: + path: metadata.labels["app.kubernetes.io/version"] + pattern: '^[A-Za-z0-9]([-A-Za-z0-9_.]{0,61}[A-Za-z0-9])?$' + + - it: trims trailing underscores after truncation + template: templates/statefulset.yaml + chart: + appVersion: 0.1.9-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa+tail + asserts: + - equal: + path: metadata.labels["app.kubernetes.io/version"] + value: 0.1.9-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - matchRegex: + path: metadata.labels["app.kubernetes.io/version"] + pattern: '^[A-Za-z0-9]([-A-Za-z0-9_.]{0,61}[A-Za-z0-9])?$' + + - it: trims trailing dots after truncation + template: templates/statefulset.yaml + chart: + appVersion: 0.1.9+aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.tail + asserts: + - equal: + path: metadata.labels["app.kubernetes.io/version"] + value: 0.1.9_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - matchRegex: + path: metadata.labels["app.kubernetes.io/version"] + pattern: '^[A-Za-z0-9]([-A-Za-z0-9_.]{0,61}[A-Za-z0-9])?$' + + - it: preserves an explicit gateway tag with build metadata in appVersion + template: templates/statefulset.yaml + set: + gateway.image.tag: release-test + asserts: + - equal: + path: spec.template.spec.containers[0].image + value: ghcr.io/nvidia/openshell/gateway:release-test + + - it: preserves digest precedence over a gateway tag for the workload + template: templates/statefulset.yaml + set: + gateway.image.tag: release-test + gateway.image.digest: sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + asserts: + - equal: + path: spec.template.spec.containers[0].image + value: ghcr.io/nvidia/openshell/gateway@sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + + - it: preserves digest precedence over a gateway tag for the certgen Job + template: templates/certgen.yaml + documentIndex: 3 + set: + gateway.image.tag: release-test + gateway.image.digest: sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + asserts: + - equal: + path: spec.template.spec.containers[0].image + value: ghcr.io/nvidia/openshell/gateway@sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + + - it: leaves the appVersion image fallback unchanged + template: templates/statefulset.yaml + asserts: + - equal: + path: spec.template.spec.containers[0].image + value: ghcr.io/nvidia/openshell/gateway:0.1.9+build.1 diff --git a/skills/debug-openshell-cluster/SKILL.md b/skills/debug-openshell-cluster/SKILL.md index bf9e9e0b83..c6d5e98d07 100644 --- a/skills/debug-openshell-cluster/SKILL.md +++ b/skills/debug-openshell-cluster/SKILL.md @@ -511,6 +511,13 @@ the release. Look for failed installs, unexpected values, missing namespace, wro image tag, TLS settings that do not match the registered endpoint, and scheduling failures. +If Kubernetes rejects `app.kubernetes.io/version` on a resource or certgen hook, +inspect the rendered label and chart app version. Charts normalize SemVer build +metadata for labels (`0.1.9+build.1` becomes `0.1.9_build.1`) without changing +the app version or image references. Upgrade older charts that emit `+` in +labels; use explicit image tags or digests when the app version is not a valid +container image tag. + When checking a Helm values migration, compare the rendered `gateway.toml` with the intended `gatewayConfig` tables. Explicit resource-admission settings and the Kubernetes Secrets credential namespace take precedence over deprecated @@ -1750,7 +1757,6 @@ Shared serving leases last at most fifteen seconds from issuance, independently of configuration renewal; include membership failure detection when measuring a partition's stale-owner interval. Storage failures prevent renewal. - Application ingress consumers call the separate `openshell.v1.ServiceDiscovery` service, rather than `OpenShell`. Discovery snapshots share a one-second cache per workspace (16 cached workspaces, four concurrent collections). The gateway