chore(helm): switch to 3.0.0 and drop compat measures

Author: keynslug

deploy/charts/emqx-operator/Chart.yaml

@@ -6,11 +6,11 @@ type: application
 
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
-version: 2.3.0-rc.1
+version: 3.0.0-rc.1
 
 # This is the version number of the application being deployed.
-appVersion: 2.3.0
+appVersion: 3.0.0
 
 sources:
-  - https://github.com/emqx/emqx-operator/tree/main-2.3/deploy/charts/emqx-operator
+  - https://github.com/emqx/emqx-operator/tree/main-3.x/deploy/charts/emqx-operator
   - https://github.com/emqx/emqx

deploy/charts/emqx-operator/templates/NOTES.txt

@@ -3,18 +3,3 @@ EMQX Operator Controller {{ .Chart.AppVersion }} has been deployed successfully!
 The operator is running in namespace: {{ .Release.Namespace }}
 
 Now you can create EMQX Custom Resources to deploy EMQX clusters.
-
-{{- if .Values.upgrade.preUpgradeCheck }}
-
-A pre-upgrade compatibility check Job ran automatically to ensure a smooth
-upgrade from any prior installation.
-
-The check:
-  - Verified no legacy custom resources exist (emqxbrokers, emqxenterprises,
-    emqxplugins) that would be destroyed when Helm removes their CRDs
-  - Patched CRDs to remove conversion webhooks, preventing API server
-    errors during the operator replacement window
-
-To skip the pre-upgrade Job on future installs (e.g. in air-gapped environments):
-  --set upgrade.preUpgradeCheck=false
-{{- end }}

deploy/charts/emqx-operator/templates/controller-manager-rbac.yaml

@@ -65,6 +65,7 @@ rules:
   resources:
   - pods
   verbs:
+  - delete
   - get
   - list
   - update
@@ -104,14 +105,12 @@ rules:
   - apps.emqx.io
   resources:
   - emqxes/finalizers
-  - rebalances/finalizers
   verbs:
   - update
 - apiGroups:
   - apps.emqx.io
   resources:
   - emqxes/status
-  - rebalances/status
   verbs:
   - get
   - patch

deploy/charts/emqx-operator/templates/pre-upgrade-job.yaml

@@ -12,9 +12,9 @@ singleNamespace: false
 # Development configures the logger to use a Zap development config
 # (stacktraces on warnings, no sampling), otherwise a Zap production
 # config will be used (stacktraces on errors, sampling).
-# NOTE: On by default for 2.3.0 as it changes a lot, a higher risk of
+# NOTE: On by default for 3.0.0 as it changes a lot, a higher risk of
 #       bug reports. Impact is tolerable, usually not much debug output.
-# TODO: Switch off by default in 2.3.1.
+# TODO: Switch off by default in 3.1.0.
 development: true
 
 replicaCount: 1
@@ -65,27 +65,3 @@ nodeSelector: {}
 tolerations: []
 
 affinity: {}
-
-## Upgrade settings.
-## A pre-install/pre-upgrade Job runs automatically to ensure a smooth
-## upgrade from earlier chart versions:
-##   1. Checks for legacy custom resources (emqxbrokers, emqxenterprises,
-##      emqxplugins) and blocks the upgrade if any exist, because Helm
-##      will delete those CRDs (and their CRs) during the upgrade.
-##   2. Patches CRD conversion webhooks to strategy "None" so the API
-##      server does not fail while the old operator is being replaced.
-##
-## The Job is fully idempotent and becomes a no-op on fresh installs.
-upgrade:
-  ## Run the pre-upgrade compatibility check Job.
-  ## Enabled by default so that upgrades from 2.2.x work out of the box.
-  ## Set to false to skip the Job entirely (e.g. in air-gapped
-  ## environments where pulling the kubectl image is not possible).
-  preUpgradeCheck: true
-
-  ## Image used for the pre-upgrade cleanup Job.
-  ## Must include kubectl and sh.
-  image:
-    repository: alpine/k8s
-    tag: "1.31.4"
-    pullPolicy: IfNotPresent

deploy/charts/emqx-operator/values.yaml

@@ -22,7 +22,7 @@ import (
 	. "github.com/onsi/gomega"
 )
 
