Files
Jun-Hao WanandGitHub af80e19cf4 [Scheduler] Replace AddMetadataToPod with AddMetadataToChildResource across all schedulers (#4123)
* [Scheduler] Replace AddMetadataToPod with AddMetadataToChildResource across all schedulers

Signed-off-by: win5923 <[email protected]>

* Extract AddSchedulerNameToObject to batchscheduler utils package

Signed-off-by: win5923 <[email protected]>

* Add test for rayv1.RayCluster to AddSchedulerNameToObject

Signed-off-by: win5923 <[email protected]>

---------

Signed-off-by: win5923 <[email protected]>
2025-10-27 08:23:13 -07:00

71 lines
2.6 KiB
Go

package schedulerinterface
import (
"context"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/client-go/rest"
"sigs.k8s.io/controller-runtime/pkg/builder"
"sigs.k8s.io/controller-runtime/pkg/client"
)
// BatchScheduler manages submitting RayCluster pods to a third-party scheduler.
type BatchScheduler interface {
// Name corresponds to the schedulerName in Kubernetes:
// https://kubernetes.io/docs/tasks/extend-kubernetes/configure-multiple-schedulers/
Name() string
// DoBatchSchedulingOnSubmission handles submitting the RayCluster/RayJob to the batch scheduler on creation / update
// For most batch schedulers, this results in the creation of a PodGroup.
DoBatchSchedulingOnSubmission(ctx context.Context, object metav1.Object) error
// AddMetadataToChildResource enriches the child resource (batchv1.Job, rayv1.RayCluster) with metadata necessary to tie it to the scheduler.
// For example, setting labels for queues / priority, and setting schedulerName.
AddMetadataToChildResource(ctx context.Context, parent metav1.Object, child metav1.Object, groupName string)
}
// BatchSchedulerFactory handles initial setup of the scheduler plugin by registering the
// necessary callbacks with the operator, and the creation of the BatchScheduler itself.
type BatchSchedulerFactory interface {
// New creates a new BatchScheduler for the scheduler plugin.
New(ctx context.Context, config *rest.Config, cli client.Client) (BatchScheduler, error)
// AddToScheme adds the types in this scheduler to the given scheme (runs during init).
AddToScheme(scheme *runtime.Scheme)
// ConfigureReconciler configures the RayCluster Reconciler in the process of being built by
// adding watches for its scheduler-specific custom resource types, and any other needed setup.
ConfigureReconciler(b *builder.Builder) *builder.Builder
}
type DefaultBatchScheduler struct{}
type DefaultBatchSchedulerFactory struct{}
func GetDefaultPluginName() string {
return "default"
}
func (d *DefaultBatchScheduler) Name() string {
return GetDefaultPluginName()
}
func (d *DefaultBatchScheduler) DoBatchSchedulingOnSubmission(_ context.Context, _ metav1.Object) error {
return nil
}
func (d *DefaultBatchScheduler) AddMetadataToChildResource(_ context.Context, _ metav1.Object, _ metav1.Object, _ string) {
}
func (df *DefaultBatchSchedulerFactory) New(_ context.Context, _ *rest.Config, _ client.Client) (BatchScheduler, error) {
return &DefaultBatchScheduler{}, nil
}
func (df *DefaultBatchSchedulerFactory) AddToScheme(_ *runtime.Scheme) {
}
func (df *DefaultBatchSchedulerFactory) ConfigureReconciler(b *builder.Builder) *builder.Builder {
return b
}