Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate QueueVisibility feature and corresponding API. #3110

Merged
merged 1 commit into from
Sep 24, 2024
Merged

Deprecate QueueVisibility feature and corresponding API. #3110

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions apis/config/v1beta1/configuration_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,9 @@ type Configuration struct {

// QueueVisibility is configuration to expose the information about the top
// pending workloads.
// Deprecated: This field will be removed on v1beta2, use VisibilityOnDemand
// (https://kueue.sigs.k8s.io/docs/tasks/manage/monitor_pending_workloads/pending_workloads_on_demand/)
// instead.
QueueVisibility *QueueVisibility `json:"queueVisibility,omitempty"`

// MultiKueue controls the behaviour of the MultiKueue AdmissionCheck Controller.
Expand Down
3 changes: 3 additions & 0 deletions apis/kueue/v1beta1/clusterqueue_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,9 @@ 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
// (https://kueue.sigs.k8s.io/docs/tasks/manage/monitor_pending_workloads/pending_workloads_on_demand/)
// instead.
// +optional
PendingWorkloadsStatus *ClusterQueuePendingWorkloadsStatus `json:"pendingWorkloadsStatus"`

Expand Down
3 changes: 3 additions & 0 deletions charts/kueue/templates/crd/kueue.x-k8s.io_clusterqueues.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -706,6 +706,9 @@ spec:
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
(https://kueue.sigs.k8s.io/docs/tasks/manage/monitor_pending_workloads/pending_workloads_on_demand/)
instead.
properties:
clusterQueuePendingWorkload:
description: Head contains the list of top pending workloads.
Expand Down
3 changes: 3 additions & 0 deletions config/components/crd/bases/kueue.x-k8s.io_clusterqueues.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -691,6 +691,9 @@ spec:
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
(https://kueue.sigs.k8s.io/docs/tasks/manage/monitor_pending_workloads/pending_workloads_on_demand/)
instead.
properties:
clusterQueuePendingWorkload:
description: Head contains the list of top pending workloads.
Expand Down
1 change: 1 addition & 0 deletions pkg/features/kube_features.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
35 changes: 18 additions & 17 deletions site/content/en/docs/installation/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,23 +233,24 @@ 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 | 0.8 |
| `VisibilityOnDemand` | `true` | Beta | 0.9 | |
| `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 | 0.8 |
| `VisibilityOnDemand` | `true` | Beta | 0.9 | |
| `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

Expand Down
5 changes: 4 additions & 1 deletion site/content/en/docs/reference/kueue-config.v1beta1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,10 @@ integrations (including K8S job).</p>
</td>
<td>
<p>QueueVisibility is configuration to expose the information about the top
pending workloads.</p>
pending workloads.
Deprecated: This field will be removed on v1beta2, use VisibilityOnDemand
(https://kueue.sigs.k8s.io/docs/tasks/manage/monitor_pending_workloads/pending_workloads_on_demand/)
instead.</p>
</td>
</tr>
<tr><td><code>multiKueue</code> <B>[Required]</B><br/>
Expand Down
5 changes: 4 additions & 1 deletion site/content/en/docs/reference/kueue.v1beta1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -922,7 +922,10 @@ 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
(https://kueue.sigs.k8s.io/docs/tasks/manage/monitor_pending_workloads/pending_workloads_on_demand/)
instead.</p>
</td>
</tr>
<tr><td><code>fairSharing</code><br/>
Expand Down
9 changes: 7 additions & 2 deletions ...t/en/docs/tasks/manage/monitor_pending_workloads/pending_workloads_in_status.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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:

Expand Down