Skip to content

🌱 add mboersma and richardcase as MachinePool reviewers #12263

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jackfrancis
Copy link
Contributor

@jackfrancis jackfrancis commented May 21, 2025

What this PR does / why we need it:

This PR reorganizes the MachinePool controller code organizations to match other controllers (e.g., Machine) in order to better tag @mboersma and @richardcase as reviewers as we work on the v1beta2 MachinePool efforts:

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label May 21, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign enxebre for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found 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 do-not-merge/needs-area PR is missing an area label label May 21, 2025
@k8s-ci-robot
Copy link
Contributor

This PR is currently missing an area label, which is used to identify the modified component when generating release notes.

Area labels can be added by org members by writing /area ${COMPONENT} in a comment

Please see the labels list for possible areas.

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.

@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label May 21, 2025
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 21, 2025
@fabriziopandini
Copy link
Member

TBH, considering that consistency across different API objects is a major theme of the ongoing work for v1beta2, I would prefer that we keep the current model that ensured that any change to the API surface is vetted from top level approvers; same goes for the contract documentation.

I have no objection instead to adding separated owner files to other folders where most of the work will happen (MP controllers, MP web hooks, Machine pool implementation CAPD).

Also, as a data point, according to https://cluster-api.sigs.k8s.io/contributing#contributors-ladder we introduced sub-level owner files in 2021, revamped it in 2022; based on what I saw in those years, the major benefit that sub-level files are producing is to provide a little bit of visibility and public recognition to active contributors; so far instead impacts on PR speed are not relevant or none at all (in other words, I don't see the owners file structure as a limitation or a blocker for the work in front of us).

@sbueringer
Copy link
Member

sbueringer commented May 22, 2025

but should enable more rapid collaboration for work items that are isolated to that code.

I'm not sure if approver bandwith is a problem at this point (at least I"m not aware of PRs that suffer from that at the moment).

I think it won't slow down the effort if PRs are reviewed between MachinePool reviewers and then a top-level approver adds a final approve.

Please also note that usually approver access is granted after folks demonstrate continuous contributions (including reviews) in the corresponding area over time and not ahead of time.

I'm fine with adding owner files to MachinePool directories and I would start with reviewer permissions. Even that is usually only done after a continuous history of reviews

@fabriziopandini
Copy link
Member

Note: Machine pool will end up into /api/core folder with #12262

@jackfrancis
Copy link
Contributor Author

@fabriziopandini @sbueringer appreciate the detailed feedback, that all makes sense.

Given that there aren't really MP-specific directories, there is probably not an OWNERS file solution here. Another benefit besides PR velocity (which you both have outlined these changes won't really improve) is auto-notifications, when a MP-affecting change lands, it'd be convenient to automatically tag Richard and Matt for reviews. But it sounds like the current arrangement of maintainers manually tagging them will work fine as well.

I don't see a way that we could modify this PR and feel confident that it will materially improve the v1beta2 effort. Do we all agree we should close this one?

@sbueringer
Copy link
Member

sbueringer commented May 22, 2025

I think one thing we can do is move some code around to move machinepool and CAPD DockerMachinePool controller code into machinepool directories and add Owner files there

We already have this folder structure for most of our other controllers: https://github.com/kubernetes-sigs/cluster-api/tree/8ca7179f801a2e9f6d39f4c1bb8a2e92e1f10dd0/internal/controllers
(So this would be a good thing to do anyway and should be low effort)

This should get Richard and Matt pinged for most MP PRs and it's also still a good way to signal ownership (I would just start with reviewer and then later promote to approver)

We also gradually wanted to get rid of the exp folders anyway. I can provide more details of what I would move around exactly if there's interest to do that

@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels May 22, 2025
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 22, 2025
@jackfrancis jackfrancis force-pushed the exp-api-owners branch 2 times, most recently from 9aa41f7 to 65df838 Compare May 22, 2025 16:48
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels May 22, 2025
@jackfrancis
Copy link
Contributor Author

/retitle add mboersma and richardcase as MachinePool reviewers

@k8s-ci-robot k8s-ci-robot changed the title 🌱 add mboersma and richardcase as exp API owners add mboersma and richardcase as MachinePool reviewers May 22, 2025
@jackfrancis jackfrancis changed the title add mboersma and richardcase as MachinePool reviewers 🌱 add mboersma and richardcase as MachinePool reviewers May 22, 2025
@@ -24,7 +24,7 @@ import (
"sigs.k8s.io/controller-runtime/pkg/controller"

"sigs.k8s.io/cluster-api/controllers/clustercache"
machinepool "sigs.k8s.io/cluster-api/exp/internal/controllers"
"sigs.k8s.io/cluster-api/exp/internal/controllers/machinepool"
Copy link
Member

@fabriziopandini fabriziopandini May 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I got Stefan's comment right, this should be "sigs.k8s.io/cluster-api/internal/controllers/machinepool" (without exp)

Same for CAPD

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we're okay with that

Copy link
Member

@sbueringer sbueringer May 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CAPD should be test/infrastructure/docker/internal/controllers/dockermachinepool/

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I took @sbueringer's suggestion

I think one thing we can do is move some code around to move machinepool and CAPD DockerMachinePool controller code into machinepool directories and add Owner files there

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't realize we were ready to move out of exp, happy to do that if we want to (and can rename to dockermachinepool)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I let Fabrizio decide

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CAPD doesn't have yet a folder for each controller, let's move the content of test/infrastructure/docker/exp/internal/controllers to test/infrastructure/docker/internal/controllers and rename files as dockermachinepool as suggested by Jack (we can add Matt and Richard into cluster-api-test-reviewers too)

Also, what about the webhooks folders

Copy link
Member

@sbueringer sbueringer May 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if we need that fine-granular owner ship in webhooks too. We have the same question for APIs and then the next question is: what if any of that code uses shared code.

I think for now I would mostly stick to the MP controller code

In general OWNERS might also allow ownership on a per-file level. But IIRC this broke a few years ago and I'm not sure if that's fixed already

We also have MP code sprinkled around the rest of the code base. E.g. e2e tests. I think for those cases top-level maintainers can always help out with an approve. Shouldn't prevent MP reviewers/approvers to do initial reviews / approves

Like we do in other repositories where we own config, but not actually have approver permissions everywhere (e.g. test-infra)

@sbueringer
Copy link
Member

/hold
We want to merge #12262 first (probably we're merging 12262 tomorrow)

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label May 22, 2025
Signed-off-by: Jack Francis <jackfrancis@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. do-not-merge/needs-area PR is missing an area label size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants