docs: add tiername usage documentation for NetworkTopologyAware#5484
docs: add tiername usage documentation for NetworkTopologyAware#5484vanshika2720 wants to merge 1 commit into
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
There was a problem hiding this comment.
Code Review
This pull request updates the documentation for Volcano's Network Topology Aware Scheduling to introduce topology tier selection using tier names (highestTierName) instead of only numerical levels. The review feedback highlights critical issues where the scheduler plugin does not currently parse highestTierName in its configuration, and the API check for hard topology mode fails to account for cases where only highestTierName is configured. Additionally, a correction is suggested to remove references to a non-existent tiername field in the documentation.
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.
There was a problem hiding this comment.
Pull request overview
This PR updates Volcano’s NetworkTopologyAware documentation to describe how to use highestTierName (tier name) for topology-aware scheduling boundaries, complementing the existing highestTierAllowed (numeric tier) guidance.
Changes:
- Documented
highestTierNameusage in the NetworkTopologyAware user guide, including examples and recommendations. - Added a “Topology Tier Selection” section to the design document describing tier-name-based boundary selection.
- Minor markdown/formatting cleanups in existing YAML snippets.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| docs/user-guide/how_to_use_network_topology_aware_scheduling.md | Adds highestTierName documentation, examples, and a new section about configuring tier selection (but currently describes unsupported scheduler plugin args). |
| docs/design/Network Topology Aware Scheduling.md | Adds design-level explanation of tier-name-based boundaries and default behavior (with some behavioral inaccuracies for soft mode). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
95b490b to
87021e1
Compare
Signed-off-by: Vanshika <pahalvanshikaa@gmail.com>
87021e1 to
a639a76
Compare
|
/cc @hajnalmt |
|
@hajnalmt Please review |
What type of PR is this?
/kind documentation
What this PR does / why we need it:
This PR updates the NetworkTopologyAware documentation to include guidance for using
highestTierName(tiername).The feature was introduced in #4795, but the design document and user guide did not explain how to configure topology-aware scheduling using tier names. This PR adds documentation describing topology tiers,
highestTierNamebehavior, configuration examples, and usage recommendations.Which issue(s) this PR fixes:
Fixes #5483
Special notes for your reviewer:
Does this PR introduce a user-facing change?