Documentation ¶
Index ¶
- type Binder
- type Config
- type Configurator
- type FakeConfigurator
- func (fc *FakeConfigurator) Create() (*Config, error)
- func (fc *FakeConfigurator) CreateFromConfig(policy schedulerapi.Policy) (*Config, error)
- func (fc *FakeConfigurator) CreateFromKeys(predicateKeys, priorityKeys sets.String, ...) (*Config, error)
- func (fc *FakeConfigurator) CreateFromProvider(providerName string) (*Config, error)
- func (fc *FakeConfigurator) GetClient() clientset.Interface
- func (fc *FakeConfigurator) GetHardPodAffinitySymmetricWeight() int
- func (fc *FakeConfigurator) GetNodeLister() corelisters.NodeLister
- func (fc *FakeConfigurator) GetPredicateMetadataProducer() (algorithm.MetadataProducer, error)
- func (fc *FakeConfigurator) GetPredicates(predicateKeys sets.String) (map[string]algorithm.FitPredicate, error)
- func (fc *FakeConfigurator) GetPriorityFunctionConfigs(priorityKeys sets.String) ([]algorithm.PriorityConfig, error)
- func (fc *FakeConfigurator) GetPriorityMetadataProducer() (algorithm.MetadataProducer, error)
- func (fc *FakeConfigurator) GetScheduledPodLister() corelisters.PodLister
- func (fc *FakeConfigurator) GetSchedulerName() string
- func (fc *FakeConfigurator) MakeDefaultErrorFunc(backoff *util.PodBackoff, podQueue *cache.FIFO) func(pod *v1.Pod, err error)
- func (fc *FakeConfigurator) ResponsibleForPod(pod *v1.Pod) bool
- func (fc *FakeConfigurator) Run()
- type PodConditionUpdater
- type Scheduler
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct { // It is expected that changes made via SchedulerCache will be observed // by NodeLister and Algorithm. SchedulerCache schedulercache.Cache // Ecache is used for optimistically invalid affected cache items after // successfully binding a pod Ecache *core.EquivalenceCache NodeLister algorithm.NodeLister Algorithm algorithm.ScheduleAlgorithm Binder Binder // PodConditionUpdater is used only in case of scheduling errors. If we succeed // with scheduling, PodScheduled condition will be updated in apiserver in /bind // handler so that binding and setting PodCondition it is atomic. PodConditionUpdater PodConditionUpdater // NextPod should be a function that blocks until the next pod // is available. We don't use a channel for this, because scheduling // a pod may take some amount of time and we don't want pods to get // stale while they sit in a channel. NextPod func() *v1.Pod // WaitForCacheSync waits for scheduler cache to populate. // It returns true if it was successful, false if the controller should shutdown. WaitForCacheSync func() bool // Error is called if there is an error. It is passed the pod in // question, and the error Error func(*v1.Pod, error) // Recorder is the EventRecorder to use Recorder record.EventRecorder // Close this to shut down the scheduler. StopEverything chan struct{} }
Config is an implementation of the Scheduler's configured input data. TODO over time we should make this struct a hidden implementation detail of the scheduler.
type Configurator ¶ added in v1.6.0
type Configurator interface { GetPriorityFunctionConfigs(priorityKeys sets.String) ([]algorithm.PriorityConfig, error) GetPriorityMetadataProducer() (algorithm.MetadataProducer, error) GetPredicateMetadataProducer() (algorithm.MetadataProducer, error) GetPredicates(predicateKeys sets.String) (map[string]algorithm.FitPredicate, error) GetHardPodAffinitySymmetricWeight() int GetSchedulerName() string MakeDefaultErrorFunc(backoff *util.PodBackoff, podQueue *cache.FIFO) func(pod *v1.Pod, err error) // Probably doesn't need to be public. But exposed for now in case. ResponsibleForPod(pod *v1.Pod) bool // Needs to be exposed for things like integration tests where we want to make fake nodes. GetNodeLister() corelisters.NodeLister GetClient() clientset.Interface GetScheduledPodLister() corelisters.PodLister Run() Create() (*Config, error) CreateFromProvider(providerName string) (*Config, error) CreateFromConfig(policy schedulerapi.Policy) (*Config, error) CreateFromKeys(predicateKeys, priorityKeys sets.String, extenders []algorithm.SchedulerExtender) (*Config, error) }
Configurator defines I/O, caching, and other functionality needed to construct a new scheduler. An implementation of this can be seen in factory.go.
type FakeConfigurator ¶
type FakeConfigurator struct {
Config *Config
}
FakeConfigurator is an implementation for test.
func (*FakeConfigurator) Create ¶
func (fc *FakeConfigurator) Create() (*Config, error)
Create returns FakeConfigurator.Config
func (*FakeConfigurator) CreateFromConfig ¶
func (fc *FakeConfigurator) CreateFromConfig(policy schedulerapi.Policy) (*Config, error)
CreateFromConfig returns FakeConfigurator.Config
func (*FakeConfigurator) CreateFromKeys ¶
func (fc *FakeConfigurator) CreateFromKeys(predicateKeys, priorityKeys sets.String, extenders []algorithm.SchedulerExtender) (*Config, error)
CreateFromKeys returns FakeConfigurator.Config
func (*FakeConfigurator) CreateFromProvider ¶
func (fc *FakeConfigurator) CreateFromProvider(providerName string) (*Config, error)
CreateFromProvider returns FakeConfigurator.Config
func (*FakeConfigurator) GetClient ¶
func (fc *FakeConfigurator) GetClient() clientset.Interface
GetClient is not implemented yet.
func (*FakeConfigurator) GetHardPodAffinitySymmetricWeight ¶
func (fc *FakeConfigurator) GetHardPodAffinitySymmetricWeight() int
GetHardPodAffinitySymmetricWeight is not implemented yet.
func (*FakeConfigurator) GetNodeLister ¶
func (fc *FakeConfigurator) GetNodeLister() corelisters.NodeLister
GetNodeLister is not implemented yet.
func (*FakeConfigurator) GetPredicateMetadataProducer ¶
func (fc *FakeConfigurator) GetPredicateMetadataProducer() (algorithm.MetadataProducer, error)
GetPredicateMetadataProducer is not implemented yet.
func (*FakeConfigurator) GetPredicates ¶
func (fc *FakeConfigurator) GetPredicates(predicateKeys sets.String) (map[string]algorithm.FitPredicate, error)
GetPredicates is not implemented yet.
func (*FakeConfigurator) GetPriorityFunctionConfigs ¶
func (fc *FakeConfigurator) GetPriorityFunctionConfigs(priorityKeys sets.String) ([]algorithm.PriorityConfig, error)
GetPriorityFunctionConfigs is not implemented yet.
func (*FakeConfigurator) GetPriorityMetadataProducer ¶
func (fc *FakeConfigurator) GetPriorityMetadataProducer() (algorithm.MetadataProducer, error)
GetPriorityMetadataProducer is not implemented yet.
func (*FakeConfigurator) GetScheduledPodLister ¶
func (fc *FakeConfigurator) GetScheduledPodLister() corelisters.PodLister
GetScheduledPodLister is not implemented yet.
func (*FakeConfigurator) GetSchedulerName ¶
func (fc *FakeConfigurator) GetSchedulerName() string
GetSchedulerName is not implemented yet.
func (*FakeConfigurator) MakeDefaultErrorFunc ¶
func (fc *FakeConfigurator) MakeDefaultErrorFunc(backoff *util.PodBackoff, podQueue *cache.FIFO) func(pod *v1.Pod, err error)
MakeDefaultErrorFunc is not implemented yet.
func (*FakeConfigurator) ResponsibleForPod ¶
func (fc *FakeConfigurator) ResponsibleForPod(pod *v1.Pod) bool
ResponsibleForPod is not implemented yet.
type PodConditionUpdater ¶ added in v1.3.0
type PodConditionUpdater interface {
Update(pod *v1.Pod, podCondition *v1.PodCondition) error
}
PodConditionUpdater updates the condition of a pod based on the passed PodCondition
type Scheduler ¶
type Scheduler struct {
// contains filtered or unexported fields
}
Scheduler watches for new unscheduled pods. It attempts to find nodes that they fit on and writes bindings back to the api server.
func NewFromConfigurator ¶ added in v1.6.0
func NewFromConfigurator(c Configurator, modifiers ...func(c *Config)) (*Scheduler, error)
NewFromConfigurator returns a new scheduler that is created entirely by the Configurator. Assumes Create() is implemented. Supports intermediate Config mutation for now if you provide modifier functions which will run after Config is created.
func (*Scheduler) Config ¶
Config return scheduler's config pointer. It is exposed for testing purposes.
func (*Scheduler) Run ¶
func (sched *Scheduler) Run()
Run begins watching and scheduling. It waits for cache to be synced, then starts a goroutine and returns immediately.
func (*Scheduler) StopEverything ¶ added in v1.6.0
func (sched *Scheduler) StopEverything()
StopEverything closes the scheduler config's StopEverything channel, to shut down the Scheduler.
Directories ¶
Path | Synopsis |
---|---|
Package scheduler contains a generic Scheduler interface and several implementations.
|
Package scheduler contains a generic Scheduler interface and several implementations. |
Package factory can set up a scheduler.
|
Package factory can set up a scheduler. |