implement helm values replace feature

Author: Diaphteiros

cmd/platform-service-dns/app/run.go

@@ -245,7 +245,7 @@ func (o *RunOptions) Run(ctx context.Context) error {
 		}
 		return fmt.Errorf("error getting DNSServiceConfig '%s': %w", svcCfg.Name, err)
 	}
-	if err := cluster.NewClusterReconciler(o.PlatformCluster, mgr.GetEventRecorderFor(cluster.ControllerName), o.ProviderName, o.ProviderNamespace).SetupWithManager(mgr); err != nil {
+	if err := cluster.NewClusterReconciler(o.PlatformCluster, mgr.GetEventRecorderFor(cluster.ControllerName), o.ProviderName, o.ProviderNamespace, o.Environment).SetupWithManager(mgr); err != nil {
 		return fmt.Errorf("unable to add Cluster reconciler to manager: %w", err)
 	}
 

go.mod

@@ -100,7 +100,7 @@ require (
 	gopkg.in/evanphx/json-patch.v4 v4.12.0 // indirect
 	gopkg.in/inf.v0 v0.9.1 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
-	k8s.io/apiextensions-apiserver v0.34.1 // indirect
+	k8s.io/apiextensions-apiserver v0.34.1
 	k8s.io/apiserver v0.34.1 // indirect
 	k8s.io/component-base v0.34.1 // indirect
 	k8s.io/klog/v2 v2.130.1 // indirect

internal/controllers/cluster/controller.go

@@ -11,6 +11,7 @@ import (
 
 	corev1 "k8s.io/api/core/v1"
 	rbacv1 "k8s.io/api/rbac/v1"
+	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime/schema"
@@ -53,17 +54,18 @@ type ClusterReconciler struct {
 	eventRecorder     record.EventRecorder
 	ProviderName      string
 	ProviderNamespace string
+	Environment       string
 	KnownClusters     map[types.NamespacedName]struct{}
 	KnownClustersLock *sync.RWMutex
-	FakeClientMapping map[string]client.Client // this must be nil except for unit tests
 }
 
-func NewClusterReconciler(platformCluster *clusters.Cluster, recorder record.EventRecorder, providerName, providerNamespace string) *ClusterReconciler {
+func NewClusterReconciler(platformCluster *clusters.Cluster, recorder record.EventRecorder, providerName, providerNamespace, environment string) *ClusterReconciler {
 	return &ClusterReconciler{
 		PlatformCluster:   platformCluster,
 		eventRecorder:     recorder,
 		ProviderName:      providerName,
 		ProviderNamespace: providerNamespace,
+		Environment:       environment,
 		KnownClusters:     map[types.NamespacedName]struct{}{},
 		KnownClustersLock: &sync.RWMutex{},
 	}
@@ -542,7 +544,14 @@ func (r *ClusterReconciler) deployHelmRelease(ctx context.Context, c *clustersv1
 		hr.Spec.ReleaseName = "external-dns"
 		hr.Spec.TargetNamespace = "external-dns"
 		// values
-		hr.Spec.Values = rr.Config.HelmValues.DeepCopy()
+		values := string(rr.Config.HelmValues.Raw)
+		// at some point '<' and '>' get escaped and we have to match the escaped version here
+		values = strings.ReplaceAll(values, fmt.Sprintf("%sprovider.namespace%s", "\\u003c", "\\u003e"), r.ProviderNamespace)
+		values = strings.ReplaceAll(values, fmt.Sprintf("%sprovider.name%s", "\\u003c", "\\u003e"), r.ProviderName)
+		values = strings.ReplaceAll(values, fmt.Sprintf("%senvironment%s", "\\u003c", "\\u003e"), r.Environment)
+		values = strings.ReplaceAll(values, fmt.Sprintf("%scluster.namespace%s", "\\u003c", "\\u003e"), c.Namespace)
+		values = strings.ReplaceAll(values, fmt.Sprintf("%scluster.name%s", "\\u003c", "\\u003e"), c.Name)
+		hr.Spec.Values = &apiextensionsv1.JSON{Raw: []byte(values)}
 		// install configuration
 		if hr.Spec.Install == nil {
 			hr.Spec.Install = &fluxhelmv2.Install{}

internal/controllers/cluster/controller_test.go

@@ -14,6 +14,7 @@ import (
 	"k8s.io/apimachinery/pkg/runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
+	"sigs.k8s.io/yaml"
 
 	fluxhelmv2 "github.com/fluxcd/helm-controller/api/v2"
 	fluxsourcev1 "github.com/fluxcd/source-controller/api/v1"
@@ -35,6 +36,7 @@ const (
 
 	providerName      = "dns-service"
 	providerNamespace = "test"
+	environment       = "default"
 	managedByValue    = providerName + "." + cluster.ControllerName
 )
 
@@ -46,13 +48,7 @@ func defaultTestSetup(testDirPathSegments ...string) *testutils.Environment {
 		WithInitObjectPath(testDirPathSegments...).
 		WithDynamicObjectsWithStatus(&clustersv1alpha1.AccessRequest{}).
 		WithReconcilerConstructor(func(c client.Client) reconcile.Reconciler {
-			cRec := cluster.NewClusterReconciler(clusters.NewTestClusterFromClient(platformCluster, c), nil, providerName, providerNamespace)
-			cRec.FakeClientMapping = map[string]client.Client{
-				"cluster-01": nil,
-				"cluster-02": nil,
-				"cluster-03": nil,
-			}
-			return cRec
+			return cluster.NewClusterReconciler(clusters.NewTestClusterFromClient(platformCluster, c), nil, providerName, providerNamespace, environment)
 		}).
 		Build()
 
@@ -476,6 +472,37 @@ var _ = Describe("ClusterReconciler", func() {
 		}))
 	})
 
+	It("should replace the special keywords in the values correctly", func() {
+		env := defaultTestSetup("testdata", "test-03")
+
+		cfg := &dnsv1alpha1.DNSServiceConfig{}
+		Expect(env.Client().Get(env.Ctx, client.ObjectKey{Name: providerName}, cfg)).To(Succeed())
+
+		c1 := &clustersv1alpha1.Cluster{}
+		Expect(env.Client().Get(env.Ctx, client.ObjectKey{Name: "cluster-01", Namespace: "foo"}, c1)).To(Succeed())
+		rr := env.ShouldReconcile(testutils.RequestFromObject(c1))
+		Expect(rr.RequeueAfter).To(BeNumerically(">", 0))
+		fakeAccessRequestReadiness(env, c1)
+		rr = env.ShouldReconcile(testutils.RequestFromObject(c1))
+		Expect(rr.RequeueAfter).To(BeZero())
+
+		// verify that the correct resources were created
+		expectedLabels := map[string]string{
+			openmcpconst.ManagedByLabel:      managedByValue,
+			openmcpconst.ManagedPurposeLabel: c1.Name,
+		}
+		hrs := &fluxhelmv2.HelmReleaseList{}
+		Expect(env.Client().List(env.Ctx, hrs, client.InNamespace(c1.Namespace), client.MatchingLabels(expectedLabels))).To(Succeed())
+		Expect(hrs.Items).To(HaveLen(1))
+		valueData := map[string]any{}
+		Expect(yaml.Unmarshal(hrs.Items[0].Spec.Values.Raw, &valueData)).To(Succeed())
+		Expect(valueData).To(HaveKeyWithValue("clusterName", c1.Name))
+		Expect(valueData).To(HaveKeyWithValue("clusterNamespace", c1.Namespace))
+		Expect(valueData).To(HaveKeyWithValue("environment", environment))
+		Expect(valueData).To(HaveKeyWithValue("providerName", providerName))
+		Expect(valueData).To(HaveKeyWithValue("providerNamespace", providerNamespace))
+	})
+
 })
 
 func fakeAccessRequestReadiness(env *testutils.Environment, c *clustersv1alpha1.Cluster) {

internal/controllers/cluster/testdata/test-01/config.yaml

@@ -18,17 +18,11 @@ spec:
   - name: foo
     purposeSelector:
       name: foo
-    helmValues: |
-      {
-        "foo": "foo"
-      }
+    helmValues:
+      foo: foo
   - name: asdf
-    helmValues: |
-      {
-        "foo": "bar"
-      }
+    helmValues:
+      foo: bar
   - name: qwer
-    helmValues: |
-      {
-        "foo": "baz"
-      }
+    helmValues:
+      foo: baz

internal/controllers/cluster/testdata/test-02/config.yaml

@@ -18,16 +18,12 @@ spec:
           and:
           - name: foo
           - name: bar
-    helmValues: |
-      {
-        "foo": "baz"
-      }
+    helmValues:
+      foo: baz
   - name: foobar
     purposeSelector:
       and:
       - name: foo
       - name: foobar
-    helmValues: |
-      {
-        "foo": "foo"
-      }
+    helmValues:
+      foo: foo

internal/controllers/cluster/testdata/test-03/config.yaml

@@ -11,7 +11,9 @@ spec:
   - name: foo
     purposeSelector:
       name: foo
-    helmValues: |
-      {
-        "foo": "foo"
-      }
+    helmValues:
+      providerNamespace: <provider.namespace>
+      providerName: <provider.name>
+      environment: <environment>
+      clusterNamespace: <cluster.namespace>
+      clusterName: <cluster.name>

internal/controllers/cluster/testdata/test-04/config.yaml

@@ -11,7 +11,5 @@ spec:
   - name: foo
     purposeSelector:
       name: foo
-    helmValues: |
-      {
-        "foo": "foo"
-      }
+    helmValues:
+      foo: foo