|
| 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 access to a limited pool of resources by determining when a job waits, is admitted to start by creating pods, or should be _preempted_, meaning that active pods for that job are deleted. |
| 10 | + |
| 11 | +In the context of {product-title}, a job can be defined as a one-time or on-demand task that runs to completion. |
| 12 | + |
| 13 | +{product-title} 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. |
| 14 | + |
| 15 | +{product-title} is based on the link:https://kueue.sigs.k8s.io/docs/[Kueue] open source project. |
| 16 | + |
| 17 | +// Personas |
| 18 | +[id="about-kueue-personas"] |
| 19 | +== {product-title} personas |
| 20 | + |
| 21 | +Different personas exist in a {product-title} workflow. |
| 22 | + |
| 23 | +Batch administrators:: Batch administrators manage the cluster infrastructure and establish quotas and queues. |
| 24 | +Batch users:: Batch users run jobs on the cluster. Examples of batch users might be researchers, AI/ML engineers, or data scientists. |
| 25 | +Serving users:: Serving users run jobs on the cluster. For example, to expose a trained AI/ML model for inference. |
| 26 | +Platform developers:: Platform developers integrate {product-title} with other software. They might also contribute to the Kueue open source project. |
| 27 | + |
| 28 | +[id="about-kueue-workflow"] |
| 29 | +== {product-title} workflow |
| 30 | +// TODO: add diagram? |
| 31 | + |
| 32 | +The {product-title} workflow can be described at a high level as follows: |
| 33 | + |
| 34 | +. Batch administrators create and configure `Flavor`, `Queue`, and `ClusterQueue` resources. |
| 35 | +. User personas create jobs on the cluster. |
| 36 | +. The Kubernetes API server validates and accepts job data. |
| 37 | +. {product-title} admits jobs based on configured options, such as order or quota. It injects affinity into the job by using flavors. |
| 38 | +. Depending on the job type, one of the available controllers creates pods. |
| 39 | +. The Kubernetes scheduler assigns pods to a node in the cluster. |
| 40 | +. The Kubernetes cluster autoscaler provisions more nodes as required. |
| 41 | + |
| 42 | +//// |
| 43 | +TODO:Add docs explaining different job / workload types |
| 44 | +These can be added as we add stories / docs for different use cases |
| 45 | +//// |
0 commit comments