Merge pull request #3802 from telepresenceio/thallgren/rename-chart-folder

Rename charts/telepresence to charts/telepresence-oss.

Author: thallgren

.github/workflows/release.yaml

@@ -77,7 +77,7 @@ jobs:
           docker buildx build --platform=linux/amd64,linux/arm64 --build-arg TELEPRESENCE_VERSION=${{env.TELEPRESENCE_SEMVER}} \
           --push --tag ${{env.TELEPRESENCE_REGISTRY}}/tel2:${{env.TELEPRESENCE_SEMVER}} -f build-aux/docker/images/Dockerfile.traffic .
       - name: Push Helm Chart
-        run: helm push build-output/telepresence-chart.tgz oci://${{env.TELEPRESENCE_REGISTRY}}
+        run: helm push build-output/telepresence-oss-chart.tgz oci://${{env.TELEPRESENCE_REGISTRY}}
       - name: Log out from registry
         if: always()
         run: docker logout

CHANGELOG.yml

@@ -113,6 +113,12 @@ items:
         body: >-
           The clusterID was deprecated some time ago, and replaced by the ID of the namespace where the traffic-manager
           is installed.
+      - type: bugfix
+        title: Rename charts/telepresence to charts/telepresence-oss.
+        body: >-
+          The Helm chart name "telepresence-oss" was inconsistent with its contained folder "telepresence". As a result,
+          attempts to install the chart using an argo ApplicationSet failed. The contained folder was renamed to match
+          the chart name.
       - type: bugfix
         title: Conflict detection between namespaced and cluster-wide install.
         body: >-

build-aux/main.mk

@@ -291,9 +291,9 @@ push-client-image: client-image ## (Build) Push the client container image to $(
 push-images: push-tel2-image push-client-image
 
 .PHONY: helm-chart
-helm-chart: $(BUILDDIR)/telepresence-chart.tgz
+helm-chart: $(BUILDDIR)/telepresence-oss-chart.tgz
 
-$(BUILDDIR)/telepresence-chart.tgz: $(wildcard charts/telepresence/**/*)
+$(BUILDDIR)/telepresence-oss-chart.tgz: $(wildcard charts/telepresence-oss/**/*)
 	mkdir -p $(BUILDDIR)
 	go run packaging/helmpackage.go -o $@ -v $(TELEPRESENCE_SEMVER)
 

charts/chart.go

