factory

Documentation

Overview

Package factory can set up a scheduler. This code is here instead of cmd/scheduler for both testability and reuse.

Index

• Constants
• func InsertPredicateKeyToAlgoProvider(providerName, key string) error
• func InsertPredicateKeyToAlgorithmProviderMap(key string)
• func IsFitPredicateRegistered(name string) bool
• func IsPriorityFunctionRegistered(name string) bool
• func ListAlgorithmProviders() string
• func ListRegisteredFitPredicates() []string
• func ListRegisteredPriorityFunctions() []string
• func NewConfigFactory(schedulerName string, client clientset.Interface, ...) scheduler.Configurator
• func NewPodInformer(client clientset.Interface, resyncPeriod time.Duration, schedulerName string) coreinformers.PodInformer
• func RegisterAlgorithmProvider(name string, predicateKeys, priorityKeys sets.String) string
• func RegisterCustomFitPredicate(policy schedulerapi.PredicatePolicy) string
• func RegisterCustomPriorityFunction(policy schedulerapi.PriorityPolicy) string
• func RegisterFitPredicate(name string, predicate algorithm.FitPredicate) string
• func RegisterFitPredicateFactory(name string, predicateFactory FitPredicateFactory) string
• func RegisterGetEquivalencePodFunction(equivalenceFuncFactory EquivalencePodFuncFactory)
• func RegisterMandatoryFitPredicate(name string, predicate algorithm.FitPredicate) string
• func RegisterPredicateMetadataProducerFactory(factory PredicateMetadataProducerFactory)
• func RegisterPriorityConfigFactory(name string, pcf PriorityConfigFactory) string
• func RegisterPriorityFunction(name string, function algorithm.PriorityFunction, weight int) string
• func RegisterPriorityFunction2(name string, mapFunction algorithm.PriorityMapFunction, ...) string
• func RegisterPriorityMetadataProducerFactory(factory MetadataProducerFactory)
• func RemoveFitPredicate(name string)
• func RemovePredicateKeyFromAlgoProvider(providerName, key string) error
• func RemovePredicateKeyFromAlgorithmProviderMap(key string)
• type AlgorithmProviderConfig
  • func GetAlgorithmProvider(name string) (*AlgorithmProviderConfig, error)
• type EquivalencePodFuncFactory
• type FitPredicateFactory
• type MetadataProducerFactory
• type PluginFactoryArgs
• type PredicateMetadataProducerFactory
• type PriorityConfigFactory
• type PriorityFunctionFactory
• type PriorityFunctionFactory2

Constants

const (
	DefaultProvider = "DefaultProvider"
)

Functions

func InsertPredicateKeyToAlgoProvider

func InsertPredicateKeyToAlgoProvider(providerName, key string) error

InsertPredicateKeyToAlgoProvider insert a fit predicate key to algorithmProvider.

func InsertPredicateKeyToAlgorithmProviderMap

func InsertPredicateKeyToAlgorithmProviderMap(key string)

InsertPredicateKeyToAlgorithmProviderMap insert a fit predicate key to all algorithmProviders which in algorithmProviderMap.

func IsFitPredicateRegistered

func IsFitPredicateRegistered(name string) bool

IsFitPredicateRegistered is useful for testing providers.

func IsPriorityFunctionRegistered

func IsPriorityFunctionRegistered(name string) bool

IsPriorityFunctionRegistered is useful for testing providers.

func ListAlgorithmProviders

func ListAlgorithmProviders() string

ListAlgorithmProviders is called when listing all available algorithm providers in `kube-scheduler --help`

func ListRegisteredFitPredicates

func ListRegisteredFitPredicates() []string

func ListRegisteredPriorityFunctions

func ListRegisteredPriorityFunctions() []string

func NewConfigFactory

func NewConfigFactory(
	schedulerName string,
	client clientset.Interface,
	nodeInformer coreinformers.NodeInformer,
	podInformer coreinformers.PodInformer,
	pvInformer coreinformers.PersistentVolumeInformer,
	pvcInformer coreinformers.PersistentVolumeClaimInformer,
	replicationControllerInformer coreinformers.ReplicationControllerInformer,
	replicaSetInformer extensionsinformers.ReplicaSetInformer,
	statefulSetInformer appsinformers.StatefulSetInformer,
	serviceInformer coreinformers.ServiceInformer,
	pdbInformer policyinformers.PodDisruptionBudgetInformer,
	storageClassInformer storageinformers.StorageClassInformer,
	hardPodAffinitySymmetricWeight int32,
	enableEquivalenceClassCache bool,
) scheduler.Configurator

NewConfigFactory initializes the default implementation of a Configurator To encourage eventual privatization of the struct type, we only return the interface.

func NewPodInformer

func NewPodInformer(client clientset.Interface, resyncPeriod time.Duration, schedulerName string) coreinformers.PodInformer

NewPodInformer creates a shared index informer that returns only non-terminal pods.

func RegisterAlgorithmProvider

func RegisterAlgorithmProvider(name string, predicateKeys, priorityKeys sets.String) string

RegisterAlgorithmProvider registers a new algorithm provider with the algorithm registry. This should be called from the init function in a provider plugin.

func RegisterCustomFitPredicate

func RegisterCustomFitPredicate(policy schedulerapi.PredicatePolicy) string

RegisterCustomFitPredicate registers a custom fit predicate with the algorithm registry. Returns the name, with which the predicate was registered.

func RegisterCustomPriorityFunction

func RegisterCustomPriorityFunction(policy schedulerapi.PriorityPolicy) string

RegisterCustomPriorityFunction registers a custom priority function with the algorithm registry. Returns the name, with which the priority function was registered.

