app

Documentation

Overview

Package app implements a Server object for running the scheduler.

Index

• func NewSchedulerCommand(schedulingHooks []frameworkext.SchedulingPhaseHook, registryOptions ...Option) *cobra.Command
• func Run(ctx context.Context, cc *schedulerserverconfig.CompletedConfig, ...) error
• func Setup(ctx context.Context, opts *options.Options, ...) (*schedulerserverconfig.CompletedConfig, *scheduler.Scheduler, error)
• type Option
  • func WithPlugin(name string, factory runtime.PluginFactory) Option

Functions

func NewSchedulerCommand

func NewSchedulerCommand(schedulingHooks []frameworkext.SchedulingPhaseHook, registryOptions ...Option) *cobra.Command

NewSchedulerCommand creates a *cobra.Command object with default parameters and registryOptions

func Run

func Run(ctx context.Context, cc *schedulerserverconfig.CompletedConfig, sched *scheduler.Scheduler) error

Run executes the scheduler based on the given configuration. It only returns on error or when context is done.

func Setup

func Setup(ctx context.Context, opts *options.Options, schedulingHooks []frameworkext.SchedulingPhaseHook, outOfTreeRegistryOptions ...Option) (*schedulerserverconfig.CompletedConfig, *scheduler.Scheduler, error)

Setup creates a completed config and a scheduler based on the command args and options

Types

type Option

type Option func(frameworkext.ExtendedHandle, runtime.Registry) error

Option configures a framework.Registry.

func WithPlugin

func WithPlugin(name string, factory runtime.PluginFactory) Option

WithPlugin creates an Option based on plugin name and factory. Please don't remove this function: it is used to register out-of-tree plugins, hence there are no references to it from the kubernetes scheduler code base.