Skip to content

docs(capacity): document ancestor reclaim level#530

Open
hajnalmt wants to merge 1 commit into
volcano-sh:masterfrom
hajnalmt:docs/capacity-ancestor-reclaim-level
Open

docs(capacity): document ancestor reclaim level#530
hajnalmt wants to merge 1 commit into
volcano-sh:masterfrom
hajnalmt:docs/capacity-ancestor-reclaim-level

Conversation

@hajnalmt

Copy link
Copy Markdown
Member
  • Please check if the PR fulfills these requirements
  • The commit message follows our guidelines
  • What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
    /kind documentation

  • What this PR does / why we need it:
    Documents the capacity plugin ancestorReclaimLevel argument in the Hierarchical Queue guide.

The update keeps the base scheduler configuration focused on enabling hierarchical queues, adds ancestorReclaimLevel only in the dedicated “Configure Ancestor Reclaim Scope” section, and places the detailed “Understanding ancestorReclaimLevel” explanation after “Building Hierarchical Queues”. It also adds concrete queue and pod reclaim scenarios with Mermaid diagrams, including explicit a100=1 requests for the running pods in the A100 examples.

AI assistance was used for drafting and local verification. The final wording and structure needed substantial human steering and review; hajnalmt had to hammer the assistant quite a lot to keep the placement, semantics, and examples aligned with the intended documentation change.

Related: volcano-sh/volcano#5115

@volcano-sh-bot volcano-sh-bot added the kind/documentation Categorizes issue or PR as related to documentation. label Jun 12, 2026
@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 jessestutler 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/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jun 12, 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 for hierarchical queues in Volcano (both current and versioned docs) to explain the configuration and behavior of the ancestorReclaimLevel parameter. It includes detailed scenarios and Mermaid diagrams to illustrate how different levels affect resource reclamation. The review feedback suggests a minor improvement to replace the non-standard term 'non-used' with 'unused' for better readability.

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 Outdated
Comment thread versioned_docs/version-v1.15.0/KeyFeatures/HierarchicalQueue.md Outdated
@hajnalmt hajnalmt force-pushed the docs/capacity-ancestor-reclaim-level branch from 994880a to 5969a87 Compare June 12, 2026 20:05
Explain the capacity plugin ancestorReclaimLevel setting in the
Hierarchical Queue guide, including configuration and concrete pod
reclaim scenarios with queue-tree diagrams.

Signed-off-by: Hajnal Máté <hajnalmt@gmail.com>
@hajnalmt hajnalmt force-pushed the docs/capacity-ancestor-reclaim-level branch from 5969a87 to 9bb0bc5 Compare June 12, 2026 20:22
In this example, `queue-b` is over its own `deserved` resources and its parent `parent-b` is also over its `deserved` resources. `queue-a` has a pending pod that cannot be scheduled without reclaim.

```mermaid
graph TD

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Seems that mermaid didn't be rendered in the netlify preview page, could you check it mate?

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

Labels

kind/documentation Categorizes issue or PR as related to documentation. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document capacity plugin ancestorReclaimLevel

3 participants