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

📖 Runtime SDK proposal #6181

Merged

Conversation

fabriziopandini
Copy link
Member

@fabriziopandini fabriziopandini commented Feb 21, 2022

What this PR does / why we need it:
This proposal introduces the Cluster API Runtime SDK, a set of rules, recommendations, and fundamental capabilities required to implement a new extensibility mechanism that will allow systems, products, and services built on top of Cluster API to interact with the Workload Cluster’s lifecycle.

Which issue(s) this PR fixes:
Fixes #5175

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Feb 21, 2022
@k8s-ci-robot k8s-ci-robot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Feb 21, 2022
@enxebre
Copy link
Member

enxebre commented Feb 23, 2022

Thanks @fabriziopandini looks great to me overall. I'm only missing some concrete good real world examples that users are having to workaround or lacking support today that would be solved by this powerful system, so it's clear what it's driving the effort. It'd be good if folks can chime in so we can flesh out the user stories with those concrete examples that are not solved today.

docs/proposals/20220221-runtime-SDK.md Outdated Show resolved Hide resolved
docs/proposals/20220221-runtime-SDK.md Outdated Show resolved Hide resolved
docs/proposals/20220221-runtime-SDK.md Outdated Show resolved Hide resolved
docs/proposals/20220221-runtime-SDK.md Show resolved Hide resolved
docs/proposals/20220221-runtime-SDK.md Show resolved Hide resolved
docs/proposals/20220221-runtime-SDK.md Outdated Show resolved Hide resolved
docs/proposals/20220221-runtime-SDK.md Show resolved Hide resolved
docs/proposals/20220221-runtime-SDK.md Outdated Show resolved Hide resolved
docs/proposals/20220221-runtime-SDK.md Outdated Show resolved Hide resolved
docs/proposals/20220221-runtime-SDK.md Show resolved Hide resolved
docs/proposals/20220221-runtime-SDK.md Outdated Show resolved Hide resolved
docs/proposals/20220221-runtime-SDK.md Outdated Show resolved Hide resolved
docs/proposals/20220221-runtime-SDK.md Outdated Show resolved Hide resolved
docs/proposals/20220221-runtime-SDK.md Outdated Show resolved Hide resolved
docs/proposals/20220221-runtime-SDK.md Outdated Show resolved Hide resolved
docs/proposals/20220221-runtime-SDK.md Outdated Show resolved Hide resolved
docs/proposals/20220221-runtime-SDK.md Show resolved Hide resolved
@elmiko
Copy link
Contributor

elmiko commented Mar 9, 2022

from community meeting on 9 march 2022,

comments have been addresses, please have another review to see if we can merge

@sbueringer
Copy link
Member

lgtm pending squash from my side

@enxebre
Copy link
Member

enxebre commented Mar 11, 2022

just a few questions, lgtm overall, no objections to proceed.

Copy link
Contributor

@killianmuldoon killianmuldoon left a comment

Choose a reason for hiding this comment

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

/lgtm

@k8s-ci-robot k8s-ci-robot added lgtm "Looks good to me", indicates that a PR is ready to be merged. and removed lgtm "Looks good to me", indicates that a PR is ready to be merged. labels Mar 17, 2022
docs/proposals/20220221-runtime-SDK.md Outdated Show resolved Hide resolved
docs/proposals/20220221-runtime-SDK.md Outdated Show resolved Hide resolved
@fabriziopandini
Copy link
Member Author

as per March 23th office hours discussion we are setting a lazy consensus deadline for the 1st of April

Copy link
Member

@vincepri vincepri left a comment

Choose a reason for hiding this comment

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

LGTM

docs/proposals/20220221-runtime-SDK.md Outdated Show resolved Hide resolved
docs/proposals/20220221-runtime-SDK.md Outdated Show resolved Hide resolved
docs/proposals/20220221-runtime-SDK.md Outdated Show resolved Hide resolved
Copy link
Contributor

@alexander-demicev alexander-demicev left a comment

Choose a reason for hiding this comment

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

I'm happy to see the project is moving in this direction! I think there is one more thing that can be mentioned in the proposal. If hooks API structures are meant to be reused by other projects, we should keep the package that contains them separated from controller-runtime or any other dependencies if possible. Even with lazy load, go will fetch dependencies for the entire package. In order to avoid this coupling, webhooks or any helpers can be placed in separate packages.

@sbueringer
Copy link
Member

sbueringer commented Mar 31, 2022

I'm happy to see the project is moving in this direction! I think there is one more thing that can be mentioned in the proposal. If hooks API structures are meant to be reused by other projects, we should keep the package that contains them separated from controller-runtime or any other dependencies if possible. Even with lazy load, go will fetch dependencies for the entire package. In order to avoid this coupling, webhooks or any helpers can be placed in separate packages.

I assume you are referring to things like the Request/Response types we will use for the Runtime Hooks?

The current plan is that those can be used to implement Runtime Extensions. The current idea is to put them into a similar package structure like our regular API types (api/{v1alpha1,v1alpha2}). As far as I'm aware we don't need a dependency to controller-runtime in those API packages (in contrast to the regular API types we don't have to implement CR interfaces for conversion / admission webhooks).

P.S. Other things surfaced in this proposal like catalog / registry will definitely be in separate non-versioned packages. Same applies to other utils.

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 31, 2022
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 1, 2022
@fabriziopandini
Copy link
Member Author

fixed last round of nits and squashed commits

@sbueringer
Copy link
Member

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 1, 2022
@killianmuldoon
Copy link
Contributor

//lgtm

Copy link
Contributor

@elmiko elmiko left a comment

Choose a reason for hiding this comment

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

this looks really thorough to me, thanks for all the hard work
/lgtm

Copy link
Member

@vincepri vincepri left a comment

Choose a reason for hiding this comment

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

/approve
/lgtm
/hold

for other reviewers

@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 Apr 4, 2022
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: 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 Apr 4, 2022
@fabriziopandini
Copy link
Member Author

/hold cancel
given that lazy consensus deadline is expired

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 "Looks good to me", indicates that a PR is ready to be merged. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

RFE: Runtime Extensions