The Telepresence Helm chart could not be used as a chart dependency

thallgren · thallgren · commit 408f2d22cdbb · 2025-04-05T08:37:11.000+02:00
The JSON schema validation implemented in Telepresence 2.22.0 had a defect: it rejected the `global` object. This object, a Helm-managed construct, facilitates the propagation of arbitrary configurations from a parent chart to its dependencies. Consequently, charts intended for dependency use must permit the presence of the `global` object. Closes #3833 Signed-off-by: Thomas Hallgren <thomas@tada.se>
diff --git a/CHANGELOG.yml b/CHANGELOG.yml
@@ -27,6 +27,14 @@ items:
   - version: 2.22.3
     date: (TBD)
     notes:
+      - type: bugfix
+        title: The Telepresence Helm chart could not be used as a dependency in another chart.
+        body: >-
+          The JSON schema validation implemented in Telepresence 2.22.0 had a defect: it rejected the `global` object.
+          This object, a Helm-managed construct, facilitates the propagation of arbitrary configurations from a parent
+          chart to its dependencies. Consequently, charts intended for dependency use must permit the presence of the
+          `global` object.
+        docs: https://github.com/telepresenceio/telepresence/issues/3833
       - type: bugfix
         title: Recreating namespaces was not possible when using a dynamically namespaced Traffic Manager
         body: >-
diff --git a/charts/telepresence-oss/values.schema.yaml b/charts/telepresence-oss/values.schema.yaml
@@ -251,6 +251,10 @@ properties:
         items:
           $ref: "#/$defs/subject"
 
+  global:
+    type: object
+    additionalProperties: true
+
   grpc:
     type: object
     additionalProperties: false
diff --git a/docs/release-notes.md b/docs/release-notes.md
@@ -2,6 +2,12 @@
 [comment]: # (Code generated by relnotesgen. DO NOT EDIT.)
 # <img src="images/logo.png" height="64px"/> Telepresence Release Notes
 ## Version 2.22.3
+## <div style="display:flex;"><img src="images/bugfix.png" alt="bugfix" style="width:30px;height:fit-content;"/><div style="display:flex;margin-left:7px;">The Telepresence Helm chart could not be used as a dependency in another chart.</div></div>
+<div style="margin-left: 15px">
+
+The JSON schema validation implemented in Telepresence 2.22.0 had a defect: it rejected the `global` object. This object, a Helm-managed construct, facilitates the propagation of arbitrary configurations from a parent chart to its dependencies. Consequently, charts intended for dependency use must permit the presence of the `global` object.
+</div>
+
 ## <div style="display:flex;"><img src="images/bugfix.png" alt="bugfix" style="width:30px;height:fit-content;"/><div style="display:flex;margin-left:7px;">[Recreating namespaces was not possible when using a dynamically namespaced Traffic Manager](https://github.com/telepresenceio/telepresence/issues/3831)</div></div>
 <div style="margin-left: 15px">
 
diff --git a/docs/release-notes.mdx b/docs/release-notes.mdx
@@ -8,6 +8,12 @@ import { Note, Title, Body } from '@site/src/components/ReleaseNotes'
 
 # Telepresence Release Notes
 ## Version 2.22.3
+<Note>
+	<Title type="bugfix">The Telepresence Helm chart could not be used as a dependency in another chart.</Title>
+	<Body>
+The JSON schema validation implemented in Telepresence 2.22.0 had a defect: it rejected the `global` object. This object, a Helm-managed construct, facilitates the propagation of arbitrary configurations from a parent chart to its dependencies. Consequently, charts intended for dependency use must permit the presence of the `global` object.
+  </Body>
+</Note>
 <Note>
 	<Title type="bugfix" docs="https://github.com/telepresenceio/telepresence/issues/3831">Recreating namespaces was not possible when using a dynamically namespaced Traffic Manager</Title>
 	<Body>
