feat: apply built in overrides before end user overrides (#610)

we should apply the release built in overrides before applying the
overrides we read from the command line. we were only applying the
latter before this patch so this also solves a bug.

this commit also adds unit tests for the built in overrides and an
a validation after the installation e2e test.

Author: ricardomaraschini

cmd/embedded-cluster/install.go

@@ -307,6 +307,7 @@ func ensureK0sConfig(c *cli.Context) error {
 
 // applyUnsupportedOverrides applies overrides to the k0s configuration. Applies first the
 // overrides embedded into the binary and after the ones provided by the user (--overrides).
+// we first apply the k0s config override and then apply the built in overrides.
 func applyUnsupportedOverrides(c *cli.Context, cfg *k0sconfig.ClusterConfig) (*k0sconfig.ClusterConfig, error) {
 	var err error
 	if embcfg, err := release.GetEmbeddedClusterConfig(); err != nil {
@@ -316,6 +317,9 @@ func applyUnsupportedOverrides(c *cli.Context, cfg *k0sconfig.ClusterConfig) (*k
 		if cfg, err = config.PatchK0sConfig(cfg, overrides); err != nil {
 			return nil, fmt.Errorf("unable to patch k0s config: %w", err)
 		}
+		if cfg, err = config.ApplyBuiltInExtensionsOverrides(cfg, embcfg); err != nil {
+			return nil, fmt.Errorf("unable to release built in overrides: %w", err)
+		}
 	}
 	if c.String("overrides") == "" {
 		return cfg, nil
@@ -328,6 +332,9 @@ func applyUnsupportedOverrides(c *cli.Context, cfg *k0sconfig.ClusterConfig) (*k
 	if cfg, err = config.PatchK0sConfig(cfg, overrides); err != nil {
 		return nil, fmt.Errorf("unable to apply overrides: %w", err)
 	}
+	if cfg, err = config.ApplyBuiltInExtensionsOverrides(cfg, eucfg); err != nil {
+		return nil, fmt.Errorf("unable to end user built in overrides: %w", err)
+	}
 	return cfg, nil
 }
 

e2e/kots-release-install/cluster-config.yaml

@@ -18,6 +18,16 @@ spec:
           xyz-test-label: xyz-value
         name: xyz
   unsupportedOverrides:
+    builtInExtensions:
+      - name: admin-console
+        values: |
+          labels:
+            release-custom-label: release-clustom-value
+      - name: embedded-cluster-operator
+        values: |
+          global:
+            labels:
+              release-custom-label: release-clustom-value
     k0s: |
       config:
         metadata:

e2e/kots-release-upgrade/cluster-config.yaml

@@ -21,6 +21,16 @@ spec:
           final-test-label: final-value
         name: final
   unsupportedOverrides:
+    builtInExtensions:
+      - name: admin-console
+        values: |
+          labels:
+            release-custom-label: release-clustom-value
+      - name: embedded-cluster-operator
+        values: |
+          global:
+            labels:
+              release-custom-label: release-clustom-value
     k0s: |
       config:
         metadata:

e2e/scripts/single-node-install.sh

@@ -248,6 +248,21 @@ ensure_installation_label() {
     fi
 }
 
+# ensure_release_builtin_overrides verifies if the built in overrides we provide as part
+# of the release have been applied to the helm charts.
+ensure_release_builtin_overrides() {
+    if ! kubectl get charts.helm.k0sproject.io -n kube-system k0s-addon-chart-admin-console -o yaml | grep -q -E "^ +release-custom-label"; then
+        echo "release-custom-label not found in k0s-addon-chart-admin-console"
+        kubectl get charts.helm.k0sproject.io -n kube-system k0s-addon-chart-admin-console -o yaml
+        return 1
+    fi
+    if ! kubectl get charts.helm.k0sproject.io -n kube-system k0s-addon-chart-embedded-cluster-operator -o yaml | grep -q -E "^ +release-custom-label"; then
+        echo "release-custom-label not found in k0s-addon-chart-embedded-cluster-operator"
+        kubectl get charts.helm.k0sproject.io -n kube-system k0s-addon-chart-embedded-cluster-operator -o yaml
+        return 1
+    fi
+}
+
 main() {
     local app_deploy_method="$1"
 
@@ -319,6 +334,9 @@ main() {
     if ! ensure_installation_label; then
         exit 1
     fi
+    if ! ensure_release_builtin_overrides; then
+        exit 1
+    fi
     if ! systemctl status embedded-cluster; then
         echo "Failed to get status of embedded-cluster service"
         exit 1

pkg/addons/applier.go

@@ -115,15 +115,6 @@ func (a *Applier) GenerateHelmConfigs(additionalCharts []v1beta1.Chart, addition
 
 	// charts required by the application
 	charts = append(charts, additionalCharts...)
-	if a.endUserConfig != nil {
-		for i, chart := range charts {
-			values, err := a.endUserConfig.Spec.ApplyEndUserAddOnOverrides(chart.Name, chart.Values)
-			if err != nil {
-				return nil, nil, fmt.Errorf("unable to apply end user overrides for %s: %w", chart.Name, err)
-			}
-			charts[i].Values = values
-		}
-	}
 	repositories = append(repositories, additionalRepositories...)
 
 	return charts, repositories, nil

pkg/addons/applier_test.go

@@ -9,6 +9,7 @@ import (
 	jsonpatch "github.com/evanphx/json-patch"
 	"github.com/k0sproject/dig"
 	k0sconfig "github.com/k0sproject/k0s/pkg/apis/k0s/v1beta1"
+	embeddedclusterv1beta1 "github.com/replicatedhq/embedded-cluster-kinds/apis/v1beta1"
 	"github.com/replicatedhq/embedded-cluster-operator/controllers"
 	"gopkg.in/yaml.v2"
 	k8syaml "sigs.k8s.io/yaml"
@@ -97,6 +98,22 @@ func extractK0sConfigPatch(raw string) (string, error) {
 	return string(data), nil
 }
 
+// ApplyBuiltIndExtensionsOverrides applies the cluster config built in extensions overrides on top
+// of the provided cluster configuration. Returns the changed configuration.
+func ApplyBuiltInExtensionsOverrides(cfg *k0sconfig.ClusterConfig, releaseConfig *embeddedclusterv1beta1.Config) (*k0sconfig.ClusterConfig, error) {
+	if cfg.Spec == nil || cfg.Spec.Extensions == nil || cfg.Spec.Extensions.Helm == nil {
+		return cfg, nil
+	}
+	for i, chart := range cfg.Spec.Extensions.Helm.Charts {
+		values, err := releaseConfig.Spec.ApplyEndUserAddOnOverrides(chart.Name, chart.Values)
+		if err != nil {
+			return nil, fmt.Errorf("unable to apply end user overrides for %s: %w", chart.Name, err)
+		}
+		cfg.Spec.Extensions.Helm.Charts[i].Values = values
+	}
+	return cfg, nil
+}
+
 // PatchK0sConfig patches a K0s config with the provided patch. Returns the patched config,
 // patch is expected to be a YAML encoded k0s configuration. We marshal the original config
 // and the patch into JSON and apply the latter as a merge patch to the former.