Skip to content

Fix Volcano instaillation guide/ Add gang scheduling configuration in /config dir / Add unit test #611

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.

Sign up for GitHub

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

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

Fix Volcano instaillation guide/ Add gang scheduling configuration in /config dir / Add unit test #611

wants to merge 1 commit into from

Conversation

@JesseStutler
Copy link
Contributor

What type of PR is this?

/kind documentation
/kind feature

What this PR does / why we need it

  1. Fix Volcano installation guide, The current README does not include the steps for configuring the Volcano clusterrole if users use kubectl to install lws.
  2. Add gang scheduling configuration in /config dir, following the recommendation as @ardaguclu Add Gang Scheduling Support for lws and volcano implementation example #498 (comment)
  3. Add unit test for CalculatePGMinResources, following the comment as @kerthcet Add Gang Scheduling Support for lws and volcano implementation example #498 (comment)

Which issue(s) this PR fixes

NONE

Special notes for your reviewer

Does this PR introduce a user-facing change?

NONE

@k8s-ci-robot k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature. labels Aug 7, 2025
@netlify
Copy link

netlify bot commented Aug 7, 2025 •
edited
Loading

✅ Deploy Preview for kubernetes-sigs-lws ready!

Name Link
🔨 Latest commit f39e027
🔍 Latest deploy log https://app.netlify.com/projects/kubernetes-sigs-lws/deploys/68a1e5e9f1ce9100080f8894
😎 Deploy Preview https://deploy-preview-611--kubernetes-sigs-lws.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

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

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: JesseStutler
Once this PR has been reviewed and has the lgtm label, please assign kerthcet 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 needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Aug 7, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @JesseStutler. 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-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Aug 7, 2025
@JesseStutler
Copy link
Contributor Author

/cc @kerthcet @ardaguclu

@k8s-ci-robot k8s-ci-robot requested a review from kerthcet August 7, 2025 03:07
@LuyuZhang00
Copy link
Contributor

LuyuZhang00 commented Aug 8, 2025 •
edited
Loading

Gang-scheduling is an important feature. It would be better if you could update the examples in site/content/en/docs/.

@JesseStutler
Copy link
Contributor Author

Gang-scheduling is an important feature. It would be better if you could update the examples in site/content/en/docs/.

@LuyuZhang00 Yes I will also add content to site in later PRs, otherwise this PR may contain too many seperate contents

@yankay
Copy link
Member

yankay commented Aug 11, 2025

/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 Aug 11, 2025
ardaguclu
ardaguclu reviewed Aug 11, 2025
View reviewed changes
config/rbac/role.yaml Outdated
- get
- patch
- update
# If you want to enable gang scheduling with volcano, you need to uncomment the following section
Copy link
Contributor

Choose a reason for hiding this comment

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

In my opinion, this role can be located under its dedicated file in https://github.com/kubernetes-sigs/lws/tree/main/config/rbac. User just needs to enable it in here https://github.com/kubernetes-sigs/lws/blob/main/config/rbac/kustomization.yaml (by default it can be commented out). This would align more kustomize way.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure, thanks for your suggestion. I have modified now, please check

@JesseStutler
1. Fix Volcano installation guide
f39e027 
2. Add gang scheduling configuration in /config dir
3. Add unit test for CalculatePGMinResources

Signed-off-by: JesseStutler <[email protected]>
@JesseStutler JesseStutler requested a review from ardaguclu August 17, 2025 14:24
@kerthcet
Copy link
Contributor

/assign

@yankay yankay mentioned this pull request Sep 1, 2025
Open
yankay
yankay reviewed Sep 1, 2025
View reviewed changes
config/rbac/volcano_rbac.yaml
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
name: lws-volcano-role
Copy link
Member

Choose a reason for hiding this comment

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

HI @JesseStutler

If we can avoid creating a new ClusterRole lws-volcano-role here and instead reuse an existing ClusterRole, it would be more consistent with Helm.
Then we can use the patches mechanism in config/default/kustomization.yaml.

Would this be better?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

#611 (comment), at first I add the volcano related cluster role in the config/rbac/role.yaml but @ardaguclu suggested that I can seperate a lws-volcano-role so I followed it. So what should I do now 😂

Copy link
Contributor

Choose a reason for hiding this comment

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

If we update role.yaml, in any case this role will be added. But this functionality is optional. So that in my opinion it is better to have it separately.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Edwinhr716 Edwinhr716 Awaiting requested review from Edwinhr716

@kerthcet kerthcet Awaiting requested review from kerthcet

@ardaguclu ardaguclu Awaiting requested review from ardaguclu

1 more reviewer

@yankay yankay yankay left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@kerthcet kerthcet

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@JesseStutler @k8s-ci-robot @LuyuZhang00 @yankay @kerthcet @ardaguclu