Skip to content

Commit 0b12f2d

Browse files
committed
docs: fix quickstart and queue docs
1 parent 2259f01 commit 0b12f2d

File tree

4 files changed

+8
-4
lines changed

4 files changed

+8
-4
lines changed

docs/queues/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Scheduling queues are the core resource management primitive in KAI Scheduler, providing hierarchical resource allocation with quota guarantees and priority-based distribution.
44

5+
Currently only queues that have parent queues can be scheduled to and top level queues cannot be used by jobs. This is a limitation that will be fixed in the future (github.com/NVIDIA/KAI-scheduler/issues/621).
6+
57
## Table of Contents
68
- [Queue Attributes](#queue-attributes)
79
- [API Reference](#api-reference)

docs/quickstart/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ After installing KAI Scheduler, a **two-level queue hierarchy** is automatically
1111
* `default-parent-queue` – Top-level (parent) queue. By default, this queue has no reserved resource quotas, allowing governance of resource distribution for its leaf queues.
1212
* `default-queue` – Leaf (child) queue under the `default-parent-queue` top-level queue. Workloads should reference this queue.
1313

14+
The expected default queues are in [default-queues.yaml](default-queues.yaml).
15+
1416
No manual queue setup is required. Both queues will exist immediately after installation, allowing you to start submitting workloads right away.
1517
To customize scheduling, you can create additional queues or modify existing ones to set quotas, priorities, and hierarchies.
1618

docs/quickstart/pods/cpu-only-pod.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ kind: Pod
66
metadata:
77
name: cpu-only-pod
88
labels:
9-
kai.scheduler/queue: test
9+
kai.scheduler/queue: default-queue
1010
spec:
1111
schedulerName: kai-scheduler
1212
containers:
@@ -16,4 +16,4 @@ spec:
1616
resources:
1717
requests:
1818
cpu: 100m
19-
memory: 250M
19+
memory: 250M

docs/quickstart/pods/gpu-pod.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ kind: Pod
66
metadata:
77
name: gpu-pod
88
labels:
9-
kai.scheduler/queue: test
9+
kai.scheduler/queue: default-queue
1010
spec:
1111
schedulerName: kai-scheduler
1212
containers:
@@ -16,4 +16,4 @@ spec:
1616
args: ["nvidia-smi; trap 'exit 0' TERM; sleep infinity & wait"]
1717
resources:
1818
limits:
19-
nvidia.com/gpu: "1"
19+
nvidia.com/gpu: "1"

0 commit comments

Comments
 (0)