docs: document nodegroup resource limits#544
Conversation
Signed-off-by: ruanwenjun <[email protected]>
volcano-sh-bot
added
the
kind/documentation
|
[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 |
|
Welcome @ruanwenjun! It looks like this is your first PR to volcano-sh/website 🎉 |
volcano-sh-bot
added
the
size/M
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds documentation in both English and Chinese explaining how to configure queue resource limits for each nodegroup using the volcano.sh/nodegroup-resource-limits annotation. The review feedback suggests minor phrasing improvements in both language versions to enhance precision and clarity, such as using 'the amount of resources' instead of 'how many resources' and 'resulting resource usage' instead of 'future usage' to better match the provided formula.
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.
|
|
||
| ### Configure queue resource limits for each nodegroup | ||
|
|
||
| Use the `volcano.sh/nodegroup-resource-limits` annotation to limit how many resources a queue can allocate from each nodegroup. |
There was a problem hiding this comment.
Using 'the amount of resources' is more idiomatic and precise than 'how many resources' when referring to continuous resource dimensions like CPU and memory.
| Use the `volcano.sh/nodegroup-resource-limits` annotation to limit how many resources a queue can allocate from each nodegroup. | |
| Use the `volcano.sh/nodegroup-resource-limits` annotation to limit the amount of resources a queue can allocate from each nodegroup. |
There was a problem hiding this comment.
Updated in b5401ab to use “the amount of resources” for clearer and more idiomatic wording.
| allocated(Q, G) + task request <= limit(Q, G) | ||
| ``` | ||
|
|
||
| If the future usage exceeds the configured limit, the node is rejected for that task. Other allowed nodegroups remain schedulable, so the queue can prefer `groupname1` and overflow to `groupname2` when the logical limit for `groupname1` is reached. |
There was a problem hiding this comment.
The term 'future usage' is somewhat ambiguous. It would be clearer and more precise to describe it as 'resulting resource usage' or 'total resource usage (allocated resources plus the task's request)' to match the formula allocated(Q, G) + task request <= limit(Q, G) shown above.
| If the future usage exceeds the configured limit, the node is rejected for that task. Other allowed nodegroups remain schedulable, so the queue can prefer `groupname1` and overflow to `groupname2` when the logical limit for `groupname1` is reached. | |
| If the resulting resource usage exceeds the configured limit, the node is rejected for that task. Other allowed nodegroups remain schedulable, so the queue can prefer `groupname1` and overflow to `groupname2` when the logical limit for `groupname1` is reached. |
There was a problem hiding this comment.
Updated in b5401ab to use “resulting resource usage”, matching the allocation formula above.
|
|
||
| ### 为每个 NodeGroup 配置 Queue 资源上限 | ||
|
|
||
| 使用 `volcano.sh/nodegroup-resource-limits` 注解限制 Queue 最多可从各个 NodeGroup 分配多少资源。 |
There was a problem hiding this comment.
Using '分配的资源量' (the amount of resources allocated) is more idiomatic and precise than '分配多少资源' (how many resources allocated) for resource dimensions like CPU and memory.
| 使用 `volcano.sh/nodegroup-resource-limits` 注解限制 Queue 最多可从各个 NodeGroup 分配多少资源。 | |
| 使用 `volcano.sh/nodegroup-resource-limits` 注解限制 Queue 最多可从各个 NodeGroup 分配的资源量。 |
There was a problem hiding this comment.
Updated in b5401ab to use “分配的资源量” for more precise Chinese wording.
| allocated(Q, G) + task request <= limit(Q, G) | ||
| ``` | ||
|
|
||
| 如果调度后的资源用量超过配置的上限，插件会拒绝将该任务调度到此节点。其他允许使用的 NodeGroup 仍可参与调度，因此 Queue 可以优先使用 `groupname1`，并在达到 `groupname1` 的逻辑资源上限后将任务调度到 `groupname2`。 |
There was a problem hiding this comment.
To make the explanation more precise and align with the formula allocated(Q, G) + task request <= limit(Q, G), we can refine '调度后的资源用量' (resource usage after scheduling) to '调度后的累计资源用量' (accumulated resource usage after scheduling).
| 如果调度后的资源用量超过配置的上限，插件会拒绝将该任务调度到此节点。其他允许使用的 NodeGroup 仍可参与调度，因此 Queue 可以优先使用 `groupname1`，并在达到 `groupname1` 的逻辑资源上限后将任务调度到 `groupname2`。 | |
| 如果调度后的累计资源用量超过配置的上限，插件会拒绝将该任务调度到此节点。其他允许使用的 NodeGroup 仍可参与调度，因此 Queue 可以优先使用 `groupname1`，并在达到 `groupname1` 的逻辑资源上限后将任务调度到 `groupname2`。 |
There was a problem hiding this comment.
Updated in b5401ab to use “调度后的累计资源用量”, aligning the description with the allocation formula.
Signed-off-by: ruanwenjun <[email protected]>
|
/cc @JesseStutler |
3 participants
/kind documentation
Documents the per-queue, per-nodegroup resource limits introduced by volcano-sh/volcano#5461.
volcano.sh/nodegroup-resource-limitsannotation format and a complete Queue example.Validation:
git diff --checknpm run buildRelated to volcano-sh/volcano#5461