⚠️ Add client.SubResourceWriter #2072

alvaroaleman · 2022-11-28T02:50:32Z

This change adds a SubResourceWriter to the client package that can be used to Create, Update or Patch arbitrary subresources.

This fixes the majority of #172, the only thing missing for it to close would be to add subresource Get, as I think there is no existing usage of subresource Delete.

Relative to #1922 the main changes are:

Use distinct options for subresource Update and Patch which makes this a breaking change
Add subresource Create, needed for example for ServiceAccount tokens

Supersedes and thereby closes #1922
Supersedes and thereby closes #2015

/cc @FillZpp @joelanford @sbueringer

k8s-ci-robot · 2022-11-28T02:50:37Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: alvaroaleman

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:

~~OWNERS~~ [alvaroaleman]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

pkg/client/options.go

pkg/client/typed_client.go

FillZpp · 2022-11-29T02:53:31Z

pkg/client/interfaces.go

-type StatusWriter interface {
+// SubResourceClient knows how to create a client which can update subresource
+// for kubernetes objects.
+type SubResourceClient interface {


Should we add a TODO comment for SubResourceReader and those non-CRUD subresources?

Not sure, I think by then we would rename the SubResourceWriter

This change adds a SubResourceWriter to the client package that can be used to Create, Update or Patch arbitrary subresources. Co-authored-by: Sergey Zagursky <gvozdoder@gmail.com>

FillZpp · 2022-11-30T09:15:34Z

/lgtm

FillZpp · 2022-11-30T09:27:57Z

Whoops, didn't notice it is approved, maybe I should have added a /hold. Not sure if someone else has any comment.

Ref: kubernetes-sigs/controller-runtime#2072

* Add additional SubResource* functions for FieldOwner This enhances #2072 to allow FieldOwner work with SubResources to set the FieldManager option. * Typos * Apply gofmt -s * Add tests for FieldOwner

Ref: kubernetes-sigs/controller-runtime#2072

- github.com/onsi/ginkgo/v2 v2.5.1 -> v2.7.0 - github.com/onsi/gomega v1.24.1 -> v1.26.0 - github.com/openshift/library-go v0.0.0-20221129182131-19da1bc0df5f -> v0.0.0-20221216200640-2a52b7ce52f9 - github.com/operator-framework/api v0.17.1 -> v0.17.3 - github.com/samber/lo v1.36.0 -> v1.37.0 - golang.org/x/tools v0.3.0 -> v0.4.0 - k8s.io/* v0.25.4 -> v0.26.1 - k8s.io/kube-openapi v0.0.0-20221123214604-86e75ddd809a -> v0.0.0-20221207184640-f3cff1453715 - sigs.k8s.io/controller-runtime v0.13.1 -> v0.14.1 - sigs.k8s.io/controller-tools v0.10.0 -> v0.11.1 Consume client.SubResourceWriter from sigs.k8s.io/controller-runtime, see: kubernetes-sigs/controller-runtime#2072 Signed-off-by: Simone Tiraboschi <stirabos@redhat.com>

Ref: kubernetes-sigs/controller-runtime#2072

- github.com/onsi/ginkgo/v2 v2.5.1 -> v2.7.0 - github.com/onsi/gomega v1.24.1 -> v1.26.0 - github.com/openshift/library-go v0.0.0-20221129182131-19da1bc0df5f -> v0.0.0-20221216200640-2a52b7ce52f9 - github.com/operator-framework/api v0.17.1 -> v0.17.3 - github.com/samber/lo v1.36.0 -> v1.37.0 - golang.org/x/tools v0.3.0 -> v0.4.0 - k8s.io/* v0.25.4 -> v0.26.1 - k8s.io/kube-openapi v0.0.0-20221123214604-86e75ddd809a -> v0.0.0-20221207184640-f3cff1453715 - sigs.k8s.io/controller-runtime v0.13.1 -> v0.14.1 - sigs.k8s.io/controller-tools v0.10.0 -> v0.11.1 Consume client.SubResourceWriter from sigs.k8s.io/controller-runtime, see: kubernetes-sigs/controller-runtime#2072 Signed-off-by: Simone Tiraboschi <stirabos@redhat.com>

This enhances kubernetes-sigs#2072 to allow FieldOwner work with SubResources to set the FieldManager option.

* Add additional SubResource* functions for FieldOwner This enhances #2072 to allow FieldOwner work with SubResources to set the FieldManager option. * Typos * Apply gofmt -s * Add tests for FieldOwner --------- Co-authored-by: David Schmitt <david.schmitt@overmind.tech>

Ref: kubernetes-sigs/controller-runtime#2072

…`v0.14.1` (#7248) * Update `k8s.io/*` to `v0.26.0` * Update `sigs.k8s.io/controller-runtime` to `v0.14.1` * Set `RecoverPanic` globally for the manager of `controller-manager` controllers * Set `RecoverPanic` globally for the manager of `gardenlet` controllers * Set `RecoverPanic` globally for the manager of `operator` controllers * Set `RecoverPanic` globally for the manager of `resource-manager` controllers * Set `RecoverPanic` globally for the manager of `scheduler` controllers * Set `RecoverPanic` globally in manager options for extension controllers * Change RecoverPanic bool to bool pointer for other controllers * Run `make generate` * Set `AllowInvalidLabelValueInSelector` to true in LabelSelectorValidationOptions for backwards compatibility See kubernetes/kubernetes#113699 for more details * Drop `Not` predicate util function in favor of controller-runtime `predicate.Not` * Drop `NewClientWithFieldSelectorSupport` function in favor of controller-runtime `WithIndex` function kubernetes-sigs/controller-runtime/pull/2025 * Use `Build()` function for all controllers * Use Subresource client for `shoots/binding` and drop generated clientset * Use Subresource client for `shoots/adminkubeconfig` and drop generated clientset * Use Status() client for Status Ref: kubernetes-sigs/controller-runtime#2072 * Adapt unit tests with mock StatusWriter * Add "ValidatingAdmissionPolicy" to default admission plugins * Adapt changes related to removed fields in kube-proxy config * Add unit test cases for "#IsAdmissionPluginSupported" function * Update envtest version * Return error from `informer.AddEventHandler` * Copy onsi/gomega/format package also to gomegacheck testdata * Address PR review feedback * Vendor current `etcd-druid` master * Use `builder.Watches()` wherever possible * Call `etcdOptions.Complete()` for gardener apiserver config etcd-encryption is supported out-of-the-box now. ref: kubernetes/kubernetes#112789 * Use Subresource client for `serviceaccounts/token` wherever possible * Update `ahmetb/gen-crd-api-reference-docs` to `0.3.0` * Update `sigs.k8s.io/controller-tools` to `v0.11.0` Update to `v0.11.1` once kubernetes/kubernetes/pull/114617 is released. In k8s v0.26.0 the CRD generation is broken. * Remove unneeded dependencies for `gardener-scheduler` from skaffold.yaml * Hardcode `RecoverPanic` to true for extensions controller * Use `k8s.io/apimachinery/pkg/util/sets` and drop copied packages * Drop ready check for garden informer sync for gardenlet Adding ready check to manager is not possible after it's started, since controller-runtime, `v0.11.0`. However the check was broken, and it is now fixed in kubernetes-sigs/controller-runtime#2090, so we have to drop this. * Adapt `provider-local` webhook * Address PR review feedback * Fix panic in ManagedSeed controller Contexts: from this PR, we're not setting RecoverPanic to true in tests * Vendor `etcd-druid` `v0.15.3` * Update `k8s.io/*` and `controller-runtime` k8s.io/* - 0.26.0=>0.26.1 controller-tools - 0.11.0=>0.11.1 * Run `make generate` * Rebase * Address PR review feedback * Fix failing test * Adapt `highavailabilityconfig` webhook integration test `autoscaling/v2beta2.HorizontalPodAutoscaler` is removed in v1.26. Ref: https://kubernetes.io/docs/reference/using-api/deprecation-guide/#v1-26 * Use `apiutil.NewDynamicRESTMapper` for Manager cache in tests Co-authored-by: Rafael Franzke <rafael.franzke@sap.com> * Don't set `RecoverPanic` for os extensions in AddToManager This is not required since we call `mgrOpts.Options()` here : https://github.com/gardener/gardener/blob/c9cb564d1adad0a1ecf9d44f23fb249bcf946a79/extensions/pkg/controller/operatingsystemconfig/oscommon/app/app.go#L88 * Truncate time in test to microsecond precision Ref: kubernetes/kubernetes#111936 * Rebase --------- Co-authored-by: Rafael Franzke <rafael.franzke@sap.com>

kubernetes-sigs/controller-runtime#2072

…`v0.14.1` (gardener#7248) * Update `k8s.io/*` to `v0.26.0` * Update `sigs.k8s.io/controller-runtime` to `v0.14.1` * Set `RecoverPanic` globally for the manager of `controller-manager` controllers * Set `RecoverPanic` globally for the manager of `gardenlet` controllers * Set `RecoverPanic` globally for the manager of `operator` controllers * Set `RecoverPanic` globally for the manager of `resource-manager` controllers * Set `RecoverPanic` globally for the manager of `scheduler` controllers * Set `RecoverPanic` globally in manager options for extension controllers * Change RecoverPanic bool to bool pointer for other controllers * Run `make generate` * Set `AllowInvalidLabelValueInSelector` to true in LabelSelectorValidationOptions for backwards compatibility See kubernetes/kubernetes#113699 for more details * Drop `Not` predicate util function in favor of controller-runtime `predicate.Not` * Drop `NewClientWithFieldSelectorSupport` function in favor of controller-runtime `WithIndex` function kubernetes-sigs/controller-runtime/pull/2025 * Use `Build()` function for all controllers * Use Subresource client for `shoots/binding` and drop generated clientset * Use Subresource client for `shoots/adminkubeconfig` and drop generated clientset * Use Status() client for Status Ref: kubernetes-sigs/controller-runtime#2072 * Adapt unit tests with mock StatusWriter * Add "ValidatingAdmissionPolicy" to default admission plugins * Adapt changes related to removed fields in kube-proxy config * Add unit test cases for "#IsAdmissionPluginSupported" function * Update envtest version * Return error from `informer.AddEventHandler` * Copy onsi/gomega/format package also to gomegacheck testdata * Address PR review feedback * Vendor current `etcd-druid` master * Use `builder.Watches()` wherever possible * Call `etcdOptions.Complete()` for gardener apiserver config etcd-encryption is supported out-of-the-box now. ref: kubernetes/kubernetes#112789 * Use Subresource client for `serviceaccounts/token` wherever possible * Update `ahmetb/gen-crd-api-reference-docs` to `0.3.0` * Update `sigs.k8s.io/controller-tools` to `v0.11.0` Update to `v0.11.1` once kubernetes/kubernetes/pull/114617 is released. In k8s v0.26.0 the CRD generation is broken. * Remove unneeded dependencies for `gardener-scheduler` from skaffold.yaml * Hardcode `RecoverPanic` to true for extensions controller * Use `k8s.io/apimachinery/pkg/util/sets` and drop copied packages * Drop ready check for garden informer sync for gardenlet Adding ready check to manager is not possible after it's started, since controller-runtime, `v0.11.0`. However the check was broken, and it is now fixed in kubernetes-sigs/controller-runtime#2090, so we have to drop this. * Adapt `provider-local` webhook * Address PR review feedback * Fix panic in ManagedSeed controller Contexts: from this PR, we're not setting RecoverPanic to true in tests * Vendor `etcd-druid` `v0.15.3` * Update `k8s.io/*` and `controller-runtime` k8s.io/* - 0.26.0=>0.26.1 controller-tools - 0.11.0=>0.11.1 * Run `make generate` * Rebase * Address PR review feedback * Fix failing test * Adapt `highavailabilityconfig` webhook integration test `autoscaling/v2beta2.HorizontalPodAutoscaler` is removed in v1.26. Ref: https://kubernetes.io/docs/reference/using-api/deprecation-guide/#v1-26 * Use `apiutil.NewDynamicRESTMapper` for Manager cache in tests Co-authored-by: Rafael Franzke <rafael.franzke@sap.com> * Don't set `RecoverPanic` for os extensions in AddToManager This is not required since we call `mgrOpts.Options()` here : https://github.com/gardener/gardener/blob/c9cb564d1adad0a1ecf9d44f23fb249bcf946a79/extensions/pkg/controller/operatingsystemconfig/oscommon/app/app.go#L88 * Truncate time in test to microsecond precision Ref: kubernetes/kubernetes#111936 * Rebase --------- Co-authored-by: Rafael Franzke <rafael.franzke@sap.com>

andriisoldatenko · 2024-10-17T13:35:21Z

In the original PR #1922, there was a problem with updating the finalizer.

Can someone please explain how to implement it with the new client.SubResourceWriter, assuming we want to update ONLY the finalizer of deployment and don't have permission to update the entire object?

Thanks in advance, and sorry for commenting merged PR.

sbueringer · 2024-10-19T11:20:12Z

I dont' know how to do it, but I would recommend opening a new issue. If that is already possible directly with client-go we might be able to infer from that how it could be done with the controller-runtime client.

I think in any case it would be good to have an example / test covering that scenario

k8s-ci-robot requested review from FillZpp, joelanford and sbueringer November 28, 2022 02:50

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Nov 28, 2022

k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Nov 28, 2022

alvaroaleman force-pushed the support-subresource-modification branch from 04f01e0 to 7620718 Compare November 28, 2022 03:06

padlar reviewed Nov 28, 2022

View reviewed changes

pkg/client/options.go Outdated Show resolved Hide resolved

padlar reviewed Nov 28, 2022

View reviewed changes

pkg/client/options.go Outdated Show resolved Hide resolved

alvaroaleman force-pushed the support-subresource-modification branch from 7620718 to 5f89d78 Compare November 28, 2022 23:03

FillZpp reviewed Nov 29, 2022

View reviewed changes

⚠️ Add client.SubResourceWriter

d7724aa

This change adds a SubResourceWriter to the client package that can be used to Create, Update or Patch arbitrary subresources. Co-authored-by: Sergey Zagursky <gvozdoder@gmail.com>

alvaroaleman force-pushed the support-subresource-modification branch from 5f89d78 to d7724aa Compare November 29, 2022 23:09

k8s-ci-robot assigned FillZpp Nov 30, 2022

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 30, 2022

k8s-ci-robot merged commit 262268f into kubernetes-sigs:master Nov 30, 2022

tenzen-y mentioned this pull request Dec 5, 2022

Backend for getting logs of a trial kubeflow/katib#2039

Merged

shafeeqes added a commit to shafeeqes/gardener that referenced this pull request Dec 20, 2022

Use Subresource client for Status

9872654

Ref: kubernetes-sigs/controller-runtime#2072

shafeeqes added a commit to shafeeqes/gardener that referenced this pull request Dec 20, 2022

Use Subresource client for Status

5275ed5

Ref: kubernetes-sigs/controller-runtime#2072

shafeeqes added a commit to shafeeqes/gardener that referenced this pull request Dec 20, 2022

Use Subresource client for Status

c753669

Ref: kubernetes-sigs/controller-runtime#2072

shafeeqes added a commit to shafeeqes/gardener that referenced this pull request Dec 20, 2022

Use Subresource client for Status

d4a90be

Ref: kubernetes-sigs/controller-runtime#2072

shafeeqes added a commit to shafeeqes/gardener that referenced this pull request Dec 20, 2022

Use Subresource client for Status

8f4bebc

Ref: kubernetes-sigs/controller-runtime#2072

shafeeqes added a commit to shafeeqes/gardener that referenced this pull request Dec 21, 2022

Use Status() client for Status

637a243

Ref: kubernetes-sigs/controller-runtime#2072

shafeeqes added a commit to shafeeqes/gardener that referenced this pull request Dec 21, 2022

Use Status() client for Status

47c716b

Ref: kubernetes-sigs/controller-runtime#2072

shafeeqes added a commit to shafeeqes/gardener that referenced this pull request Dec 21, 2022

Use Status() client for Status

656f8eb

Ref: kubernetes-sigs/controller-runtime#2072

shafeeqes added a commit to shafeeqes/gardener that referenced this pull request Dec 21, 2022

Use Status() client for Status

34de93f

Ref: kubernetes-sigs/controller-runtime#2072

shafeeqes added a commit to shafeeqes/gardener that referenced this pull request Dec 21, 2022

Use Status() client for Status

a18bcb8

Ref: kubernetes-sigs/controller-runtime#2072

shafeeqes added a commit to shafeeqes/gardener that referenced this pull request Jan 2, 2023

Use Status() client for Status

338bc5a

Ref: kubernetes-sigs/controller-runtime#2072

shafeeqes added a commit to shafeeqes/gardener that referenced this pull request Jan 9, 2023

Use Status() client for Status

b819206

Ref: kubernetes-sigs/controller-runtime#2072

Gchbg mentioned this pull request Jan 10, 2023

0.14.1 regression: cannot use server-side apply #2125

Closed

shafeeqes added a commit to shafeeqes/gardener that referenced this pull request Jan 11, 2023

Use Status() client for Status

f3608f1

Ref: kubernetes-sigs/controller-runtime#2072

shafeeqes added a commit to shafeeqes/gardener that referenced this pull request Jan 12, 2023

Use Status() client for Status

1529095

Ref: kubernetes-sigs/controller-runtime#2072

shafeeqes added a commit to shafeeqes/gardener that referenced this pull request Jan 16, 2023

Use Status() client for Status

1b90855

Ref: kubernetes-sigs/controller-runtime#2072

shafeeqes added a commit to shafeeqes/gardener that referenced this pull request Jan 19, 2023

Use Status() client for Status

8deb59a

Ref: kubernetes-sigs/controller-runtime#2072

shafeeqes added a commit to shafeeqes/gardener that referenced this pull request Jan 23, 2023

Use Status() client for Status

c50211c

Ref: kubernetes-sigs/controller-runtime#2072

shafeeqes added a commit to shafeeqes/gardener that referenced this pull request Jan 24, 2023

Use Status() client for Status

3de70e0

Ref: kubernetes-sigs/controller-runtime#2072

tiraboschi mentioned this pull request Jan 27, 2023

Bump to k8s.io v0.26.1 and related dependencies kubevirt/hyperconverged-cluster-operator#2221

Merged

11 tasks

shafeeqes added a commit to shafeeqes/gardener that referenced this pull request Jan 27, 2023

Use Status() client for Status

610e8b9

Ref: kubernetes-sigs/controller-runtime#2072

shafeeqes added a commit to shafeeqes/gardener that referenced this pull request Jan 30, 2023

Use Status() client for Status

aa8e54b

Ref: kubernetes-sigs/controller-runtime#2072

george-angel added a commit to utilitywarehouse/kube-applier that referenced this pull request Feb 6, 2023

Update to use SubResourceOptions

9334ef3

kubernetes-sigs/controller-runtime#2072

alculquicondor mentioned this pull request Mar 2, 2023

Patch option error: client.FieldOwner does not implement 'SubResourcePatchOption' #2204

Closed

birkland mentioned this pull request Mar 14, 2023

Bump controller-runtime to v0.14.x solo-io/skv2#420

Merged

pluser mentioned this pull request Apr 3, 2023

Update supporting Kubernetes (1.26) topolvm/topolvm#623

Closed

17 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

⚠️ Add client.SubResourceWriter #2072

⚠️ Add client.SubResourceWriter #2072

alvaroaleman commented Nov 28, 2022 •

edited

Loading

k8s-ci-robot commented Nov 28, 2022

FillZpp Nov 29, 2022

alvaroaleman Nov 29, 2022

FillZpp commented Nov 30, 2022

FillZpp commented Nov 30, 2022

andriisoldatenko commented Oct 17, 2024

sbueringer commented Oct 19, 2024

⚠️ Add client.SubResourceWriter #2072

⚠️ Add client.SubResourceWriter #2072

Conversation

alvaroaleman commented Nov 28, 2022 • edited Loading

k8s-ci-robot commented Nov 28, 2022

FillZpp Nov 29, 2022

Choose a reason for hiding this comment

alvaroaleman Nov 29, 2022

Choose a reason for hiding this comment

FillZpp commented Nov 30, 2022

FillZpp commented Nov 30, 2022

andriisoldatenko commented Oct 17, 2024

sbueringer commented Oct 19, 2024

alvaroaleman commented Nov 28, 2022 •

edited

Loading