Allow Innovative upgrades to be skipped during upgrade

Author: prafull01

e2e/upgrades/upgrades_test.go

@@ -198,6 +198,53 @@ func TestUpgradesMajorVersion20_1To20_2(t *testing.T) {
 	steps.Run(t)
 }
 
+func TestUpgradesMajorVersionSkippingInnovativeRelease24_3To25_1(t *testing.T) {
+
+	if testing.Short() {
+		t.Skip("skipping test in short mode.")
+	}
+
+	testLog := zapr.NewLogger(zaptest.NewLogger(t))
+
+	e := testenv.CreateActiveEnvForTest()
+	env := e.Start()
+	defer e.Stop()
+
+	sb := testenv.NewDiffingSandbox(t, env)
+	sb.StartManager(t, controller.InitClusterReconcilerWithLogger(testLog))
+
+	builder := testutil.NewBuilder("crdb").WithNodeCount(3).WithTLS().
+		WithImage("cockroachdb/cockroach:v24.3.4").
+		WithPVDataStore("1Gi").WithResources(resRequirements)
+
+	steps := testutil.Steps{
+		{
+			Name: "creates a 3-node secure cluster",
+			Test: func(t *testing.T) {
+				require.NoError(t, sb.Create(builder.Cr()))
+				testutil.RequireClusterToBeReadyEventuallyTimeout(t, sb, builder, e2e.CreateClusterTimeout)
+			},
+		},
+		{
+			Name: "upgrades the cluster to the next major version",
+			Test: func(t *testing.T) {
+				current := builder.Cr()
+				require.NoError(t, sb.Get(current))
+
+				updated := current.DeepCopy()
+				updated.Spec.Image.Name = "cockroachdb/cockroach:v25.1.0"
+				require.NoError(t, sb.Patch(updated, client.MergeFrom(current)))
+				// we wait 10 min because we will be waiting 3 min for each pod.
+				testutil.RequireClusterToBeReadyEventuallyTimeout(t, sb, builder, e2e.CreateClusterTimeout)
+				testutil.RequireDbContainersToUseImage(t, sb, updated)
+				t.Log("Done with major upgrade")
+			},
+		},
+	}
+
+	steps.Run(t)
+}
+
 // TestUpgradesMinorVersionThenRollback tests a minor version bump
 // then rollsback that upgrade
 func TestUpgradesMinorVersionThenRollback(t *testing.T) {

pkg/update/internal.go

@@ -25,6 +25,31 @@ const (
 	AdminRole   = "admin"
 )
 
+// ReleaseType represents the type of a release
+type ReleaseType int
+
+const (
+	Regular ReleaseType = iota
+	Innovative
+)
+
+var (
+	// ReleaseMap is maintained in accordance with Cockroach Labs Release Notes: https://www.cockroachlabs.com/docs/releases/.
+	ReleaseMap = []struct {
+		version string
+		rType   ReleaseType
+	}{
+		{"24.1", Regular},
+		{"24.2", Innovative},
+		{"24.3", Regular},
+		{"24.4", Innovative},
+		{"25.1", Innovative},
+		{"25.2", Regular},
+		{"25.3", Innovative},
+		{"25.4", Regular},
+	}
+)
+
 // internalUsers is a set of SQL users created as part of the managed service, not to be used
 // by customers. This struct is used to hide specific users in the console.
 var internalUsers = map[string]struct{}{

pkg/update/update_cockroach_version_common.go

@@ -134,10 +134,74 @@ func isPatch(wantVersion *semver.Version, currentVersion *semver.Version) bool {
 	return currentVersion.Major() == wantVersion.Major() && currentVersion.Minor() == wantVersion.Minor()
 }
 
+// getNextReleases returns the list of possible upgrade targets
+func getNextReleases(currentVersion string) []string {
+	var nextReleases []string
+	var found bool
+
+	for _, releaseVersion := range ReleaseMap {
+		if found {
+			nextReleases = append(nextReleases, releaseVersion.version)
+			if releaseVersion.rType == Regular {
+				break
+			}
+		}
+		if releaseVersion.version == currentVersion {
+			found = true
+		}
+	}
+
+	return nextReleases
+}
+
+// getPreviousReleases returns the list of possible rollback targets
+func getPreviousReleases(currentVersion string) []string {
+	var prevReleases []string
+	var found bool
+
+	for i := len(ReleaseMap) - 1; i >= 0; i-- {
+		releaseVersion := ReleaseMap[i]
+		if found {
+			prevReleases = append(prevReleases, releaseVersion.version)
+			if releaseVersion.rType == Regular {
+				break
+			}
+		}
+		if releaseVersion.version == currentVersion {
+			found = true
+		}
+	}
+
+	return prevReleases
+}
+
 func isForwardOneMajorVersion(wantVersion *semver.Version, currentVersion *semver.Version) bool {
 	// Two cases:
 	// 19.1 to 19.2 -> same year
 	// 19.2 to 20.1 -> next year
+
+	// Since 2024, we have adopted a quarterly release cycle, with two of the four annual releases designated
+	// as innovative releases. Users have the option to skip upgrading to an innovative release.
+	if currentVersion.Major() >= 24 {
+		// Four Cases:
+		// 24.1 to 24.2 -> Same year without skipping innovative release
+		// 24.1 to 24.3 -> Same year with skipping innovative release
+		// 24.4 to 25.1 -> Next year without skipping innovative release
+		// 24.3 to 25.1 -> Next year with skipping innovative release
+		nextPossibleRelease := getNextReleases(fmt.Sprintf("%d.%d", currentVersion.Major(), currentVersion.Minor()))
+		for _, version := range nextPossibleRelease {
+			if version == fmt.Sprintf("%d.%d", wantVersion.Major(), wantVersion.Minor()) {
+				return true
+			}
+		}
+
+		// This condition allows user to upgrade one version at a time.
+		// ReleaseMap needs to be maintained if we want to skip the Innovative upgrades else this condition
+		// is enough to do forward one major version.
+		return (currentVersion.Major() == wantVersion.Major() && currentVersion.Minor()+1 == wantVersion.Minor()) ||
+			(currentVersion.Major()+1 == wantVersion.Major() && currentVersion.Minor()-3 == wantVersion.Minor())
+	}
+
 	return (currentVersion.Major() == wantVersion.Major() && currentVersion.Minor()+1 == wantVersion.Minor()) ||
 		(currentVersion.Major()+1 == wantVersion.Major() && currentVersion.Minor()-1 == wantVersion.Minor())
 }
@@ -146,6 +210,24 @@ func isBackOneMajorVersion(wantVersion *semver.Version, currentVersion *semver.V
 	// Two cases:
 	// 19.2 to 19.1 -> same year
 	// 20.1 to 19.2 -> previous year
+
+	// Since 2024, users have the option to skip rollback to an innovative release.
+	if wantVersion.Major() >= 24 {
+		// Four cases:
+		// 24.2 -> 24.1 -> Same year without skipping innovative release
+		// 24.3 -> 24.1 -> Same year with skipping innovative release
+		// 25.1 -> 24.4 -> Previous year without skipping innovative release
+		// 25.1 -> 24.3 -> Previous year with skipping innovative release
+		rollbackReleases := getPreviousReleases(fmt.Sprintf("%d.%d", currentVersion.Major(), currentVersion.Minor()))
+		for _, version := range rollbackReleases {
+			if version == fmt.Sprintf("%d.%d", wantVersion.Major(), wantVersion.Minor()) {
+				return true
+			}
+		}
+		return (currentVersion.Major() == wantVersion.Major() && currentVersion.Minor() == wantVersion.Minor()+1) ||
+			(currentVersion.Major() == wantVersion.Major()+1 && currentVersion.Minor() == wantVersion.Minor()-3)
+	}
+
 	return (currentVersion.Major() == wantVersion.Major() && currentVersion.Minor() == wantVersion.Minor()+1) ||
 		(currentVersion.Major() == wantVersion.Major()+1 && currentVersion.Minor() == wantVersion.Minor()-1)
 }