func RegisterFitPredicate

func RegisterFitPredicate(name string, predicate algorithm.FitPredicate) string

RegisterFitPredicate registers a fit predicate with the algorithm registry. Returns the name with which the predicate was registered.

func RegisterFitPredicateFactory

func RegisterFitPredicateFactory(name string, predicateFactory FitPredicateFactory) string

RegisterFitPredicateFactory registers a fit predicate factory with the algorithm registry. Returns the name with which the predicate was registered.

func RegisterGetEquivalencePodFunction

func RegisterGetEquivalencePodFunction(equivalenceFuncFactory EquivalencePodFuncFactory)

RegisterGetEquivalencePodFunction registers equivalenceFuncFactory to produce equivalence class for given pod.

func RegisterMandatoryFitPredicate

func RegisterMandatoryFitPredicate(name string, predicate algorithm.FitPredicate) string

RegisterMandatoryFitPredicate registers a fit predicate with the algorithm registry, the predicate is used by kubelet, DaemonSet; it is always included in configuration. Returns the name with which the predicate was registered.

func RegisterPredicateMetadataProducerFactory

func RegisterPredicateMetadataProducerFactory(factory PredicateMetadataProducerFactory)

func RegisterPriorityConfigFactory

func RegisterPriorityConfigFactory(name string, pcf PriorityConfigFactory) string

func RegisterPriorityFunction

func RegisterPriorityFunction(name string, function algorithm.PriorityFunction, weight int) string

DEPRECATED Use Map-Reduce pattern for priority functions. Registers a priority function with the algorithm registry. Returns the name, with which the function was registered.

func RegisterPriorityFunction2

func RegisterPriorityFunction2(
	name string,
	mapFunction algorithm.PriorityMapFunction,
	reduceFunction algorithm.PriorityReduceFunction,
	weight int) string

RegisterPriorityFunction2 registers a priority function with the algorithm registry. Returns the name, with which the function was registered. FIXME: Rename to PriorityFunctionFactory.

func RegisterPriorityMetadataProducerFactory

func RegisterPriorityMetadataProducerFactory(factory MetadataProducerFactory)

func RemoveFitPredicate

func RemoveFitPredicate(name string)

RemoveFitPredicate removes a fit predicate from factory.

func RemovePredicateKeyFromAlgoProvider

func RemovePredicateKeyFromAlgoProvider(providerName, key string) error

RemovePredicateKeyFromAlgoProvider removes a fit predicate key from algorithmProvider.

func RemovePredicateKeyFromAlgorithmProviderMap

func RemovePredicateKeyFromAlgorithmProviderMap(key string)

RemovePredicateKeyFromAlgorithmProviderMap removes a fit predicate key from all algorithmProviders which in algorithmProviderMap.

Types

type AlgorithmProviderConfig

type AlgorithmProviderConfig struct {
	FitPredicateKeys     sets.String
	PriorityFunctionKeys sets.String
}

func GetAlgorithmProvider

func GetAlgorithmProvider(name string) (*AlgorithmProviderConfig, error)

GetAlgorithmProvider should not be used to modify providers. It is publicly visible for testing.

type EquivalencePodFuncFactory

type EquivalencePodFuncFactory func(PluginFactoryArgs) algorithm.GetEquivalencePodFunc

EquivalencePodFuncFactory produces a function to get equivalence class for given pod.

type FitPredicateFactory

type FitPredicateFactory func(PluginFactoryArgs) algorithm.FitPredicate

A FitPredicateFactory produces a FitPredicate from the given args.

type MetadataProducerFactory

type MetadataProducerFactory func(PluginFactoryArgs) algorithm.MetadataProducer

MetadataProducerFactory produces MetadataProducer from the given args. TODO: Rename this to PriorityMetadataProducerFactory.

type PluginFactoryArgs

type PluginFactoryArgs struct {
	PodLister                      algorithm.PodLister
	ServiceLister                  algorithm.ServiceLister
	ControllerLister               algorithm.ControllerLister
	ReplicaSetLister               algorithm.ReplicaSetLister
	StatefulSetLister              algorithm.StatefulSetLister
	NodeLister                     algorithm.NodeLister
	NodeInfo                       predicates.NodeInfo
	PVInfo                         predicates.PersistentVolumeInfo
	PVCInfo                        predicates.PersistentVolumeClaimInfo
	StorageClassInfo               predicates.StorageClassInfo
	VolumeBinder                   *volumebinder.VolumeBinder
	HardPodAffinitySymmetricWeight int32
}

PluginFactoryArgs are passed to all plugin factory functions.

type PredicateMetadataProducerFactory

type PredicateMetadataProducerFactory func(PluginFactoryArgs) algorithm.PredicateMetadataProducer

PredicateMetadataProducerFactory produces PredicateMetadataProducer from the given args.

type PriorityConfigFactory

type PriorityConfigFactory struct {
	Function          PriorityFunctionFactory
	MapReduceFunction PriorityFunctionFactory2
	Weight            int
}

A PriorityConfigFactory produces a PriorityConfig from the given function and weight

type PriorityFunctionFactory

type PriorityFunctionFactory func(PluginFactoryArgs) algorithm.PriorityFunction

DEPRECATED Use Map-Reduce pattern for priority functions. A PriorityFunctionFactory produces a PriorityConfig from the given args.

type PriorityFunctionFactory2

type PriorityFunctionFactory2 func(PluginFactoryArgs) (algorithm.PriorityMapFunction, algorithm.PriorityReduceFunction)

A PriorityFunctionFactory produces map & reduce priority functions from a given args. FIXME: Rename to PriorityFunctionFactory.