Skip to content

Commit 0499750

Browse files
committed
OSDOCS-13820: Adding Kueue about docs
1 parent 6a6efda commit 0499750

File tree

4 files changed

+89
-8
lines changed

4 files changed

+89
-8
lines changed

_attributes/common-attributes.adoc

+2-8
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,6 @@
2121
:op-system-base-full: Red Hat Enterprise Linux (RHEL)
2222
:op-system-version: 9.x
2323
:op-system-version-9: 9
24-
ifdef::openshift-origin[]
25-
:op-system-first: Fedora CoreOS (FCOS)
26-
:op-system: FCOS
27-
:op-system-lowercase: fcos
28-
:op-system-base: Fedora
29-
:op-system-base-full: Fedora
30-
:op-system-version: 35
31-
endif::[]
3224
:tsb-name: Template Service Broker
3325
:kebab: image:kebab.png[title="Options menu"]
3426
:ai-full: Assisted Installer
@@ -144,3 +136,5 @@ endif::[]
144136
:mce-short: multicluster engine Operator
145137
//Kueue
146138
:kueue-s: Kueue
139+
:kueue-op: Kueue Operator
140+
:ocp-full: Red Hat OpenShift Container Platform

_topic_maps/_topic_map.yml

+2
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,5 @@ Distros: openshift-kueue
2929
Topics:
3030
- Name: Welcome
3131
File: index
32+
- Name: About Red Hat OpenShift Build of Kueue
33+
File: about-kueue

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.

welcome/about-kueue.adoc

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
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

Comments
 (0)