Skip to content

docs: add tiername usage documentation for NetworkTopologyAware#5484

Open
vanshika2720 wants to merge 1 commit into
volcano-sh:masterfrom
vanshika2720:docs/issue-5483
Open

docs: add tiername usage documentation for NetworkTopologyAware#5484
vanshika2720 wants to merge 1 commit into
volcano-sh:masterfrom
vanshika2720:docs/issue-5483

Conversation

@vanshika2720

Copy link
Copy Markdown
Contributor

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, highestTierName behavior, configuration examples, and usage recommendations.

Which issue(s) this PR fixes:

Fixes #5483

Special notes for your reviewer:

  • Updated the NetworkTopologyAware design document.
  • Updated the user guide with configuration examples and usage guidance.
  • Documentation only; no code changes.

Does this PR introduce a user-facing change?

Added documentation for the NetworkTopologyAware highestTierName (tiername) feature, including design details, configuration examples, and usage guidance.

Copilot AI review requested due to automatic review settings June 22, 2026 12:43
@volcano-sh-bot volcano-sh-bot added the kind/documentation Categorizes issue or PR as related to documentation. label Jun 22, 2026
@volcano-sh-bot

Copy link
Copy Markdown
Contributor

[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 archlitchi 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/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jun 22, 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 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.

Comment thread docs/user-guide/how_to_use_network_topology_aware_scheduling.md Outdated
Comment thread docs/design/Network Topology Aware Scheduling.md Outdated
Comment thread docs/design/Network Topology Aware Scheduling.md Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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 highestTierName usage 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.

Comment thread docs/user-guide/how_to_use_network_topology_aware_scheduling.md Outdated
Comment thread docs/user-guide/how_to_use_network_topology_aware_scheduling.md
Comment thread docs/user-guide/how_to_use_network_topology_aware_scheduling.md Outdated
Comment thread docs/user-guide/how_to_use_network_topology_aware_scheduling.md Outdated
Comment thread docs/design/Network Topology Aware Scheduling.md
Comment thread docs/design/Network Topology Aware Scheduling.md
@vanshika2720 vanshika2720 force-pushed the docs/issue-5483 branch 3 times, most recently from 95b490b to 87021e1 Compare June 22, 2026 15:09
Signed-off-by: Vanshika <pahalvanshikaa@gmail.com>
@vanshika2720

Copy link
Copy Markdown
Contributor Author

/cc @hajnalmt
/cc @JesseStutler

@vanshika2720

Copy link
Copy Markdown
Contributor Author

@hajnalmt Please review

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/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOC] The NetworkTopologyAware documentation should contain the guide for using tiername

3 participants