queue

Documentation

Index

• func MakeNextPodFunc(queue SchedulingQueue) func() *v1.Pod
• func NominatedNodeName(pod *v1.Pod) string
• type FIFO
  • func NewFIFO() *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) Close()
  • func (f *FIFO) Delete(pod *v1.Pod) error
  • func (f *FIFO) DeleteNominatedPodIfExists(pod *v1.Pod)
  • func (f *FIFO) MoveAllToActiveQueue()
  • func (f *FIFO) NominatedPodsForNode(nodeName string) []*v1.Pod
  • func (f *FIFO) NumUnschedulablePods() int
  • func (f *FIFO) PendingPods() []*v1.Pod
  • func (f *FIFO) Pop() (*v1.Pod, error)
  • func (f *FIFO) Update(oldPod, newPod *v1.Pod) error
  • func (f *FIFO) UpdateNominatedPodForNode(pod *v1.Pod, nodeName string)
• type PriorityQueue
  • func NewPriorityQueue(stop <-chan struct{}) *PriorityQueue
  • func NewPriorityQueueWithClock(stop <-chan struct{}, clock util.Clock) *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) Close()
  • func (p *PriorityQueue) Delete(pod *v1.Pod) error
  • func (p *PriorityQueue) DeleteNominatedPodIfExists(pod *v1.Pod)
  • func (p *PriorityQueue) MoveAllToActiveQueue()
  • func (p *PriorityQueue) NominatedPodsForNode(nodeName string) []*v1.Pod
  • func (p *PriorityQueue) NumUnschedulablePods() int
  • func (p *PriorityQueue) PendingPods() []*v1.Pod
  • func (p *PriorityQueue) Pop() (*v1.Pod, error)
  • func (p *PriorityQueue) Update(oldPod, newPod *v1.Pod) error
  • func (p *PriorityQueue) UpdateNominatedPodForNode(pod *v1.Pod, nodeName string)
• type SchedulingQueue
  • func NewSchedulingQueue(stop <-chan struct{}) SchedulingQueue
• type UnschedulablePodsMap

Functions

func MakeNextPodFunc

func MakeNextPodFunc(queue SchedulingQueue) func() *v1.Pod

MakeNextPodFunc returns a function to retrieve the next pod from a given scheduling queue

func NominatedNodeName

func NominatedNodeName(pod *v1.Pod) string

NominatedNodeName returns nominated node name of a Pod.

Types

type FIFO

type FIFO struct {
	*cache.FIFO
}

FIFO is basically a simple wrapper around cache.FIFO to make it compatible with the SchedulingQueue interface.

func NewFIFO

func NewFIFO() *FIFO

NewFIFO creates a FIFO object.

func (*FIFO) Add

func (f *FIFO) Add(pod *v1.Pod) error

Add adds a pod to the FIFO.

func (*FIFO) AddIfNotPresent

func (f *FIFO) AddIfNotPresent(pod *v1.Pod) error

AddIfNotPresent adds a pod to the FIFO if it is absent in the FIFO.

func (*FIFO) AddUnschedulableIfNotPresent

func (f *FIFO) AddUnschedulableIfNotPresent(pod *v1.Pod) error

AddUnschedulableIfNotPresent adds an unschedulable pod back to the queue. In FIFO it is added to the end of the queue.

func (*FIFO) AssignedPodAdded

func (f *FIFO) AssignedPodAdded(pod *v1.Pod)

AssignedPodAdded does nothing here.

func (*FIFO) AssignedPodUpdated

func (f *FIFO) AssignedPodUpdated(pod *v1.Pod)

AssignedPodUpdated does nothing here.

func (*FIFO) Close

func (f *FIFO) Close()

Close closes the FIFO queue.

func (*FIFO) Delete

func (f *FIFO) Delete(pod *v1.Pod) error

Delete deletes a pod in the FIFO.

func (*FIFO) DeleteNominatedPodIfExists

func (f *FIFO) DeleteNominatedPodIfExists(pod *v1.Pod)

DeleteNominatedPodIfExists does nothing in FIFO.

func (*FIFO) MoveAllToActiveQueue

func (f *FIFO) MoveAllToActiveQueue()

MoveAllToActiveQueue does nothing in FIFO as all pods are always in the active queue.

func (*FIFO) NominatedPodsForNode

func (f *FIFO) NominatedPodsForNode(nodeName string) []*v1.Pod

NominatedPodsForNode returns pods that are nominated to run on the given node, but FIFO does not support it.

func (*FIFO) NumUnschedulablePods

