Skip to content

docs: add volcano plugin guides#499

Open
hemantch01 wants to merge 2 commits into
volcano-sh:masterfrom
hemantch01:docs/add-volcano-plugin-guides
Open

docs: add volcano plugin guides#499
hemantch01 wants to merge 2 commits into
volcano-sh:masterfrom
hemantch01:docs/add-volcano-plugin-guides

Conversation

@hemantch01
Copy link
Copy Markdown

@hemantch01 hemantch01 commented May 10, 2026

  • The commit message follows our guidelines
  • What kind of change does this PR introduce? /kind documentation

  • What this PR does / why we need it:
    This PR finalizes and adds the missing user guides for the core Volcano scheduling plugins (Binpack, NodeOrder, Predicates, Priority, SLA, and TDM). All guides follow the standard maintainer frontmatter and structure, and have been locally verified on a Minikube cluster.

  • Which issue(s) this PR fixes:
    Fixes [Docs] Missing User Guides for core scheduling plugins (Binpack, NodeOrder, Priority, etc.) #498

Screenshot 2026-05-10 143526 Screenshot 2026-05-10 150238

Signed-off-by: hemantch01 <hemantchaudhary905@gmail.com>
…s, priority, sla, tdm)

Signed-off-by: hemantch01 <hemantchaudhary905@gmail.com>
@volcano-sh-bot
Copy link
Copy Markdown
Collaborator

[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 thor-wl for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Details 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

@volcano-sh-bot volcano-sh-bot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label May 10, 2026
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces a comprehensive set of user guides for various Volcano scheduler plugins, including Binpack, DRF, Gang, NodeOrder, Predicates, Priority, Proportion, SLA, and TDM. The review feedback identifies configuration errors in the Gang plugin documentation regarding argument nesting and naming, and highlights the missing 'preempt' action in the TDM plugin's scheduler configuration example.

Comment on lines +33 to +34
- name: gang
enablePreemptable: false
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The configuration for the gang plugin is missing the arguments key. In Volcano, plugin-specific configurations must be nested under arguments. Additionally, the standard argument name for controlling preemption in the gang plugin is gang.preemptable rather than enablePreemptable.

Suggested change
- name: gang
enablePreemptable: false
- name: gang
arguments:
gang.preemptable: false

namespace: volcano-system
data:
volcano-scheduler.conf: |
actions: "enqueue, allocate, backfill"
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The preempt action is missing from the actions list. The TDM plugin relies on the preempt action to trigger the eviction of workloads when the time window expires, as described in the Verification section.

Suggested change
actions: "enqueue, allocate, backfill"
actions: "enqueue, allocate, preempt, backfill"

@hemantch01 hemantch01 changed the title Docs/add volcano plugin guides docs: add volcano plugin guides May 11, 2026
@JesseStutler
Copy link
Copy Markdown
Member

Thanks for your great work, but I prefer not to put plugins related docs under user guide, but to set the plugin as the second menu and then put all plugin related docs into it. We can first wait until #493 merged and then continue refactoring

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

Labels

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.

[Docs] Missing User Guides for core scheduling plugins (Binpack, NodeOrder, Priority, etc.)

3 participants