add new component State: DeletionPending

Author: cbarbian-sap

pkg/component/reconcile.go

@@ -41,21 +41,27 @@ import (
 // TODO: make a can-i check before emitting events to deployment target (e.g. in the client factory when creating the client)
 // TODO: allow to override namespace auto-creation and adoption policy settings on a per-component level
 // (e.g. through annotations or another interface that components could optionally implement)
+// TODO: allow some timeout feature, such that component will go into error state if not ready within the given timeout
+// (e.g. through a TimeoutConfiguration interface that components could optionally implement)
 // TODO: run admission webhooks (if present) in reconcile (e.g. as post-read hook)
 
 const (
 	readyConditionReasonNew                = "FirstSeen"
-	readyConditionPending                  = "Pending"
+	readyConditionReasonPending            = "Pending"
 	readyConditionReasonProcessing         = "Processing"
 	readyConditionReasonReady              = "Ready"
 	readyConditionReasonError              = "Error"
+	readyConditionReasonDeletionPending    = "DeletionPending"
 	readyConditionReasonDeletionBlocked    = "DeletionBlocked"
 	readyConditionReasonDeletionProcessing = "DeletionProcessing"
 )
 
+// TODO: should we pass cluster.Client to hooks instead of just client.Client?
+
 // HookFunc is the function signature that can be used to
 // establish callbacks at certain points in the reconciliation logic.
-// Hooks will be passed the current (potentially unsaved) state of the component.
+// Hooks will be passed a local client (to be precise, the one belonging to the owning
+// manager), and the current (potentially unsaved) state of the component.
 // Post-hooks will only be called if the according operation (read, reconcile, delete)
 // has been successful.
 type HookFunc[T Component] func(ctx context.Context, client client.Client, component T) error
@@ -183,13 +189,20 @@ func (r *Reconciler[T]) Reconcile(ctx context.Context, req ctrl.Request) (result
 				if retryAfter == nil || *retryAfter == 0 {
 					retryAfter = &retryInterval
 				}
-				status.SetState(StatePending, readyConditionPending, err.Error())
+				// TODO: allow RetriableError to provide custom reason and message
+				if component.GetDeletionTimestamp().IsZero() {
+					status.SetState(StatePending, readyConditionReasonPending, capitalize(err.Error()))
+				} else {
+					status.SetState(StateDeletionPending, readyConditionReasonDeletionPending, capitalize(err.Error()))
+				}
 				result = ctrl.Result{RequeueAfter: *retryAfter}
 				err = nil
 			} else {
 				status.SetState(StateError, readyConditionReasonError, err.Error())
 			}
 		}
+		// TODO: should we move this behind the DeepEqual check below?
+		// TODO: follow-up on missing events
 		state, reason, message := status.GetState()
 		if state == StateError {
 			r.client.EventRecorder().Event(component, corev1.EventTypeWarning, reason, message)
@@ -284,11 +297,13 @@ func (r *Reconciler[T]) Reconcile(ctx context.Context, req ctrl.Request) (result
 			return ctrl.Result{}, errors.Wrap(err, "error checking whether deletion is possible")
 		}
 		log.V(1).Info("deletion not allowed")
+		// TODO: have an additional StateDeletionBlocked?
 		status.SetState(StateDeleting, readyConditionReasonDeletionBlocked, "Deletion blocked: "+msg)
 		return ctrl.Result{RequeueAfter: 1*time.Second + r.backoff.Next(req, readyConditionReasonDeletionBlocked)}, nil
 	} else if len(slices.Remove(component.GetFinalizers(), r.name)) > 0 {
 		// deletion is blocked because of foreign finalizers
 		log.V(1).Info("deleted blocked due to existence of foreign finalizers")
+		// TODO: have an additional StateDeletionBlocked?
 		status.SetState(StateDeleting, readyConditionReasonDeletionBlocked, "Deletion blocked due to existing foreign finalizers")
 		return ctrl.Result{RequeueAfter: 1*time.Second + r.backoff.Next(req, readyConditionReasonDeletionBlocked)}, nil
 	} else {

pkg/component/types.go

@@ -151,7 +151,7 @@ type Status struct {
 	LastObservedAt     *metav1.Time `json:"lastObservedAt,omitempty"`
 	LastAppliedAt      *metav1.Time `json:"lastAppliedAt,omitempty"`
 	Conditions         []Condition  `json:"conditions,omitempty"`
-	// +kubebuilder:validation:Enum=Ready;Pending;Processing;Deleting;Error
+	// +kubebuilder:validation:Enum=Ready;Pending;Processing;DeletionPending;Deleting;Error
 	State     State            `json:"state,omitempty"`
 	Inventory []*InventoryItem `json:"inventory,omitempty"`
 }
@@ -191,7 +191,7 @@ const (
 	ConditionUnknown ConditionStatus = "Unknown"
 )
 
-// Component state. Can be one of 'Ready', 'Pending', 'Processing', 'Deleting', 'Error'.
+// Component state. Can be one of 'Ready', 'Pending', 'Processing', 'DeletionPending', 'Deleting', 'Error'.
 type State string
 
 const (
@@ -201,6 +201,8 @@ const (
 	StatePending State = "Pending"
 	// Component state 'Processing'.
 	StateProcessing State = "Processing"
+	// Component state 'DeletionPending'.
+	StateDeletionPending State = "DeletionPending"
 	// Component state 'Deleting'.
 	StateDeleting State = "Deleting"
 	// Component state 'Error'.

pkg/component/util.go

@@ -35,6 +35,13 @@ func sha256base32(data []byte) string {
 	return strings.ToLower(base32.StdEncoding.WithPadding(base32.NoPadding).EncodeToString(sum[:]))
 }
 
+func capitalize(s string) string {
+	if len(s) <= 1 {
+		return s
+	}
+	return strings.ToUpper(s[0:1]) + s[1:]
+}
+
 func calculateObjectDigest(obj client.Object) (string, error) {
 	resourceVersion := obj.GetResourceVersion()
 	defer obj.SetResourceVersion(resourceVersion)