Skip to content

docs: clarify deserved/guarantee vs capability in hierarchical queues#543

Open
aeron-gh wants to merge 2 commits into
volcano-sh:masterfrom
aeron-gh:docs/hierarchical-queue-resource-bounds
Open

docs: clarify deserved/guarantee vs capability in hierarchical queues#543
aeron-gh wants to merge 2 commits into
volcano-sh:masterfrom
aeron-gh:docs/hierarchical-queue-resource-bounds

Conversation

@aeron-gh

Copy link
Copy Markdown

The HierarchicalQueue page explained how capability behaves when unset (it inherits up to the root queue's cluster-total default) but said nothing about deserved/guarantee. This reworks the trailing section to add that: deserved/guarantee are lower bounds that default to 0, so a child cannot set them for a dimension its parent has not set, while capability is an upper bound.

This is the lower-bound vs upper-bound distinction @hajnalmt described in volcano-sh/volcano#5634.

Fixes #542

The HierarchicalQueue page explained how capability behaves when a queue
does not set it (it inherits up to the root queue's cluster-total
default) but said nothing about deserved/guarantee when unset. Reword the
trailing section so the lower-bound (deserved/guarantee, unset means 0)
vs upper-bound (capability) behavior is clear, including that a child
cannot set deserved/guarantee for a dimension its parent has not set.

Signed-off-by: aeron-gh <[email protected]>
@volcano-sh-bot volcano-sh-bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 13, 2026
@volcano-sh-bot
volcano-sh-bot requested review from Thor-wl and k82cn July 13, 2026 21:36
@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

Copy link
Copy Markdown
Collaborator

Welcome @aeron-gh! It looks like this is your first PR to volcano-sh/website 🎉

@volcano-sh-bot volcano-sh-bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Jul 13, 2026

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

Copy link
Copy Markdown

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 updates the documentation in HierarchicalQueue.md to clarify how deserved, guarantee, and capability resource fields behave under the queue hierarchy. The reviewer pointed out that the corresponding Chinese translation file should also be updated to maintain consistency.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread docs/KeyFeatures/HierarchicalQueue.md
@aeron-gh
aeron-gh marked this pull request as ready for review July 13, 2026 21:43
@volcano-sh-bot volcano-sh-bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 13, 2026
Keep the Chinese page in sync with the English one, reusing its existing
wording and adding the same lower-bound (deserved/guarantee) vs
upper-bound (capability) explanation.

Signed-off-by: aeron-gh <[email protected]>
@volcano-sh-bot volcano-sh-bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jul 15, 2026
@aeron-gh

Copy link
Copy Markdown
Author

@hajnalmt this is the docs change from volcano-sh/volcano#5634 :
the HierarchicalQueue page now spells out the lower-bound (deserved/guarantee) vs upper-bound (capability) behavior, and the zh-Hans copy is updated to match so both stay in sync.

@yashisrani would appreciate your eyes too if you have a moment.

@yashisrani

yashisrani commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

@aeron-gh Thanks for improving this section.
The new explanation makes the hierarchy rules much clearer. The English and Chinese versions are consistent, and the restructuring into separate bullets improves readability.

Nice improvement!

@yashisrani

Copy link
Copy Markdown
Contributor

/lgtm

@volcano-sh-bot volcano-sh-bot added the lgtm Indicates that a PR is ready to be merged. label Jul 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lgtm Indicates that a PR is ready to be merged. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

HierarchicalQueue docs don't explain deserved/guarantee behavior when unset

3 participants