forked from kubernetes-sigs/kueue
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Support MPIJob managedBy feature for the MultiKueue (kubernetes-sigs#…
…3289) * Add managedBy field impl and unit tests * Update MpiJob multikueue integration test * Update e2e tests and start to use mpi-operator on managment cluster * Implement webhook defaulting * Update after code review
- Loading branch information
Showing
10 changed files
with
610 additions
and
38 deletions.
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| /* | ||
| 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 mpijob | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "github.com/kubeflow/mpi-operator/pkg/apis/kubeflow/v2beta1" | ||
| "k8s.io/apimachinery/pkg/runtime" | ||
| "k8s.io/klog/v2" | ||
| "k8s.io/utils/ptr" | ||
| ctrl "sigs.k8s.io/controller-runtime" | ||
| "sigs.k8s.io/controller-runtime/pkg/webhook/admission" | ||
|
|
||
| kueue "sigs.k8s.io/kueue/apis/kueue/v1beta1" | ||
| "sigs.k8s.io/kueue/pkg/cache" | ||
| "sigs.k8s.io/kueue/pkg/controller/constants" | ||
| "sigs.k8s.io/kueue/pkg/controller/jobframework" | ||
| "sigs.k8s.io/kueue/pkg/controller/jobframework/webhook" | ||
| "sigs.k8s.io/kueue/pkg/features" | ||
| "sigs.k8s.io/kueue/pkg/queue" | ||
| "sigs.k8s.io/kueue/pkg/util/kubeversion" | ||
| ) | ||
|
|
||
| type MpiJobWebhook struct { | ||
| manageJobsWithoutQueueName bool | ||
| kubeServerVersion *kubeversion.ServerVersionFetcher | ||
| queues *queue.Manager | ||
| cache *cache.Cache | ||
| } | ||
|
|
||
| // SetupMPIJobWebhook configures the webhook for MPIJob. | ||
| func SetupMPIJobWebhook(mgr ctrl.Manager, opts ...jobframework.Option) error { | ||
| options := jobframework.ProcessOptions(opts...) | ||
| wh := &MpiJobWebhook{ | ||
| manageJobsWithoutQueueName: options.ManageJobsWithoutQueueName, | ||
| kubeServerVersion: options.KubeServerVersion, | ||
| queues: options.Queues, | ||
| cache: options.Cache, | ||
| } | ||
| obj := &v2beta1.MPIJob{} | ||
| return webhook.WebhookManagedBy(mgr). | ||
| For(obj). | ||
| WithMutationHandler(webhook.WithLosslessDefaulter(mgr.GetScheme(), obj, wh)). | ||
| WithValidator(wh). | ||
| Complete() | ||
| } | ||
|
|
||
| // +kubebuilder:webhook:path=/mutate-kubeflow-org-v2beta1-mpijob,mutating=true,failurePolicy=fail,sideEffects=None,groups=kubeflow.org,resources=mpijobs,verbs=create,versions=v2beta1,name=mmpijob.kb.io,admissionReviewVersions=v1 | ||
|
|
||
| var _ admission.CustomDefaulter = &MpiJobWebhook{} | ||
|
|
||
| // Default implements webhook.CustomDefaulter so a webhook will be registered for the type | ||
| func (w *MpiJobWebhook) Default(ctx context.Context, obj runtime.Object) error { | ||
| mpiJob := fromObject(obj) | ||
| log := ctrl.LoggerFrom(ctx).WithName("mpijob-webhook") | ||
| log.V(5).Info("Applying defaults", "mpijob", klog.KObj(mpiJob)) | ||
|
|
||
| jobframework.ApplyDefaultForSuspend(mpiJob, w.manageJobsWithoutQueueName) | ||
|
|
||
| if canDefaultManagedBy(mpiJob.Spec.RunPolicy.ManagedBy) { | ||
| localQueueName, found := mpiJob.Labels[constants.QueueLabel] | ||
| if !found { | ||
| return nil | ||
| } | ||
| clusterQueueName, ok := w.queues.ClusterQueueFromLocalQueue(queue.QueueKey(mpiJob.ObjectMeta.Namespace, localQueueName)) | ||
| if !ok { | ||
| log.V(5).Info("Cluster queue for local queue not found", "mpijob", klog.KObj(mpiJob), "localQueue", localQueueName) | ||
| return nil | ||
| } | ||
| for _, admissionCheck := range w.cache.AdmissionChecksForClusterQueue(clusterQueueName) { | ||
| if admissionCheck.Controller == kueue.MultiKueueControllerName { | ||
| log.V(5).Info("Defaulting ManagedBy", "mpijob", klog.KObj(mpiJob), "oldManagedBy", mpiJob.Spec.RunPolicy.ManagedBy, "managedBy", kueue.MultiKueueControllerName) | ||
| mpiJob.Spec.RunPolicy.ManagedBy = ptr.To(kueue.MultiKueueControllerName) | ||
| return nil | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func canDefaultManagedBy(mpiJobSpecManagedBy *string) bool { | ||
| return features.Enabled(features.MultiKueue) && | ||
| (mpiJobSpecManagedBy == nil || *mpiJobSpecManagedBy == v2beta1.KubeflowJobController) | ||
| } | ||
|
|
||
| // +kubebuilder:webhook:path=/validate-kubeflow-org-v2beta1-mpijob,mutating=false,failurePolicy=fail,sideEffects=None,groups=kubeflow.org,resources=mpijobs,verbs=create;update,versions=v2beta1,name=vmpijob.kb.io,admissionReviewVersions=v1 | ||
|
|
||
| var _ admission.CustomValidator = &MpiJobWebhook{} | ||
|
|
||
| // ValidateCreate implements webhook.CustomValidator so a webhook will be registered for the type | ||
| func (w *MpiJobWebhook) ValidateCreate(ctx context.Context, obj runtime.Object) (admission.Warnings, error) { | ||
| mpiJob := fromObject(obj) | ||
| log := ctrl.LoggerFrom(ctx).WithName("mpijob-webhook") | ||
| log.Info("Validating create", "mpijob", klog.KObj(mpiJob)) | ||
| return nil, jobframework.ValidateJobOnCreate(mpiJob).ToAggregate() | ||
| } | ||
|
|
||
| // ValidateUpdate implements webhook.CustomValidator so a webhook will be registered for the type | ||
| func (w *MpiJobWebhook) ValidateUpdate(ctx context.Context, oldObj, newObj runtime.Object) (admission.Warnings, error) { | ||
| oldMpiJob := fromObject(oldObj) | ||
| newMpiJob := fromObject(newObj) | ||
| log := ctrl.LoggerFrom(ctx).WithName("mpijob-webhook") | ||
| log.Info("Validating update", "mpijob", klog.KObj(newMpiJob)) | ||
| allErrs := jobframework.ValidateJobOnUpdate(oldMpiJob, newMpiJob) | ||
| allErrs = append(allErrs, jobframework.ValidateJobOnCreate(newMpiJob)...) | ||
| return nil, allErrs.ToAggregate() | ||
| } | ||
|
|
||
| // ValidateDelete implements webhook.CustomValidator so a webhook will be registered for the type | ||
| func (w *MpiJobWebhook) ValidateDelete(context.Context, runtime.Object) (admission.Warnings, error) { | ||
| return nil, nil | ||
| } |
Oops, something went wrong.