Skip to content

Commit 8cd8bc0

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

File tree

4 files changed

+50
-22
lines changed

4 files changed

+50
-22
lines changed

_attributes/common-attributes.adoc

+1-20
Original file line numberDiff line numberDiff line change
@@ -10,25 +10,12 @@
1010
:toc-title:
1111
:imagesdir: images
1212
:prewrap!:
13-
// n-1 and n+1 OCP versions relative to the current branch's {product-version} attr
14-
:ocp-nminus1: 4.17
15-
:ocp-nplus1: 4.19
1613
// Operating system attributes
1714
:op-system-first: Red Hat Enterprise Linux CoreOS (RHCOS)
1815
:op-system: RHCOS
1916
:op-system-lowercase: rhcos
2017
:op-system-base: RHEL
2118
:op-system-base-full: Red Hat Enterprise Linux (RHEL)
22-
:op-system-version: 9.x
23-
: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::[]
3219
:tsb-name: Template Service Broker
3320
:kebab: image:kebab.png[title="Options menu"]
3421
:ai-full: Assisted Installer
@@ -48,8 +35,6 @@ endif::[]
4835
// Pipelines
4936
:pipelines-title: Red Hat OpenShift Pipelines
5037
:pipelines-shortname: OpenShift Pipelines
51-
:pipelines-ver: pipelines-1.18
52-
:pipelines-version-number: 1.18
5338
:tekton-chains: Tekton Chains
5439
:tekton-hub: Tekton Hub
5540
:artifact-hub: Artifact Hub
@@ -64,13 +49,9 @@ endif::[]
6449
:product-rosa: Red Hat OpenShift Service on AWS
6550
:SMProductName: Red Hat OpenShift Service Mesh
6651
:SMProductShortName: Service Mesh
67-
:SMProductVersion: 2.6.6
68-
:MaistraVersion: 2.6
6952
:KialiProduct: Kiali Operator provided by Red Hat
7053
:SMPlugin: OpenShift Service Mesh Console (OSSMC) plugin
7154
:SMPluginShort: OSSMC plugin
72-
//Service Mesh v1
73-
:SMProductVersion1x: 1.1.18.2
7455
//OLM
7556
:olm-first: Operator Lifecycle Manager (OLM)
7657
:olm: OLM
@@ -143,4 +124,4 @@ endif::[]
143124
:mce: multicluster engine for Kubernetes Operator
144125
:mce-short: multicluster engine Operator
145126
//Kueue
146-
:kueue-s: Kueue
127+
:ocp-full: Red Hat OpenShift Container Platform

_distro_map.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
openshift-kueue:
3-
name: Red Hat OpenShift Build of Kueue
3+
name: Red Hat build of Kueue
44
author: OpenShift documentation team <[email protected]>
55
site: commercial
66
site_name: Documentation
77
site_url: https://docs.openshift.com/
88
branches:
99
kueue-docs-1.0:
10-
name: '1.0.0'
10+
name: '1.0'
1111
dir: kueue

_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 build of Kueue
33+
File: about-kueue

welcome/about-kueue.adoc

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

Comments
 (0)