mirror of
https://github.com/hanzo-ml/kuberay.git
synced 2026-10-30 19:48:47 +00:00
72 lines
2.5 KiB
Go
72 lines
2.5 KiB
Go
package schedulerinterface
|
|
|
|
import (
|
|
"context"
|
|
|
|
corev1 "k8s.io/api/core/v1"
|
|
"k8s.io/apimachinery/pkg/runtime"
|
|
"k8s.io/client-go/rest"
|
|
"sigs.k8s.io/controller-runtime/pkg/builder"
|
|
|
|
rayv1 "github.com/ray-project/kuberay/ray-operator/apis/ray/v1"
|
|
)
|
|
|
|
// 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 to the batch scheduler on creation / update
|
|
// For most batch schedulers, this results in the creation of a PodGroup.
|
|
DoBatchSchedulingOnSubmission(ctx context.Context, app *rayv1.RayCluster) error
|
|
|
|
// AddMetadataToPod enriches Pod specs with metadata necessary to tie them to the scheduler.
|
|
// For example, setting labels for queues / priority, and setting schedulerName.
|
|
AddMetadataToPod(ctx context.Context, app *rayv1.RayCluster, groupName string, pod *corev1.Pod)
|
|
}
|
|
|
|
// 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) (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, _ *rayv1.RayCluster) error {
|
|
return nil
|
|
}
|
|
|
|
func (d *DefaultBatchScheduler) AddMetadataToPod(_ context.Context, _ *rayv1.RayCluster, _ string, _ *corev1.Pod) {
|
|
}
|
|
|
|
func (df *DefaultBatchSchedulerFactory) New(_ context.Context, _ *rest.Config) (BatchScheduler, error) {
|
|
return &DefaultBatchScheduler{}, nil
|
|
}
|
|
|
|
func (df *DefaultBatchSchedulerFactory) AddToScheme(_ *runtime.Scheme) {
|
|
}
|
|
|
|
func (df *DefaultBatchSchedulerFactory) ConfigureReconciler(b *builder.Builder) *builder.Builder {
|
|
return b
|
|
}
|