[Feature] Enforce UpgradeByReplace for ArangoDB Upgrade from 3.12.2/3 to 3.12.4+ (#1828)

Author: ajanikow

CHANGELOG.md

@@ -18,6 +18,7 @@
 - (Feature) Delay Action
 - (Feature) MigrateMember Action
 - (Maintenance) Ensure Enum in the UpgradeMode Enum Schema
+- (Feature) Enforce UpgradeByReplace operation by default for ArangoDB from 3.12.2/3 to 3.12.4+
 
 ## [1.2.44](https://github.com/arangodb/kube-arangodb/tree/1.2.44) (2025-02-03)
 - (Maintenance) Kubernetes 1.31.1 libraries

pkg/deployment/features/upgrade.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2016-2024 ArangoDB GmbH, Cologne, Germany
+// Copyright 2016-2025 ArangoDB GmbH, Cologne, Germany
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -20,10 +20,17 @@
 
 package features
 
+import (
+	"github.com/arangodb/go-driver"
+
+	api "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1"
+)
+
 func init() {
 	registerFeature(upgradeVersionCheck)
 	registerFeature(upgradeVersionCheckV2)
 	registerFeature(upgradeAlternativeOrder)
+	registerFeature(upgradeIndexOrderIssue)
 }
 
 var upgradeVersionCheck Feature = &feature{
@@ -48,6 +55,14 @@ var upgradeAlternativeOrder Feature = &feature{
 	hidden:             true,
 }
 
+var upgradeIndexOrderIssue Feature = &feature{
+	name:               "upgrade-index-order-issue",
+	description:        "Changes the default upgrade mode for DBServers while upgrading from 3.12.2/3.12.3 to 3.12.4+",
+	enterpriseRequired: false,
+	enabledByDefault:   true,
+	hidden:             true,
+}
+
 func UpgradeVersionCheck() Feature {
 	return upgradeVersionCheck
 }
@@ -57,3 +72,26 @@ func UpgradeVersionCheckV2() Feature {
 }
 
 func UpgradeAlternativeOrder() Feature { return upgradeAlternativeOrder }
+
+func UpgradeIndexOrderIssue() Feature { return upgradeIndexOrderIssue }
+
+func IsUpgradeIndexOrderIssueEnabled(group api.ServerGroup, from, to driver.Version) bool {
+	if !UpgradeIndexOrderIssue().Enabled() {
+		return false
+	}
+
+	if group != api.ServerGroupDBServers {
+		return false
+	}
+
+	if from.CompareTo("3.12.2") < 0 || from.CompareTo("3.12.3") > 0 {
+		// Outside of versions
+		return false
+	}
+
+	if to.CompareTo("3.12.4") < 0 {
+		return false
+	}
+
+	return true
+}

pkg/deployment/features/upgrade_test.go

@@ -0,0 +1,48 @@
+//
+// DISCLAIMER
+//
+// Copyright 2025 ArangoDB GmbH, Cologne, Germany
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// Copyright holder is ArangoDB GmbH, Cologne, Germany
+//
+
+package features
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+
+	"github.com/arangodb/go-driver"
+
+	api "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1"
+)
+
+func testIsUpgradeIndexOrderIssueEnabled(enabled bool, group api.ServerGroup, from, to driver.Version) bool {
+	*upgradeIndexOrderIssue.EnabledPointer() = enabled
+
+	return IsUpgradeIndexOrderIssueEnabled(group, from, to)
+}
+
+func Test_IsUpgradeIndexOrderIssueEnabled(t *testing.T) {
+	require.True(t, testIsUpgradeIndexOrderIssueEnabled(true, api.ServerGroupDBServers, "3.12.2", "3.12.4"))
+	require.False(t, testIsUpgradeIndexOrderIssueEnabled(false, api.ServerGroupDBServers, "3.12.2", "3.12.4"))
+	require.False(t, testIsUpgradeIndexOrderIssueEnabled(true, api.ServerGroupCoordinators, "3.12.2", "3.12.4"))
+	require.False(t, testIsUpgradeIndexOrderIssueEnabled(true, api.ServerGroupAgents, "3.12.2", "3.12.4"))
+	require.False(t, testIsUpgradeIndexOrderIssueEnabled(true, api.ServerGroupSingle, "3.12.2", "3.12.4"))
+	require.True(t, testIsUpgradeIndexOrderIssueEnabled(true, api.ServerGroupDBServers, "3.12.3", "3.12.4"))
+	require.False(t, testIsUpgradeIndexOrderIssueEnabled(true, api.ServerGroupDBServers, "3.12.4", "3.12.4"))
+	require.True(t, testIsUpgradeIndexOrderIssueEnabled(true, api.ServerGroupDBServers, "3.12.2", "3.12.55"))
+}

pkg/deployment/reconcile/plan_builder_rotate_upgrade.go

@@ -316,11 +316,15 @@ func (r *Reconciler) createUpgradePlanInternal(apiObject k8sutil.APIObject, spec
 				return nil, false
 			}
 
+			um := spec.GetServerGroupSpec(group).UpgradeMode
+
+			if features.IsUpgradeIndexOrderIssueEnabled(group, d.upgradeDecision.FromVersion, d.upgradeDecision.ToVersion) && um == nil {
+				um = util.NewType(api.ServerGroupUpgradeModeReplace)
+			}
+
 			switch group {
 			case api.ServerGroupDBServers:
-				gspec := spec.GetServerGroupSpec(group)
-
-				if gspec.UpgradeMode.Get() == api.ServerGroupUpgradeModeReplace {
+				if um.Get() == api.ServerGroupUpgradeModeReplace {
 					// Members are suppose to be replaced
 					if !m.Member.Conditions.IsTrue(api.ConditionTypeMarkedToRemove) {
 						return api.Plan{actions.NewAction(api.ActionTypeMarkToRemoveMember, m.Group, m.Member, "Replace by Upgrade")}, false