⚠️ Add TypedReconciler #2799

alvaroaleman · 2024-04-26T21:03:41Z

This change adds a TypedReconciler which allows to customize the type being used in the workqueue. There is a number of situations where a custom type might be better than the default reconcile.Request:

Multi-Cluster controllers might want to put the clusters in there
Some controllers do not reconcile individual resources of a given type but all of them at once, for example IngressControllers might do this
Some controllers do not operate on Kubernetes resources at all

alvaroaleman · 2024-04-26T21:05:57Z

/hold
This needs some more testing

alvaroaleman · 2024-06-24T14:00:22Z

pkg/handler/eventhandler.go

@@ -64,70 +65,70 @@ type EventHandler TypedEventHandler[client.Object]
 // Most users shouldn't need to implement their own TypedEventHandler.
 //
 // TypedEventHandler is experimental and subject to future change.
-type TypedEventHandler[T any] interface {
+type TypedEventHandler[object any, request comparable] interface {


The main annoyance I found with this change for standard k8s controllers is this, when using a typed eventhandler to have the added typesafety in there it is now also needed to pass the request type. Removing it would mean it is impossible to use a custom request type with source.Kind though, which is for example useful when having watches in different clusters

pkg/source/source.go

alvaroaleman · 2024-06-24T14:03:01Z

I've tried this change with some internal projects and the changes required there were minimal and mostly around the interface change in TypedEventHandler. It is really cool to be able to use a custom request type and improves readability and type safety a lot in places where something other than the default is needed.

examples/typed/main.go

pkg/builder/controller.go

pkg/source/source.go

sbueringer

Really really nice work! :)

Two high-level points:

would be good to have consistent type parameter & corresponding argument names
might be good to take another look if we have enough test coverage for the new "Typed" types

examples/typed/main.go

pkg/handler/eventhandler.go

pkg/source/source.go

pkg/builder/controller.go

pkg/internal/controller/controller_test.go

pkg/reconcile/reconcile.go

pkg/source/source.go

This change adds a TypedReconciler which allows to customize the type being used in the workqueue. There is a number of situations where a custom type might be better than the default `reconcile.Request`: * Multi-Cluster controllers might want to put the clusters in there * Some controllers do not reconcile individual resources of a given type but all of them at once, for example IngressControllers might do this * Some controllers do not operate on Kubernetes resources at all

k8s-ci-robot · 2024-07-06T19:23:56Z

@alvaroaleman: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
pull-controller-runtime-apidiff	`64e0f0b`	link	false	`/test pull-controller-runtime-apidiff`

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

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-sigs/prow repository. I understand the commands that are listed here.

alvaroaleman · 2024-07-06T19:25:35Z

/hold cancel

k8s-ci-robot · 2024-07-06T22:31:17Z

LGTM label has been added.

Git tree hash: e68ce7d6eaa2729f0fc45cc1de0e7a62ef7512d7

k8s-ci-robot · 2024-07-06T22:31:24Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: alvaroaleman, 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:

~~OWNERS~~ [alvaroaleman,vincepri]

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

sbueringer · 2024-07-11T11:55:24Z

Nice additional example, thx for adding it!

- Changes to reconciler-related types pursuant to kubernetes-sigs/controller-runtime#2799 - Removal of yellow squiggles HIVE-2616

Related upstream change: - kubernetes-sigs/controller-runtime#2799

- Changes to reconciler-related types pursuant to kubernetes-sigs/controller-runtime#2799 - Removal of yellow squiggles HIVE-2616 (cherry picked from commit 08e4987)

…pdates (#943) * Update to support the TypedEventHandler interface Related upstream change: - kubernetes-sigs/controller-runtime#2799 * Support the sha512sum Sprig template function Bumps the gomod-backward-compatible group with 11 updates in the / directory: | Package | From | To | | --- | --- | --- | | [cloud.google.com/go/compute/metadata](https://github.com/googleapis/google-cloud-go) | `0.5.0` | `0.5.2` | | [github.com/Masterminds/sprig/v3](https://github.com/Masterminds/sprig) | `3.2.3` | `3.3.0` | | [github.com/gruntwork-io/terratest](https://github.com/gruntwork-io/terratest) | `0.47.0` | `0.47.2` | | [github.com/hashicorp/hcp-sdk-go](https://github.com/hashicorp/hcp-sdk-go) | `0.110.0` | `0.115.0` | | [github.com/onsi/gomega](https://github.com/onsi/gomega) | `1.34.1` | `1.34.2` | | [github.com/prometheus/client_golang](https://github.com/prometheus/client_golang) | `1.20.3` | `1.20.4` | | [golang.org/x/crypto](https://github.com/golang/crypto) | `0.26.0` | `0.27.0` | | [google.golang.org/api](https://github.com/googleapis/google-api-go-client) | `0.192.0` | `0.199.0` | | [k8s.io/apiextensions-apiserver](https://github.com/kubernetes/apiextensions-apiserver) | `0.30.3` | `0.31.1` | | [sigs.k8s.io/controller-runtime](https://github.com/kubernetes-sigs/controller-runtime) | `0.18.4` | `0.19.0` | | [nhooyr.io/websocket](https://github.com/nhooyr/websocket-old) | `1.8.11` | `1.8.17` | Updates `cloud.google.com/go/compute/metadata` from 0.5.0 to 0.5.2 - [Release notes](https://github.com/googleapis/google-cloud-go/releases) - [Changelog](https://github.com/googleapis/google-cloud-go/blob/main/CHANGES.md) - [Commits](googleapis/google-cloud-go@v0.5.0...auth/v0.5.2) Updates `github.com/Masterminds/sprig/v3` from 3.2.3 to 3.3.0 - [Release notes](https://github.com/Masterminds/sprig/releases) - [Changelog](https://github.com/Masterminds/sprig/blob/master/CHANGELOG.md) - [Commits](Masterminds/sprig@v3.2.3...v3.3.0) Updates `github.com/gruntwork-io/terratest` from 0.47.0 to 0.47.2 - [Release notes](https://github.com/gruntwork-io/terratest/releases) - [Commits](gruntwork-io/terratest@v0.47.0...v0.47.2) Updates `github.com/hashicorp/hcp-sdk-go` from 0.110.0 to 0.115.0 - [Release notes](https://github.com/hashicorp/hcp-sdk-go/releases) - [Changelog](https://github.com/hashicorp/hcp-sdk-go/blob/main/CHANGELOG.md) - [Commits](hashicorp/hcp-sdk-go@v0.110.0...v0.115.0) Updates `github.com/onsi/gomega` from 1.34.1 to 1.34.2 - [Release notes](https://github.com/onsi/gomega/releases) - [Changelog](https://github.com/onsi/gomega/blob/master/CHANGELOG.md) - [Commits](onsi/gomega@v1.34.1...v1.34.2) Updates `github.com/prometheus/client_golang` from 1.20.3 to 1.20.4 - [Release notes](https://github.com/prometheus/client_golang/releases) - [Changelog](https://github.com/prometheus/client_golang/blob/main/CHANGELOG.md) - [Commits](prometheus/client_golang@v1.20.3...v1.20.4) Updates `golang.org/x/crypto` from 0.26.0 to 0.27.0 - [Commits](golang/crypto@v0.26.0...v0.27.0) Updates `google.golang.org/api` from 0.192.0 to 0.199.0 - [Release notes](https://github.com/googleapis/google-api-go-client/releases) - [Changelog](https://github.com/googleapis/google-api-go-client/blob/main/CHANGES.md) - [Commits](googleapis/google-api-go-client@v0.192.0...v0.199.0) Updates `k8s.io/apiextensions-apiserver` from 0.30.3 to 0.31.1 - [Release notes](https://github.com/kubernetes/apiextensions-apiserver/releases) - [Commits](kubernetes/apiextensions-apiserver@v0.30.3...v0.31.1) Updates `k8s.io/apimachinery` from 0.30.3 to 0.31.1 - [Commits](kubernetes/apimachinery@v0.30.3...v0.31.1) Updates `k8s.io/client-go` from 0.30.3 to 0.31.1 - [Changelog](https://github.com/kubernetes/client-go/blob/master/CHANGELOG.md) - [Commits](kubernetes/client-go@v0.30.3...v0.31.1) Updates `k8s.io/utils` from 0.0.0-20230726121419-3b25d923346b to 0.0.0-20240711033017-18e509b52bc8 - [Commits](https://github.com/kubernetes/utils/commits) Updates `sigs.k8s.io/controller-runtime` from 0.18.4 to 0.19.0 - [Release notes](https://github.com/kubernetes-sigs/controller-runtime/releases) - [Changelog](https://github.com/kubernetes-sigs/controller-runtime/blob/main/RELEASE.md) - [Commits](kubernetes-sigs/controller-runtime@v0.18.4...v0.19.0) Updates `nhooyr.io/websocket` from 1.8.11 to 1.8.17 - [Release notes](https://github.com/nhooyr/websocket-old/releases) - [Commits](https://github.com/nhooyr/websocket-old/commits/v1.8.17) --- updated-dependencies: - dependency-name: cloud.google.com/go/compute/metadata dependency-type: direct:production update-type: version-update:semver-patch dependency-group: gomod-backward-compatible - dependency-name: github.com/Masterminds/sprig/v3 dependency-type: direct:production update-type: version-update:semver-minor dependency-group: gomod-backward-compatible - dependency-name: github.com/gruntwork-io/terratest dependency-type: direct:production update-type: version-update:semver-patch dependency-group: gomod-backward-compatible - dependency-name: github.com/hashicorp/hcp-sdk-go dependency-type: direct:production update-type: version-update:semver-minor dependency-group: gomod-backward-compatible - dependency-name: github.com/onsi/gomega dependency-type: direct:production update-type: version-update:semver-patch dependency-group: gomod-backward-compatible - dependency-name: github.com/prometheus/client_golang dependency-type: direct:production update-type: version-update:semver-patch dependency-group: gomod-backward-compatible - dependency-name: golang.org/x/crypto dependency-type: direct:production update-type: version-update:semver-minor dependency-group: gomod-backward-compatible - dependency-name: google.golang.org/api dependency-type: direct:production update-type: version-update:semver-minor dependency-group: gomod-backward-compatible - dependency-name: k8s.io/apiextensions-apiserver dependency-type: direct:production update-type: version-update:semver-minor dependency-group: gomod-backward-compatible - dependency-name: k8s.io/apimachinery dependency-type: direct:production update-type: version-update:semver-minor dependency-group: gomod-backward-compatible - dependency-name: k8s.io/client-go dependency-type: direct:production update-type: version-update:semver-minor dependency-group: gomod-backward-compatible - dependency-name: k8s.io/utils dependency-type: direct:production update-type: version-update:semver-patch dependency-group: gomod-backward-compatible - dependency-name: sigs.k8s.io/controller-runtime dependency-type: direct:production update-type: version-update:semver-minor dependency-group: gomod-backward-compatible - dependency-name: nhooyr.io/websocket dependency-type: direct:production update-type: version-update:semver-patch dependency-group: gomod-backward-compatible ... Signed-off-by: dependabot[bot] <[email protected]> --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Ben Ash <[email protected]>

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Apr 26, 2024

k8s-ci-robot requested review from inteon and joelanford April 26, 2024 21:03

k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Apr 26, 2024

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Apr 26, 2024

alvaroaleman force-pushed the workq branch from d1c4761 to 448ee81 Compare April 26, 2024 21:38

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label May 2, 2024

alvaroaleman force-pushed the workq branch from 448ee81 to da7a60e Compare May 2, 2024 21:30

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label May 2, 2024

alvaroaleman force-pushed the workq branch from da7a60e to 35fd053 Compare May 2, 2024 21:36

alvaroaleman mentioned this pull request May 28, 2024

✨ WIP: Cluster Provider and cluster-aware controllers #2726

Open

alvaroaleman force-pushed the workq branch 2 times, most recently from 92ddc15 to e8833b6 Compare June 22, 2024 17:47

alvaroaleman commented Jun 24, 2024

View reviewed changes

pkg/source/source.go Outdated Show resolved Hide resolved

sbueringer reviewed Jun 25, 2024

View reviewed changes

examples/typed/main.go Show resolved Hide resolved

pkg/builder/controller.go Outdated Show resolved Hide resolved

alvaroaleman force-pushed the workq branch 3 times, most recently from 2a4db5d to 40c6b5c Compare June 26, 2024 01:54

sbueringer mentioned this pull request Jun 27, 2024

✨ Bump to controller-runtime v0.19 & controller-tools v0.16 kubernetes-sigs/cluster-api#10803

Merged

sbueringer reviewed Jun 27, 2024

View reviewed changes

pkg/source/source.go Outdated Show resolved Hide resolved

sbueringer reviewed Jun 27, 2024

View reviewed changes

alvaroaleman force-pushed the workq branch 5 times, most recently from 2b0b941 to 0f3a3cb Compare June 28, 2024 22:17

alvaroaleman force-pushed the workq branch from 2cedc87 to e808196 Compare July 6, 2024 18:14

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 6, 2024

k8s-ci-robot requested a review from sbueringer July 6, 2024 18:14

alvaroaleman force-pushed the workq branch from e808196 to 64e0f0b Compare July 6, 2024 19:20

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 6, 2024

vincepri approved these changes Jul 6, 2024

View reviewed changes

k8s-ci-robot assigned vincepri Jul 6, 2024

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 6, 2024

k8s-ci-robot merged commit 33446bc into kubernetes-sigs:main Jul 6, 2024
8 of 9 checks passed

alvaroaleman deleted the workq branch July 7, 2024 14:08

naemono mentioned this pull request Aug 20, 2024

Upgrade to controller-runtime 0.19.0 elastic/cloud-on-k8s#8020

Merged

troy0820 mentioned this pull request Sep 9, 2024

Cannot install @latest version v0.19.0 due to dependencies issues #2939

Closed

tnthornton mentioned this pull request Sep 24, 2024

Remove references to controller-runtime/pkg/ratelimiter crossplane/crossplane-runtime#777

Closed

1 task

2uasimojo added a commit to 2uasimojo/hive that referenced this pull request Oct 1, 2024

controller-runtime v0.19.0 fixups (and de-linting)

f09e55c

- Changes to reconciler-related types pursuant to kubernetes-sigs/controller-runtime#2799 - Removal of yellow squiggles HIVE-2616

2uasimojo added a commit to 2uasimojo/hive that referenced this pull request Oct 3, 2024

controller-runtime v0.19.0 fixups (and de-linting)

483aaea

- Changes to reconciler-related types pursuant to kubernetes-sigs/controller-runtime#2799 - Removal of yellow squiggles HIVE-2616

2uasimojo added a commit to 2uasimojo/hive that referenced this pull request Oct 3, 2024

controller-runtime v0.19.0 fixups (and de-linting)

13c3da4

- Changes to reconciler-related types pursuant to kubernetes-sigs/controller-runtime#2799 - Removal of yellow squiggles HIVE-2616

2uasimojo added a commit to 2uasimojo/hive that referenced this pull request Oct 3, 2024

controller-runtime v0.19.0 fixups (and de-linting)

95848d4

- Changes to reconciler-related types pursuant to kubernetes-sigs/controller-runtime#2799 - Removal of yellow squiggles HIVE-2616

2uasimojo added a commit to 2uasimojo/hive that referenced this pull request Oct 3, 2024

controller-runtime v0.19.0 fixups (and de-linting)

59b50ac

- Changes to reconciler-related types pursuant to kubernetes-sigs/controller-runtime#2799 - Removal of yellow squiggles HIVE-2616

2uasimojo added a commit to 2uasimojo/hive that referenced this pull request Oct 3, 2024

controller-runtime v0.19.0 fixups (and de-linting)

52496e2

- Changes to reconciler-related types pursuant to kubernetes-sigs/controller-runtime#2799 - Removal of yellow squiggles HIVE-2616

2uasimojo added a commit to 2uasimojo/hive that referenced this pull request Oct 3, 2024

controller-runtime v0.19.0 fixups (and de-linting)

08e4987

- Changes to reconciler-related types pursuant to kubernetes-sigs/controller-runtime#2799 - Removal of yellow squiggles HIVE-2616

benashz added a commit to hashicorp/vault-secrets-operator that referenced this pull request Oct 4, 2024

Update to support the TypedEventHandler interface

5101df3

Related upstream change: - kubernetes-sigs/controller-runtime#2799

yash97 mentioned this pull request Dec 11, 2024

Updating api-machinery, client-go aws/amazon-vpc-resource-controller-k8s#493

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

⚠️ Add TypedReconciler #2799

⚠️ Add TypedReconciler #2799

alvaroaleman commented Apr 26, 2024

alvaroaleman commented Apr 26, 2024

alvaroaleman Jun 24, 2024

alvaroaleman commented Jun 24, 2024

sbueringer left a comment

k8s-ci-robot commented Jul 6, 2024

alvaroaleman commented Jul 6, 2024

k8s-ci-robot commented Jul 6, 2024

k8s-ci-robot commented Jul 6, 2024

sbueringer commented Jul 11, 2024

⚠️ Add TypedReconciler #2799

⚠️ Add TypedReconciler #2799

Conversation

alvaroaleman commented Apr 26, 2024

alvaroaleman commented Apr 26, 2024

alvaroaleman Jun 24, 2024

Choose a reason for hiding this comment

alvaroaleman commented Jun 24, 2024

sbueringer left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Jul 6, 2024

alvaroaleman commented Jul 6, 2024

k8s-ci-robot commented Jul 6, 2024

k8s-ci-robot commented Jul 6, 2024

sbueringer commented Jul 11, 2024