Expose Flavors in LocalQueue Status.

kubernetes-sigs · Oct 7, 2024 · fd0ed8b · fd0ed8b
1 parent fd12357
commit fd0ed8b
Show file tree

Hide file tree

Showing 11 changed files with 262 additions and 32 deletions.
diff --git a/apis/kueue/v1beta1/localqueue_types.go b/apis/kueue/v1beta1/localqueue_types.go
@@ -48,6 +48,11 @@ type LocalQueueSpec struct {
 // +kubebuilder:validation:Pattern="^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$"
 type ClusterQueueReference string
 
+type AvailableFlavor struct {
+	// name of the flavor.
+	Name ResourceFlavorReference `json:"name"`
+}
+
 // LocalQueueStatus defines the observed state of LocalQueue
 type LocalQueueStatus struct {
 	// PendingWorkloads is the number of Workloads in the LocalQueue not yet admitted to a ClusterQueue
@@ -88,6 +93,13 @@ type LocalQueueStatus struct {
 	// +kubebuilder:validation:MaxItems=16
 	// +optional
 	FlavorUsage []LocalQueueFlavorUsage `json:"flavorUsage"`
+
+	// availableFlavors lists all currently available ResourceFlavors
+	// in specified ClusterQueue.
+	//
+	// +listType=map
+	// +listMapKey=name
+	AvailableFlavors []AvailableFlavor `json:"availableFlavors,omitempty"`
 }
 
 const (

diff --git a/apis/kueue/v1beta1/zz_generated.deepcopy.go b/apis/kueue/v1beta1/zz_generated.deepcopy.go
diff --git a/charts/kueue/templates/crd/kueue.x-k8s.io_localqueues.yaml b/charts/kueue/templates/crd/kueue.x-k8s.io_localqueues.yaml
@@ -106,6 +106,24 @@ spec:
                   admitted to a ClusterQueue and that haven't finished yet.
                 format: int32
                 type: integer
+              availableFlavors:
+                description: |-
+                  availableFlavors lists all currently available ResourceFlavors
+                  in specified ClusterQueue.
+                items:
+                  properties:
+                    name:
+                      description: name of the flavor.
+                      maxLength: 253
+                      pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
+                      type: string
+                  required:
+                  - name
+                  type: object
+                type: array
+                x-kubernetes-list-map-keys:
+                - name
+                x-kubernetes-list-type: map
               conditions:
                 description: |-
                   Conditions hold the latest available observations of the LocalQueue

diff --git a/client-go/applyconfiguration/kueue/v1beta1/availableflavor.go b/client-go/applyconfiguration/kueue/v1beta1/availableflavor.go
diff --git a/client-go/applyconfiguration/kueue/v1beta1/localqueuestatus.go b/client-go/applyconfiguration/kueue/v1beta1/localqueuestatus.go
diff --git a/client-go/applyconfiguration/utils.go b/client-go/applyconfiguration/utils.go
diff --git a/config/components/crd/bases/kueue.x-k8s.io_localqueues.yaml b/config/components/crd/bases/kueue.x-k8s.io_localqueues.yaml
@@ -91,6 +91,24 @@ spec:
                   admitted to a ClusterQueue and that haven't finished yet.
                 format: int32
                 type: integer
+              availableFlavors:
+                description: |-
+                  availableFlavors lists all currently available ResourceFlavors
+                  in specified ClusterQueue.
+                items:
+                  properties:
+                    name:
+                      description: name of the flavor.
+                      maxLength: 253
+                      pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
+                      type: string
+                  required:
+                  - name
+                  type: object
+                type: array
+                x-kubernetes-list-map-keys:
+                - name
+                x-kubernetes-list-type: map
               conditions:
                 description: |-
                   Conditions hold the latest available observations of the LocalQueue

diff --git a/pkg/cache/cache.go b/pkg/cache/cache.go
@@ -38,6 +38,7 @@ import (
 	"sigs.k8s.io/kueue/pkg/hierarchy"
 	"sigs.k8s.io/kueue/pkg/metrics"
 	"sigs.k8s.io/kueue/pkg/resources"
+	"sigs.k8s.io/kueue/pkg/util/maps"
 	"sigs.k8s.io/kueue/pkg/workload"
 )
 
@@ -668,6 +669,7 @@ type LocalQueueUsageStats struct {
 	ReservingWorkloads int
 	AdmittedResources  []kueue.LocalQueueFlavorUsage
 	AdmittedWorkloads  int
+	AvailableFlavors   []kueue.AvailableFlavor
 }
 
 func (c *Cache) LocalQueueUsage(qObj *kueue.LocalQueue) (*LocalQueueUsageStats, error) {
@@ -683,11 +685,21 @@ func (c *Cache) LocalQueueUsage(qObj *kueue.LocalQueue) (*LocalQueueUsageStats,
 		return nil, errQNotFound
 	}
 
+	availableFlavors := make(map[kueue.ResourceFlavorReference]kueue.AvailableFlavor)
+	for _, rg := range cqImpl.ResourceGroups {
+		for _, fl := range rg.Flavors {
+			availableFlavors[fl] = kueue.AvailableFlavor{
+				Name: fl,
+			}
+		}
+	}
+
 	return &LocalQueueUsageStats{
 		ReservedResources:  filterLocalQueueUsage(qImpl.usage, cqImpl.ResourceGroups),
 		ReservingWorkloads: qImpl.reservingWorkloads,
 		AdmittedResources:  filterLocalQueueUsage(qImpl.admittedUsage, cqImpl.ResourceGroups),
 		AdmittedWorkloads:  qImpl.admittedWorkloads,
+		AvailableFlavors:   maps.Values(availableFlavors),
 	}, nil
 }
 

diff --git a/pkg/controller/core/localqueue_controller.go b/pkg/controller/core/localqueue_controller.go
@@ -328,6 +328,7 @@ func (r *LocalQueueReconciler) UpdateStatusIfChanged(
 	queue.Status.AdmittedWorkloads = int32(stats.AdmittedWorkloads)
 	queue.Status.FlavorsReservation = stats.ReservedResources
 	queue.Status.FlavorUsage = stats.AdmittedResources
+	queue.Status.AvailableFlavors = stats.AvailableFlavors
 	if len(conditionStatus) != 0 && len(reason) != 0 && len(msg) != 0 {
 		meta.SetStatusCondition(&queue.Status.Conditions, metav1.Condition{
 			Type:               kueue.LocalQueueActive,

diff --git a/site/content/en/docs/reference/kueue.v1beta1.md b/site/content/en/docs/reference/kueue.v1beta1.md
@@ -497,6 +497,30 @@ If empty, the AdmissionCheck will run for all workloads submitted to the Cluster
 </tbody>
 </table>
 
+## `AvailableFlavor`     {#kueue-x-k8s-io-v1beta1-AvailableFlavor}
+
+
+**Appears in:**
+
+- [LocalQueueStatus](#kueue-x-k8s-io-v1beta1-LocalQueueStatus)
+
+
+
+<table class="table">
+<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
+<tbody>
+
+
+<tr><td><code>name</code> <B>[Required]</B><br/>
+<a href="#kueue-x-k8s-io-v1beta1-ResourceFlavorReference"><code>ResourceFlavorReference</code></a>
+</td>
+<td>
+   <p>name of the flavor.</p>
+</td>
+</tr>
+</tbody>
+</table>
+
 ## `BorrowWithinCohort`     {#kueue-x-k8s-io-v1beta1-BorrowWithinCohort}
 
 
@@ -1289,6 +1313,14 @@ workloads assigned to this LocalQueue.</p>
 workloads assigned to this LocalQueue.</p>
 </td>
 </tr>
+<tr><td><code>availableFlavors</code> <B>[Required]</B><br/>
+<a href="#kueue-x-k8s-io-v1beta1-AvailableFlavor"><code>[]AvailableFlavor</code></a>
+</td>
+<td>
+   <p>availableFlavors lists all currently available ResourceFlavors
+in specified ClusterQueue.</p>
+</td>
+</tr>
 </tbody>
 </table>
 
@@ -1613,6 +1645,8 @@ this time would be reset to null.</p>
 
 - [AdmissionCheckStrategyRule](#kueue-x-k8s-io-v1beta1-AdmissionCheckStrategyRule)
 
+- [AvailableFlavor](#kueue-x-k8s-io-v1beta1-AvailableFlavor)
+
 - [FlavorQuotas](#kueue-x-k8s-io-v1beta1-FlavorQuotas)
 
 - [FlavorUsage](#kueue-x-k8s-io-v1beta1-FlavorUsage)