[Net-5510][Net-5455]: CRD controller should only patch the finalizer in the metadata of a CRD, rather than the whole object #3362
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
ndhanushkodi
commented
Dec 13, 2023
| RemoveFinalizersPatch(obj client.Object, finalizers ...string) *FinalizerPatch | ||
| // Patch patches the object. This should only ever be used for updating the metadata of an object, and not object | ||
| // spec or status. Updating the spec could have unintended consequences like defaulting zero values. | ||
| Patch(ctx context.Context, obj client.Object, patch client.Patch, opts ...client.PatchOption) error |
There was a problem hiding this comment.
@hashi-derek does this interface look ok? I tried keeping it as AddFinalizers and RemoveFinalizers, implemented by the FinalizerPatcher in finalizer_patch.go but if I do the patching within those functions, I'd need to pass in the k8s client to to the FinalizerPatcher. Keeping Patch as a function on the controller allows the FinalizerPatcher to not need another k8s client that's already being embedded in the controller implementations.
There was a problem hiding this comment.
Yeah, this is fine. It's simpler than having the client passed in on each function call.
ndhanushkodi
commented
Dec 13, 2023
hashi-derek
reviewed
Dec 15, 2023
| RemoveFinalizersPatch(obj client.Object, finalizers ...string) *FinalizerPatch | ||
| // Patch patches the object. This should only ever be used for updating the metadata of an object, and not object | ||
| // spec or status. Updating the spec could have unintended consequences like defaulting zero values. | ||
| Patch(ctx context.Context, obj client.Object, patch client.Patch, opts ...client.PatchOption) error |
There was a problem hiding this comment.
Yeah, this is fine. It's simpler than having the client passed in on each function call.
control-plane/config-entries/controllers/configentry_controller.go
Outdated
Show resolved
Hide resolved
hashi-derek
approved these changes
Dec 18, 2023
ndhanushkodi
force-pushed
the
nd/net-5510-net-5455-patch-config-entries
branch
from
42e231c to
33effff
Compare
Co-authored-by: Derek Menteer <[email protected]>
ndhanushkodi
force-pushed
the
nd/net-5510-net-5455-patch-config-entries
branch
from
33effff to
962f047
Compare
ndhanushkodi
changed the title
ndhanushkodi
added
backport/1.2.x
This was referenced Dec 20, 2023
ndhanushkodi
added a commit
that referenced
this pull request
Dec 20, 2023
…in the metadata of a CRD, rather than the whole object (#3362) Finalizer patcher Co-authored-by: Derek Menteer <[email protected]>
ndhanushkodi
added a commit
that referenced
this pull request
Dec 20, 2023
…in the metadata of a CRD, rather than the whole object (#3362) Finalizer patcher Co-authored-by: Derek Menteer <[email protected]>
ndhanushkodi
added a commit
that referenced
this pull request
Dec 21, 2023
…atch the finalizer in the metadata of a CRD, rather than the whole object into release/1.2.x (#3414) * [Net-5510][Net-5455]: CRD controller should only patch the finalizer in the metadata of a CRD, rather than the whole object (#3362) Finalizer patcher Co-authored-by: Derek Menteer <[email protected]>
ndhanushkodi
added a commit
that referenced
this pull request
Dec 21, 2023
…atch the finalizer in the metadata of a CRD, rather than the whole object into release/1.1.x (#3415) * [Net-5510][Net-5455]: CRD controller should only patch the finalizer in the metadata of a CRD, rather than the whole object (#3362) Finalizer patcher Co-authored-by: Derek Menteer <[email protected]>
sarahalsmiller
pushed a commit
that referenced
this pull request
Jan 5, 2024
…in the metadata of a CRD, rather than the whole object (#3362) Finalizer patcher Co-authored-by: Derek Menteer <[email protected]>
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.
Changes proposed in this PR
Issue: ArgoCD will flap when configured with replace mode, which causes zero values to get defaulted and the applied config to differ from the state in K8s.
This is how the ArgoCD flapping problem happens:
This PR:
Added @hashi-derek as a coauthor for his work on a finalizer patcher POC that I used for this.
How I've tested this PR
From this repo https://github.com/ndhanushkodi/argocd-example-apps/tree/nd/debug-consul-config/consul-counting
Lightweight test steps with kubectl replace:
kubectl apply -f counting.yaml -f dashboard.yaml -f splitter.yamlTest steps with Argo CD:
How I expect reviewers to test this PR
👀
Checklist