[Feature] Delay Action (#1827)

ajanikow · web-flow · commit f81a2da94bef · 2025-02-17T13:44:21.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,6 +15,7 @@
 - (Feature) Allow to continue if ResignServer job is gone
 - (Feature) UpgradeByReplace Flow
 - (Feature) (Platform) ArangoRoute Timeout option
+- (Feature) Delay Action
 
 ## [1.2.44](https://github.com/arangodb/kube-arangodb/tree/1.2.44) (2025-02-03)
 - (Maintenance) Kubernetes 1.31.1 libraries
diff --git a/docs/generated/actions.md b/docs/generated/actions.md
@@ -25,6 +25,7 @@ nav_order: 11
 | CleanTLSCACertificate | no | 30m0s | no | Enterprise Only | Remove Certificate from CA TrustStore |
 | CleanTLSKeyfileCertificate | no | 30m0s | no | Enterprise Only | Remove old TLS certificate from server |
 | ClusterMemberCleanup | no | 10m0s | no | Community & Enterprise | Remove member from Cluster if it is gone already (Coordinators) |
+| Delay | no | 10m0s | yes | Community & Enterprise | Define delay operation |
 | ~~DisableClusterScaling~~ | no | 10m0s | no | Community & Enterprise | Disable Cluster Scaling integration |
 | DisableMaintenance | no | 10m0s | no | Community & Enterprise | Disable ArangoDB maintenance mode |
 | DisableMemberMaintenance | no | 10m0s | no | Enterprise Only | Disable ArangoDB DBServer maintenance mode |
@@ -121,6 +122,7 @@ spec:
       CleanTLSCACertificate: 30m0s
       CleanTLSKeyfileCertificate: 30m0s
       ClusterMemberCleanup: 10m0s
+      Delay: 10m0s
       DisableClusterScaling: 10m0s
       DisableMaintenance: 10m0s
       DisableMemberMaintenance: 10m0s
diff --git a/internal/actions.config.go.tmpl b/internal/actions.config.go.tmpl
@@ -1,6 +1,6 @@
 {{- $root := . -}}
 //
-// Copyright 2023 ArangoDB GmbH, Cologne, Germany
+// Copyright 2023-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.
diff --git a/internal/actions.go.tmpl b/internal/actions.go.tmpl
@@ -1,6 +1,6 @@
 {{- $root := . -}}
 //
-// Copyright 2016-2023 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.
diff --git a/internal/actions.register.go.tmpl b/internal/actions.register.go.tmpl
@@ -1,6 +1,6 @@
 {{- $root := . -}}
 //
-// Copyright 2016-2023 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.
diff --git a/internal/actions.register.test.go.tmpl b/internal/actions.register.test.go.tmpl
@@ -1,6 +1,6 @@
 {{- $root := . -}}
 //
-// Copyright 2016-2023 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.
diff --git a/internal/actions.yaml b/internal/actions.yaml
@@ -4,6 +4,12 @@ actions:
     description: Empty placeholder action
   Idle:
     description: Define idle operation in case if preconditions are not meet
+  Delay:
+    description: Define delay operation
+    optional: true
+    scopes:
+      - Normal
+      - High
   AddMember:
     description: Adds new member to the Member list
     timeout: 10m
diff --git a/pkg/apis/deployment/v1/actions.generated.go b/pkg/apis/deployment/v1/actions.generated.go
diff --git a/pkg/apis/deployment/v2alpha1/actions.generated.go b/pkg/apis/deployment/v2alpha1/actions.generated.go
diff --git a/pkg/deployment/reconcile/action.config.generated.go b/pkg/deployment/reconcile/action.config.generated.go
diff --git a/pkg/deployment/reconcile/action.register.generated.go b/pkg/deployment/reconcile/action.register.generated.go
diff --git a/pkg/deployment/reconcile/action.register.generated_test.go b/pkg/deployment/reconcile/action.register.generated_test.go
@@ -1,5 +1,5 @@
 //
-// Copyright 2016-2023 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.
@@ -160,6 +160,16 @@ func Test_Actions(t *testing.T) {
 		})
 	})
 
+	t.Run("Delay", func(t *testing.T) {
+		ActionsExistence(t, api.ActionTypeDelay)
+		t.Run("Internal", func(t *testing.T) {
+			require.False(t, api.ActionTypeDelay.Internal())
+		})
+		t.Run("Optional", func(t *testing.T) {
+			require.True(t, api.ActionTypeDelay.Optional())
+		})
+	})
+
 	t.Run("DisableClusterScaling", func(t *testing.T) {
 		// nolint:staticcheck
 		ActionsExistence(t, api.ActionTypeDisableClusterScaling)
diff --git a/pkg/deployment/reconcile/action_delay.go b/pkg/deployment/reconcile/action_delay.go
@@ -0,0 +1,77 @@
+//
+// 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 reconcile
+
+import (
+	"context"
+	"time"
+
+	api "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1"
+)
+
+const (
+	DelayActionDuration = "delayActionDuration"
+)
+
+// newDelayAction creates a new Action that implements the given
+// planned Delay action.
+func newDelayAction(action api.Action, actionCtx ActionContext) Action {
+	a := &actionDelay{}
+
+	a.actionImpl = newActionImplDefRef(action, actionCtx)
+
+	return a
+}
+
+// actionDelay implements an Delay.
+type actionDelay struct {
+	// actionImpl implement timeout and member id functions
+	actionImpl
+}
+
+// Start performs the start of the action.
+// Returns true if the action is completely finished, false in case
+// the start time needs to be recorded and a ready condition needs to be checked.
+func (a *actionDelay) Start(ctx context.Context) (bool, error) {
+	return false, nil
+}
+
+func (a *actionDelay) CheckProgress(ctx context.Context) (bool, bool, error) {
+	v, ok := a.action.Params[DelayActionDuration]
+	if !ok {
+		a.log.Str("key", DelayActionDuration).Warn("Param for the delay not defined")
+		return true, false, nil
+	}
+
+	d, err := time.ParseDuration(v)
+	if err != nil {
+		a.log.Err(err).Str("value", v).Warn("Unable to parse duration")
+		return true, false, nil
+	}
+
+	if v := a.action.StartTime; v != nil {
+		if v.Time.Add(d).Before(time.Now()) {
+			return true, false, nil
+		}
+	}
+
+	return false, false, nil
+}
