Fix description of RBAC directives for external integrations #3167
Conversation
k8s-ci-robot
added
kind/documentation
|
Hi @dgrove-oss. 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 Once the patch is verified, the new status will be reflected by the 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-sigs/prow repository. |
k8s-ci-robot
added
needs-ok-to-test
✅ Deploy Preview for kubernetes-sigs-kueue ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
/ok-to-test |
k8s-ci-robot
added
ok-to-test
| ### Job Framework | ||
|
|
||
| Add a dependency on Kueue to your `go.mod`, import the `jobframework` and use it as described above to | ||
| create your controller and webhook implementations. In the `main` function of your controller, instantiate the controller-runtime manager | ||
| create your controller and webhook implementations. Note that in addition to adding RBAC Authorization for | ||
| your CRD as described above, you also need to add RBAC Authorizations for the Kueue CRDs that will be |
There was a problem hiding this comment.
it's not very clear what you mean by "above". Maybe you can reference the specific section.
There was a problem hiding this comment.
I reorganized and expanded a bit. Hopefully it isn't too detailed now, but at least it should be unambiguous :)
k8s-ci-robot
added
size/M
dgrove-oss
force-pushed
the
external-frameworks
branch
from
204b736
to
584c5d6
Compare
|
|
||
| ### Job Framework | ||
| Extend the existing webhook for your CRD to invoke Kueue's webhook helper methods: |
There was a problem hiding this comment.
FYI: I'm actually changing the details about this #3157
Although it refers to changes that will be included in the next release, so let's go with this for now.
There was a problem hiding this comment.
I was generally aware of #3132, but not following every detail. In the case of AppWrappers, our webhooks need to accomplish both a significant amount of AppWrapper-specific defaulting/validating and also do what Kueue needs done (currently by invoking the helper methods in job framework). Will that pattern still be supported?
There was a problem hiding this comment.
yup, that's still supported. And since you keep your go types up-to-date with your CRD version, you are ok with using controller-runtime's library to build the webhook.
k8s-ci-robot
added
the
lgtm
|
LGTM label has been added. Git tree hash: 8dedd3ecd26f2fc60ba41c1a126b7824ed307e5b
|
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: alculquicondor, dgrove-oss 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 |
k8s-ci-robot
added
the
approved
|
/cherry-pick website |
|
@tenzen-y: new pull request created: #3168 In response to this:
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. |
…tes-sigs#3167) * Fix description of RBAC directives for external integrations * rework external framework section based on review comments
What type of PR is this?
/kind documentation
What this PR does / why we need it:
Corrects the documentation for external framework RBAC changes. Discussion here.
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
Does this PR introduce a user-facing change?