feat: update default chart order values (#396)

* update default chart order values to be negative

* undo order change

* use 1,3,5 order

* set default chart order for vendor-provided charts

* test that default order remains 10

* fmt

* improve grep

* test new operator

* use regex grep

* fix grep

* use updated embedded-cluster-operator

Author: laverya

Makefile

@@ -9,7 +9,7 @@ ADMIN_CONSOLE_IMAGE_OVERRIDE =
 ADMIN_CONSOLE_MIGRATIONS_IMAGE_OVERRIDE =
 EMBEDDED_OPERATOR_CHART_URL = oci://registry.replicated.com/library
 EMBEDDED_OPERATOR_CHART_NAME = embedded-cluster-operator
-EMBEDDED_OPERATOR_CHART_VERSION = 0.22.7
+EMBEDDED_OPERATOR_CHART_VERSION = 0.23.0
 OPENEBS_CHART_URL = https://openebs.github.io/charts
 OPENEBS_CHART_NAME = openebs/openebs
 OPENEBS_CHART_VERSION = 3.10.0

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

@@ -38,7 +38,6 @@ spec:
           chartname: ingress-nginx/ingress-nginx
           namespace: ingress-nginx
           version: "4.8.3"
-          order: 4
           values: |
             controller:
               service:

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

@@ -43,7 +43,6 @@ spec:
           chartname: ingress-nginx/ingress-nginx
           namespace: ingress-nginx
           version: "4.9.1"
-          order: 4
           values: |
             controller:
               service:
@@ -57,4 +56,4 @@ spec:
           name: goldpinger
           namespace: goldpinger
           version: 6.1.2
-          order: 5
+          order: 11

e2e/scripts/check-postupgrade-state.sh

@@ -90,6 +90,13 @@ main() {
 
     echo "ensure that the admin console branding is available"
     kubectl get cm -n kotsadm kotsadm-application-metadata
+
+    echo "ensure that the default chart order remained 10"
+    if ! kubectl describe clusterconfig -n kube-system k0s | grep -q -e 'Order:\W*10' ; then
+        kubectl describe clusterconfig -n kube-system k0s
+        echo "no charts had an order of '10'"
+        exit 1
+    fi
 }
 
 export EMBEDDED_CLUSTER_METRICS_BASEURL="https://staging.replicated.app"

go.mod

@@ -11,7 +11,7 @@ require (
 	github.com/gosimple/slug v1.13.1
 	github.com/jedib0t/go-pretty v4.3.0+incompatible
 	github.com/k0sproject/dig v0.2.0
-	github.com/replicatedhq/embedded-cluster-operator v0.22.7
+	github.com/replicatedhq/embedded-cluster-operator v0.23.0
 	github.com/replicatedhq/embedded-cluster-utils v0.0.0-20240214185439-68a1dfae58be
 	github.com/replicatedhq/kotskinds v0.0.0-20230724164735-f83482cc9cfe
 	github.com/replicatedhq/troubleshoot v0.83.0
@@ -40,6 +40,7 @@ require (
 	github.com/google/pprof v0.0.0-20230323073829-e72429f035bd // indirect
 	github.com/gorilla/mux v1.8.1 // indirect
 	github.com/matttproud/golang_protobuf_extensions/v2 v2.0.0 // indirect
+	github.com/ohler55/ojg v1.21.2 // indirect
 	github.com/opencontainers/go-digest v1.0.0 // indirect
 	github.com/prometheus/client_golang v1.18.0 // indirect
 	github.com/prometheus/client_model v0.5.0 // indirect
@@ -141,7 +142,7 @@ require (
 	gopkg.in/square/go-jose.v2 v2.6.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1
 	k8s.io/apiextensions-apiserver v0.29.0 // indirect
-	k8s.io/client-go v0.29.1 // indirect
+	k8s.io/client-go v0.29.2 // indirect
 	k8s.io/klog/v2 v2.120.1 // indirect
 	k8s.io/kube-openapi v0.0.0-20231113174909-778a5567bc1e // indirect
 	k8s.io/utils v0.0.0-20231121161247-cf03d44ff3cf // indirect

go.sum

@@ -208,6 +208,10 @@ github.com/muhlemmer/gu v0.3.1/go.mod h1:YHtHR+gxM+bKEIIs7Hmi9sPT3ZDUvTN/i88wQpZ
 github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 h1:C3w9PqII01/Oq1c1nUAm88MOHcQC9l5mIlSMApZMrHA=
 github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822/go.mod h1:+n7T8mK8HuQTcFwEeznm/DIxMOiR9yIdICNftLE1DvQ=
 github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e/go.mod h1:zD1mROLANZcx1PVRCS0qkT7pwLkGfwJo4zjcN/Tysno=
+github.com/ohler55/ojg v1.21.1 h1:b2RLUaDcy9gvn46dmhTjezu/TDauoR0/kgKTqkwIxto=
+github.com/ohler55/ojg v1.21.1/go.mod h1:gQhDVpQLqrmnd2eqGAvJtn+NfKoYJbe/A4Sj3/Vro4o=
+github.com/ohler55/ojg v1.21.2 h1:6N3eBqzMQ4lYurweV/H/c3DK0Z2ufj8aZcAj3mhknwM=
+github.com/ohler55/ojg v1.21.2/go.mod h1:gQhDVpQLqrmnd2eqGAvJtn+NfKoYJbe/A4Sj3/Vro4o=
 github.com/oklog/ulid v1.3.1 h1:EGfNDEx6MqHz8B3uNV6QAib1UR2Lm97sHi3ocA6ESJ4=
 github.com/oklog/ulid v1.3.1/go.mod h1:CirwcVhetQ6Lv90oh/F+FBtV6XMibvdAFo93nm5qn4U=
 github.com/onsi/ginkgo/v2 v2.15.0 h1:79HwNRBAZHOEwrczrgSOPy+eFTTlIGELKy5as+ClttY=
@@ -239,6 +243,8 @@ github.com/prometheus/procfs v0.12.0 h1:jluTpSng7V9hY0O2R9DzzJHYb2xULk9VTR1V1R/k
 github.com/prometheus/procfs v0.12.0/go.mod h1:pcuDEFsWDnvcgNzo4EEweacyhjeA9Zk3cnaOZAZEfOo=
 github.com/replicatedhq/embedded-cluster-operator v0.22.7 h1:IwH4SUZnQtANAfBXbdQO+GLMHzEXk1rx6xUoQAw2rb8=
 github.com/replicatedhq/embedded-cluster-operator v0.22.7/go.mod h1:aDdrVEbQeoPYHG+fIJxODOTZA3asYZ9SS1Yeb2tfRPQ=
+github.com/replicatedhq/embedded-cluster-operator v0.23.0 h1:+1Y6g9Ed+e8yNvIh7IQTB73ER0LXjjBTKbxthZy65rQ=
+github.com/replicatedhq/embedded-cluster-operator v0.23.0/go.mod h1:CFiwfofNfU2lwUVC0hA6XTodmM40hYJwXgdMza1AT2w=
 github.com/replicatedhq/embedded-cluster-utils v0.0.0-20240214185439-68a1dfae58be h1:wuHmBUANuvCUeX4WmUVf7AWOlRTJMAmAR/GsYOY0Jdo=
 github.com/replicatedhq/embedded-cluster-utils v0.0.0-20240214185439-68a1dfae58be/go.mod h1:4JmMC2CwMCLxq05GEW3XSPPVotqyamAF/omrbB3pH+c=
 github.com/replicatedhq/kotskinds v0.0.0-20230724164735-f83482cc9cfe h1:3AJInd06UxzqHmgy8+24CPsT2tYSE0zToJZyuX9q+MA=
@@ -473,6 +479,8 @@ k8s.io/apimachinery v0.29.2 h1:EWGpfJ856oj11C52NRCHuU7rFDwxev48z+6DSlGNsV8=
 k8s.io/apimachinery v0.29.2/go.mod h1:6HVkd1FwxIagpYrHSwJlQqZI3G9LfYWRPAkUvLnXTKU=
 k8s.io/client-go v0.29.1 h1:19B/+2NGEwnFLzt0uB5kNJnfTsbV8w6TgQRz9l7ti7A=
 k8s.io/client-go v0.29.1/go.mod h1:TDG/psL9hdet0TI9mGyHJSgRkW3H9JZk2dNEUS7bRks=
+k8s.io/client-go v0.29.2 h1:FEg85el1TeZp+/vYJM7hkDlSTFZ+c5nnK44DJ4FyoRg=
+k8s.io/client-go v0.29.2/go.mod h1:knlvFZE58VpqbQpJNbCbctTVXcd35mMyAAwBdpt4jrA=
 k8s.io/component-base v0.29.0 h1:T7rjd5wvLnPBV1vC4zWd/iWRbV8Mdxs+nGaoaFzGw3s=
 k8s.io/component-base v0.29.0/go.mod h1:sADonFTQ9Zc9yFLghpDpmNXEdHyQmFIGbiuZbqAXQ1M=
 k8s.io/klog/v2 v2.120.1 h1:QXU6cPEOIslTGvZaXvFWiP9VKyeet3sawzTOvdXb4Vw=

pkg/addons/adminconsole/adminconsole.go

@@ -232,7 +232,7 @@ func (a *AdminConsole) GenerateHelmConfig(onlyDefaults bool) ([]v1beta1.Chart, [
 		Version:   Version,
 		Values:    string(values),
 		TargetNS:  a.namespace,
-		Order:     3,
+		Order:     5,
 	}
 	return []v1beta1.Chart{chartConfig}, nil, nil
 }

pkg/addons/embeddedclusteroperator/embeddedclusteroperator.go

@@ -78,7 +78,7 @@ func (e *EmbeddedClusterOperator) GenerateHelmConfig(onlyDefaults bool) ([]v1bet
 		ChartName: fmt.Sprintf("%s/%s", ChartURL, ChartName),
 		Version:   Version,
 		TargetNS:  "embedded-cluster",
-		Order:     2,
+		Order:     3,
 	}
 
 	if !onlyDefaults {

pkg/config/config.go

@@ -11,6 +11,7 @@ import (
 	jsonpatch "github.com/evanphx/json-patch"
 	"github.com/k0sproject/dig"
 	k0sconfig "github.com/k0sproject/k0s/pkg/apis/k0s/v1beta1"
+	"github.com/replicatedhq/embedded-cluster-operator/controllers"
 	"gopkg.in/yaml.v2"
 	k8syaml "sigs.k8s.io/yaml"
 
@@ -183,6 +184,12 @@ func AdditionalCharts() []k0sconfig.Chart {
 	if err == nil {
 		if clusterConfig != nil {
 			if clusterConfig.Spec.Extensions.Helm != nil {
+				for k := range clusterConfig.Spec.Extensions.Helm.Charts {
+					if clusterConfig.Spec.Extensions.Helm.Charts[k].Order == 0 {
+						clusterConfig.Spec.Extensions.Helm.Charts[k].Order = controllers.DEFAULT_VENDOR_CHART_ORDER
+					}
+				}
+
 				return clusterConfig.Spec.Extensions.Helm.Charts
 			}
 		}