-// helmInstall installs the local 2.3.x chart into the given namespace with --wait.
+// helmInstall installs the local 3.x chart into the given namespace with --wait.
 func helmInstall(namespace string, extraArgs ...string) error {
 	args := []string{
 		"install",
@@ -39,31 +39,31 @@ func helmInstall(namespace string, extraArgs ...string) error {
 	return Run("helm", args...)
 }
 
-// helmUpgrade upgrades to the local 2.3.x chart in the given namespace with --wait.
-func helmUpgrade(namespace string) error {
-	return Run("helm", "upgrade",
-		helmReleaseName,
-		localChartPath,
-		"--namespace", namespace,
-		"--set", "image.repository="+operatorImageRepo,
-		"--set", "image.tag="+operatorImageTag,
-		"--set", "image.pullPolicy=Never",
-		"--wait",
-		"--timeout", "2m",
-	)
-}
-
-// helmCleanup removes all resources that 2.3.x chart may have left behind in
+// helmUpgrade upgrades to the local 3.x chart in the given namespace with --wait.
+// func helmUpgrade(namespace string) error {
+// 	return Run("helm", "upgrade",
+// 		helmReleaseName,
+// 		localChartPath,
+// 		"--namespace", namespace,
+// 		"--set", "image.repository="+operatorImageRepo,
+// 		"--set", "image.tag="+operatorImageTag,
+// 		"--set", "image.pullPolicy=Never",
+// 		"--wait",
+// 		"--timeout", "2m",
+// 	)
+// }
+
+// helmCleanup removes all resources that 3.x chart may have left behind in
 // the given namespace, including the Helm release itself.
 func helmCleanup(namespace string) {
 	_ = Run("helm", "uninstall", helmReleaseName, "--namespace", namespace)
-	_ = Kubectl("delete", "clusterrole", "emqx-operator-manager-role", "--ignore-not-found")
-	_ = Kubectl("delete", "clusterrolebinding", "emqx-operator-manager-rolebinding", "--ignore-not-found")
-	_ = Kubectl("delete", "clusterrole", "emqx-operator-pre-upgrade", "--ignore-not-found")
-	_ = Kubectl("delete", "clusterrolebinding", "emqx-operator-pre-upgrade", "--ignore-not-found")
-	_ = Kubectl("delete", "crd", "emqxes.apps.emqx.io", "--ignore-not-found")
-	_ = Kubectl("delete", "crd", "rebalances.apps.emqx.io", "--ignore-not-found")
-	_ = Kubectl("delete", "ns", namespace, "--ignore-not-found")
+	_ = Kubectl("delete", "clusterrole", "emqx-operator-manager-role")
+	_ = Kubectl("delete", "clusterrolebinding", "emqx-operator-manager-rolebinding")
+	_ = Kubectl("delete", "clusterrole", "emqx-operator-pre-upgrade")
+	_ = Kubectl("delete", "clusterrolebinding", "emqx-operator-pre-upgrade")
+	_ = Kubectl("delete", "crd", "emqxes.apps.emqx.io")
+	_ = Kubectl("delete", "crd", "rebalances.apps.emqx.io")
+	_ = Kubectl("delete", "ns", namespace)
 }
 
 //nolint:errcheck
@@ -89,13 +89,14 @@ var _ = Describe("Helm Install", Ordered, func() {
 		}
 	})
 
-	It("should install cleanly / cleanup no-op", func() {
-		By("install 2.3.x chart")
+	It("should install cleanly", func() {
+		By("install 3.x chart")
 		Expect(helmInstall(namespace)).To(Succeed())
 
 		By("verify CRDs are installed")
 		Expect(crdExists("emqxes.apps.emqx.io")).To(BeTrue())
-		Expect(crdExists("rebalances.apps.emqx.io")).To(BeTrue())
+		// NOTE: Rebalance controller is disabled in this release. See api/v3alpha1/rebalance_types.go.
+		// Expect(crdExists("rebalances.apps.emqx.io")).To(BeTrue())
 
 		By("verify operator deployment is available")
 		Expect(Kubectl("wait", "deployment",
@@ -105,22 +106,4 @@ var _ = Describe("Helm Install", Ordered, func() {
 			"--timeout", "1m",
 		)).To(Succeed())
 	})
-
-	It("should install cleanly / pre-upgrade check disabled", func() {
-		By("install 2.3.x with pre-upgrade check disabled")
-		Expect(helmInstall(namespace, "--set", "upgrade.preUpgradeCheck=false")).
-			To(Succeed())
-
-		By("verify operator is running")
-		Expect(Kubectl("wait", "deployment",
-			"emqx-operator-controller-manager",
-			"--for", "condition=Available",
-			"--namespace", namespace,
-			"--timeout", "1m",
-		)).To(Succeed())
-
-		By("verify CRDs are installed")
-		Expect(crdExists("emqxes.apps.emqx.io")).To(BeTrue())
-		Expect(crdExists("rebalances.apps.emqx.io")).To(BeTrue())
-	})
 })

test/e2e-helm/helm_install_test.go

@@ -31,7 +31,7 @@ const (
 	// helmReleaseName is the Helm release name used across all Helm upgrade tests.
 	helmReleaseName = "emqx-operator"
 
-	// localChartPath is the path to the local 2.3.x chart being tested.
+	// localChartPath is the path to the local 3.x chart being tested.
 	localChartPath = "deploy/charts/emqx-operator"
 
 	// operatorImage is the operator image which should already be built and available.
@@ -71,11 +71,6 @@ func crdExists(name string) bool {
 	return Kubectl("get", "crd", name) == nil
 }
 
-// resourceExists checks whether a cluster-scoped resource exists.
-func resourceExists(kind, name string) bool {
-	return Kubectl("get", kind, name) == nil
-}
-
 // dumpHelmDiagnostics writes debug info for the given namespace to GinkgoWriter.
 func dumpHelmDiagnostics(namespace string) {
 	out, _ := Output("helm", "list", "--namespace", namespace)