Skip to content

Commit eeae1f3

Browse files
committed
update about section
1 parent 4e7c946 commit eeae1f3

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

about/about-kueue.adoc

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
include::_attributes/common-attributes.adoc[]
3+
[id="about-kueue"]
4+
= About {product-title}
5+
:context: about-kueue
6+
7+
toc::[]
8+
9+
{product-title} is a Kubernetes-native system that manages quotas and how jobs consume them. Kueue decides when a job waits, when a job is admitted to start by creating pods, and when a job should be _preempted_ (active pods should be deleted).
10+
11+
Kueue is compatible with environments that use heterogeneous, elastic resources. This means that the environment has many different resource types, and those resources are capable of dynamic scaling.
12+
13+
// Personas
14+
[id="about-kueue-personas"]
15+
== {kueue-s} personas
16+
17+
Different personas exist in a {kueue-s} workflow.
18+
19+
Batch administrators:: manage the cluster infrastructure and establish quotas and queues.
20+
Batch users:: runs workloads. Examples of batch users might be researchers, AI/ML engineers, or data scientists.
21+
Serving users:: runs workloads, for example, to expose a trained AI/ML model for inference.
22+
Platform developers:: integrates Kueue with other software. Might contribute to the upstream Kueue project.
23+
24+
// How it works
25+
[id="about-kueue-workflow"]
26+
== {kueue-s} workflow
27+
// TODO: add diagram?
28+
29+
The {kueue-s} workflow can be described at a high level as follows:
30+
31+
. Batch administrators create and configure resource flavors and queues.
32+
. User personas create jobs on the cluster.
33+
. The `kube-apiserver` component validates and accepts job data.
34+
. Kueue admits jobs based on configured options, such as order or quota.
35+
. The job controller creates pods.
36+
. The `kube-scheduler` component assigns pods to a node in the cluster.
37+
. The `cluster-autoscaler` component provisions more nodes as required.

0 commit comments

Comments
 (0)