[Feature] SilentRotation High plan (#1238)

Author: ajanikow

CHANGELOG.md

@@ -5,6 +5,7 @@
 - (Feature) Add Kubernetes Client logger
 - (Feature) CreationFailed ArangoMember Phase
 - (Bugfix) Fix Rebalancer NPE in case if member is missing in Status
+- (Feature) SilentRotation High plan
 
 ## [1.2.24](https://github.com/arangodb/kube-arangodb/tree/1.2.24) (2023-01-25)
 - (Bugfix) Fix deployment creation on ARM64

pkg/apis/deployment/v1/plan.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2016-2022 ArangoDB GmbH, Cologne, Germany
+// Copyright 2016-2023 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.
@@ -170,6 +170,12 @@ func NewAction(actionType ActionType, group ServerGroup, memberID string, reason
 type ActionBuilder interface {
 	// NewAction instantiates a new Action.
 	NewAction(actionType ActionType, reason ...string) Action
+
+	// Group returns ServerGroup for this builder
+	Group() ServerGroup
+
+	// MemberID returns Member ID for this builder
+	MemberID() string
 }
 
 type actionBuilder struct {
@@ -181,6 +187,14 @@ func (a actionBuilder) NewAction(actionType ActionType, reason ...string) Action
 	return NewAction(actionType, a.group, a.memberID, reason...)
 }
 
+func (a actionBuilder) Group() ServerGroup {
+	return a.group
+}
+
+func (a actionBuilder) MemberID() string {
+	return a.memberID
+}
+
 // NewActionBuilder create new action builder with provided group and id
 func NewActionBuilder(group ServerGroup, memberID string) ActionBuilder {
 	return actionBuilder{

pkg/apis/deployment/v2alpha1/plan.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2016-2022 ArangoDB GmbH, Cologne, Germany
+// Copyright 2016-2023 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.
@@ -170,6 +170,12 @@ func NewAction(actionType ActionType, group ServerGroup, memberID string, reason
 type ActionBuilder interface {
 	// NewAction instantiates a new Action.
 	NewAction(actionType ActionType, reason ...string) Action
+
+	// Group returns ServerGroup for this builder
+	Group() ServerGroup
+
+	// MemberID returns Member ID for this builder
+	MemberID() string
 }
 
 type actionBuilder struct {
@@ -181,6 +187,14 @@ func (a actionBuilder) NewAction(actionType ActionType, reason ...string) Action
 	return NewAction(actionType, a.group, a.memberID, reason...)
 }
 
+func (a actionBuilder) Group() ServerGroup {
+	return a.group
+}
+
+func (a actionBuilder) MemberID() string {
+	return a.memberID
+}
+
 // NewActionBuilder create new action builder with provided group and id
 func NewActionBuilder(group ServerGroup, memberID string) ActionBuilder {
 	return actionBuilder{

pkg/deployment/actions/wrapper.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2016-2022 ArangoDB GmbH, Cologne, Germany
+// Copyright 2016-2023 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.
@@ -47,6 +47,14 @@ func (a actionBuilderWrap) NewAction(actionType api.ActionType, reason ...string
 	return NewAction(actionType, a.group, a.member, reason...)
 }
 
+func (a actionBuilderWrap) Group() api.ServerGroup {
+	return a.group
+}
+
+func (a actionBuilderWrap) MemberID() string {
+	return a.member.ID
+}
+
 func actionWrap(a api.Action, member *api.MemberStatus, wrap ...actionWrapper) api.Action {
 	for _, w := range wrap {
 		a = w(a, member)

pkg/deployment/reconcile/action_add_member.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2016-2022 ArangoDB GmbH, Cologne, Germany
+// Copyright 2016-2023 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.
@@ -24,6 +24,7 @@ import (
 	"context"
 
 	api "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1"
+	"github.com/arangodb/kube-arangodb/pkg/deployment/reconcile/shared"
 	"github.com/arangodb/kube-arangodb/pkg/deployment/topology"
 	"github.com/arangodb/kube-arangodb/pkg/util/errors"
 )
@@ -67,5 +68,5 @@ func (a *actionAddMember) Start(ctx context.Context) (bool, error) {
 
 // ActionPlanAppender appends wait methods to the plan
 func (a *actionAddMember) ActionPlanAppender(current api.Plan) (api.Plan, bool) {
-	return withWaitForMember(current, a.action.Group, withPredefinedMember(a.action.MemberID)), true
+	return withWaitForMember(current, a.action.Group, shared.WithPredefinedMember(a.action.MemberID)), true
 }

pkg/deployment/reconcile/action_set_condition_v2.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2016-2022 ArangoDB GmbH, Cologne, Germany
+// Copyright 2016-2023 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.
@@ -26,18 +26,7 @@ import (
 	core "k8s.io/api/core/v1"
 
 	api "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1"
-)
-
-const (
-	setConditionActionV2KeyTypeAdd    string = "add"
-	setConditionActionV2KeyTypeRemove string = "remove"
-
-	setConditionActionV2KeyType    string = "type"
-	setConditionActionV2KeyAction  string = "action"
-	setConditionActionV2KeyStatus  string = "status"
-	setConditionActionV2KeyReason  string = "reason"
-	setConditionActionV2KeyMessage string = "message"
-	setConditionActionV2KeyHash    string = "hash"
+	"github.com/arangodb/kube-arangodb/pkg/deployment/reconcile/shared"
 )
 
 func newSetConditionV2Action(action api.Action, actionCtx ActionContext) Action {
@@ -57,32 +46,32 @@ type actionSetConditionV2 struct {
 
 // Start starts the action for changing conditions on the provided member.
 func (a actionSetConditionV2) Start(ctx context.Context) (bool, error) {
-	at, ok := a.action.Params[setConditionActionV2KeyType]
+	at, ok := a.action.Params[shared.SetConditionActionV2KeyType]
 	if !ok {
-		a.log.Info("key %s is missing in action definition", setConditionActionV2KeyType)
+		a.log.Info("key %s is missing in action definition", shared.SetConditionActionV2KeyType)
 		return true, nil
 	}
 
-	aa, ok := a.action.Params[setConditionActionV2KeyAction]
+	aa, ok := a.action.Params[shared.SetConditionActionV2KeyAction]
 	if !ok {
-		a.log.Info("key %s is missing in action definition", setConditionActionV2KeyAction)
+		a.log.Info("key %s is missing in action definition", shared.SetConditionActionV2KeyAction)
 		return true, nil
 	}
 
 	switch at {
-	case setConditionActionV2KeyTypeAdd:
-		ah := a.action.Params[setConditionActionV2KeyHash]
-		am := a.action.Params[setConditionActionV2KeyMessage]
-		ar := a.action.Params[setConditionActionV2KeyReason]
-		as := a.action.Params[setConditionActionV2KeyStatus] == string(core.ConditionTrue)
+	case shared.SetConditionActionV2KeyTypeAdd:
+		ah := a.action.Params[shared.SetConditionActionV2KeyHash]
+		am := a.action.Params[shared.SetConditionActionV2KeyMessage]
+		ar := a.action.Params[shared.SetConditionActionV2KeyReason]
+		as := a.action.Params[shared.SetConditionActionV2KeyStatus] == string(core.ConditionTrue)
 
 		if err := a.actionCtx.WithStatusUpdateErr(ctx, func(s *api.DeploymentStatus) (bool, error) {
 			return s.Conditions.UpdateWithHash(api.ConditionType(aa), as, ar, am, ah), nil
 		}); err != nil {
 			a.log.Err(err).Warn("unable to update status")
 			return true, nil
 		}
-	case setConditionActionV2KeyTypeRemove:
+	case shared.SetConditionActionV2KeyTypeRemove:
 		if err := a.actionCtx.WithStatusUpdateErr(ctx, func(s *api.DeploymentStatus) (bool, error) {
 			return s.Conditions.Remove(api.ConditionType(aa)), nil
 		}); err != nil {

pkg/deployment/reconcile/action_set_member_condition_v2.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2016-2022 ArangoDB GmbH, Cologne, Germany
+// Copyright 2016-2023 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.
@@ -26,6 +26,7 @@ import (
 	core "k8s.io/api/core/v1"
 
 	api "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1"
+	"github.com/arangodb/kube-arangodb/pkg/deployment/reconcile/shared"
 )
 
 func newSetMemberConditionV2Action(action api.Action, actionCtx ActionContext) Action {
@@ -45,24 +46,24 @@ type actionSetMemberConditionV2 struct {
 
 // Start starts the action for changing conditions on the provided member.
 func (a actionSetMemberConditionV2) Start(ctx context.Context) (bool, error) {
-	at, ok := a.action.Params[setConditionActionV2KeyType]
+	at, ok := a.action.Params[shared.SetConditionActionV2KeyType]
 	if !ok {
-		a.log.Info("key %s is missing in action definition", setConditionActionV2KeyType)
+		a.log.Info("key %s is missing in action definition", shared.SetConditionActionV2KeyType)
 		return true, nil
 	}
 
-	aa, ok := a.action.Params[setConditionActionV2KeyAction]
+	aa, ok := a.action.Params[shared.SetConditionActionV2KeyAction]
 	if !ok {
-		a.log.Info("key %s is missing in action definition", setConditionActionV2KeyAction)
+		a.log.Info("key %s is missing in action definition", shared.SetConditionActionV2KeyAction)
 		return true, nil
 	}
 
 	switch at {
-	case setConditionActionV2KeyTypeAdd:
-		ah := a.action.Params[setConditionActionV2KeyHash]
-		am := a.action.Params[setConditionActionV2KeyMessage]
-		ar := a.action.Params[setConditionActionV2KeyReason]
-		as := a.action.Params[setConditionActionV2KeyStatus] == string(core.ConditionTrue)
+	case shared.SetConditionActionV2KeyTypeAdd:
+		ah := a.action.Params[shared.SetConditionActionV2KeyHash]
+		am := a.action.Params[shared.SetConditionActionV2KeyMessage]
+		ar := a.action.Params[shared.SetConditionActionV2KeyReason]
+		as := a.action.Params[shared.SetConditionActionV2KeyStatus] == string(core.ConditionTrue)
 
 		if err := a.actionCtx.WithStatusUpdateErr(ctx, func(s *api.DeploymentStatus) (bool, error) {
 			status, g, ok := s.Members.ElementByID(a.action.MemberID)
@@ -89,7 +90,7 @@ func (a actionSetMemberConditionV2) Start(ctx context.Context) (bool, error) {
 			a.log.Err(err).Warn("unable to update status")
 			return true, nil
 		}
-	case setConditionActionV2KeyTypeRemove:
+	case shared.SetConditionActionV2KeyTypeRemove:
 		if err := a.actionCtx.WithStatusUpdateErr(ctx, func(s *api.DeploymentStatus) (bool, error) {
 			status, g, ok := s.Members.ElementByID(a.action.MemberID)
 			if !ok {

pkg/deployment/reconcile/condition_member_recreation.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2016-2022 ArangoDB GmbH, Cologne, Germany
+// Copyright 2016-2023 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.
@@ -30,6 +30,7 @@ import (
 
 	"github.com/arangodb/kube-arangodb/pkg/apis/deployment"
 	api "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1"
+	"github.com/arangodb/kube-arangodb/pkg/deployment/reconcile/shared"
 	"github.com/arangodb/kube-arangodb/pkg/util"
 	"github.com/arangodb/kube-arangodb/pkg/util/k8sutil"
 )
@@ -47,12 +48,12 @@ func (r *Reconciler) createMemberRecreationConditionsPlan(ctx context.Context,
 		if !recreate {
 			if _, ok := m.Member.Conditions.Get(api.MemberReplacementRequired); ok {
 				// Unset condition
-				p = append(p, removeMemberConditionActionV2("Member replacement not required", api.MemberReplacementRequired, m.Group, m.Member.ID))
+				p = append(p, shared.RemoveMemberConditionActionV2("Member replacement not required", api.MemberReplacementRequired, m.Group, m.Member.ID))
 			}
 		} else {
 			if c, ok := m.Member.Conditions.Get(api.MemberReplacementRequired); !ok || !c.IsTrue() || c.Message != message {
 				// Update condition
-				p = append(p, updateMemberConditionActionV2("Member replacement required", api.MemberReplacementRequired, m.Group, m.Member.ID, true, "Member replacement required", message, ""))
+				p = append(p, shared.UpdateMemberConditionActionV2("Member replacement required", api.MemberReplacementRequired, m.Group, m.Member.ID, true, "Member replacement required", message, ""))
 			}
 		}
 	}

pkg/deployment/reconcile/plan_builder_clean_out.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2016-2022 ArangoDB GmbH, Cologne, Germany
+// Copyright 2016-2023 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.
@@ -25,6 +25,7 @@ import (
 
 	api "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1"
 	"github.com/arangodb/kube-arangodb/pkg/deployment/agency"
+	"github.com/arangodb/kube-arangodb/pkg/deployment/reconcile/shared"
 	"github.com/arangodb/kube-arangodb/pkg/util/k8sutil"
 )
 
@@ -50,9 +51,9 @@ func (r *Reconciler) createCleanOutPlan(ctx context.Context, _ k8sutil.APIObject
 
 		if cleanedStatus != cleanedAgency {
 			if cleanedAgency {
-				plan = append(plan, updateMemberConditionActionV2("DBServer cleaned", api.ConditionTypeCleanedOut, m.Group, m.Member.ID, true, "DBServer cleaned", "DBServer cleaned", ""))
+				plan = append(plan, shared.UpdateMemberConditionActionV2("DBServer cleaned", api.ConditionTypeCleanedOut, m.Group, m.Member.ID, true, "DBServer cleaned", "DBServer cleaned", ""))
 			} else {
-				plan = append(plan, removeMemberConditionActionV2("DBServer is not cleaned", api.ConditionTypeCleanedOut, m.Group, m.Member.ID))
+				plan = append(plan, shared.RemoveMemberConditionActionV2("DBServer is not cleaned", api.ConditionTypeCleanedOut, m.Group, m.Member.ID))
 			}
 		}
 	}

pkg/deployment/reconcile/plan_builder_cluster.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2016-2022 ArangoDB GmbH, Cologne, Germany
+// Copyright 2016-2023 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.
@@ -28,6 +28,7 @@ import (
 
 	api "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1"
 	"github.com/arangodb/kube-arangodb/pkg/deployment/actions"
+	"github.com/arangodb/kube-arangodb/pkg/deployment/reconcile/shared"
 	"github.com/arangodb/kube-arangodb/pkg/util/globals"
 	"github.com/arangodb/kube-arangodb/pkg/util/k8sutil"
 )
@@ -82,7 +83,7 @@ func (r *Reconciler) createClusterOperationPlan(ctx context.Context, apiObject k
 
 			if member.LastHeartbeatAcked.Add(coordinatorHealthFailedTimeout).Before(time.Now()) {
 				return api.Plan{
-					actions.NewAction(api.ActionTypeClusterMemberCleanup, api.ServerGroupCoordinators, withPredefinedMember(string(id))),
+					actions.NewAction(api.ActionTypeClusterMemberCleanup, api.ServerGroupCoordinators, shared.WithPredefinedMember(string(id))),
 				}
 			}
 		case driver.ServerRoleDBServer:
@@ -95,7 +96,7 @@ func (r *Reconciler) createClusterOperationPlan(ctx context.Context, apiObject k
 			}
 
 			return api.Plan{
-				actions.NewAction(api.ActionTypeClusterMemberCleanup, api.ServerGroupDBServers, withPredefinedMember(string(id))),
+				actions.NewAction(api.ActionTypeClusterMemberCleanup, api.ServerGroupDBServers, shared.WithPredefinedMember(string(id))),
 			}
 		}
 	}