Introduce .spec.suspend and .status.lastHandledReconcileAt for ImagePolicy #799

Signed-off-by: Daniel Guns <danbguns@gmail.com>

Author: dgunzy

api/v1beta2/imagepolicy_types.go

@@ -69,6 +69,11 @@ type ImagePolicySpec struct {
 	// +kubebuilder:validation:Pattern="^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$"
 	// +optional
 	Interval *metav1.Duration `json:"interval,omitempty"`
+
+	// This flag tells the controller to suspend subsequent policy reconciliations.
+	// It does not apply to already started reconciliations. Defaults to false.
+	// +optional
+	Suspend bool `json:"suspend,omitempty"`
 }
 
 // ReflectionPolicy describes a policy for if/when to reflect a value from the registry in a certain resource field.
@@ -178,6 +183,8 @@ type ImagePolicyStatus struct {
 	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
 	// +optional
 	Conditions []metav1.Condition `json:"conditions,omitempty"`
+
+	meta.ReconcileRequestStatus `json:",inline"`
 }
 
 // GetConditions returns the status conditions of the object.
@@ -219,8 +226,13 @@ func (in *ImagePolicy) GetDigestReflectionPolicy() ReflectionPolicy {
 
 func (in *ImagePolicy) GetInterval() time.Duration {
 	if in.GetDigestReflectionPolicy() == ReflectAlways {
+		if in.Spec.Interval == nil || in.Spec.Interval.Duration == 0 {
+			return 10 * time.Minute
+		}
+
 		return in.Spec.Interval.Duration
 	}
+
 	return 0
 }
 

api/v1beta2/zz_generated.deepcopy.go

@@ -169,6 +169,11 @@ spec:
                     - range
                     type: object
                 type: object
+              suspend:
+                description: |-
+                  This flag tells the controller to suspend subsequent policy reconciliations.
+                  It does not apply to already started reconciliations. Defaults to false.
+                type: boolean
             required:
             - imageRepositoryRef
             - policy
@@ -243,6 +248,12 @@ spec:
                   - type
                   type: object
                 type: array
+              lastHandledReconcileAt:
+                description: |-
+                  LastHandledReconcileAt holds the value of the most recent
+                  reconcile request value, so a change of the annotation value
+                  can be detected.
+                type: string
               latestRef:
                 description: |-
                   LatestRef gives the first in the list of images scanned by

config/crd/bases/image.toolkit.fluxcd.io_imagepolicies.yaml

@@ -167,6 +167,19 @@ reflection policy is set to &ldquo;Always&rdquo;.</p>
 <p>Defaults to 10m.</p>
 </td>
 </tr>
+<tr>
+<td>
+<code>suspend</code><br>
+<em>
+bool
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>This flag tells the controller to suspend subsequent policy reconciliations.
+It does not apply to already started reconciliations. Defaults to false.</p>
+</td>
+</tr>
 </table>
 </td>
 </tr>
@@ -349,6 +362,19 @@ reflection policy is set to &ldquo;Always&rdquo;.</p>
 <p>Defaults to 10m.</p>
 </td>
 </tr>
+<tr>
+<td>
+<code>suspend</code><br>
+<em>
+bool
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>This flag tells the controller to suspend subsequent policy reconciliations.
+It does not apply to already started reconciliations. Defaults to false.</p>
+</td>
+</tr>
 </tbody>
 </table>
 </div>
@@ -424,6 +450,21 @@ int64
 <em>(Optional)</em>
 </td>
 </tr>
+<tr>
+<td>
+<code>ReconcileRequestStatus</code><br>
+<em>
+<a href="https://godoc.org/github.com/fluxcd/pkg/apis/meta#ReconcileRequestStatus">
+github.com/fluxcd/pkg/apis/meta.ReconcileRequestStatus
+</a>
+</em>
+</td>
+<td>
+<p>
+(Members of <code>ReconcileRequestStatus</code> are embedded into this type.)
+</p>
+</td>
+</tr>
 </tbody>
 </table>
 </div>

docs/api/v1beta2/image-reflector.md

@@ -179,6 +179,7 @@ func (imageRepositoryPredicate) Update(e event.UpdateEvent) bool {
 
 func (r *ImagePolicyReconciler) Reconcile(ctx context.Context, req ctrl.Request) (result ctrl.Result, retErr error) {
 	start := time.Now()
+	log := ctrl.LoggerFrom(ctx)
 
 	// Fetch the ImagePolicy.
 	obj := &imagev1.ImagePolicy{}
@@ -191,6 +192,13 @@ func (r *ImagePolicyReconciler) Reconcile(ctx context.Context, req ctrl.Request)
 
 	// Always attempt to patch the object after each reconciliation.
 	defer func() {
+		// If the reconcile request annotation was set, consider it
+		// handled (NB it doesn't matter here if it was changed since last
+		// time)
+		if token, ok := meta.ReconcileAnnotationValue(obj.GetAnnotations()); ok {
+			obj.Status.SetLastHandledReconcileRequest(token)
+		}
+
 		// Create patch options for patching the object.
 		patchOpts := pkgreconcile.AddPatchOptions(obj, r.patchOptions, imagePolicyOwnedConditions, r.ControllerName)
 		if err := serialPatcher.Patch(ctx, obj, patchOpts...); err != nil {
@@ -219,6 +227,12 @@ func (r *ImagePolicyReconciler) Reconcile(ctx context.Context, req ctrl.Request)
 		return ctrl.Result{Requeue: true}, nil
 	}
 
+	// Return if the object is suspended.
+	if obj.Spec.Suspend {
+		log.Info("reconciliation is suspended for this object")
+		return ctrl.Result{}, nil
+	}
+
 	// Call subreconciler.
 	result, retErr = r.reconcile(ctx, serialPatcher, obj)
 	return
@@ -245,9 +259,12 @@ func composeImagePolicyReadyMessage(obj *imagev1.ImagePolicy) string {
 func (r *ImagePolicyReconciler) reconcile(ctx context.Context, sp *patch.SerialPatcher, obj *imagev1.ImagePolicy) (result ctrl.Result, retErr error) {
 	oldObj := obj.DeepCopy()
 
+	// Set a default next reconcile time before processing the object.
+	nextReconcileTime := obj.GetInterval()
+
 	// If there's no error and no requeue is requested, it's a success.
 	isSuccess := func(res ctrl.Result, err error) bool {
-		if err != nil || res.Requeue {
+		if err != nil || res.RequeueAfter != nextReconcileTime {
 			return false
 		}
 		return true
@@ -365,7 +382,8 @@ func (r *ImagePolicyReconciler) reconcile(ctx context.Context, sp *patch.SerialP
 	// Let result finalizer compute the Ready condition.
 	conditions.Delete(obj, meta.ReadyCondition)
 
-	result, retErr = ctrl.Result{RequeueAfter: obj.GetInterval()}, nil
+	// Set the next reconcile time in the result based on the interval.
+	result, retErr = ctrl.Result{RequeueAfter: nextReconcileTime}, nil
 	return
 }