Skip to content

docs: fix typo deserverd→deserved and add multi-tenant Queue example#500

Open
pushtisonawala wants to merge 1 commit into
volcano-sh:masterfrom
pushtisonawala:master
Open

docs: fix typo deserverd→deserved and add multi-tenant Queue example#500
pushtisonawala wants to merge 1 commit into
volcano-sh:masterfrom
pushtisonawala:master

Conversation

@pushtisonawala
Copy link
Copy Markdown

  • What kind of change does this PR introduce?

/kind documentation

  • What this PR does / why we need it:

Fixed a typo: deserverddeserved in
queue_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.

  • Which issue(s) this PR fixes:

No existing issue — found while reading the docs as part of
preparing for LFX Term 2 mentorship contribution.

@volcano-sh-bot volcano-sh-bot added the kind/documentation Categorizes issue or PR as related to documentation. label May 10, 2026
@volcano-sh-bot
Copy link
Copy Markdown
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 k82cn 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
Copy link
Copy Markdown
Collaborator

Welcome @pushtisonawala! It looks like this is your first PR to volcano-sh/website 🎉

@volcano-sh-bot volcano-sh-bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label May 10, 2026
Copy link
Copy Markdown

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

Comment thread content/en/docs/queue.md
Comment on lines +111 to +139
# 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
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

high

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

Comment thread content/en/docs/queue.md
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.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The explanation can be improved by using more precise terminology and correcting the grammatical consistency (using 'its' for the singular 'team').

Suggested change
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.

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.

2 participants