generated from kubernetes/kubernetes-template-project
-
Notifications
You must be signed in to change notification settings - Fork 239
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.
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
Provide Kubeflow XGBoostJob support for MultiKueue #2746
Merged
k8s-ci-robot
merged 2 commits into
kubernetes-sigs:main
from
epam:feature/support-kubeflow-xgboost-in-mk
Aug 5, 2024
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -328,6 +328,7 @@ rules: | |
| - xgboostjobs/status | ||
| verbs: | ||
| - get | ||
| - patch | ||
| - update | ||
| - apiGroups: | ||
| - kueue.x-k8s.io | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -327,6 +327,7 @@ rules: | |
| - xgboostjobs/status | ||
| verbs: | ||
| - get | ||
| - patch | ||
| - update | ||
| - apiGroups: | ||
| - kueue.x-k8s.io | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
117 changes: 117 additions & 0 deletions
117
pkg/controller/jobs/kubeflow/jobs/xgboostjob/xgboostjob_multikueue_adapter.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| /* | ||
| Copyright 2024 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 xgboostjob | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "fmt" | ||
|
|
||
| kftraining "github.com/kubeflow/training-operator/pkg/apis/kubeflow.org/v1" | ||
| "k8s.io/apimachinery/pkg/runtime" | ||
| "k8s.io/apimachinery/pkg/runtime/schema" | ||
| "k8s.io/apimachinery/pkg/types" | ||
| "k8s.io/klog/v2" | ||
| "sigs.k8s.io/controller-runtime/pkg/client" | ||
|
|
||
| kueuealpha "sigs.k8s.io/kueue/apis/kueue/v1alpha1" | ||
| "sigs.k8s.io/kueue/pkg/controller/constants" | ||
| "sigs.k8s.io/kueue/pkg/controller/jobframework" | ||
| "sigs.k8s.io/kueue/pkg/util/api" | ||
| clientutil "sigs.k8s.io/kueue/pkg/util/client" | ||
| ) | ||
|
|
||
| type multikueueAdapter struct{} | ||
|
|
||
| var _ jobframework.MultiKueueAdapter = (*multikueueAdapter)(nil) | ||
|
|
||
| func (b *multikueueAdapter) SyncJob(ctx context.Context, localClient client.Client, remoteClient client.Client, key types.NamespacedName, workloadName, origin string) error { | ||
| localJob := kftraining.XGBoostJob{} | ||
| err := localClient.Get(ctx, key, &localJob) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| remoteJob := &kftraining.XGBoostJob{} | ||
| err = remoteClient.Get(ctx, key, remoteJob) | ||
| if client.IgnoreNotFound(err) != nil { | ||
| return err | ||
| } | ||
|
|
||
| // if the remote exists, just copy the status | ||
| if err == nil { | ||
| return clientutil.PatchStatus(ctx, localClient, &localJob, func() (bool, error) { | ||
| localJob.Status = remoteJob.Status | ||
| return true, nil | ||
| }) | ||
| } | ||
|
|
||
| remoteJob = &kftraining.XGBoostJob{ | ||
| ObjectMeta: api.CloneObjectMetaForCreation(&localJob.ObjectMeta), | ||
| Spec: *localJob.Spec.DeepCopy(), | ||
| } | ||
|
|
||
| // add the prebuilt workload | ||
| if remoteJob.Labels == nil { | ||
| remoteJob.Labels = make(map[string]string, 2) | ||
| } | ||
| remoteJob.Labels[constants.PrebuiltWorkloadLabel] = workloadName | ||
| remoteJob.Labels[kueuealpha.MultiKueueOriginLabel] = origin | ||
|
|
||
| return remoteClient.Create(ctx, remoteJob) | ||
| } | ||
|
|
||
| func (b *multikueueAdapter) DeleteRemoteObject(ctx context.Context, remoteClient client.Client, key types.NamespacedName) error { | ||
| job := kftraining.XGBoostJob{} | ||
| err := remoteClient.Get(ctx, key, &job) | ||
| if err != nil { | ||
| return client.IgnoreNotFound(err) | ||
| } | ||
| return client.IgnoreNotFound(remoteClient.Delete(ctx, &job)) | ||
| } | ||
|
|
||
| func (b *multikueueAdapter) KeepAdmissionCheckPending() bool { | ||
| return false | ||
| } | ||
|
|
||
| func (b *multikueueAdapter) IsJobManagedByKueue(context.Context, client.Client, types.NamespacedName) (bool, string, error) { | ||
| return true, "", nil | ||
| } | ||
|
|
||
| func (b *multikueueAdapter) GVK() schema.GroupVersionKind { | ||
| return gvk | ||
| } | ||
|
|
||
| var _ jobframework.MultiKueueWatcher = (*multikueueAdapter)(nil) | ||
|
|
||
| func (*multikueueAdapter) GetEmptyList() client.ObjectList { | ||
| return &kftraining.XGBoostJobList{} | ||
| } | ||
|
|
||
| func (*multikueueAdapter) WorkloadKeyFor(o runtime.Object) (types.NamespacedName, error) { | ||
| xgBoostJob, isXgBoostJob := o.(*kftraining.XGBoostJob) | ||
| if !isXgBoostJob { | ||
| return types.NamespacedName{}, errors.New("not a XgBoostJob") | ||
| } | ||
|
|
||
| prebuiltWl, hasPrebuiltWorkload := xgBoostJob.Labels[constants.PrebuiltWorkloadLabel] | ||
| if !hasPrebuiltWorkload { | ||
| return types.NamespacedName{}, fmt.Errorf("no prebuilt workload found for XgBoostJob: %s", klog.KObj(xgBoostJob)) | ||
| } | ||
|
|
||
| return types.NamespacedName{Name: prebuiltWl, Namespace: xgBoostJob.Namespace}, nil | ||
| } | ||
159 changes: 159 additions & 0 deletions
159
pkg/controller/jobs/kubeflow/jobs/xgboostjob/xgboostjob_multikueue_adapter_test.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,159 @@ | ||
| /* | ||
| Copyright 2024 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 xgboostjob | ||
|
|
||
| import ( | ||
| "context" | ||
| "testing" | ||
|
|
||
| "github.com/google/go-cmp/cmp" | ||
| "github.com/google/go-cmp/cmp/cmpopts" | ||
| kftraining "github.com/kubeflow/training-operator/pkg/apis/kubeflow.org/v1" | ||
| corev1 "k8s.io/api/core/v1" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "k8s.io/apimachinery/pkg/types" | ||
| "sigs.k8s.io/controller-runtime/pkg/client" | ||
| "sigs.k8s.io/controller-runtime/pkg/client/interceptor" | ||
|
|
||
| kueuealpha "sigs.k8s.io/kueue/apis/kueue/v1alpha1" | ||
| "sigs.k8s.io/kueue/pkg/controller/constants" | ||
| "sigs.k8s.io/kueue/pkg/util/slices" | ||
| utiltesting "sigs.k8s.io/kueue/pkg/util/testing" | ||
| kfutiltesting "sigs.k8s.io/kueue/pkg/util/testingjobs/xgboostjob" | ||
| ) | ||
|
|
||
| const ( | ||
| TestNamespace = "ns" | ||
| ) | ||
|
|
||
| func TestMultikueueAdapter(t *testing.T) { | ||
| objCheckOpts := []cmp.Option{ | ||
| cmpopts.IgnoreFields(metav1.ObjectMeta{}, "ResourceVersion"), | ||
| cmpopts.EquateEmpty(), | ||
| } | ||
|
|
||
| xgboostJobBuilder := kfutiltesting.MakeXGBoostJob("xgboostjob1", TestNamespace).Queue("queue").Suspend(false) | ||
|
|
||
| cases := map[string]struct { | ||
| managersXGBoostJobs []kftraining.XGBoostJob | ||
| workerXGBoostJobs []kftraining.XGBoostJob | ||
|
|
||
| operation func(ctx context.Context, adapter *multikueueAdapter, managerClient, workerClient client.Client) error | ||
|
|
||
| wantError error | ||
| wantManagersXGBoostJobs []kftraining.XGBoostJob | ||
| wantWorkerXGBoostJobs []kftraining.XGBoostJob | ||
| }{ | ||
| "sync creates missing remote xgboostjob": { | ||
| managersXGBoostJobs: []kftraining.XGBoostJob{ | ||
| *xgboostJobBuilder.Clone().Obj(), | ||
| }, | ||
| operation: func(ctx context.Context, adapter *multikueueAdapter, managerClient, workerClient client.Client) error { | ||
| return adapter.SyncJob(ctx, managerClient, workerClient, types.NamespacedName{Name: "xgboostjob1", Namespace: TestNamespace}, "wl1", "origin1") | ||
| }, | ||
|
|
||
| wantManagersXGBoostJobs: []kftraining.XGBoostJob{ | ||
| *xgboostJobBuilder.Clone().Obj(), | ||
| }, | ||
| wantWorkerXGBoostJobs: []kftraining.XGBoostJob{ | ||
| *xgboostJobBuilder.Clone(). | ||
| Label(constants.PrebuiltWorkloadLabel, "wl1"). | ||
| Label(kueuealpha.MultiKueueOriginLabel, "origin1"). | ||
| Obj(), | ||
| }, | ||
| }, | ||
| "sync status from remote XgBoostJob": { | ||
| managersXGBoostJobs: []kftraining.XGBoostJob{ | ||
| *xgboostJobBuilder.Clone().Obj(), | ||
| }, | ||
| workerXGBoostJobs: []kftraining.XGBoostJob{ | ||
| *xgboostJobBuilder.Clone(). | ||
| Label(constants.PrebuiltWorkloadLabel, "wl1"). | ||
| Label(kueuealpha.MultiKueueOriginLabel, "origin1"). | ||
| StatusConditions(kftraining.JobCondition{Type: kftraining.JobSucceeded, Status: corev1.ConditionTrue}). | ||
| Obj(), | ||
| }, | ||
| operation: func(ctx context.Context, adapter *multikueueAdapter, managerClient, workerClient client.Client) error { | ||
| return adapter.SyncJob(ctx, managerClient, workerClient, types.NamespacedName{Name: "xgboostjob1", Namespace: TestNamespace}, "wl1", "origin1") | ||
| }, | ||
|
|
||
| wantManagersXGBoostJobs: []kftraining.XGBoostJob{ | ||
| *xgboostJobBuilder.Clone(). | ||
| StatusConditions(kftraining.JobCondition{Type: kftraining.JobSucceeded, Status: corev1.ConditionTrue}). | ||
| Obj(), | ||
| }, | ||
| wantWorkerXGBoostJobs: []kftraining.XGBoostJob{ | ||
| *xgboostJobBuilder.Clone(). | ||
| Label(constants.PrebuiltWorkloadLabel, "wl1"). | ||
| Label(kueuealpha.MultiKueueOriginLabel, "origin1"). | ||
| StatusConditions(kftraining.JobCondition{Type: kftraining.JobSucceeded, Status: corev1.ConditionTrue}). | ||
| Obj(), | ||
| }, | ||
| }, | ||
| "remote XgBoostJob is deleted": { | ||
| workerXGBoostJobs: []kftraining.XGBoostJob{ | ||
| *xgboostJobBuilder.Clone(). | ||
| Label(constants.PrebuiltWorkloadLabel, "wl1"). | ||
| Label(kueuealpha.MultiKueueOriginLabel, "origin1"). | ||
| Obj(), | ||
| }, | ||
| operation: func(ctx context.Context, adapter *multikueueAdapter, managerClient, workerClient client.Client) error { | ||
| return adapter.DeleteRemoteObject(ctx, workerClient, types.NamespacedName{Name: "xgboostjob1", Namespace: TestNamespace}) | ||
| }, | ||
| }, | ||
| } | ||
| for name, tc := range cases { | ||
| t.Run(name, func(t *testing.T) { | ||
| managerBuilder := utiltesting.NewClientBuilder(kftraining.AddToScheme).WithInterceptorFuncs(interceptor.Funcs{SubResourcePatch: utiltesting.TreatSSAAsStrategicMerge}) | ||
| managerBuilder = managerBuilder.WithLists(&kftraining.XGBoostJobList{Items: tc.managersXGBoostJobs}) | ||
| managerBuilder = managerBuilder.WithStatusSubresource(slices.Map(tc.managersXGBoostJobs, func(w *kftraining.XGBoostJob) client.Object { return w })...) | ||
| managerClient := managerBuilder.Build() | ||
|
|
||
| workerBuilder := utiltesting.NewClientBuilder(kftraining.AddToScheme).WithInterceptorFuncs(interceptor.Funcs{SubResourcePatch: utiltesting.TreatSSAAsStrategicMerge}) | ||
| workerBuilder = workerBuilder.WithLists(&kftraining.XGBoostJobList{Items: tc.workerXGBoostJobs}) | ||
| workerClient := workerBuilder.Build() | ||
|
|
||
| ctx, _ := utiltesting.ContextWithLog(t) | ||
|
|
||
| adapter := &multikueueAdapter{} | ||
|
|
||
| gotErr := tc.operation(ctx, adapter, managerClient, workerClient) | ||
|
|
||
| if diff := cmp.Diff(tc.wantError, gotErr, cmpopts.EquateErrors()); diff != "" { | ||
| t.Errorf("unexpected error (-want/+got):\n%s", diff) | ||
| } | ||
|
|
||
| gotManagersXGBoostJob := &kftraining.XGBoostJobList{} | ||
| if err := managerClient.List(ctx, gotManagersXGBoostJob); err != nil { | ||
| t.Errorf("unexpected list manager's XgBoostJobs error %s", err) | ||
| } else { | ||
| if diff := cmp.Diff(tc.wantManagersXGBoostJobs, gotManagersXGBoostJob.Items, objCheckOpts...); diff != "" { | ||
| t.Errorf("unexpected manager's XgBoostJobs (-want/+got):\n%s", diff) | ||
| } | ||
| } | ||
|
|
||
| gotWorkerXGBoostJobs := &kftraining.XGBoostJobList{} | ||
| if err := workerClient.List(ctx, gotWorkerXGBoostJobs); err != nil { | ||
| t.Errorf("unexpected list worker's XgBoostJobs error %s", err) | ||
| } else { | ||
| if diff := cmp.Diff(tc.wantWorkerXGBoostJobs, gotWorkerXGBoostJobs.Items, objCheckOpts...); diff != "" { | ||
| t.Errorf("unexpected worker's XgBoostJobs (-want/+got):\n%s", diff) | ||
| } | ||
| } | ||
| }) | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The adapter code is almost identical between the integrations. I would like to put effort at some point to commonize it, at least for Kubeflow. @mszadkow could you attempt commonizing them in this PR, or in a follow up?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure I will make the attempt, I would prefer in follow up
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sg, I will prefer to commonize the adapters for the 2 integrations we currently have before adding new ones.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, I will do that thing first
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
to be clear it is ok in a follow up to this pr.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1
Commonizing the adapters would be better.