docs: fix typo deserverd→deserved and add multi-tenant Queue example#500
docs: fix typo deserverd→deserved and add multi-tenant Queue example#500pushtisonawala 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 |
|
Welcome @pushtisonawala! It looks like this is your first PR to volcano-sh/website 🎉 |
There was a problem hiding this comment.
Code Review
This pull request introduces a multi-tenant example to the queue documentation and corrects multiple instances of the typo 'deserverd' to 'deserved' in the resource management guide. The review feedback identifies a technical discrepancy in the new example where the use of the guarantee field conflicts with the described resource-sharing behavior; it is recommended to use the deserved field instead to allow for fair-share borrowing. Additionally, minor grammatical improvements were suggested for the explanatory text to ensure clarity and consistency.
| # Team A's queue - gets 4 CPUs guaranteed | ||
| apiVersion: scheduling.volcano.sh/v1beta1 | ||
| kind: Queue | ||
| metadata: | ||
| name: team-a | ||
| spec: | ||
| capability: | ||
| cpu: "8" | ||
| memory: 16Gi | ||
| guarantee: | ||
| resource: | ||
| cpu: "4" | ||
| memory: 8Gi | ||
| reclaimable: true | ||
| --- | ||
| # Team B's queue - gets 4 CPUs guaranteed | ||
| apiVersion: scheduling.volcano.sh/v1beta1 | ||
| kind: Queue | ||
| metadata: | ||
| name: team-b | ||
| spec: | ||
| capability: | ||
| cpu: "8" | ||
| memory: 16Gi | ||
| guarantee: | ||
| resource: | ||
| cpu: "4" | ||
| memory: 8Gi | ||
| reclaimable: true |
There was a problem hiding this comment.
The multi-tenant example uses the guarantee field to define resource limits, but the description at line 142 states that teams can share idle resources. According to the Volcano documentation (see line 57 of this file and line 30 of queue_resource_management.md), guarantee resources are strictly reserved and cannot be used by other queues even if idle.
To achieve the described sharing behavior, the deserved field should be used instead. The deserved field defines the fair-share amount that can be borrowed by other queues when not in use. Furthermore, deserved is a mandatory field when using the recommended capacity plugin (as noted in queue_resource_management.md line 35).
# Team A's queue - gets 4 CPUs deserved (shareable fair-share)
apiVersion: scheduling.volcano.sh/v1beta1
kind: Queue
metadata:
name: team-a
spec:
capability:
cpu: "8"
memory: 16Gi
deserved:
cpu: "4"
memory: 8Gi
reclaimable: true
---
# Team B's queue - gets 4 CPUs deserved (shareable fair-share)
apiVersion: scheduling.volcano.sh/v1beta1
kind: Queue
metadata:
name: team-b
spec:
capability:
cpu: "8"
memory: 16Gi
deserved:
cpu: "4"
memory: 8Gi
reclaimable: true| reclaimable: true | ||
| ``` | ||
|
|
||
| Each team submits their jobs to their own queue. If Team A's jobs are idle, Team B can use the extra resources, and vice versa. |
There was a problem hiding this comment.
The explanation can be improved by using more precise terminology and correcting the grammatical consistency (using 'its' for the singular 'team').
| Each team submits their jobs to their own queue. If Team A's jobs are idle, Team B can use the extra resources, and vice versa. | |
| Each team submits its jobs to its own queue. If Team A's jobs are idle, Team B can use the extra resources (up to its capability), and vice versa. |
/kind documentation
Fixed a typo:
deserverd→deservedinqueue_resource_management.md (appeared in multiple places).
Also added a multi-tenant usage example to queue.md to help
users understand how multiple teams can share cluster resources
using separate Queues.
No existing issue — found while reading the docs as part of
preparing for LFX Term 2 mentorship contribution.