schedulerinterface

Documentation

Index

• func GetDefaultPluginName() string
• type BatchScheduler
• type BatchSchedulerFactory
• type DefaultBatchScheduler
  • func (d *DefaultBatchScheduler) AddMetadataToPod(app *rayv1.RayCluster, groupName string, pod *corev1.Pod)
  • func (d *DefaultBatchScheduler) DoBatchSchedulingOnSubmission(ctx context.Context, app *rayv1.RayCluster) error
  • func (d *DefaultBatchScheduler) Name() string
• type DefaultBatchSchedulerFactory
  • func (df *DefaultBatchSchedulerFactory) AddToScheme(scheme *runtime.Scheme)
  • func (df *DefaultBatchSchedulerFactory) ConfigureReconciler(b *builder.Builder) *builder.Builder
  • func (df *DefaultBatchSchedulerFactory) New(config *rest.Config) (BatchScheduler, error)

Functions

func GetDefaultPluginName

func GetDefaultPluginName() string

Types

type BatchScheduler

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(app *rayv1.RayCluster, groupName string, pod *corev1.Pod)
}

BatchScheduler manages submitting RayCluster pods to a third-party scheduler.

type BatchSchedulerFactory

type BatchSchedulerFactory interface {
	// New creates a new BatchScheduler for the scheduler plugin.
	New(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
}

BatchSchedulerFactory handles initial setup of the scheduler plugin by registering the necessary callbacks with the operator, and the creation of the BatchScheduler itself.

type DefaultBatchScheduler

type DefaultBatchScheduler struct{}

func (*DefaultBatchScheduler) AddMetadataToPod

func (d *DefaultBatchScheduler) AddMetadataToPod(app *rayv1.RayCluster, groupName string, pod *corev1.Pod)

func (*DefaultBatchScheduler) DoBatchSchedulingOnSubmission

func (d *DefaultBatchScheduler) DoBatchSchedulingOnSubmission(ctx context.Context, app *rayv1.RayCluster) error

func (*DefaultBatchScheduler) Name

func (d *DefaultBatchScheduler) Name() string

type DefaultBatchSchedulerFactory

type DefaultBatchSchedulerFactory struct{}

func (*DefaultBatchSchedulerFactory) AddToScheme

func (df *DefaultBatchSchedulerFactory) AddToScheme(scheme *runtime.Scheme)

func (*DefaultBatchSchedulerFactory) ConfigureReconciler

func (df *DefaultBatchSchedulerFactory) ConfigureReconciler(b *builder.Builder) *builder.Builder

func (*DefaultBatchSchedulerFactory) New

func (df *DefaultBatchSchedulerFactory) New(config *rest.Config) (BatchScheduler, error)