HMC and velero controller-runtime versions are incompatible

[zerospiel]

Context
The github.com/Mirantis/hmc module currently has sigs.k8s.io/[email protected] direct dependency along with the github.com/vmware-tanzu/[email protected], the latter utilizes sigs.k8s.io/[email protected].

Problem
These two versions of the CR have breaking changes hence importing any packages except API-related is not possible because the dependency tree cannot be resolved due to the aforementioned changes. To be precise the following are the errors produced during the go build of the hmc binary:

# github.com/vmware-tanzu/velero/pkg/util/kube
../../../../pkg/mod/github.com/vmware-tanzu/[email protected]/pkg/util/kube/event_handler.go:34:9: cannot use &enqueueRequestsFromMapFunc{…} (value of type *enqueueRequestsFromMapFunc) as handler.TypedEventHandler["sigs.k8s.io/controller-runtime/pkg/client".Object, reconcile.Request] value in return statement: *enqueueRequestsFromMapFunc does not implement handler.TypedEventHandler["sigs.k8s.io/controller-runtime/pkg/client".Object, reconcile.Request] (wrong type for method Create)
                have Create(context.Context, event.TypedCreateEvent["sigs.k8s.io/controller-runtime/pkg/client".Object], workqueue.RateLimitingInterface)
                want Create(context.Context, event.TypedCreateEvent["sigs.k8s.io/controller-runtime/pkg/client".Object], workqueue.TypedRateLimitingInterface[reconcile.Request])
../../../../pkg/mod/github.com/vmware-tanzu/[email protected]/pkg/util/kube/event_handler.go:39:30: cannot use &enqueueRequestsFromMapFunc{} (value of type *enqueueRequestsFromMapFunc) as handler.TypedEventHandler["sigs.k8s.io/controller-runtime/pkg/client".Object, reconcile.Request] value in variable declaration: *enqueueRequestsFromMapFunc does not implement handler.TypedEventHandler["sigs.k8s.io/controller-runtime/pkg/client".Object, reconcile.Request] (wrong type for method Create)
                have Create(context.Context, event.TypedCreateEvent["sigs.k8s.io/controller-runtime/pkg/client".Object], workqueue.RateLimitingInterface)
                want Create(context.Context, event.TypedCreateEvent["sigs.k8s.io/controller-runtime/pkg/client".Object], workqueue.TypedRateLimitingInterface[reconcile.Request])

Resolution/DOD
The CR version in velero should be bumped at least to 0.19.0 (higher is better), and change the current implementation of the event handler here according to the updated interface in the CR.

After bumping the minimal requirement, we have to bump velero module at least to the development branch, and waiting until a new tag has the updated CR version would be much better.

[s3rj1k]

Before any action can be taken for upstream, we should verify that bumping sigs.k8s.io/controller-runtime to v0.19.x does not break expected compatibility-matrix https://github.com/vmware-tanzu/velero?tab=readme-ov-file#velero-compatibility-matrix, meaning for v1.15 it is expected that Kubernetes versions from 1.18 till latest are operational.

[s3rj1k]

Related change by @zerospiel zerospiel/velero@5818629

[zerospiel]

Just to note: the aforementioned change is a kludge to make it work in the fork, nothing more, the actual implementation should contain generics

[s3rj1k]

Community page: https://velero.io/community/

[s3rj1k]

vmware-tanzu/velero#8513 (comment)