✨ client: Add client-wide fieldManager #2771
Conversation
This PR adds a new `client` function `WithFieldOwner` that wraps a `client.Client` and adds a `client.FieldOwner` option to all writes from this client. If additional FieldOwner options are specified on methods of this client, the value specified here will be overridden.
k8s-ci-robot
added
the
cncf-cla: yes
k8s-ci-robot
added
the
size/L
k8s-ci-robot
added
the
lgtm
|
LGTM label has been added. Git tree hash: 1ac0bc513eae0e67430c76c18b160197da20c516
|
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: ahmetb, vincepri 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 |
k8s-ci-robot
added
the
approved
|
/cherrypick release-0.17 |
|
@ahmetb: new pull request created: #2772 In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
|
/cherrypick release-0.16 |
|
@sbueringer: new pull request created: #2775 In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
| @@ -0,0 +1,148 @@ | |||
| /* | |||
There was a problem hiding this comment.
@ahmetb Can you please adjust the filename to fieldowner_test.go? (just for main is okay)
| // will be overridden. | ||
| func WithFieldOwner(c Client, fieldOwner string) Client { | ||
| return &clientWithFieldManager{ | ||
| manager: fieldOwner, |
There was a problem hiding this comment.
nit: Maybe we should call this owner or fieldOwner consistently (compared to manager in one client and owner in the other)
Summary
This PR adds a new
clientfunctionWithFieldOwnerthat wraps aclient.Clientand adds aclient.FieldOwneroption to all writes from this client. If additional FieldOwner options are specified on methods of this client, the value specified here will be overridden.Why do we need it?
I have found myself trying to distinguish between different reconcilers in the same controller-manager process for both troubleshooting purposes (i.e having
managedFieldsshow the specific controller) and prevent colocated reconcilers from managing the same field.The alternative was to add
client.FieldManagerto each individual call, which is tedious and error-prone. Instead, I would prefer to have the client use the same fieldManager across all its write calls.