|
| 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 | +//What is kueue? |
| 10 | +{product-title} is a job and resource management system for {ocp-full} clusters. |
| 11 | + |
| 12 | +// Who should / when should someone use Kueue? |
| 13 | +{kueue-s} 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 | +// Personas |
| 16 | +[id="about-kueue-personas"] |
| 17 | +== {kueue-s} personas |
| 18 | + |
| 19 | +There are two different personas used in a {kueue-s} workflow; batch administrators, and batch users. |
| 20 | + |
| 21 | +A batch administrator manages the cluster infrastructure and establishes quotas and queues. |
| 22 | + |
| 23 | +As a batch administrator, you can complete the following tasks: |
| 24 | + |
| 25 | +- Setup role-based access control to Kueue objects. |
| 26 | +- Administer cluster quotas by using cluster queues and local queues. |
| 27 | +- Setup "all-or-nothing" with ready pods. |
| 28 | +- Monitor pending workloads. |
| 29 | +- Run Kueue-managed jobs with a custom workload priorities. |
| 30 | +- Setup a multi-Kueue environment. |
| 31 | +- Use a third-party certificate authority with Kueue. |
| 32 | + |
| 33 | +// How it works |
| 34 | +[id="about-kueue-workflow"] |
| 35 | +== {kueue-s} workflow |
| 36 | + |
| 37 | +// TODO: add diagram |
| 38 | + |
| 39 | +The {kueue-s} workflow can be described at a high level as follows: |
| 40 | + |
| 41 | +. Batch administrators create and configure resource flavors and queues. |
| 42 | +. Batch users create jobs on the cluster. |
| 43 | +. The `kube-apiserver` component validates and accepts job data. |
| 44 | +. {kueue-s} admits jobs based on configured options, such as order or quota. |
| 45 | +// how does nodeaffinity work |
| 46 | +. The job controller creates pods. |
| 47 | +. The `kube-scheduler` component assigns pods to a node in the cluster. |
| 48 | +. The `cluster-autoscaler` component provisions more nodes as required. |
0 commit comments