ImagePolicy: Add predicates to filter events #334
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ImagePolicy watcher adds every change to its own kind in the work queue which results in unnecessary multiple reconciliations. Add a predicate to allow own kind events only on generation change. Signed-off-by: Sunny <[email protected]>
relu
approved these changes
Jan 4, 2023
| @@ -260,7 +262,7 @@ func (r *ImagePolicyReconciler) SetupWithManager(mgr ctrl.Manager, opts ImagePol | |||
| } | |||
|
|
|||
| return ctrl.NewControllerManagedBy(mgr). | |||
| For(&imagev1.ImagePolicy{}). | |||
| For(&imagev1.ImagePolicy{}, builder.WithPredicates(predicate.GenerationChangedPredicate{})). | |||
There was a problem hiding this comment.
This is just an observation and is out of scope, but I'm wondering if we should support the reconcile request annotation for ImagePolicy in which case we'd also need to add the ReconcileRequestedPredicate in here. I think ImagePolicy is the only CR we don't support reconciliation requests for at the moment.
There was a problem hiding this comment.
Similar to ImagePolicy, Notification-controller Alerts also watch Providers but it supports reconcile request annotation. Based on that, we can either add the same here or maybe remove it from Alert.
There may be some historic reason behind it that I'm unaware of.
hiddeco
approved these changes
Jan 10, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
ImagePolicy watcher adds every change to its own kind in the work queue which results in unnecessary multiple reconciliations.
Add a predicate to allow own kind events only on generation change. Other reconcilers in other repositories also use such predicates for the same purpose.
NOTE: In the current implementation of ImagePolicy reconciler, there's no logging due to which it's not apparent how many times it reconciled in the background. With the refactor in #311, every ImagePolicy reconciliation logs, which made multiple reconciliations more visible.
For example, creating a new ImagePolicy resulted in:
{"level":"info","ts":"2023-01-03T23:11:46.763+0530","msg":"Latest image tag for 'ghcr.io/stefanprodan/podinfo' resolved to 5.0.3","controller":"imagepolicy","controllerGroup":"image.toolkit.fluxcd.io","controllerKind":"ImagePolicy","ImagePolicy":{"name":"podinfo","namespace":"default"},"namespace":"default","name":"podinfo","reconcileID":"cf5bd588-32a2-44ab-8027-6185e3d91775"} {"level":"info","ts":"2023-01-03T23:11:46.770+0530","msg":"Latest image tag for 'ghcr.io/stefanprodan/podinfo' resolved to 5.0.3","controller":"imagepolicy","controllerGroup":"image.toolkit.fluxcd.io","controllerKind":"ImagePolicy","ImagePolicy":{"name":"podinfo","namespace":"default"},"namespace":"default","name":"podinfo","reconcileID":"80729b49-a66d-482a-8d2e-9bbd2fc6bcf0"} {"level":"info","ts":"2023-01-03T23:11:47.514+0530","msg":"Latest image tag for 'ghcr.io/stefanprodan/podinfo' resolved to 5.0.3","controller":"imagepolicy","controllerGroup":"image.toolkit.fluxcd.io","controllerKind":"ImagePolicy","ImagePolicy":{"name":"podinfo","namespace":"default"},"namespace":"default","name":"podinfo","reconcileID":"6046cb8e-8ad6-4a89-82b8-1165ff3c6b85"}With the new predicate:
{"level":"info","ts":"2023-01-04T00:02:40.199+0530","msg":"Latest image tag for 'ghcr.io/stefanprodan/podinfo' resolved to 5.0.3","controller":"imagepolicy","controllerGroup":"image.toolkit.fluxcd.io","controllerKind":"ImagePolicy","ImagePolicy":{"name":"podinfo","namespace":"default"},"namespace":"default","name":"podinfo","reconcileID":"f0fcefe4-2361-4216-a099-eee751b525e8"}Fixing it separately in the main branch to keep the number of specific changes in the refactor branch low.