diff --git a/integration_test/install_test.go b/integration_test/install_test.go
@@ -1,10 +1,14 @@
 package integration_test
 
 import (
+	"archive/tar"
+	"compress/gzip"
 	"context"
 	"fmt"
+	"io"
 	"os"
 	"path/filepath"
+	"runtime"
 	"strings"
 	"time"
 
@@ -330,3 +334,112 @@ func ensureTrafficManager(ctx context.Context, kc *k8s.Cluster) error {
 		k8s.GetManagerNamespace(ctx),
 		&helm.Request{Type: helm.Install})
 }
+
+func unTgz(ctx context.Context, srcTgz, dstPath string) error {
+	rd, err := os.Open(srcTgz)
+	if err != nil {
+		return err
+	}
+	defer rd.Close()
+
+	err = dos.MkdirAll(ctx, dstPath, 0o755)
+	if err != nil {
+		return err
+	}
+
+	zrd, err := gzip.NewReader(rd)
+	if err != nil {
+		return err
+	}
+	src := tar.NewReader(zrd)
+	for {
+		header, err := src.Next()
+		if err != nil {
+			if err == io.EOF {
+				break
+			}
+			return err
+		}
+
+		dst := dstPath + "/" + header.Name
+		mode := os.FileMode(header.Mode)
+		switch header.Typeflag {
+		case tar.TypeDir:
+			err = dos.MkdirAll(ctx, dst, mode)
+			if err != nil {
+				return err
+			}
+		case tar.TypeReg:
+			err = dos.MkdirAll(ctx, filepath.Dir(dst), 0o755)
+			if err != nil {
+				return err
+			}
+			w, err := dos.OpenFile(ctx, dst, os.O_CREATE|os.O_WRONLY, mode)
+			if err != nil {
+				return err
+			}
+			_, err = io.Copy(w, src)
+			_ = w.Close()
+			if err != nil {
+				return err
+			}
+		default:
+			return fmt.Errorf("unable to untar type : %c in file %s", header.Typeflag, header.Name)
+		}
+	}
+	return nil
+}
+
+func (is *installSuite) Test_HelmSubChart() {
+	if runtime.GOOS == "windows" || !(is.ManagerVersion().EQ(version.Structured) && is.ClientVersion().EQ(version.Structured)) {
+		is.T().Skip("Not part of compatibility tests. Need forward slashes in path, and PackageHelmChart assumes current version.")
+	}
+	ctx := is.Context()
+	require := is.Require()
+
+	t := is.T()
+	subChart, err := is.PackageHelmChart(ctx)
+	require.NoError(err)
+
+	base := t.TempDir()
+	require.NoError(unTgz(ctx, subChart, filepath.Join(base, "charts")))
+
+	chart := fmt.Sprintf(`apiVersion: v2
+dependencies:
+  - name: telepresence-oss
+    registry: ../charts/telepresence-oss
+    version: %s
+    condition: enabled
+description: Helm chart to deploy telepresence
+name: parent
+version: 1.0.0`, is.ClientVersion())
+
+	vals := is.GetSetArgsForHelm(ctx, map[string]any{
+		"global": map[string]any{
+			"some-string": "value",
+			"some-obj": map[string]any{
+				"foo": "bar",
+			},
+			"some-bool": true,
+		},
+		"telepresence-oss": map[string]any{
+			"clientRbac": map[string]any{
+				"create": true,
+				"subjects": []rbac.Subject{
+					{
+						Kind:      "ServiceAccount",
+						Name:      itest.TestUser,
+						Namespace: is.ManagerNamespace(),
+					},
+				},
+			},
+		},
+	}, false)
+	require.NoError(dos.WriteFile(ctx, filepath.Join(base, "Chart.yaml"), []byte(chart), 0o644))
+
+	vals = append([]string{"template", "parent", base, "-n", is.ManagerNamespace()}, vals...)
+	so, err := itest.Output(ctx, "helm", vals...)
+	require.NoError(err)
+	require.Contains(so, "# Source: parent/charts/telepresence-oss/templates/clientRbac/connect.yaml")
+	require.Contains(so, "name: "+itest.TestUser)
+}
