Deprecate the QueueVisibility feature gate and corresponding API.

kubernetes-sigs · Sep 23, 2024 · 57de77b · 57de77b
1 parent f5e245f
commit 57de77b
Show file tree

Hide file tree

Showing 10 changed files with 45 additions and 26 deletions.
diff --git a/apis/kueue/v1beta1/clusterqueue_types.go b/apis/kueue/v1beta1/clusterqueue_types.go
@@ -265,6 +265,7 @@ type ClusterQueueStatus struct {
 
 	// pendingWorkloads is the number of workloads currently waiting to be
 	// admitted to this clusterQueue.
+	// Deprecated: This field will be removed on v1beta2, use VisibilityOnDemand instead.
 	// +optional
 	PendingWorkloads int32 `json:"pendingWorkloads"`
 
@@ -289,6 +290,7 @@ type ClusterQueueStatus struct {
 
 	// PendingWorkloadsStatus contains the information exposed about the current
 	// status of the pending workloads in the cluster queue.
+	// Deprecated: This field will be removed on v1beta2, use VisibilityOnDemand instead.
 	// +optional
 	PendingWorkloadsStatus *ClusterQueuePendingWorkloadsStatus `json:"pendingWorkloadsStatus"`
 

diff --git a/apis/kueue/v1beta1/localqueue_types.go b/apis/kueue/v1beta1/localqueue_types.go
@@ -50,7 +50,8 @@ type ClusterQueueReference string
 
 // 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
+	// PendingWorkloads is the number of Workloads in the LocalQueue not yet admitted to a ClusterQueue.
+	// Deprecated: This field will be removed on v1beta2, use VisibilityOnDemand instead.
 	// +optional
 	PendingWorkloads int32 `json:"pendingWorkloads"`
 

diff --git a/charts/kueue/templates/crd/kueue.x-k8s.io_clusterqueues.yaml b/charts/kueue/templates/crd/kueue.x-k8s.io_clusterqueues.yaml
@@ -700,12 +700,14 @@ spec:
                 description: |-
                   pendingWorkloads is the number of workloads currently waiting to be
                   admitted to this clusterQueue.
+                  Deprecated: This field will be removed on v1beta2, use VisibilityOnDemand instead.
                 format: int32
                 type: integer
               pendingWorkloadsStatus:
                 description: |-
                   PendingWorkloadsStatus contains the information exposed about the current
                   status of the pending workloads in the cluster queue.
+                  Deprecated: This field will be removed on v1beta2, use VisibilityOnDemand instead.
                 properties:
                   clusterQueuePendingWorkload:
                     description: Head contains the list of top pending workloads.

diff --git a/charts/kueue/templates/crd/kueue.x-k8s.io_localqueues.yaml b/charts/kueue/templates/crd/kueue.x-k8s.io_localqueues.yaml
@@ -255,8 +255,9 @@ spec:
                 - name
                 x-kubernetes-list-type: map
               pendingWorkloads:
-                description: PendingWorkloads is the number of Workloads in the LocalQueue
-                  not yet admitted to a ClusterQueue
+                description: |-
+                  PendingWorkloads is the number of Workloads in the LocalQueue not yet admitted to a ClusterQueue.
+                  Deprecated: This field will be removed on v1beta2, use VisibilityOnDemand instead.
                 format: int32
                 type: integer
               reservingWorkloads:

diff --git a/config/components/crd/bases/kueue.x-k8s.io_clusterqueues.yaml b/config/components/crd/bases/kueue.x-k8s.io_clusterqueues.yaml
@@ -685,12 +685,14 @@ spec:
                 description: |-
                   pendingWorkloads is the number of workloads currently waiting to be
                   admitted to this clusterQueue.
+                  Deprecated: This field will be removed on v1beta2, use VisibilityOnDemand instead.
                 format: int32
                 type: integer
               pendingWorkloadsStatus:
                 description: |-
                   PendingWorkloadsStatus contains the information exposed about the current
                   status of the pending workloads in the cluster queue.
+                  Deprecated: This field will be removed on v1beta2, use VisibilityOnDemand instead.
                 properties:
                   clusterQueuePendingWorkload:
                     description: Head contains the list of top pending workloads.

diff --git a/config/components/crd/bases/kueue.x-k8s.io_localqueues.yaml b/config/components/crd/bases/kueue.x-k8s.io_localqueues.yaml
@@ -240,8 +240,9 @@ spec:
                 - name
                 x-kubernetes-list-type: map
               pendingWorkloads:
-                description: PendingWorkloads is the number of Workloads in the LocalQueue
-                  not yet admitted to a ClusterQueue
+                description: |-
+                  PendingWorkloads is the number of Workloads in the LocalQueue not yet admitted to a ClusterQueue.
+                  Deprecated: This field will be removed on v1beta2, use VisibilityOnDemand instead.
                 format: int32
                 type: integer
               reservingWorkloads:

diff --git a/pkg/features/kube_features.go b/pkg/features/kube_features.go
@@ -39,6 +39,7 @@ const (
 	// owner: @stuton
 	// kep: https://github.com/kubernetes-sigs/kueue/tree/main/keps/168-pending-workloads-visibility
 	// alpha: v0.5
+	// Deprecated: v0.9
 	//
 	// Enables queue visibility.
 	QueueVisibility featuregate.Feature = "QueueVisibility"

diff --git a/site/content/en/docs/installation/_index.md b/site/content/en/docs/installation/_index.md
@@ -233,22 +233,23 @@ spec:
 
 The currently supported features are:
 
-| Feature                           | Default | Stage | Since | Until |
-|-----------------------------------|---------|-------|-------|-------|
-| `FlavorFungibility`               | `true`  | Beta  | 0.5   |       |
-| `MultiKueue`                      | `false` | Alpha | 0.6   |       |
-| `MultiKueueBatchJobWithManagedBy` | `false` | Alpha | 0.8   |       |
-| `PartialAdmission`                | `false` | Alpha | 0.4   | 0.4   |
-| `PartialAdmission`                | `true`  | Beta  | 0.5   |       |
-| `ProvisioningACC`                 | `false` | Alpha | 0.5   | 0.6   |
-| `ProvisioningACC`                 | `true`  | Beta  | 0.7   |       |
-| `QueueVisibility`                 | `false` | Alpha | 0.5   |       |
-| `VisibilityOnDemand`              | `false` | Alpha | 0.6   |       |
-| `PrioritySortingWithinCohort`     | `true`  | Beta  | 0.6   |       |
-| `LendingLimit`                    | `false` | Alpha | 0.6   | 0.8   |
-| `LendingLimit`                    | `true`  | Beta  | 0.9   |       |
-| `MultiplePreemptions`             | `false` | Alpha | 0.8   | 0.8   |
-| `MultiplePreemptions`             | `true`  | Beta  | 0.9   |       |
+| Feature                           | Default | Stage      | Since | Until |
+|-----------------------------------|---------|------------|-------|-------|
+| `FlavorFungibility`               | `true`  | Beta       | 0.5   |       |
+| `MultiKueue`                      | `false` | Alpha      | 0.6   |       |
+| `MultiKueueBatchJobWithManagedBy` | `false` | Alpha      | 0.8   |       |
+| `PartialAdmission`                | `false` | Alpha      | 0.4   | 0.4   |
+| `PartialAdmission`                | `true`  | Beta       | 0.5   |       |
+| `ProvisioningACC`                 | `false` | Alpha      | 0.5   | 0.6   |
+| `ProvisioningACC`                 | `true`  | Beta       | 0.7   |       |
+| `QueueVisibility`                 | `false` | Alpha      | 0.5   | 0.9   |
+| `QueueVisibility`                 | `false` | Deprecated | 0.9   |       |
+| `VisibilityOnDemand`              | `false` | Alpha      | 0.6   |       |
+| `PrioritySortingWithinCohort`     | `true`  | Beta       | 0.6   |       |
+| `LendingLimit`                    | `false` | Alpha      | 0.6   | 0.8   |
+| `LendingLimit`                    | `true`  | Beta       | 0.9   |       |
+| `MultiplePreemptions`             | `false` | Alpha      | 0.8   | 0.8   |
+| `MultiplePreemptions`             | `true`  | Beta       | 0.9   |       |
 
 ## What's next
 

diff --git a/site/content/en/docs/reference/kueue.v1beta1.md b/site/content/en/docs/reference/kueue.v1beta1.md
@@ -890,7 +890,8 @@ workloads admitted in this ClusterQueue.</p>
 </td>
 <td>
    <p>pendingWorkloads is the number of workloads currently waiting to be
-admitted to this clusterQueue.</p>
+admitted to this clusterQueue.
+Deprecated: This field will be removed on v1beta2, use VisibilityOnDemand instead.</p>
 </td>
 </tr>
 <tr><td><code>reservingWorkloads</code><br/>
@@ -922,7 +923,8 @@ current state.</p>
 </td>
 <td>
    <p>PendingWorkloadsStatus contains the information exposed about the current
-status of the pending workloads in the cluster queue.</p>
+status of the pending workloads in the cluster queue.
+Deprecated: This field will be removed on v1beta2, use VisibilityOnDemand instead.</p>
 </td>
 </tr>
 <tr><td><code>fairSharing</code><br/>
@@ -1243,7 +1245,8 @@ no new reservation being made.</p>
 <code>int32</code>
 </td>
 <td>
-   <p>PendingWorkloads is the number of Workloads in the LocalQueue not yet admitted to a ClusterQueue</p>
+   <p>PendingWorkloads is the number of Workloads in the LocalQueue not yet admitted to a ClusterQueue.
+Deprecated: This field will be removed on v1beta2, use VisibilityOnDemand instead.</p>
 </td>
 </tr>
 <tr><td><code>reservingWorkloads</code><br/>

diff --git a/...t/en/docs/tasks/manage/monitor_pending_workloads/pending_workloads_in_status.md b/...t/en/docs/tasks/manage/monitor_pending_workloads/pending_workloads_in_status.md
@@ -1,6 +1,6 @@
 ---
 title: "Pending workloads in Status"
-date: 2023-09-27
+date: 2024-09-23
 weight: 3
 description: >
   Obtain the pending workloads in ClusterQueue and LocalQueue statuses.
@@ -28,7 +28,12 @@ QueueVisibility is an `Alpha` feature disabled by default, check the [Change the
 
 ## Monitor pending workloads
 
-{{< feature-state state="alpha" for_version="v0.5" >}}
+{{< feature-state state="deprecated" for_version="v0.9" >}}
+
+{{% alert title="Warning" color="warning" %}}
+This feature is deprecated and will be deleted on v1beta2. 
+Please use [Pending Workloads on-demand](/docs/tasks/manage/monitor_pending_workloads/pending_workloads_on_demand/) instead.
+{{% /alert %}}
 
 To install a simple setup of cluster queue, run the following command: