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

TAS: PodSet label and Workload annotation for PodTemplates #3228

Merged
merged 1 commit into from
Oct 15, 2024
Merged

TAS: PodSet label and Workload annotation for PodTemplates #3228

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
29 changes: 29 additions & 0 deletions apis/kueue/v1alpha1/tas_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
/*
Copyright The Kubernetes Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package v1alpha1

const (
// WorkloadAnnotation is an annotation set on the Job's PodTemplate to
// indicate the name of the admitted Workload corresponding to the Job. The
// annotation is set when starting the Job, and removed on stopping the Job.
WorkloadAnnotation = "kueue.x-k8s.io/workload"

// PodSetLabel is a label set on the Job's PodTemplate to indicate the name
// of the PodSet of the admitted Workload corresponding to the PodTemplate.
// The label is set when starting the Job, and removed on stopping the Job.
PodSetLabel = "kueue.x-k8s.io/podset"
)
6 changes: 5 additions & 1 deletion pkg/controller/jobframework/reconciler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ import (
"sigs.k8s.io/controller-runtime/pkg/reconcile"

configapi "sigs.k8s.io/kueue/apis/config/v1beta1"
kueuealpha "sigs.k8s.io/kueue/apis/kueue/v1alpha1"
kueue "sigs.k8s.io/kueue/apis/kueue/v1beta1"
"sigs.k8s.io/kueue/pkg/cache"
"sigs.k8s.io/kueue/pkg/constants"
Expand Down Expand Up @@ -973,7 +974,10 @@ func getPodSetsInfoFromStatus(ctx context.Context, c client.Client, w *kueue.Wor
if err != nil {
return nil, err
}

if features.Enabled(features.TopologyAwareScheduling) {
info.Labels[kueuealpha.PodSetLabel] = podSetFlavor.Name
info.Annotations[kueuealpha.WorkloadAnnotation] = w.Name
}
for _, admissionCheck := range w.Status.AdmissionChecks {
for _, podSetUpdate := range admissionCheck.PodSetUpdates {
if podSetUpdate.Name == info.Name {
Expand Down
35 changes: 35 additions & 0 deletions pkg/controller/jobs/job/job_controller_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,12 @@ import (
"sigs.k8s.io/controller-runtime/pkg/client/interceptor"
"sigs.k8s.io/controller-runtime/pkg/reconcile"

kueuealpha "sigs.k8s.io/kueue/apis/kueue/v1alpha1"
kueue "sigs.k8s.io/kueue/apis/kueue/v1beta1"
"sigs.k8s.io/kueue/pkg/constants"
controllerconsts "sigs.k8s.io/kueue/pkg/controller/constants"
"sigs.k8s.io/kueue/pkg/controller/jobframework"
"sigs.k8s.io/kueue/pkg/features"
"sigs.k8s.io/kueue/pkg/podset"
utiltesting "sigs.k8s.io/kueue/pkg/util/testing"
utiltestingjob "sigs.k8s.io/kueue/pkg/util/testingjobs/job"
Expand Down Expand Up @@ -416,6 +418,8 @@ func TestReconciler(t *testing.T) {
PriorityValue(200)

cases := map[string]struct {
enableTopologyAwareScheduling bool

reconcilerOptions []jobframework.Option
job batchv1.Job
workloads []kueue.Workload
Expand All @@ -426,6 +430,36 @@ func TestReconciler(t *testing.T) {
wantEvents []utiltesting.EventRecord
wantErr error
}{
"PodSet label and Workload annotation are set when Job is starting; TopologyAwareScheduling enabled": {
enableTopologyAwareScheduling: true,
reconcilerOptions: []jobframework.Option{
jobframework.WithManageJobsWithoutQueueName(true),
},
job: *baseJobWrapper.DeepCopy(),
wantJob: *baseJobWrapper.Clone().
Suspend(false).
PodLabel(kueuealpha.PodSetLabel, kueue.DefaultPodSetName).
PodAnnotation(kueuealpha.WorkloadAnnotation, "wl").
Obj(),
workloads: []kueue.Workload{
*baseWorkloadWrapper.Clone().
Admitted(true).
Obj(),
},
wantWorkloads: []kueue.Workload{
*baseWorkloadWrapper.Clone().
Admitted(true).
Obj(),
},
wantEvents: []utiltesting.EventRecord{
{
Key: types.NamespacedName{Name: "job", Namespace: "ns"},
EventType: "Normal",
Reason: "Started",
Message: "Admitted by clusterQueue cq",
},
},
},
"when workload is created, it has its owner ProvReq annotations": {
job: *baseJobWrapper.Clone().
SetAnnotation(controllerconsts.ProvReqAnnotationPrefix+"test-annotation", "test-val").
Expand Down Expand Up @@ -2713,6 +2747,7 @@ func TestReconciler(t *testing.T) {
}
for name, tc := range cases {
t.Run(name, func(t *testing.T) {
features.SetFeatureGateDuringTest(t, features.TopologyAwareScheduling, tc.enableTopologyAwareScheduling)
ctx, _ := utiltesting.ContextWithLog(t)
clientBuilder := utiltesting.NewClientBuilder().WithInterceptorFuncs(interceptor.Funcs{SubResourcePatch: utiltesting.TreatSSAAsStrategicMerge})
if err := SetupIndexes(ctx, utiltesting.AsIndexer(clientBuilder)); err != nil {
Expand Down
8 changes: 8 additions & 0 deletions pkg/features/kube_features.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,13 @@ const (
// Enable more than one workload sharing flavors to preempt within a Cohort,
// as long as the preemption targets don't overlap.
MultiplePreemptions featuregate.Feature = "MultiplePreemptions"

// owner: @mimowo
// alpha: v0.9
//
// Enable Topology Aware Scheduling allowing to optimize placement of Pods
// to put them on closely located nodes (e.g. within the same rack or block).
TopologyAwareScheduling featuregate.Feature = "TopologyAwareScheduling"
)

func init() {
Expand All @@ -125,6 +132,7 @@ var defaultFeatureGates = map[featuregate.Feature]featuregate.FeatureSpec{
LendingLimit: {Default: true, PreRelease: featuregate.Beta},
MultiKueueBatchJobWithManagedBy: {Default: false, PreRelease: featuregate.Alpha},
MultiplePreemptions: {Default: true, PreRelease: featuregate.Beta},
TopologyAwareScheduling: {Default: false, PreRelease: featuregate.Alpha},
}

func SetFeatureGateDuringTest(tb testing.TB, f featuregate.Feature, value bool) {
Expand Down
1 change: 1 addition & 0 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 @@ -252,6 +252,7 @@ The currently supported features are:
| `LendingLimit` | `true` | Beta | 0.9 | |
| `MultiplePreemptions` | `false` | Alpha | 0.8 | 0.8 |
| `MultiplePreemptions` | `true` | Beta | 0.9 | |
| `TopologyAwareScheduling` | `false` | Alpha | 0.9 | |

## What's next

Expand Down