Documentation
¶
Index ¶
- Constants
- Variables
- func EqualPriorityMap(_ *v1.Pod, _ interface{}, nodeInfo *schedulercache.NodeInfo) (schedulerapi.HostPriority, error)
- func NewGenericScheduler(cache schedulercache.Cache, eCache *EquivalenceCache, podQueue SchedulingQueue, ...) algorithm.ScheduleAlgorithm
- func NewHTTPExtender(config *schedulerapi.ExtenderConfig) (algorithm.SchedulerExtender, error)
- func NominatedNodeName(pod *v1.Pod) string
- func PrioritizeNodes(pod *v1.Pod, nodeNameToInfo map[string]*schedulercache.NodeInfo, ...) (schedulerapi.HostPriorityList, error)
- type AlgorithmCache
- type EquivalenceCache
- func (ec *EquivalenceCache) InvalidateAllCachedPredicateItemOfNode(nodeName string)
- func (ec *EquivalenceCache) InvalidateCachedPredicateItem(nodeName string, predicateKeys sets.String)
- func (ec *EquivalenceCache) InvalidateCachedPredicateItemForPodAdd(pod *v1.Pod, nodeName string)
- func (ec *EquivalenceCache) InvalidateCachedPredicateItemOfAllNodes(predicateKeys sets.String)
- func (ec *EquivalenceCache) RunPredicate(pred algorithm.FitPredicate, predicateKey string, pod *v1.Pod, ...) (bool, []algorithm.PredicateFailureReason, error)
- type FIFO
- func (f *FIFO) Add(pod *v1.Pod) error
- func (f *FIFO) AddIfNotPresent(pod *v1.Pod) error
- func (f *FIFO) AddUnschedulableIfNotPresent(pod *v1.Pod) error
- func (f *FIFO) AssignedPodAdded(pod *v1.Pod)
- func (f *FIFO) AssignedPodUpdated(pod *v1.Pod)
- func (f *FIFO) Delete(pod *v1.Pod) error
- func (f *FIFO) MoveAllToActiveQueue()
- func (f *FIFO) Pop() (*v1.Pod, error)
- func (f *FIFO) Update(oldPod, newPod *v1.Pod) error
- func (f *FIFO) WaitingPods() []*v1.Pod
- func (f *FIFO) WaitingPodsForNode(nodeName string) []*v1.Pod
- type FailedPredicateMap
- type FitError
- type HTTPExtender
- func (h *HTTPExtender) Bind(binding *v1.Binding) error
- func (h *HTTPExtender) Filter(pod *v1.Pod, nodes []*v1.Node, ...) ([]*v1.Node, schedulerapi.FailedNodesMap, error)
- func (h *HTTPExtender) IsBinder() bool
- func (h *HTTPExtender) IsIgnorable() bool
- func (h *HTTPExtender) IsInterested(pod *v1.Pod) bool
- func (h *HTTPExtender) Prioritize(pod *v1.Pod, nodes []*v1.Node) (*schedulerapi.HostPriorityList, int, error)
- func (h *HTTPExtender) ProcessPreemption(pod *v1.Pod, nodeToVictims map[*v1.Node]*schedulerapi.Victims, ...) (map[*v1.Node]*schedulerapi.Victims, error)
- func (h *HTTPExtender) SupportsPreemption() bool
- type Heap
- func (h *Heap) Add(obj interface{}) error
- func (h *Heap) AddIfNotPresent(obj interface{}) error
- func (h *Heap) Delete(obj interface{}) error
- func (h *Heap) Get(obj interface{}) (interface{}, bool, error)
- func (h *Heap) GetByKey(key string) (interface{}, bool, error)
- func (h *Heap) List() []interface{}
- func (h *Heap) Pop() (interface{}, error)
- func (h *Heap) Update(obj interface{}) error
- type HostPredicate
- type KeyFunc
- type LessFunc
- type PredicateMap
- type PriorityQueue
- func (p *PriorityQueue) Add(pod *v1.Pod) error
- func (p *PriorityQueue) AddIfNotPresent(pod *v1.Pod) error
- func (p *PriorityQueue) AddUnschedulableIfNotPresent(pod *v1.Pod) error
- func (p *PriorityQueue) AssignedPodAdded(pod *v1.Pod)
- func (p *PriorityQueue) AssignedPodUpdated(pod *v1.Pod)
- func (p *PriorityQueue) Delete(pod *v1.Pod) error
- func (p *PriorityQueue) MoveAllToActiveQueue()
- func (p *PriorityQueue) Pop() (*v1.Pod, error)
- func (p *PriorityQueue) Update(oldPod, newPod *v1.Pod) error
- func (p *PriorityQueue) WaitingPods() []*v1.Pod
- func (p *PriorityQueue) WaitingPodsForNode(nodeName string) []*v1.Pod
- type SchedulingQueue
- type UnschedulablePodsMap
Constants ¶
const ( // DefaultExtenderTimeout defines the default extender timeout in second. DefaultExtenderTimeout = 5 * time.Second )
const (
// NoNodeAvailableMsg is used to format message when no nodes available.
NoNodeAvailableMsg = "0/%v nodes are available"
)
Variables ¶
var ErrNoNodesAvailable = fmt.Errorf("no nodes available to schedule pods")
ErrNoNodesAvailable is used to describe the error that no nodes available to schedule pods.
Functions ¶
func EqualPriorityMap ¶
func EqualPriorityMap(_ *v1.Pod, _ interface{}, nodeInfo *schedulercache.NodeInfo) (schedulerapi.HostPriority, error)
EqualPriorityMap is a prioritizer function that gives an equal weight of one to all nodes
func NewGenericScheduler ¶
func NewGenericScheduler( cache schedulercache.Cache, eCache *EquivalenceCache, podQueue SchedulingQueue, predicates map[string]algorithm.FitPredicate, predicateMetaProducer algorithm.PredicateMetadataProducer, prioritizers []algorithm.PriorityConfig, priorityMetaProducer algorithm.PriorityMetadataProducer, extenders []algorithm.SchedulerExtender, volumeBinder *volumebinder.VolumeBinder, pvcLister corelisters.PersistentVolumeClaimLister, alwaysCheckAllPredicates bool, disablePreemption bool, ) algorithm.ScheduleAlgorithm
NewGenericScheduler creates a genericScheduler object.
func NewHTTPExtender ¶
func NewHTTPExtender(config *schedulerapi.ExtenderConfig) (algorithm.SchedulerExtender, error)
NewHTTPExtender creates an HTTPExtender object.
func NominatedNodeName ¶
NominatedNodeName returns nominated node name of a Pod.
func PrioritizeNodes ¶
func PrioritizeNodes( pod *v1.Pod, nodeNameToInfo map[string]*schedulercache.NodeInfo, meta interface{}, priorityConfigs []algorithm.PriorityConfig, nodes []*v1.Node, extenders []algorithm.SchedulerExtender, ) (schedulerapi.HostPriorityList, error)
PrioritizeNodes prioritizes the nodes by running the individual priority functions in parallel. Each priority function is expected to set a score of 0-10 0 is the lowest priority score (least preferred node) and 10 is the highest Each priority function can also have its own weight The node scores returned by the priority function are multiplied by the weights to get weighted scores All scores are finally combined (added) to get the total weighted scores of all nodes
Types ¶
type AlgorithmCache ¶
type AlgorithmCache map[string]PredicateMap
The AlgorithmCache stores PredicateMap with predicate name as key, PredicateMap as value.
type EquivalenceCache ¶
type EquivalenceCache struct {
// contains filtered or unexported fields
}
EquivalenceCache holds: 1. a map of AlgorithmCache with node name as key 2. function to get equivalence pod
func NewEquivalenceCache ¶
func NewEquivalenceCache() *EquivalenceCache
NewEquivalenceCache returns EquivalenceCache to speed up predicates by caching result from previous scheduling.
func (*EquivalenceCache) InvalidateAllCachedPredicateItemOfNode ¶
func (ec *EquivalenceCache) InvalidateAllCachedPredicateItemOfNode(nodeName string)
InvalidateAllCachedPredicateItemOfNode marks all cached items on given node as invalid
func (*EquivalenceCache) InvalidateCachedPredicateItem ¶
func (ec *EquivalenceCache) InvalidateCachedPredicateItem(nodeName string, predicateKeys sets.String)
InvalidateCachedPredicateItem marks all items of given predicateKeys, of all pods, on the given node as invalid
func (*EquivalenceCache) InvalidateCachedPredicateItemForPodAdd ¶
func (ec *EquivalenceCache) InvalidateCachedPredicateItemForPodAdd(pod *v1.Pod, nodeName string)
InvalidateCachedPredicateItemForPodAdd is a wrapper of InvalidateCachedPredicateItem for pod add case
func (*EquivalenceCache) InvalidateCachedPredicateItemOfAllNodes ¶
func (ec *EquivalenceCache) InvalidateCachedPredicateItemOfAllNodes(predicateKeys sets.String)
InvalidateCachedPredicateItemOfAllNodes marks all items of given predicateKeys, of all pods, on all node as invalid
func (*EquivalenceCache) RunPredicate ¶ added in v1.11.7
func (ec *EquivalenceCache) RunPredicate( pred algorithm.FitPredicate, predicateKey string, pod *v1.Pod, meta algorithm.PredicateMetadata, nodeInfo *schedulercache.NodeInfo, equivClassInfo *equivalenceClassInfo, cache schedulercache.Cache, ) (bool, []algorithm.PredicateFailureReason, error)
RunPredicate will return a cached predicate result. In case of a cache miss, the predicate will be run and its results cached for the next call.
NOTE: RunPredicate will not update the equivalence cache if the given NodeInfo is stale.
type FIFO ¶
FIFO is basically a simple wrapper around cache.FIFO to make it compatible with the SchedulingQueue interface.
func (*FIFO) AddIfNotPresent ¶
AddIfNotPresent adds a pod to the FIFO if it is absent in the FIFO.
func (*FIFO) AddUnschedulableIfNotPresent ¶
AddUnschedulableIfNotPresent adds an unschedulable pod back to the queue. In FIFO it is added to the end of the queue.
func (*FIFO) AssignedPodAdded ¶
AssignedPodAdded does nothing here.
func (*FIFO) AssignedPodUpdated ¶
AssignedPodUpdated does nothing here.
func (*FIFO) MoveAllToActiveQueue ¶
func (f *FIFO) MoveAllToActiveQueue()
MoveAllToActiveQueue does nothing in FIFO as all pods are always in the active queue.
func (*FIFO) Pop ¶
Pop removes the head of FIFO and returns it. This is just a copy/paste of cache.Pop(queue Queue) from fifo.go that scheduler has always been using. There is a comment in that file saying that this method shouldn't be used in production code, but scheduler has always been using it. This function does minimal error checking.
func (*FIFO) WaitingPods ¶ added in v1.11.7
WaitingPods returns all the waiting pods in the queue.
type FailedPredicateMap ¶
type FailedPredicateMap map[string][]algorithm.PredicateFailureReason
FailedPredicateMap declares a map[string][]algorithm.PredicateFailureReason type.
type FitError ¶
type FitError struct { Pod *v1.Pod NumAllNodes int FailedPredicates FailedPredicateMap }
FitError describes a fit error of a pod.
type HTTPExtender ¶
type HTTPExtender struct {
// contains filtered or unexported fields
}
HTTPExtender implements the algorithm.SchedulerExtender interface.
func (*HTTPExtender) Bind ¶
func (h *HTTPExtender) Bind(binding *v1.Binding) error
Bind delegates the action of binding a pod to a node to the extender.
func (*HTTPExtender) Filter ¶
func (h *HTTPExtender) Filter( pod *v1.Pod, nodes []*v1.Node, nodeNameToInfo map[string]*schedulercache.NodeInfo, ) ([]*v1.Node, schedulerapi.FailedNodesMap, error)
Filter based on extender implemented predicate functions. The filtered list is expected to be a subset of the supplied list. failedNodesMap optionally contains the list of failed nodes and failure reasons.
func (*HTTPExtender) IsBinder ¶
func (h *HTTPExtender) IsBinder() bool
IsBinder returns whether this extender is configured for the Bind method.
func (*HTTPExtender) IsIgnorable ¶ added in v1.11.7
func (h *HTTPExtender) IsIgnorable() bool
IsIgnorable returns true indicates scheduling should not fail when this extender is unavailable
func (*HTTPExtender) IsInterested ¶
func (h *HTTPExtender) IsInterested(pod *v1.Pod) bool
IsInterested returns true if at least one extended resource requested by this pod is managed by this extender.
func (*HTTPExtender) Prioritize ¶
func (h *HTTPExtender) Prioritize(pod *v1.Pod, nodes []*v1.Node) (*schedulerapi.HostPriorityList, int, error)
Prioritize based on extender implemented priority functions. Weight*priority is added up for each such priority function. The returned score is added to the score computed by Kubernetes scheduler. The total score is used to do the host selection.
func (*HTTPExtender) ProcessPreemption ¶ added in v1.11.7
func (h *HTTPExtender) ProcessPreemption( pod *v1.Pod, nodeToVictims map[*v1.Node]*schedulerapi.Victims, nodeNameToInfo map[string]*schedulercache.NodeInfo, ) (map[*v1.Node]*schedulerapi.Victims, error)
ProcessPreemption returns filtered candidate nodes and victims after running preemption logic in extender.
func (*HTTPExtender) SupportsPreemption ¶ added in v1.11.7
func (h *HTTPExtender) SupportsPreemption() bool
SupportsPreemption returns if a extender support preemption. A extender should have preempt verb defined and enabled its own node cache.
type Heap ¶
type Heap struct {
// contains filtered or unexported fields
}
Heap is a producer/consumer queue that implements a heap data structure. It can be used to implement priority queues and similar data structures.
func (*Heap) Add ¶
Add inserts an item, and puts it in the queue. The item is updated if it already exists.
func (*Heap) AddIfNotPresent ¶
AddIfNotPresent inserts an item, and puts it in the queue. If an item with the key is present in the map, no changes is made to the item.
type HostPredicate ¶
type HostPredicate struct { Fit bool FailReasons []algorithm.PredicateFailureReason }
HostPredicate is the cached predicate result
type LessFunc ¶
type LessFunc func(interface{}, interface{}) bool
LessFunc is a function type to compare two objects.
type PredicateMap ¶
type PredicateMap map[uint64]HostPredicate
PredicateMap stores HostPrediacte with equivalence hash as key
type PriorityQueue ¶
type PriorityQueue struct {
// contains filtered or unexported fields
}
PriorityQueue implements a scheduling queue. It is an alternative to FIFO. The head of PriorityQueue is the highest priority pending pod. This structure has two sub queues. One sub-queue holds pods that are being considered for scheduling. This is called activeQ and is a Heap. Another queue holds pods that are already tried and are determined to be unschedulable. The latter is called unschedulableQ.
func NewPriorityQueue ¶
func NewPriorityQueue() *PriorityQueue
NewPriorityQueue creates a PriorityQueue object.
func (*PriorityQueue) Add ¶
func (p *PriorityQueue) Add(pod *v1.Pod) error
Add adds a pod to the active queue. It should be called only when a new pod is added so there is no chance the pod is already in either queue.
func (*PriorityQueue) AddIfNotPresent ¶
func (p *PriorityQueue) AddIfNotPresent(pod *v1.Pod) error
AddIfNotPresent adds a pod to the active queue if it is not present in any of the two queues. If it is present in any, it doesn't do any thing.
func (*PriorityQueue) AddUnschedulableIfNotPresent ¶
func (p *PriorityQueue) AddUnschedulableIfNotPresent(pod *v1.Pod) error
AddUnschedulableIfNotPresent does nothing if the pod is present in either queue. Otherwise it adds the pod to the unschedulable queue if p.receivedMoveRequest is false, and to the activeQ if p.receivedMoveRequest is true.
func (*PriorityQueue) AssignedPodAdded ¶
func (p *PriorityQueue) AssignedPodAdded(pod *v1.Pod)
AssignedPodAdded is called when a bound pod is added. Creation of this pod may make pending pods with matching affinity terms schedulable.
func (*PriorityQueue) AssignedPodUpdated ¶
func (p *PriorityQueue) AssignedPodUpdated(pod *v1.Pod)
AssignedPodUpdated is called when a bound pod is updated. Change of labels may make pending pods with matching affinity terms schedulable.
func (*PriorityQueue) Delete ¶
func (p *PriorityQueue) Delete(pod *v1.Pod) error
Delete deletes the item from either of the two queues. It assumes the pod is only in one queue.
func (*PriorityQueue) MoveAllToActiveQueue ¶
func (p *PriorityQueue) MoveAllToActiveQueue()
MoveAllToActiveQueue moves all pods from unschedulableQ to activeQ. This function adds all pods and then signals the condition variable to ensure that if Pop() is waiting for an item, it receives it after all the pods are in the queue and the head is the highest priority pod. TODO(bsalamat): We should add a back-off mechanism here so that a high priority pod which is unschedulable does not go to the head of the queue frequently. For example in a cluster where a lot of pods being deleted, such a high priority pod can deprive other pods from getting scheduled.
func (*PriorityQueue) Pop ¶
func (p *PriorityQueue) Pop() (*v1.Pod, error)
Pop removes the head of the active queue and returns it. It blocks if the activeQ is empty and waits until a new item is added to the queue. It also clears receivedMoveRequest to mark the beginning of a new scheduling cycle.
func (*PriorityQueue) Update ¶
func (p *PriorityQueue) Update(oldPod, newPod *v1.Pod) error
Update updates a pod in the active queue if present. Otherwise, it removes the item from the unschedulable queue and adds the updated one to the active queue.
func (*PriorityQueue) WaitingPods ¶ added in v1.11.7
func (p *PriorityQueue) WaitingPods() []*v1.Pod
WaitingPods returns all the waiting pods in the queue.
func (*PriorityQueue) WaitingPodsForNode ¶
func (p *PriorityQueue) WaitingPodsForNode(nodeName string) []*v1.Pod
WaitingPodsForNode returns pods that are nominated to run on the given node, but they are waiting for other pods to be removed from the node before they can be actually scheduled.
type SchedulingQueue ¶
type SchedulingQueue interface { Add(pod *v1.Pod) error AddIfNotPresent(pod *v1.Pod) error AddUnschedulableIfNotPresent(pod *v1.Pod) error Pop() (*v1.Pod, error) Update(oldPod, newPod *v1.Pod) error Delete(pod *v1.Pod) error MoveAllToActiveQueue() AssignedPodAdded(pod *v1.Pod) AssignedPodUpdated(pod *v1.Pod) WaitingPodsForNode(nodeName string) []*v1.Pod WaitingPods() []*v1.Pod }
SchedulingQueue is an interface for a queue to store pods waiting to be scheduled. The interface follows a pattern similar to cache.FIFO and cache.Heap and makes it easy to use those data structures as a SchedulingQueue.
func NewSchedulingQueue ¶
func NewSchedulingQueue() SchedulingQueue
NewSchedulingQueue initializes a new scheduling queue. If pod priority is enabled a priority queue is returned. If it is disabled, a FIFO is returned.
type UnschedulablePodsMap ¶
type UnschedulablePodsMap struct {
// contains filtered or unexported fields
}
UnschedulablePodsMap holds pods that cannot be scheduled. This data structure is used to implement unschedulableQ.