Skip to content

Conversation

@bearslyricattack
Copy link
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, ...)
  • What this PR does / why we need it:

  • Which issue(s) this PR fixes:

@volcano-sh-bot volcano-sh-bot added retest-not-required-docs-only kind/bug Categorizes issue or PR as related to a bug. labels Aug 3, 2025
@volcano-sh-bot volcano-sh-bot added kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature. kind/design Categorizes issue or PR as related to design. labels Aug 3, 2025
Copy link

@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.

Summary of Changes

Hello @bearslyricattack, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

I've updated the architecture.md documentation file to provide a much more comprehensive and detailed overview of Volcano's system architecture and its various components. The goal is to give users a deeper understanding of how Volcano integrates with Kubernetes and how its core parts work together to manage high-performance workloads. This includes expanded descriptions of existing components like the Scheduler, Controller, Admission, and Vcctl, as well as the introduction of new components such as the Agent for resource monitoring and Network-qos for network bandwidth management. Each component now has dedicated sections detailing its purpose, functionality, and configurable parameters.

Highlights

  • Expanded Architecture Overview: The initial architecture overview has been significantly expanded to provide a more comprehensive understanding of Volcano's compatibility with Kubernetes, its design philosophy, and its core components (Scheduler, ControllerManager, Admission, Vcctl). It also introduces the layered architecture and its benefits.
  • Detailed Component Descriptions: New sections have been added to describe each major Volcano component in detail: Scheduler, Controller (with its various sub-controllers like gc-controller, job-controller, jobflow-controller, jobtemplate-controller, pg-controller, queue-controller), Admission, Vcctl, Agent, and Network-qos. Each component's role, functionality, and extensive configurable parameters are now documented.
  • Introduction of Agent Component: The addition of the 'Agent' component highlights Volcano's capability for resource monitoring and oversubscription management on Kubernetes nodes, aiming to improve cluster resource utilization.
  • Introduction of Network-qos Component: The 'Network-qos' component is introduced, detailing its function in intelligently regulating network bandwidth between different types of workloads (online vs. offline) to ensure service quality.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@volcano-sh-bot volcano-sh-bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Aug 3, 2025
Copy link

@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 significantly expands the architecture documentation, providing detailed information about Volcano's components and their parameters. The new content is comprehensive and valuable. My review focuses on improving consistency in formatting, naming, and structure to enhance the document's professionalism and readability. Key suggestions include standardizing table formats, ensuring consistent terminology and casing, and improving clarity in some descriptions. Overall, this is a great addition to the documentation.


#### jobflow-controller

jobflow-controller主要负责管理和协调 JobFlow CR的生命周期。它通过监听 JobFlow、JobTemplate 和 Job 资源的变化,处理相关事件并维护 JobFlow 的状态。

Choose a reason for hiding this comment

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

medium

为了保持术语一致性,建议将控制器名称统一为大写驼峰式(PascalCase),与其他控制器(如 Job ControllerPodGroup Controller)的描述风格保持一致。

例如,jobflow-controller 应描述为 JobFlow Controller

类似的,第231行的 jobTemplate Controller 也应统一为 JobTemplate Controller

Suggested change
jobflow-controller主要负责管理和协调 JobFlow CR的生命周期。它通过监听 JobFlow、JobTemplate 和 Job 资源的变化,处理相关事件并维护 JobFlow 的状态。
JobFlow Controller 主要负责管理和协调 JobFlow CR 的生命周期。它通过监听 JobFlow、JobTemplate 和 Job 资源的变化,处理相关事件并维护 JobFlow 的状态。


#### 参数

vcctl不需要

Choose a reason for hiding this comment

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

medium

当前对 vcctl 参数的描述 vcctl不需要 过于简单,可能会让用户感到困惑。建议提供更清晰的说明,解释 vcctl 是一个客户端工具,其参数是通过子命令提供的。

Suggested change
vcctl不需要
vcctl 是一个客户端工具,其参数通过子命令提供。请使用 `vcctl -h``vcctl [command] -h` 获取详细用法。

#### 介绍

Volcano由scheduler、controllermanager、admission和vcctl组成:
Network插件是一个专为 Kubernetes 集群设计的网络带宽管理解决方案,旨在智能调节不同类型工作负载之间的网络资源分配。该插件通过 CNI 机制与现有网络插件链式组合,实现对容器网络流量的精细控制。

Choose a reason for hiding this comment

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

medium

为了与章节标题 ### Network-qos 保持一致,建议将这里的 Network插件 修改为 Network-qos 插件

Suggested change
Network插件是一个专为 Kubernetes 集群设计的网络带宽管理解决方案,旨在智能调节不同类型工作负载之间的网络资源分配。该插件通过 CNI 机制与现有网络插件链式组合,实现对容器网络流量的精细控制。
Network-qos 插件是一个专为 Kubernetes 集群设计的网络带宽管理解决方案,旨在智能调节不同类型工作负载之间的网络资源分配。该插件通过 CNI 机制与现有网络插件链式组合,实现对容器网络流量的精细控制。

@volcano-sh-bot volcano-sh-bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Aug 3, 2025
Copy link

Copilot AI left a comment

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 significantly expands the architecture documentation for Volcano by adding comprehensive component descriptions and parameter references. The changes replace the previous brief overview with detailed explanations of Volcano's architecture, component responsibilities, and configuration options.

Key changes:

  • Updated overview section with expanded architectural description and replaced diagram reference (arch_1.png → arch_3.jpg)
  • Added detailed component documentation for Scheduler, Controller, Admission, Vcctl, Agent, and Network-qos components
  • Included comprehensive parameter tables for each component with descriptions, defaults, and examples
  • Added subsection descriptions for all controller types (gc-controller, job-controller, jobflow-controller, etc.)

Reviewed Changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated 4 comments.

File Description
content/zh/docs/architecture.md Chinese version of expanded architecture documentation with detailed component parameters and configuration options
content/en/docs/architecture.md English version of expanded architecture documentation with detailed component parameters and configuration options

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines 278 to 279
- Vcctl
Volcano vcctl是Volcano的命令行客户端工具。
Copy link

Copilot AI Nov 11, 2025

Choose a reason for hiding this comment

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

Old content from the previous version was not properly removed. These lines (278-279) should be deleted as they appear in the middle of the Admission section's parameter tables and are now redundant with the new Vcctl section starting at line 319.

Suggested change
- Vcctl
Volcano vcctl是Volcano的命令行客户端工具。

Copilot uses AI. Check for mistakes.
| ---------------------- | -------- | ------- | ------------------------------------------------------------ |
| `--supported-features` | []string | `["*"]` | 支持的特性列表。`*` 表示支持所有默认启用的特性,`foo` 表示支持名为 `foo` 的特性,`-foo` 表示不支持名为 `foo` 的特性 |

#### Network-qos
Copy link

Copilot AI Nov 11, 2025

Choose a reason for hiding this comment

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

Heading hierarchy inconsistency: Network-qos should be at the same level as Agent (###) rather than a subsection of Agent (####). Network-qos is listed as a separate top-level component in line 40, indicating it should have its own ### heading like other main components.

Suggested change
#### Network-qos
### Network-qos

Copilot uses AI. Check for mistakes.

##### Introduction

The Network plugin is a network bandwidth management solution designed specifically for Kubernetes clusters, Used in conjunction with the Agent component,aimed at intelligently adjusting network resource allocation between different types of workloads. This plugin integrates with existing network plugins through the CNI mechanism, enabling fine-grained control over container network traffic.
Copy link

Copilot AI Nov 11, 2025

Choose a reason for hiding this comment

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

Missing space after comma. Should be 'Agent component, aimed' instead of 'Agent component,aimed'.

Copilot uses AI. Check for mistakes.
| ---------------------- | -------- | ------- | ------------------------------------------------------------ |
| `--supported-features` | []string | `["*"]` | List of supported features. `*` means support all features enabled by default, `foo` means support feature named `foo`, `-foo` means don't support feature named `foo` |

#### Network-qos
Copy link

Copilot AI Nov 11, 2025

Choose a reason for hiding this comment

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

Heading hierarchy inconsistency: Network-qos should be at the same level as Agent (###) rather than a subsection of Agent (####). Network-qos is listed as a separate top-level component in line 40, indicating it should have its own ### heading like other main components.

Suggested change
#### Network-qos
### Network-qos

Copilot uses AI. Check for mistakes.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@volcano-sh-bot volcano-sh-bot added the do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. label Nov 21, 2025
@volcano-sh-bot
Copy link
Collaborator

Keywords which can automatically close issues and at(@) or hashtag(#) mentions are not allowed in commit messages.

The list of commits with invalid commit messages:

  • c177874 Update content/zh/docs/architecture.md
Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

@volcano-sh-bot
Copy link
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 william-wang 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

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

Labels

do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. kind/bug Categorizes issue or PR as related to a bug. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/design Categorizes issue or PR as related to design. kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature. 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.

2 participants