[Feature] Allow to configure action timeouts (#934)

Author: ajanikow

CHANGELOG.md

@@ -8,6 +8,7 @@
 - (Update) Bump K8S API to 1.21.10
 - (Feature) (ACS) Add ACS handler
 - (Feature) Allow to restart DBServers in cases when WriteConcern will be satisfied
+- (Feature) Allow to configure action timeouts
 
 ## [1.2.8](https://github.com/arangodb/kube-arangodb/tree/1.2.8) (2022-02-24)
 - Do not check License V2 on Community images

pkg/apis/deployment/v1/timeouts.go

@@ -31,14 +31,18 @@ const (
 )
 
 type Timeouts struct {
-	// AddMember action timeout
-	AddMember *Timeout `json:"addMember,omitempty"`
 
 	// MaintenanceGracePeriod action timeout
 	MaintenanceGracePeriod *Timeout `json:"maintenanceGracePeriod,omitempty"`
 
-	// RuntimeContainerImageUpdate action timeout
-	RuntimeContainerImageUpdate *Timeout `json:"runtimeContainerImageUpdate,omitempty"`
+	// Actions
+	Actions ActionTimeouts `json:"actions,omitempty"`
+
+	// deprecated
+	AddMember *Timeout `json:"-"`
+
+	// deprecated
+	RuntimeContainerImageUpdate *Timeout `json:"-"`
 }
 
 func (t *Timeouts) GetMaintenanceGracePeriod() time.Duration {
@@ -57,6 +61,12 @@ func (t *Timeouts) Get() Timeouts {
 	return *t
 }
 
+type ActionTimeouts map[ActionType]Timeout
+
+func NewTimeout(timeout time.Duration) Timeout {
+	return Timeout(meta.Duration{Duration: timeout})
+}
+
 type Timeout meta.Duration
 
 func (t *Timeout) Get(d time.Duration) time.Duration {

pkg/deployment/reconcile/action.go

@@ -30,6 +30,16 @@ import (
 	"github.com/rs/zerolog"
 )
 
+func GetAllActions() []api.ActionType {
+	z := make([]api.ActionType, 0, len(definedActions))
+
+	for k := range definedActions {
+		z = append(z, k)
+	}
+
+	return z
+}
+
 // ActionCore executes a single Plan item.
 type ActionCore interface {
 	// Start performs the start of the action.
@@ -45,8 +55,6 @@ type ActionCore interface {
 type Action interface {
 	ActionCore
 
-	// Timeout returns the amount of time after which this action will timeout.
-	Timeout(deploymentSpec api.DeploymentSpec) time.Duration
 	// MemberID Return the MemberID used / created in this action
 	MemberID() string
 }
@@ -144,9 +152,10 @@ type actionFactory func(log zerolog.Logger, action api.Action, actionCtx ActionC
 var (
 	definedActions     = map[api.ActionType]actionFactory{}
 	definedActionsLock sync.Mutex
+	actionTimeouts     = api.ActionTimeouts{}
 )
 
-func registerAction(t api.ActionType, f actionFactory) {
+func registerAction(t api.ActionType, f actionFactory, timeout time.Duration) {
 	definedActionsLock.Lock()
 	defer definedActionsLock.Unlock()
 
@@ -156,6 +165,7 @@ func registerAction(t api.ActionType, f actionFactory) {
 	}
 
 	definedActions[t] = f
+	actionTimeouts[t] = api.NewTimeout(timeout)
 }
 
 func getActionFactory(t api.ActionType) (actionFactory, bool) {

pkg/deployment/reconcile/action_add_member.go

@@ -22,7 +22,6 @@ package reconcile
 
 import (
 	"context"
-	"time"
 
 	"github.com/arangodb/kube-arangodb/pkg/deployment/topology"
 
@@ -35,17 +34,15 @@ import (
 )
 
 func init() {
-	registerAction(api.ActionTypeAddMember, newAddMemberAction)
+	registerAction(api.ActionTypeAddMember, newAddMemberAction, addMemberTimeout)
 }
 
 // newAddMemberAction creates a new Action that implements the given
 // planned AddMember action.
 func newAddMemberAction(log zerolog.Logger, action api.Action, actionCtx ActionContext) Action {
 	a := &actionAddMember{}
 
-	a.actionImpl = newBaseActionImpl(log, action, actionCtx, func(deploymentSpec api.DeploymentSpec) time.Duration {
-		return deploymentSpec.Timeouts.Get().AddMember.Get(addMemberTimeout)
-	}, &a.newMemberID)
+	a.actionImpl = newBaseActionImpl(log, action, actionCtx, &a.newMemberID)
 
 	return a
 }

pkg/deployment/reconcile/action_arango_member_update_pod_spec.go

@@ -33,15 +33,15 @@ import (
 )
 
 func init() {
-	registerAction(api.ActionTypeArangoMemberUpdatePodSpec, newArangoMemberUpdatePodSpecAction)
+	registerAction(api.ActionTypeArangoMemberUpdatePodSpec, newArangoMemberUpdatePodSpecAction, defaultTimeout)
 }
 
 // newArangoMemberUpdatePodSpecAction creates a new Action that implements the given
 // planned ArangoMemberUpdatePodSpec action.
 func newArangoMemberUpdatePodSpecAction(log zerolog.Logger, action api.Action, actionCtx ActionContext) Action {
 	a := &actionArangoMemberUpdatePodSpec{}
 
-	a.actionImpl = newActionImplDefRef(log, action, actionCtx, defaultTimeout)
+	a.actionImpl = newActionImplDefRef(log, action, actionCtx)
 
 	return a
 }

pkg/deployment/reconcile/action_arango_member_update_pod_status.go

@@ -31,7 +31,7 @@ import (
 )
 
 func init() {
-	registerAction(api.ActionTypeArangoMemberUpdatePodStatus, newArangoMemberUpdatePodStatusAction)
+	registerAction(api.ActionTypeArangoMemberUpdatePodStatus, newArangoMemberUpdatePodStatusAction, defaultTimeout)
 }
 
 const (
@@ -43,7 +43,7 @@ const (
 func newArangoMemberUpdatePodStatusAction(log zerolog.Logger, action api.Action, actionCtx ActionContext) Action {
 	a := &actionArangoMemberUpdatePodStatus{}
 
-	a.actionImpl = newActionImplDefRef(log, action, actionCtx, defaultTimeout)
+	a.actionImpl = newActionImplDefRef(log, action, actionCtx)
 
 	return a
 }

pkg/deployment/reconcile/action_backup_restore.go

@@ -32,13 +32,13 @@ import (
 )
 
 func init() {
-	registerAction(api.ActionTypeBackupRestore, newBackupRestoreAction)
+	registerAction(api.ActionTypeBackupRestore, newBackupRestoreAction, backupRestoreTimeout)
 }
 
 func newBackupRestoreAction(log zerolog.Logger, action api.Action, actionCtx ActionContext) Action {
 	a := &actionBackupRestore{}
 
-	a.actionImpl = newActionImplDefRef(log, action, actionCtx, backupRestoreTimeout)
+	a.actionImpl = newActionImplDefRef(log, action, actionCtx)
 
 	return a
 }

pkg/deployment/reconcile/action_backup_restore_clean.go

@@ -28,13 +28,13 @@ import (
 )
 
 func init() {
-	registerAction(api.ActionTypeBackupRestoreClean, newBackupRestoreCleanAction)
+	registerAction(api.ActionTypeBackupRestoreClean, newBackupRestoreCleanAction, backupRestoreTimeout)
 }
 
 func newBackupRestoreCleanAction(log zerolog.Logger, action api.Action, actionCtx ActionContext) Action {
 	a := &actionBackupRestoreClean{}
 
-	a.actionImpl = newActionImplDefRef(log, action, actionCtx, backupRestoreTimeout)
+	a.actionImpl = newActionImplDefRef(log, action, actionCtx)
 
 	return a
 }

pkg/deployment/reconcile/action_bootstrap_set_password.go

@@ -37,13 +37,13 @@ import (
 )
 
 func init() {
-	registerAction(api.ActionTypeBootstrapSetPassword, newBootstrapSetPasswordAction)
+	registerAction(api.ActionTypeBootstrapSetPassword, newBootstrapSetPasswordAction, defaultTimeout)
 }
 
 func newBootstrapSetPasswordAction(log zerolog.Logger, action api.Action, actionCtx ActionContext) Action {
 	a := &actionBootstrapSetPassword{}
 
-	a.actionImpl = newActionImplDefRef(log, action, actionCtx, defaultTimeout)
+	a.actionImpl = newActionImplDefRef(log, action, actionCtx)
 
 	return a
 }
@@ -66,7 +66,7 @@ func (a actionBootstrapSetPassword) Start(ctx context.Context) (bool, error) {
 			a.log.Warn().Msgf("User does not exist in password hashes")
 			return true, nil
 		} else {
-			ctxChild, cancel := context.WithTimeout(ctx, a.Timeout(spec))
+			ctxChild, cancel := globals.GetGlobals().Timeouts().ArangoD().WithTimeout(ctx)
 			defer cancel()
 
 			if password, err := a.setUserPassword(ctxChild, user, secret.Get()); err != nil {

pkg/deployment/reconcile/action_bootstrap_update.go

@@ -28,13 +28,13 @@ import (
 )
 
 func init() {
-	registerAction(api.ActionTypeBootstrapUpdate, newBootstrapUpdateAction)
+	registerAction(api.ActionTypeBootstrapUpdate, newBootstrapUpdateAction, defaultTimeout)
 }
 
 func newBootstrapUpdateAction(log zerolog.Logger, action api.Action, actionCtx ActionContext) Action {
 	a := &actionBootstrapUpdate{}
 
-	a.actionImpl = newActionImplDefRef(log, action, actionCtx, defaultTimeout)
+	a.actionImpl = newActionImplDefRef(log, action, actionCtx)
 
 	return a
 }