Use patches for adding and removing finalizers #118
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
Using update can have unintended consequences such as setting empty values of fields that were nil on the server. This happens for the evaluationInterval field where if it wasn't set, the update adds an empty map, which triggers the spec-sync to remove the nil map. This unnecessary spec-sync update causes the status update to fail later on in the ConfigurationPolicy processing. Additionally, when a finalizer can't be added or removed, the evaluation stops and would be retried on the next run. This is a safer approach. Signed-off-by: mprahl <mprahl@users.noreply.github.com>
yiraeChristineKim
approved these changes
Apr 6, 2023
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: mprahl, yiraeChristineKim The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
JustinKuli
reviewed
Apr 6, 2023
Comment on lines
+722
to
+724
| mergePatch := []byte(`{"metadata": {"finalizers": ["` + pruneObjectFinalizer + `"]}}`) | ||
|
|
||
| err := r.Update(context.TODO(), &plc) | ||
| err := r.Patch(context.TODO(), &plc, client.RawPatch(types.MergePatchType, mergePatch)) |
There was a problem hiding this comment.
@mprahl could this accidentally remove any other finalizer on the resource? I was expecting a JSON patch like [{"op":"add","path":"/metadata/finalizers/-","value":"..."}]
There was a problem hiding this comment.
Good catch. I thought the merge patch would act like strategic merge but I got the two confused. Here is a PR with the fix:
#119
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.
Using update can have unintended consequences such as setting empty values of fields that were nil on the server. This happens for the evaluationInterval field where if it wasn't set, the update adds an empty map, which triggers the spec-sync to remove the nil map. This unnecessary spec-sync update causes the status update to fail later on in the ConfigurationPolicy processing.
Additionally, when a finalizer can't be added or removed, the evaluation stops and would be retried on the next run. This is a safer approach.