Allow configuring a cache sync timeout

[alvaroaleman]

Currently when a cache can not be synced (for example due to misconfigured rbac) the Controller will just block indefinitely/until the binary gets stopped:

controller-runtime/pkg/internal/controller/controller.go

Line 172 in 5c2b42d

if err := syncingSource.WaitForSync(ctx); err != nil {

As an author of controllers I want to configure a timeout for this and want my Controller to error out if its unable to sync its caches within this timeout.

[vincepri]

/help
/milestone v0.7.x

[k8s-ci-robot]

@vincepri:
This request has been marked as needing help from a contributor.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help command.

In response to this:

/help
/milestone v0.7.x

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.

[varshaprasad96]

Hi @alvaroaleman , I would like to work on this issue. Would the implementation be to:

• Wrap WaitForSync to pass a Context with a timeout so that the ctx is cancelled when WaitForCacheSync is called.
• include a Timeout variable in the controller which falls back to a default value if not set by the user.

Is this the right approach for the implementation?

[alvaroaleman]

@varshaprasad96 yes, that sounds exactly right

[varshaprasad96]

/assign