Allow disabling waiting for specific resources

Signed-off-by: Stefan Prodan <[email protected]>
stefanprodan · Dec 15, 2024 · 75e8c51 · 75e8c51
1 parent ae42baf
commit 75e8c51
Show file tree

Hide file tree

Showing 4 changed files with 61 additions and 12 deletions.
diff --git a/api/v1alpha1/actions.go b/api/v1alpha1/actions.go
@@ -33,4 +33,7 @@ var (
 	// IfNotPresentAction is the annotation that defines if a Kubernetes resource
 	// should be applied only if it doesn't exist on the cluster.
 	IfNotPresentAction = fmt.Sprintf("action.%s/one-off", GroupVersion.Group)
+
+	// WaitAction is the annotation that defines if a Kubernetes resource should be included in the readiness check.
+	WaitAction = fmt.Sprintf("action.%s/wait", GroupVersion.Group)
 )
diff --git a/docs/cue/module/apply-behavior.md b/docs/cue/module/apply-behavior.md
@@ -5,11 +5,12 @@ with the `action.timoni.sh` annotations.
 
 ## Annotations
 
-| CUE                      | Generated YAML                      |
-|--------------------------|-------------------------------------|
-| `timoniv1.Action.Force`  | `action.timoni.sh/force: enabled`   |
-| `timoniv1.Action.OneOff` | `action.timoni.sh/one-off: enabled` |
-| `timoniv1.Action.Keep`   | `action.timoni.sh/prune: disabled`  |
+| CUE                              | Generated YAML                      |
+|----------------------------------|-------------------------------------|
+| `timoniv1.Action.Force`          | `action.timoni.sh/force: enabled`   |
+| `timoniv1.Action.OneOff`         | `action.timoni.sh/one-off: enabled` |
+| `timoniv1.Action.Keep`           | `action.timoni.sh/prune: disabled`  |
+| `timoniv1.Action.DisableWaiting` | `action.timoni.sh/wait: disabled`   |
 
 ### Force Apply
 
@@ -72,10 +73,9 @@ import (
 ### Disable Pruning
 
 To prevent Timoni's garbage collector from deleting certain
-resources such as Kubernetes Persistent Volumes,
+resources such as Kubernetes Persistent Volume Claims,
 these resources can be annotated with `action.timoni.sh/prune: "disabled"`.
 
-
 Example:
 
 ```cue
@@ -99,3 +99,34 @@ import (
 }
 
 ```
+
+
+### Disable Waiting
+
+To prevent Timoni's readiness check from waiting for certain
+resources such as Kubernetes Persistent Volumes,
+these resources can be annotated with `action.timoni.sh/wait: "disabled"`.
+
+Example:
+
+```cue
+package templates
+
+import (
+	corev1 "k8s.io/api/core/v1"
+	timoniv1 "timoni.sh/core/v1alpha1"
+)
+
+#DatabasePV: corev1.#PersistentVolume & {
+	#config:    #Config
+	apiVersion: "v1"
+	kind:       "PersistentVolume"
+	metadata: timoniv1.#MetaComponent & {
+		#Meta:      #config.metadata
+		#Component: "database"
+	}
+	metadata: annotations: timoniv1.Action.DisableWaiting
+	spec: {...}
+}
+
+```
diff --git a/internal/reconciler/reconciler.go b/internal/reconciler/reconciler.go
@@ -23,6 +23,7 @@ import (
 
 	"cuelang.org/go/cue"
 	"github.com/fluxcd/pkg/ssa"
+	ssautil "github.com/fluxcd/pkg/ssa/utils"
 	"github.com/go-logr/logr"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	kerrors "k8s.io/apimachinery/pkg/util/errors"
@@ -127,20 +128,30 @@ func (r *Reconciler) ApplyInstance(ctx context.Context, log logr.Logger, builder
 	})
 }
 
-func (a *Reconciler) Wait(ctx context.Context, log logr.Logger, _ *ssa.ChangeSet, rs *engine.ResourceSet) error {
+func (r *Reconciler) Wait(ctx context.Context, log logr.Logger, _ *ssa.ChangeSet, rs *engine.ResourceSet) error {
 	doneMsg := ""
 	if rs != nil && rs.Name != "" {
 		doneMsg = fmt.Sprintf("%s resources ready", rs.Name)
 	}
-	return a.doWait(ctx, log, rs, "waiting for %d resource(s) to become ready", doneMsg)
+	return r.doWait(ctx, log, rs, "waiting for %d resource(s) to become ready", doneMsg)
 }
 
 func (r *Reconciler) doWait(_ context.Context, log logr.Logger, rs *engine.ResourceSet, progressMsgFmt string, doneMsg string) error {
-	if !r.opts.Wait {
+	if !r.opts.Wait || rs == nil || len(rs.Objects) == 0 {
 		return nil
 	}
-	progress := r.progressStartFn(fmt.Sprintf(progressMsgFmt, len(rs.Objects)))
-	err := r.resourceManager.Wait(rs.Objects, r.waitOptions)
+
+	var waitForObjects []*unstructured.Unstructured
+	for _, obj := range rs.Objects {
+		if !ssautil.AnyInMetadata(obj, map[string]string{
+			apiv1.WaitAction: apiv1.DisabledValue,
+		}) {
+			waitForObjects = append(waitForObjects, obj)
+		}
+	}
+
+	progress := r.progressStartFn(fmt.Sprintf(progressMsgFmt, len(waitForObjects)))
+	err := r.resourceManager.Wait(waitForObjects, r.waitOptions)
 	progress.Stop()
 	if err != nil {
 		return err

diff --git a/schemas/timoni.sh/core/v1alpha1/action.cue b/schemas/timoni.sh/core/v1alpha1/action.cue
@@ -18,6 +18,10 @@ Action: {
 	Keep: {
 		"action.timoni.sh/prune": ActionStatus.Disabled
 	}
+	// DisableWaiting annotation is for excluding resouces from Timoni's readiness check.
+	DisableWaiting: {
+		"action.timoni.sh/wait": ActionStatus.Disabled
+	}
 }
 
 ActionStatus: {