✨ [WIP] Add BaseContext to manager Options for use with Runnables

[aphistic]

This PR adds a new BaseContext option to manager.Options. It's designed to be used as the basis of any Runnables created by a Manager, so there's a way to connect the contexts from the user's side to the Runnable side. Currently a new context.Background() is created so the Runnables aren't canceled when a top-level context is, so this provides a way for a user to put info in their Runnable contexts.

There's a discussion about this in #1817, and this PR closes #1817.

I've marked this as a WIP because the functionality works fine through anecdotal usage, but I'm unable to run the tests locally using the recommended make test, so I can't add any tests for this at the moment. I brought it up in the #controller-runtime Slack channel but haven't seen any responses yet.

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: aphistic / name: Kristin Davidson (7f57edc)

[k8s-ci-robot]

Welcome @aphistic!

It looks like this is your first PR to kubernetes-sigs/controller-runtime 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/controller-runtime has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

[k8s-ci-robot]

Hi @aphistic. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

[FillZpp]

/ok-to-test

[vincepri]

Hi @aphistic apologies for the delay in answering. The changes in this PR look good and I'm completely fine merging it in, it gives ultimate control to the caller and retains current functionality.

The main reason we need a context that's separate from the main start one is to control the stop procedure in a really specific order.

[vincepri]

/lgtm

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: aphistic, 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 [vincepri]

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

[aphistic]

Hi @aphistic apologies for the delay in answering. The changes in this PR look good and I'm completely fine merging it in, it gives ultimate control to the caller and retains current functionality.

The main reason we need a context that's separate from the main start one is to control the stop procedure in a really specific order.

Hi @vincepri! My main concern about it is that I wasn't able to add any tests for it to validate that the BaseContext is being connected through to the Runnable. I'm happy to see it merged, but I could add these tests if I could get make test to run locally for me. I keep running into linting errors that don't make any sense. =/