Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from Mar 30, 2022

Conversation

aphistic
Copy link
Contributor

@aphistic aphistic commented Mar 24, 2022

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
Copy link

linux-foundation-easycla bot commented Mar 24, 2022

CLA Signed

The committers listed above are authorized under a signed CLA.

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

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Mar 24, 2022
@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Mar 24, 2022

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 k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Mar 24, 2022
@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Mar 24, 2022

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.

@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Mar 24, 2022
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Mar 24, 2022
@FillZpp
Copy link
Contributor

FillZpp commented Mar 28, 2022

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Mar 28, 2022
Copy link
Member

@vincepri vincepri left a comment

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
Copy link
Member

vincepri commented Mar 30, 2022

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Mar 30, 2022
@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Mar 30, 2022

[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:

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 30, 2022
@k8s-ci-robot k8s-ci-robot merged commit b921952 into kubernetes-sigs:master Mar 30, 2022
9 checks passed
@k8s-ci-robot k8s-ci-robot added this to the v0.10.x milestone Mar 30, 2022
@aphistic
Copy link
Contributor Author

aphistic commented Mar 30, 2022

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. =/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm Indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants