Avoid reconciliation loops with predicates #268
Merged
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.
Summary
From the godoc:
GenerationChangedPredicate implements a default update predicate function on Generation change.
This predicate will skip update events that have no change in the object's metadata.generation field.
The metadata.generation field of an object is incremented by the API server when writes are made to the spec field of an object.
This allows a controller to ignore update events where the spec is unchanged, and only the metadata and/or status fields are changed.
For CustomResource objects the Generation is only incremented when the status subresource is enabled.
Caveats:
E.g For Deployment objects the Generation is also incremented on writes to the metadata.annotations field.
For object types other than CustomResources be sure to verify which fields will trigger a Generation increment when they are written to.
So in the event that the status block is overwritten or wiped by someone else the controller will not self-correct to restore the correct status.
Checklist
bug
,enhancement
,documentation
,change
,breaking
,as they show up in the changelog