Skip to content

Commit

Permalink
ENG-12318: Removes text about Kueue being optional; adds note about s…
Browse files Browse the repository at this point in the history
…ingle cluster queue; clarifies that all of the objects are Kueue objects
  • Loading branch information
bredamc committed Sep 11, 2024
1 parent 2590f45 commit eff7053
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions modules/overview-of-kueue-resources.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
// ENG-12318: Commenting out references to multiple cluster queues for now, and replacing with edited version
//Cluster administrators can configure Kueue resource flavors, cluster queues, and local queues to manage distributed workload resources across multiple nodes in an OpenShift cluster.
// When multiple cluster queues are supported, delete the following line and uncomment the previous line.
Cluster administrators can configure Kueue resource flavors, cluster queue, and local queues to manage distributed workload resources across multiple nodes in an OpenShift cluster.
Cluster administrators can configure Kueue objects (such as resource flavors, a cluster queue, and local queues) to manage distributed workload resources across multiple nodes in an OpenShift cluster.

== Resource flavor
The Kueue `ResourceFlavor` object describes the resource variations that are available in a cluster.
Expand Down Expand Up @@ -77,6 +77,13 @@ The Kueue `ClusterQueue` object manages a pool of cluster resources such as pods
// When multiple cluster queues are supported, delete the following line and uncomment the previous line.
A cluster queue can reference multiple resource flavors.

ifndef::upstream[]

[NOTE]
====
In {productname-short} {vernum}, {org-name} supports only a single cluster queue per cluster.
====
endif::[]

Cluster administrators can configure a cluster queue to define the resource flavors that the queue manages, and assign a quota for each resource in each resource flavor.
// ENG-12318: Commenting out references to multiple cluster queues for now
Expand Down Expand Up @@ -123,8 +130,8 @@ Cluster administrators can configure local queues to specify the project name an
Each local queue then grants access to the resources that its specified cluster queue manages.
A cluster administrator can optionally define one local queue in a project as the default local queue for that project.

When configuring a distributed workload, the user can specify the local queue name.
If a cluster administrator configured a default local queue, or if not using Kueue to manage resources, the user can omit the local queue specification from the distributed workload code.
When configuring a distributed workload, the user specifies the local queue name.
If a cluster administrator configured a default local queue, the user can omit the local queue specification from the distributed workload code.

Kueue allocates the resources for a distributed workload from the cluster queue that is associated with the local queue, if the total requested resources are within the quota limits specified in that cluster queue.

Expand Down

0 comments on commit eff7053

Please sign in to comment.