func (f *FIFO) NumUnschedulablePods() int

NumUnschedulablePods returns the number of unschedulable pods exist in the SchedulingQueue.

func (*FIFO) PendingPods

func (f *FIFO) PendingPods() []*v1.Pod

PendingPods returns all the pods in the queue.

func (*FIFO) Pop

func (f *FIFO) Pop() (*v1.Pod, error)

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) Update

func (f *FIFO) Update(oldPod, newPod *v1.Pod) error

Update updates a pod in the FIFO.

func (*FIFO) UpdateNominatedPodForNode

func (f *FIFO) UpdateNominatedPodForNode(pod *v1.Pod, nodeName string)

UpdateNominatedPodForNode does nothing in FIFO.

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 three 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. The third queue holds pods that are moved from unschedulable queues and will be moved to active queue when backoff are completed.

func NewPriorityQueue

func NewPriorityQueue(stop <-chan struct{}) *PriorityQueue

NewPriorityQueue creates a PriorityQueue object.

func NewPriorityQueueWithClock

func NewPriorityQueueWithClock(stop <-chan struct{}, clock util.Clock) *PriorityQueue

NewPriorityQueueWithClock creates a PriorityQueue which uses the passed clock for time.

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 active/unschedulable/backoff queues

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 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 any queue. If pod is unschedulable, it adds pod to unschedulable queue if p.receivedMoveRequest is false or to backoff queue if p.receivedMoveRequest is true but pod is subject to backoff. In other cases, it adds pod to active queue and clears p.receivedMoveRequest.

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) Close

func (p *PriorityQueue) Close()

Close closes the priority queue.

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) DeleteNominatedPodIfExists

func (p *PriorityQueue) DeleteNominatedPodIfExists(pod *v1.Pod)

DeleteNominatedPodIfExists deletes pod nominatedPods.

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.

func (*PriorityQueue) NominatedPodsForNode

func (p *PriorityQueue) NominatedPodsForNode(nodeName string) []*v1.Pod

NominatedPodsForNode 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.

func (*PriorityQueue) NumUnschedulablePods

func (p *PriorityQueue) NumUnschedulablePods() int

NumUnschedulablePods returns the number of unschedulable pods exist in the SchedulingQueue.

func (*PriorityQueue) PendingPods

func (p *PriorityQueue) PendingPods() []*v1.Pod

PendingPods returns all the pending pods in the queue. This function is used for debugging purposes in the scheduler cache dumper and comparer.

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.

func (*PriorityQueue) Update

func (p *PriorityQueue) Update(oldPod, newPod *v1.Pod) error

Update updates a pod in the active or backoff queue if present. Otherwise, it removes the item from the unschedulable queue if pod is updated in a way that it may become schedulable and adds the updated one to the active queue. If pod is not present in any of the queues, it is added to the active queue.

func (*PriorityQueue) UpdateNominatedPodForNode

func (p *PriorityQueue) UpdateNominatedPodForNode(pod *v1.Pod, nodeName string)

UpdateNominatedPodForNode adds a pod to the nominated pods of the given node. This is called during the preemption process after a node is nominated to run the pod. We update the structure before sending a request to update the pod object to avoid races with the following scheduling cycles.

type SchedulingQueue

type SchedulingQueue interface {
	Add(pod *v1.Pod) error
	AddIfNotPresent(pod *v1.Pod) error
	AddUnschedulableIfNotPresent(pod *v1.Pod) error
	// Pop removes the head of the queue and returns it. It blocks if the
	// queue is empty and waits until a new item is added to the queue.
	Pop() (*v1.Pod, error)
	Update(oldPod, newPod *v1.Pod) error
	Delete(pod *v1.Pod) error
	MoveAllToActiveQueue()
	AssignedPodAdded(pod *v1.Pod)
	AssignedPodUpdated(pod *v1.Pod)
	NominatedPodsForNode(nodeName string) []*v1.Pod
	PendingPods() []*v1.Pod
	// Close closes the SchedulingQueue so that the goroutine which is
	// waiting to pop items can exit gracefully.
	Close()
	// UpdateNominatedPodForNode adds the given pod to the nominated pod map or
	// updates it if it already exists.
	UpdateNominatedPodForNode(pod *v1.Pod, nodeName string)
	// DeleteNominatedPodIfExists deletes nominatedPod from internal cache
	DeleteNominatedPodIfExists(pod *v1.Pod)
	// NumUnschedulablePods returns the number of unschedulable pods exist in the SchedulingQueue.
	NumUnschedulablePods() int
}

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(stop <-chan struct{}) 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.