@@ -18,25 +18,21 @@ import (
 type DirType int8
 
 const (
-	DirTypeTelepresence     DirType = iota
-	DirTypeTelepresenceCRDs DirType = iota
+	DirTypeTelepresence   DirType = iota
+	TelepresenceChartName         = "telepresence-oss"
 )
 
-var (
-	//go:embed all:telepresence
-	TelepresenceFS embed.FS
-	//go:embed all:telepresence-crds
-	TelepresenceCRDsFS embed.FS
-)
+//go:embed all:telepresence-oss
+var TelepresenceFS embed.FS
 
 // filePriority returns the sort-priority of a filename; higher priority files sorts earlier.
 func filePriority(chartName, filename string) int {
 	prio := map[string]int{
 		fmt.Sprintf("%s/Chart.yaml)", chartName):        4,
 		fmt.Sprintf("%s/values.yaml)", chartName):       3,
 		fmt.Sprintf("%s/values.schema.json", chartName): 2,
-		// "telepresence/templates/**":    1,
-		// "otherwise":                    0,
+		// "telepresence/templates-oss/**":    1,
+		// "otherwise":                        0,
 	}[filename]
 	if prio == 0 && strings.HasPrefix(filename, fmt.Sprintf("%s/templates/", chartName)) {
 		prio = 1
@@ -80,8 +76,7 @@ var ChartOverlayFunc map[DirType]ChartOverlayFuncDef //nolint:gochecknoglobals /
 // WriteChart is a minimal `helm package`.
 func WriteChart(helmChartDir DirType, out io.Writer, chartName, version string, overlays ...fs.FS) error {
 	embedChart := map[DirType]embed.FS{
-		DirTypeTelepresence:     TelepresenceFS,
-		DirTypeTelepresenceCRDs: TelepresenceCRDsFS,
+		DirTypeTelepresence: TelepresenceFS,
 	}[helmChartDir]
 
 	var baseDir fs.FS = embedChart

charts/telepresence-crds/Chart.yaml

@@ -2,14 +2,14 @@ apiVersion: v2
 name: telepresence-oss
 description: A chart for deploying the server-side components of Telepresence
 type: application
-version: "1.1.1-bogus.overwritten.by.charts.go"
+version: "1.1.1-bogus.overwritten.by.chart.go"
 icon: https://raw.githubusercontent.com/telepresenceio/telepresence.io/master/src/assets/images/telepresence-edgy.svg
 
 # Note: This is the version of the Traffic Manager that will be installed by
 # this chart. The telepresence CLI will always attempt to update the Traffic
 # Manager if it is not the same version as the CLI so ensure you are keeping
 # these in sync.
-appVersion: "1.1.1-bogus.overwritten.by.charts.go"
+appVersion: "1.1.1-bogus.overwritten.by.chart.go"
 
 annotations:
   artifacthub.io/license: Apache-2.0

charts/telepresence-crds/values.yaml

@@ -96,6 +96,12 @@ The traffic-agent configuration was moved into a pod-annotation. This avoids syn
 The clusterID was deprecated some time ago, and replaced by the ID of the namespace where the traffic-manager is installed.
 </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;">Rename charts/telepresence to charts/telepresence-oss.</div></div>
+<div style="margin-left: 15px">
+
+The Helm chart name "telepresence-oss" was inconsistent with its contained folder "telepresence". As a result, attempts to install the chart using an argo ApplicationSet failed. The contained folder was renamed to match the chart name.
+</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;">[Conflict detection between namespaced and cluster-wide install.](install/manager#namespace-collision-detection)</div></div>
 <div style="margin-left: 15px">
 

charts/telepresence-crds/.helmignore renamed to charts/telepresence-oss/.helmignore

@@ -84,6 +84,10 @@ namespaceSelector:
 	<Title type="change">Drop deprecated current-cluster-id command.</Title>
 	<Body>The clusterID was deprecated some time ago, and replaced by the ID of the namespace where the traffic-manager is installed.</Body>
 </Note>
+<Note>
+	<Title type="bugfix">Rename charts/telepresence to charts/telepresence-oss.</Title>
+	<Body>The Helm chart name "telepresence-oss" was inconsistent with its contained folder "telepresence". As a result, attempts to install the chart using an argo ApplicationSet failed. The contained folder was renamed to match the chart name.</Body>
+</Note>
 <Note>
 	<Title type="bugfix" docs="install/manager#namespace-collision-detection">Conflict detection between namespaced and cluster-wide install.</Title>
 	<Body>The namespace conflict detection mechanism would only discover conflicts between two _namespaced_ Traffic Managers trying to manage the same namespace. This is now fixed so that all types conflicts are discovered.</Body>

charts/telepresence/Chart.yaml renamed to charts/telepresence-oss/Chart.yaml

@@ -26,12 +26,12 @@ import (
 )
 
 func (s *cluster) PackageHelmChart(ctx context.Context) (string, error) {
-	filename := filepath.Join(getT(ctx).TempDir(), "telepresence-chart.tgz")
+	filename := filepath.Join(getT(ctx).TempDir(), telcharts.TelepresenceChartName+"-chart.tgz")
 	fh, err := os.OpenFile(filename, os.O_CREATE|os.O_WRONLY, 0o666)
 	if err != nil {
 		return "", err
 	}
-	if err := telcharts.WriteChart(telcharts.DirTypeTelepresence, fh, "telepresence", s.self.ManagerVersion().String()); err != nil {
+	if err := telcharts.WriteChart(telcharts.DirTypeTelepresence, fh, telcharts.TelepresenceChartName, s.self.ManagerVersion().String()); err != nil {
 		_ = fh.Close()
 		return "", err
 	}

charts/telepresence/README.md renamed to charts/telepresence-oss/README.md

@@ -42,5 +42,5 @@ func packageHelmChart(filename string, version semver.Version) error {
 		return err
 	}
 	defer fh.Close()
-	return telcharts.WriteChart(telcharts.DirTypeTelepresence, fh, "telepresence", version.String())
+	return telcharts.WriteChart(telcharts.DirTypeTelepresence, fh, telcharts.TelepresenceChartName, version.String())
 }

charts/telepresence/templates/NOTES.txt renamed to charts/telepresence-oss/templates/NOTES.txt

@@ -27,7 +27,6 @@ type HelmCommand struct {
 
 var (
 	HelmInstallExtendFlagsFunc func(*pflag.FlagSet)                                      //nolint:gochecknoglobals // extension point
-	HelmExtendFlagsFunc        func(*pflag.FlagSet)                                      //nolint:gochecknoglobals // extension point
 	HelmInstallPrologFunc      func(context.Context, *pflag.FlagSet, *HelmCommand) error //nolint:gochecknoglobals // extension point
 )
 
@@ -58,7 +57,6 @@ func helmInstall() *cobra.Command {
 	flags.BoolVar(&ha.CreateNamespace, "create-namespace", true, "create a namespace for the traffic-manager if not present")
 	flags.StringVar(&ha.Version, "version", "", "the telepresence version if different from the client's version. May be a range (e.g. ^2.21.0)")
 	ha.addValueSettingFlags(flags)
-	ha.addCRDsFlags(flags)
 	uf := flags.Lookup("upgrade")
 	uf.Hidden = true
 	uf.Deprecated = `Use "telepresence helm upgrade" instead of "telepresence helm install --upgrade"`
@@ -81,7 +79,6 @@ func helmUpgrade() *cobra.Command {
 
 	flags := cmd.Flags()
 	ha.addValueSettingFlags(flags)
-	ha.addCRDsFlags(flags)
 	flags.BoolVarP(&ha.NoHooks, "no-hooks", "", false, "disable pre/post upgrade hooks")
 	flags.BoolVarP(&ha.ResetValues, "reset-values", "", false, "when upgrading, reset the values to the ones built into the chart")
 	flags.BoolVarP(&ha.ReuseValues, "reuse-values", "", false,
@@ -108,12 +105,6 @@ func (ha *HelmCommand) addValueSettingFlags(flags *pflag.FlagSet) {
 	}
 }
 
-func (ha *HelmCommand) addCRDsFlags(flags *pflag.FlagSet) {
-	if HelmExtendFlagsFunc != nil {
-		HelmExtendFlagsFunc(flags)
-	}
-}
-
 func helmUninstall() *cobra.Command {
 	ha := &HelmCommand{
 		Request: helm.Request{
@@ -128,7 +119,6 @@ func helmUninstall() *cobra.Command {
 	}
 	flags := cmd.Flags()
 	flags.BoolVarP(&ha.NoHooks, "no-hooks", "", false, "prevent hooks from running during uninstallation")
-	ha.addCRDsFlags(flags)
 	ha.rq = daemon.InitRequest(cmd)
 	return cmd
 }

charts/telepresence/templates/_helpers.tpl renamed to charts/telepresence-oss/templates/_helpers.tpl

@@ -19,7 +19,7 @@ import (
 
 func loadCoreChart(version string) (*chart.Chart, error) {
 	var buf bytes.Buffer
-	if err := telcharts.WriteChart(telcharts.DirTypeTelepresence, &buf, "telepresence", version); err != nil {
+	if err := telcharts.WriteChart(telcharts.DirTypeTelepresence, &buf, telcharts.TelepresenceChartName, version); err != nil {
 		return nil, err
 	}
 	return loader.LoadArchive(&buf)
@@ -65,11 +65,3 @@ func pullCoreChart(ctx context.Context, helmConfig *action.Configuration, ref, v
 	defer f.Close()
 	return loader.LoadArchive(f)
 }
-
-func loadCRDChart(version string) (*chart.Chart, error) {
-	var buf bytes.Buffer
-	if err := telcharts.WriteChart(telcharts.DirTypeTelepresenceCRDs, &buf, "telepresence-crds", version); err != nil {
-		return nil, err
-	}
-	return loader.LoadArchive(&buf)
-}

charts/telepresence/templates/agentInjectorWebhook.yaml renamed to charts/telepresence-oss/templates/agentInjectorWebhook.yaml

@@ -32,7 +32,6 @@ import (
 const (
 	helmDriver                = "secrets"
 	trafficManagerReleaseName = agentmap.ManagerAppName
-	crdReleaseName            = "telepresence-crds"
 )
 
 var GetValuesFunc = GetValues //nolint:gochecknoglobals // extension point
@@ -52,7 +51,6 @@ type Request struct {
 	ReuseValues     bool
 	ResetValues     bool
 	CreateNamespace bool
-	Crds            bool
 	NoHooks         bool
 	Version         string
 }
@@ -115,10 +113,6 @@ func (hr *Request) Run(ctx context.Context, cr *connector.ConnectRequest) error
 	}
 
 	updatedResource := "Traffic Manager"
-	if hr.Crds {
-		updatedResource = "Telepresence CRDs"
-	}
-
 	ioutil.Printf(dos.Stdout(ctx), "\n%s %s successfully\n", updatedResource, msg)
 	return nil
 }
@@ -323,18 +317,12 @@ func isInstalled(
 }
 
 func EnsureTrafficManager(ctx context.Context, clientGetter genericclioptions.RESTClientGetter, namespace string, req *Request) (err error) {
-	if req.Crds {
-		dlog.Debug(ctx, "loading build-in helm chart")
-		err = ensureIsInstalled(ctx, clientGetter, true, crdReleaseName, namespace, req)
-	} else {
-		err = ensureIsInstalled(ctx, clientGetter, false, trafficManagerReleaseName, namespace, req)
-	}
-	return err
+	return ensureIsInstalled(ctx, clientGetter, trafficManagerReleaseName, namespace, req)
 }
 
 // EnsureTrafficManager ensures the traffic manager is installed.
 func ensureIsInstalled(
-	ctx context.Context, clientGetter genericclioptions.RESTClientGetter, crd bool,
+	ctx context.Context, clientGetter genericclioptions.RESTClientGetter,
 	releaseName, namespace string, req *Request,
 ) error {
 	cleanFailedState := func(helmConfig *action.Configuration) error {
@@ -399,13 +387,10 @@ func ensureIsInstalled(
 	version := getTrafficManagerVersion(vals)
 
 	var chrt *chart.Chart
-	switch {
-	case crd:
-		chrt, err = loadCRDChart(version)
-	case req.Version != "":
+	if req.Version != "" {
 		version = req.Version
 		chrt, err = pullCoreChart(ctx, helmConfig, "oci://ghcr.io/telepresenceio/telepresence-oss", version)
-	default:
+	} else {
 		chrt, err = loadCoreChart(version)
 	}
 	if err != nil {
@@ -434,19 +419,10 @@ func ensureIsInstalled(
 func DeleteTrafficManager(
 	ctx context.Context, clientGetter genericclioptions.RESTClientGetter, namespace string, errOnFail bool, req *Request,
 ) error {
-	if !req.Crds {
-		err := ensureIsDeleted(ctx, clientGetter, trafficManagerReleaseName, namespace, errOnFail, req)
-		if err != nil {
-			return err
-		}
-		return nil
-	}
-
-	err := ensureIsDeleted(ctx, clientGetter, crdReleaseName, namespace, errOnFail, req)
+	err := ensureIsDeleted(ctx, clientGetter, trafficManagerReleaseName, namespace, errOnFail, req)
 	if err != nil {
 		return err
 	}
-
 	return nil
 }