Documentation
¶
Index ¶
- Constants
- Variables
- func GetNamespacedName(namespace, name string) string
- func GetPodKey(pod *v1.Pod) (string, error)
- type ActionType
- type AffinityTerm
- type BindPlugin
- type ClusterEvent
- type Code
- type CycleState
- func (c *CycleState) Clone() *CycleState
- func (c *CycleState) Delete(key StateKey)
- func (c *CycleState) Read(key StateKey) (StateData, error)
- func (c *CycleState) SetRecordPluginMetrics(flag bool)
- func (c *CycleState) ShouldRecordPluginMetrics() bool
- func (c *CycleState) Write(key StateKey, val StateData)
- type Diagnosis
- type EnqueueExtensions
- type Extender
- type FilterPlugin
- type FitError
- type Framework
- type GVK
- type Handle
- type HostPortInfo
- type ImageStateSummary
- type LessFunc
- type NodeInfo
- func (n *NodeInfo) AddPod(pod *v1.Pod)
- func (n *NodeInfo) AddPodInfo(podInfo *PodInfo)
- func (n *NodeInfo) Clone() *NodeInfo
- func (n *NodeInfo) Node() *v1.Node
- func (n *NodeInfo) RemoveNode()
- func (n *NodeInfo) RemovePod(pod *v1.Pod) error
- func (n *NodeInfo) SetNode(node *v1.Node)
- func (n *NodeInfo) String() string
- type NodeInfoLister
- type NodePluginScores
- type NodeScore
- type NodeScoreList
- type NodeToStatusMap
- type NominatingInfo
- type NominatingMode
- type PermitPlugin
- type Plugin
- type PluginScore
- type PluginsRunner
- type PodInfo
- type PodNominator
- type PodsToActivate
- type PostBindPlugin
- type PostFilterPlugin
- type PostFilterResult
- type PreBindPlugin
- type PreEnqueuePlugin
- type PreFilterExtensions
- type PreFilterPlugin
- type PreFilterResult
- type PreScorePlugin
- type ProtocolPort
- type QueueSortPlugin
- type QueuedPodInfo
- type ReservePlugin
- type Resource
- type ScoreExtensions
- type ScorePlugin
- type SharedLister
- type StateData
- type StateKey
- type Status
- func (s *Status) AppendReason(reason string)
- func (s *Status) AsError() error
- func (s *Status) Code() Code
- func (s *Status) Equal(x *Status) bool
- func (s *Status) FailedPlugin() string
- func (s *Status) IsSkip() bool
- func (s *Status) IsSuccess() bool
- func (s *Status) IsUnschedulable() bool
- func (s *Status) IsWait() bool
- func (s *Status) Message() string
- func (s *Status) Reasons() []string
- func (s *Status) SetFailedPlugin(plugin string)
- func (s *Status) WithError(err error) *Status
- func (s *Status) WithFailedPlugin(plugin string) *Status
- type StorageInfoLister
- type WaitingPod
- type WeightedAffinityTerm
Constants ¶
const ( // MaxNodeScore is the maximum score a Score plugin is expected to return. MaxNodeScore int64 = 100 // MinNodeScore is the minimum score a Score plugin is expected to return. MinNodeScore int64 = 0 // MaxTotalScore is the maximum total score. MaxTotalScore int64 = math.MaxInt64 )
const ( // NoNodeAvailableMsg is used to format message when no nodes available. NoNodeAvailableMsg = "0/%v nodes are available" // SeparatorFormat is used to separate PreFilterMsg, FilterMsg and PostFilterMsg. SeparatorFormat = " %v." )
const DefaultBindAllHostIP = "0.0.0.0"
DefaultBindAllHostIP defines the default ip address used to bind to all host.
Variables ¶
var ( // ErrNotFound is the not found error message. ErrNotFound = errors.New("not found") )
Functions ¶
func GetNamespacedName ¶ added in v1.25.0
GetNamespacedName returns the string format of a namespaced resource name.
Types ¶
type ActionType ¶ added in v1.21.0
type ActionType int64
ActionType is an integer to represent one type of resource change. Different ActionTypes can be bit-wised to compose new semantics.
const ( Add ActionType = 1 << iota // 1 Delete // 10 // UpdateNodeXYZ is only applicable for Node events. UpdateNodeAllocatable // 100 UpdateNodeLabel // 1000 UpdateNodeTaint // 10000 UpdateNodeCondition // 100000 All ActionType = 1<<iota - 1 // 111111 // Use the general Update type if you don't either know or care the specific sub-Update type to use. Update = UpdateNodeAllocatable | UpdateNodeLabel | UpdateNodeTaint | UpdateNodeCondition )
Constants for ActionTypes.
type AffinityTerm ¶
type AffinityTerm struct { Namespaces sets.String Selector labels.Selector TopologyKey string NamespaceSelector labels.Selector }
AffinityTerm is a processed version of v1.PodAffinityTerm.
type BindPlugin ¶
type BindPlugin interface { Plugin // Bind plugins will not be called until all pre-bind plugins have completed. Each // bind plugin is called in the configured order. A bind plugin may choose whether // or not to handle the given Pod. If a bind plugin chooses to handle a Pod, the // remaining bind plugins are skipped. When a bind plugin does not handle a pod, // it must return Skip in its Status code. If a bind plugin returns an Error, the // pod is rejected and will not be bound. Bind(ctx context.Context, state *CycleState, p *v1.Pod, nodeName string) *Status }
BindPlugin is an interface that must be implemented by "Bind" plugins. Bind plugins are used to bind a pod to a Node.
type ClusterEvent ¶ added in v1.21.0
type ClusterEvent struct { Resource GVK ActionType ActionType Label string }
ClusterEvent abstracts how a system resource's state gets changed. Resource represents the standard API resources such as Pod, Node, etc. ActionType denotes the specific change such as Add, Update or Delete.
func (ClusterEvent) IsWildCard ¶ added in v1.22.0
func (ce ClusterEvent) IsWildCard() bool
IsWildCard returns true if ClusterEvent follows WildCard semantics
type Code ¶
type Code int
Code is the Status code/type which is returned from plugins.
const ( // Success means that plugin ran correctly and found pod schedulable. // NOTE: A nil status is also considered as "Success". Success Code = iota // Error is used for internal plugin errors, unexpected input, etc. Error // Unschedulable is used when a plugin finds a pod unschedulable. The scheduler might attempt to // run other postFilter plugins like preemption to get this pod scheduled. // Use UnschedulableAndUnresolvable to make the scheduler skipping other postFilter plugins. // The accompanying status message should explain why the pod is unschedulable. Unschedulable // UnschedulableAndUnresolvable is used when a plugin finds a pod unschedulable and // other postFilter plugins like preemption would not change anything. // Plugins should return Unschedulable if it is possible that the pod can get scheduled // after running other postFilter plugins. // The accompanying status message should explain why the pod is unschedulable. UnschedulableAndUnresolvable // Wait is used when a Permit plugin finds a pod scheduling should wait. Wait // Skip is used in the following scenarios: // - when a Bind plugin chooses to skip binding. // - when a PreFilter plugin returns Skip so that coupled Filter plugin/PreFilterExtensions() will be skipped. // - when a PreScore plugin returns Skip so that coupled Score plugin will be skipped. Skip )
These are predefined codes used in a Status.
type CycleState ¶
type CycleState struct { // SkipFilterPlugins are plugins that will be skipped in the Filter extension point. SkipFilterPlugins sets.Set[string] // SkipScorePlugins are plugins that will be skipped in the Score extension point. SkipScorePlugins sets.Set[string] // contains filtered or unexported fields }
CycleState provides a mechanism for plugins to store and retrieve arbitrary data. StateData stored by one plugin can be read, altered, or deleted by another plugin. CycleState does not provide any data protection, as all plugins are assumed to be trusted. Note: CycleState uses a sync.Map to back the storage. It's aimed to optimize for the "write once and read many times" scenarios. It is the recommended pattern used in all in-tree plugins - plugin-specific state is written once in PreFilter/PreScore and afterwards read many times in Filter/Score.
func NewCycleState ¶
func NewCycleState() *CycleState
NewCycleState initializes a new CycleState and returns its pointer.
func (*CycleState) Clone ¶
func (c *CycleState) Clone() *CycleState
Clone creates a copy of CycleState and returns its pointer. Clone returns nil if the context being cloned is nil.
func (*CycleState) Delete ¶
func (c *CycleState) Delete(key StateKey)
Delete deletes data with the given key from CycleState. This function is thread safe by using sync.Map.
func (*CycleState) Read ¶
func (c *CycleState) Read(key StateKey) (StateData, error)
Read retrieves data with the given "key" from CycleState. If the key is not present an error is returned. This function is thread safe by using sync.Map.
func (*CycleState) SetRecordPluginMetrics ¶
func (c *CycleState) SetRecordPluginMetrics(flag bool)
SetRecordPluginMetrics sets recordPluginMetrics to the given value.
func (*CycleState) ShouldRecordPluginMetrics ¶
func (c *CycleState) ShouldRecordPluginMetrics() bool
ShouldRecordPluginMetrics returns whether PluginExecutionDuration metrics should be recorded.
func (*CycleState) Write ¶
func (c *CycleState) Write(key StateKey, val StateData)
Write stores the given "val" in CycleState with the given "key". This function is thread safe by using sync.Map.
type Diagnosis ¶ added in v1.21.0
type Diagnosis struct { NodeToStatusMap NodeToStatusMap UnschedulablePlugins sets.String // PreFilterMsg records the messages returned from PreFilter plugins. PreFilterMsg string // PostFilterMsg records the messages returned from PostFilter plugins. PostFilterMsg string }
Diagnosis records the details to diagnose a scheduling failure.
type EnqueueExtensions ¶ added in v1.21.0
type EnqueueExtensions interface { // EventsToRegister returns a series of possible events that may cause a Pod // failed by this plugin schedulable. // The events will be registered when instantiating the internal scheduling queue, // and leveraged to build event handlers dynamically. // Note: the returned list needs to be static (not depend on configuration parameters); // otherwise it would lead to undefined behavior. EventsToRegister() []ClusterEvent }
EnqueueExtensions is an optional interface that plugins can implement to efficiently move unschedulable Pods in internal scheduling queues. Plugins that fail pod scheduling (e.g., Filter plugins) are expected to implement this interface.
type Extender ¶
type Extender interface { // Name returns a unique name that identifies the extender. Name() string // Filter based on extender-implemented predicate functions. The filtered list is // expected to be a subset of the supplied list. // The failedNodes and failedAndUnresolvableNodes optionally contains the list // of failed nodes and failure reasons, except nodes in the latter are // unresolvable. Filter(pod *v1.Pod, nodes []*v1.Node) (filteredNodes []*v1.Node, failedNodesMap extenderv1.FailedNodesMap, failedAndUnresolvable extenderv1.FailedNodesMap, err error) // Prioritize based on extender-implemented priority functions. The returned scores & weight // are used to compute the weighted score for an extender. The weighted scores are added to // the scores computed by Kubernetes scheduler. The total scores are used to do the host selection. Prioritize(pod *v1.Pod, nodes []*v1.Node) (hostPriorities *extenderv1.HostPriorityList, weight int64, err error) // Bind delegates the action of binding a pod to a node to the extender. Bind(binding *v1.Binding) error // IsBinder returns whether this extender is configured for the Bind method. IsBinder() bool // IsInterested returns true if at least one extended resource requested by // this pod is managed by this extender. IsInterested(pod *v1.Pod) bool // ProcessPreemption returns nodes with their victim pods processed by extender based on // given: // 1. Pod to schedule // 2. Candidate nodes and victim pods (nodeNameToVictims) generated by previous scheduling process. // The possible changes made by extender may include: // 1. Subset of given candidate nodes after preemption phase of extender. // 2. A different set of victim pod for every given candidate node after preemption phase of extender. ProcessPreemption( pod *v1.Pod, nodeNameToVictims map[string]*extenderv1.Victims, nodeInfos NodeInfoLister, ) (map[string]*extenderv1.Victims, error) // SupportsPreemption returns if the scheduler extender support preemption or not. SupportsPreemption() bool // IsIgnorable returns true indicates scheduling should not fail when this extender // is unavailable. This gives scheduler ability to fail fast and tolerate non-critical extenders as well. IsIgnorable() bool }
Extender is an interface for external processes to influence scheduling decisions made by Kubernetes. This is typically needed for resources not directly managed by Kubernetes.
type FilterPlugin ¶
type FilterPlugin interface { Plugin // Filter is called by the scheduling framework. // All FilterPlugins should return "Success" to declare that // the given node fits the pod. If Filter doesn't return "Success", // it will return "Unschedulable", "UnschedulableAndUnresolvable" or "Error". // For the node being evaluated, Filter plugins should look at the passed // nodeInfo reference for this particular node's information (e.g., pods // considered to be running on the node) instead of looking it up in the // NodeInfoSnapshot because we don't guarantee that they will be the same. // For example, during preemption, we may pass a copy of the original // nodeInfo object that has some pods removed from it to evaluate the // possibility of preempting them to schedule the target pod. Filter(ctx context.Context, state *CycleState, pod *v1.Pod, nodeInfo *NodeInfo) *Status }
FilterPlugin is an interface for Filter plugins. These plugins are called at the filter extension point for filtering out hosts that cannot run a pod. This concept used to be called 'predicate' in the original scheduler. These plugins should return "Success", "Unschedulable" or "Error" in Status.code. However, the scheduler accepts other valid codes as well. Anything other than "Success" will lead to exclusion of the given host from running the pod.
type Framework ¶
type Framework interface { Handle // PreEnqueuePlugins returns the registered preEnqueue plugins. PreEnqueuePlugins() []PreEnqueuePlugin // QueueSortFunc returns the function to sort pods in scheduling queue QueueSortFunc() LessFunc // RunPreFilterPlugins runs the set of configured PreFilter plugins. It returns // *Status and its code is set to non-success if any of the plugins returns // anything but Success. If a non-success status is returned, then the scheduling // cycle is aborted. // It also returns a PreFilterResult, which may influence what or how many nodes to // evaluate downstream. RunPreFilterPlugins(ctx context.Context, state *CycleState, pod *v1.Pod) (*PreFilterResult, *Status) // RunPostFilterPlugins runs the set of configured PostFilter plugins. // PostFilter plugins can either be informational, in which case should be configured // to execute first and return Unschedulable status, or ones that try to change the // cluster state to make the pod potentially schedulable in a future scheduling cycle. RunPostFilterPlugins(ctx context.Context, state *CycleState, pod *v1.Pod, filteredNodeStatusMap NodeToStatusMap) (*PostFilterResult, *Status) // RunPreBindPlugins runs the set of configured PreBind plugins. It returns // *Status and its code is set to non-success if any of the plugins returns // anything but Success. If the Status code is "Unschedulable", it is // considered as a scheduling check failure, otherwise, it is considered as an // internal error. In either case the pod is not going to be bound. RunPreBindPlugins(ctx context.Context, state *CycleState, pod *v1.Pod, nodeName string) *Status // RunPostBindPlugins runs the set of configured PostBind plugins. RunPostBindPlugins(ctx context.Context, state *CycleState, pod *v1.Pod, nodeName string) // RunReservePluginsReserve runs the Reserve method of the set of // configured Reserve plugins. If any of these calls returns an error, it // does not continue running the remaining ones and returns the error. In // such case, pod will not be scheduled. RunReservePluginsReserve(ctx context.Context, state *CycleState, pod *v1.Pod, nodeName string) *Status // RunReservePluginsUnreserve runs the Unreserve method of the set of // configured Reserve plugins. RunReservePluginsUnreserve(ctx context.Context, state *CycleState, pod *v1.Pod, nodeName string) // RunPermitPlugins runs the set of configured Permit plugins. If any of these // plugins returns a status other than "Success" or "Wait", it does not continue // running the remaining plugins and returns an error. Otherwise, if any of the // plugins returns "Wait", then this function will create and add waiting pod // to a map of currently waiting pods and return status with "Wait" code. // Pod will remain waiting pod for the minimum duration returned by the Permit plugins. RunPermitPlugins(ctx context.Context, state *CycleState, pod *v1.Pod, nodeName string) *Status // WaitOnPermit will block, if the pod is a waiting pod, until the waiting pod is rejected or allowed. WaitOnPermit(ctx context.Context, pod *v1.Pod) *Status // RunBindPlugins runs the set of configured Bind plugins. A Bind plugin may choose // whether or not to handle the given Pod. If a Bind plugin chooses to skip the // binding, it should return code=5("skip") status. Otherwise, it should return "Error" // or "Success". If none of the plugins handled binding, RunBindPlugins returns // code=5("skip") status. RunBindPlugins(ctx context.Context, state *CycleState, pod *v1.Pod, nodeName string) *Status // HasFilterPlugins returns true if at least one Filter plugin is defined. HasFilterPlugins() bool // HasPostFilterPlugins returns true if at least one PostFilter plugin is defined. HasPostFilterPlugins() bool // HasScorePlugins returns true if at least one Score plugin is defined. HasScorePlugins() bool // ListPlugins returns a map of extension point name to list of configured Plugins. ListPlugins() *config.Plugins // ProfileName returns the profile name associated to a profile. ProfileName() string // PercentageOfNodesToScore returns percentageOfNodesToScore associated to a profile. PercentageOfNodesToScore() *int32 }
Framework manages the set of plugins in use by the scheduling framework. Configured plugins are called at specified points in a scheduling context.
type GVK ¶ added in v1.21.0
type GVK string
GVK is short for group/version/kind, which can uniquely represent a particular API resource.
const ( Pod GVK = "Pod" Node GVK = "Node" PersistentVolume GVK = "PersistentVolume" PersistentVolumeClaim GVK = "PersistentVolumeClaim" PodScheduling GVK = "PodScheduling" ResourceClaim GVK = "ResourceClaim" StorageClass GVK = "storage.k8s.io/StorageClass" CSINode GVK = "storage.k8s.io/CSINode" CSIDriver GVK = "storage.k8s.io/CSIDriver" CSIStorageCapacity GVK = "storage.k8s.io/CSIStorageCapacity" WildCard GVK = "*" )
Constants for GVKs.
type Handle ¶
type Handle interface { // PodNominator abstracts operations to maintain nominated Pods. PodNominator // PluginsRunner abstracts operations to run some plugins. PluginsRunner // is taken at the beginning of a scheduling cycle and remains unchanged until // a pod finishes "Permit" point. There is no guarantee that the information // remains unchanged in the binding phase of scheduling, so plugins in the binding // cycle (pre-bind/bind/post-bind/un-reserve plugin) should not use it, // otherwise a concurrent read/write error might occur, they should use scheduler // cache instead. SnapshotSharedLister() SharedLister // IterateOverWaitingPods acquires a read lock and iterates over the WaitingPods map. IterateOverWaitingPods(callback func(WaitingPod)) // GetWaitingPod returns a waiting pod given its UID. GetWaitingPod(uid types.UID) WaitingPod // RejectWaitingPod rejects a waiting pod given its UID. // The return value indicates if the pod is waiting or not. RejectWaitingPod(uid types.UID) bool // ClientSet returns a kubernetes clientSet. ClientSet() clientset.Interface // KubeConfig returns the raw kube config. KubeConfig() *restclient.Config // EventRecorder returns an event recorder. EventRecorder() events.EventRecorder // RunFilterPluginsWithNominatedPods runs the set of configured filter plugins for nominated pod on the given node. RunFilterPluginsWithNominatedPods(ctx context.Context, state *CycleState, pod *v1.Pod, info *NodeInfo) *Status // Extenders returns registered scheduler extenders. Extenders() []Extender // Parallelizer returns a parallelizer holding parallelism for scheduler. Parallelizer() parallelize.Parallelizer }
Handle provides data and some tools that plugins can use. It is passed to the plugin factories at the time of plugin initialization. Plugins must store and use this handle to call framework functions.
type HostPortInfo ¶
type HostPortInfo map[string]map[ProtocolPort]struct{}
HostPortInfo stores mapping from ip to a set of ProtocolPort
func (HostPortInfo) Add ¶
func (h HostPortInfo) Add(ip, protocol string, port int32)
Add adds (ip, protocol, port) to HostPortInfo
func (HostPortInfo) CheckConflict ¶
func (h HostPortInfo) CheckConflict(ip, protocol string, port int32) bool
CheckConflict checks if the input (ip, protocol, port) conflicts with the existing ones in HostPortInfo.
func (HostPortInfo) Len ¶
func (h HostPortInfo) Len() int
Len returns the total number of (ip, protocol, port) tuple in HostPortInfo
func (HostPortInfo) Remove ¶
func (h HostPortInfo) Remove(ip, protocol string, port int32)
Remove removes (ip, protocol, port) from HostPortInfo
type ImageStateSummary ¶
type ImageStateSummary struct { // Size of the image Size int64 // Used to track how many nodes have this image NumNodes int }
ImageStateSummary provides summarized information about the state of an image.
type LessFunc ¶
type LessFunc func(podInfo1, podInfo2 *QueuedPodInfo) bool
LessFunc is the function to sort pod info
type NodeInfo ¶
type NodeInfo struct { // Pods running on the node. Pods []*PodInfo // The subset of pods with affinity. PodsWithAffinity []*PodInfo // The subset of pods with required anti-affinity. PodsWithRequiredAntiAffinity []*PodInfo // Ports allocated on the node. UsedPorts HostPortInfo // Total requested resources of all pods on this node. This includes assumed // pods, which scheduler has sent for binding, but may not be scheduled yet. Requested *Resource // Total requested resources of all pods on this node with a minimum value // applied to each container's CPU and memory requests. This does not reflect // the actual resource requests for this node, but is used to avoid scheduling // many zero-request pods onto one node. NonZeroRequested *Resource // We store allocatedResources (which is Node.Status.Allocatable.*) explicitly // as int64, to avoid conversions and accessing map. Allocatable *Resource // ImageStates holds the entry of an image if and only if this image is on the node. The entry can be used for // checking an image's existence and advanced usage (e.g., image locality scheduling policy) based on the image // state information. ImageStates map[string]*ImageStateSummary // PVCRefCounts contains a mapping of PVC names to the number of pods on the node using it. // Keys are in the format "namespace/name". PVCRefCounts map[string]int // Whenever NodeInfo changes, generation is bumped. // This is used to avoid cloning it if the object didn't change. Generation int64 // contains filtered or unexported fields }
NodeInfo is node level aggregated information.
func NewNodeInfo ¶
NewNodeInfo returns a ready to use empty NodeInfo object. If any pods are given in arguments, their information will be aggregated in the returned object.
func (*NodeInfo) AddPodInfo ¶ added in v1.21.0
AddPodInfo adds pod information to this NodeInfo. Consider using this instead of AddPod if a PodInfo is already computed.
func (*NodeInfo) RemoveNode ¶
func (n *NodeInfo) RemoveNode()
RemoveNode removes the node object, leaving all other tracking information.
type NodeInfoLister ¶
type NodeInfoLister interface { // List returns the list of NodeInfos. List() ([]*NodeInfo, error) // HavePodsWithAffinityList returns the list of NodeInfos of nodes with pods with affinity terms. HavePodsWithAffinityList() ([]*NodeInfo, error) // HavePodsWithRequiredAntiAffinityList returns the list of NodeInfos of nodes with pods with required anti-affinity terms. HavePodsWithRequiredAntiAffinityList() ([]*NodeInfo, error) // Get returns the NodeInfo of the given node name. Get(nodeName string) (*NodeInfo, error) }
NodeInfoLister interface represents anything that can list/get NodeInfo objects from node name.
type NodePluginScores ¶ added in v1.26.0
type NodePluginScores struct { // Name is node name. Name string // Scores is scores from plugins and extenders. Scores []PluginScore // TotalScore is the total score in Scores. TotalScore int64 }
NodePluginScores is a struct with node name and scores for that node.
type NodeScoreList ¶
type NodeScoreList []NodeScore
NodeScoreList declares a list of nodes and their scores.
type NodeToStatusMap ¶
NodeToStatusMap declares map from node name to its status.
type NominatingInfo ¶ added in v1.23.2
type NominatingInfo struct { NominatedNodeName string NominatingMode NominatingMode }
func (*NominatingInfo) Mode ¶ added in v1.23.2
func (ni *NominatingInfo) Mode() NominatingMode
type NominatingMode ¶ added in v1.23.2
type NominatingMode int
const ( ModeNoop NominatingMode = iota ModeOverride )
type PermitPlugin ¶
type PermitPlugin interface { Plugin // Permit is called before binding a pod (and before prebind plugins). Permit // plugins are used to prevent or delay the binding of a Pod. A permit plugin // must return success or wait with timeout duration, or the pod will be rejected. // The pod will also be rejected if the wait timeout or the pod is rejected while // waiting. Note that if the plugin returns "wait", the framework will wait only // after running the remaining plugins given that no other plugin rejects the pod. Permit(ctx context.Context, state *CycleState, p *v1.Pod, nodeName string) (*Status, time.Duration) }
PermitPlugin is an interface that must be implemented by "Permit" plugins. These plugins are called before a pod is bound to a node.
type Plugin ¶
type Plugin interface {
Name() string
}
Plugin is the parent type for all the scheduling framework plugins.
type PluginScore ¶ added in v1.26.0
PluginScore is a struct with plugin/extender name and score.
type PluginsRunner ¶
type PluginsRunner interface { // RunPreScorePlugins runs the set of configured PreScore plugins. If any // of these plugins returns any status other than "Success", the given pod is rejected. RunPreScorePlugins(context.Context, *CycleState, *v1.Pod, []*v1.Node) *Status // RunScorePlugins runs the set of configured scoring plugins. // It returns a list that stores scores from each plugin and total score for each Node. // It also returns *Status, which is set to non-success if any of the plugins returns // a non-success status. RunScorePlugins(context.Context, *CycleState, *v1.Pod, []*v1.Node) ([]NodePluginScores, *Status) // RunFilterPlugins runs the set of configured Filter plugins for pod on // the given node. Note that for the node being evaluated, the passed nodeInfo // reference could be different from the one in NodeInfoSnapshot map (e.g., pods // considered to be running on the node could be different). For example, during // preemption, we may pass a copy of the original nodeInfo object that has some pods // removed from it to evaluate the possibility of preempting them to // schedule the target pod. RunFilterPlugins(context.Context, *CycleState, *v1.Pod, *NodeInfo) *Status // RunPreFilterExtensionAddPod calls the AddPod interface for the set of configured // PreFilter plugins. It returns directly if any of the plugins return any // status other than Success. RunPreFilterExtensionAddPod(ctx context.Context, state *CycleState, podToSchedule *v1.Pod, podInfoToAdd *PodInfo, nodeInfo *NodeInfo) *Status // RunPreFilterExtensionRemovePod calls the RemovePod interface for the set of configured // PreFilter plugins. It returns directly if any of the plugins return any // status other than Success. RunPreFilterExtensionRemovePod(ctx context.Context, state *CycleState, podToSchedule *v1.Pod, podInfoToRemove *PodInfo, nodeInfo *NodeInfo) *Status }
PluginsRunner abstracts operations to run some plugins. This is used by preemption PostFilter plugins when evaluating the feasibility of scheduling the pod on nodes when certain running pods get evicted.
type PodInfo ¶
type PodInfo struct { Pod *v1.Pod RequiredAffinityTerms []AffinityTerm RequiredAntiAffinityTerms []AffinityTerm PreferredAffinityTerms []WeightedAffinityTerm PreferredAntiAffinityTerms []WeightedAffinityTerm }
PodInfo is a wrapper to a Pod with additional pre-computed information to accelerate processing. This information is typically immutable (e.g., pre-processed inter-pod affinity selectors).
type PodNominator ¶
type PodNominator interface { // AddNominatedPod adds the given pod to the nominator or // updates it if it already exists. AddNominatedPod(pod *PodInfo, nominatingInfo *NominatingInfo) // DeleteNominatedPodIfExists deletes nominatedPod from internal cache. It's a no-op if it doesn't exist. DeleteNominatedPodIfExists(pod *v1.Pod) // UpdateNominatedPod updates the <oldPod> with <newPod>. UpdateNominatedPod(oldPod *v1.Pod, newPodInfo *PodInfo) // NominatedPodsForNode returns nominatedPods on the given node. NominatedPodsForNode(nodeName string) []*PodInfo }
PodNominator abstracts operations to maintain nominated Pods.
type PodsToActivate ¶ added in v1.22.0
type PodsToActivate struct { sync.Mutex // Map is keyed with namespaced pod name, and valued with the pod. Map map[string]*v1.Pod }
PodsToActivate stores pods to be activated.
func NewPodsToActivate ¶ added in v1.22.0
func NewPodsToActivate() *PodsToActivate
NewPodsToActivate instantiates a PodsToActivate object.
func (*PodsToActivate) Clone ¶ added in v1.22.0
func (s *PodsToActivate) Clone() StateData
Clone just returns the same state.
type PostBindPlugin ¶
type PostBindPlugin interface { Plugin // PostBind is called after a pod is successfully bound. These plugins are // informational. A common application of this extension point is for cleaning // up. If a plugin needs to clean-up its state after a pod is scheduled and // bound, PostBind is the extension point that it should register. PostBind(ctx context.Context, state *CycleState, p *v1.Pod, nodeName string) }
PostBindPlugin is an interface that must be implemented by "PostBind" plugins. These plugins are called after a pod is successfully bound to a node.
type PostFilterPlugin ¶
type PostFilterPlugin interface { Plugin // PostFilter is called by the scheduling framework. // A PostFilter plugin should return one of the following statuses: // - Unschedulable: the plugin gets executed successfully but the pod cannot be made schedulable. // - Success: the plugin gets executed successfully and the pod can be made schedulable. // - Error: the plugin aborts due to some internal error. // // Informational plugins should be configured ahead of other ones, and always return Unschedulable status. // Optionally, a non-nil PostFilterResult may be returned along with a Success status. For example, // a preemption plugin may choose to return nominatedNodeName, so that framework can reuse that to update the // preemptor pod's .spec.status.nominatedNodeName field. PostFilter(ctx context.Context, state *CycleState, pod *v1.Pod, filteredNodeStatusMap NodeToStatusMap) (*PostFilterResult, *Status) }
PostFilterPlugin is an interface for "PostFilter" plugins. These plugins are called after a pod cannot be scheduled.
type PostFilterResult ¶
type PostFilterResult struct {
*NominatingInfo
}
PostFilterResult wraps needed info for scheduler framework to act upon PostFilter phase.
func NewPostFilterResultWithNominatedNode ¶ added in v1.23.2
func NewPostFilterResultWithNominatedNode(name string) *PostFilterResult
type PreBindPlugin ¶
type PreBindPlugin interface { Plugin // PreBind is called before binding a pod. All prebind plugins must return // success or the pod will be rejected and won't be sent for binding. PreBind(ctx context.Context, state *CycleState, p *v1.Pod, nodeName string) *Status }
PreBindPlugin is an interface that must be implemented by "PreBind" plugins. These plugins are called before a pod being scheduled.
type PreEnqueuePlugin ¶ added in v1.26.0
type PreEnqueuePlugin interface { Plugin // PreEnqueue is called prior to adding Pods to activeQ. PreEnqueue(ctx context.Context, p *v1.Pod) *Status }
PreEnqueuePlugin is an interface that must be implemented by "PreEnqueue" plugins. These plugins are called prior to adding Pods to activeQ. Note: an preEnqueue plugin is expected to be lightweight and efficient, so it's not expected to involve expensive calls like accessing external endpoints; otherwise it'd block other Pods' enqueuing in event handlers.
type PreFilterExtensions ¶
type PreFilterExtensions interface { // AddPod is called by the framework while trying to evaluate the impact // of adding podToAdd to the node while scheduling podToSchedule. AddPod(ctx context.Context, state *CycleState, podToSchedule *v1.Pod, podInfoToAdd *PodInfo, nodeInfo *NodeInfo) *Status // RemovePod is called by the framework while trying to evaluate the impact // of removing podToRemove from the node while scheduling podToSchedule. RemovePod(ctx context.Context, state *CycleState, podToSchedule *v1.Pod, podInfoToRemove *PodInfo, nodeInfo *NodeInfo) *Status }
PreFilterExtensions is an interface that is included in plugins that allow specifying callbacks to make incremental updates to its supposedly pre-calculated state.
type PreFilterPlugin ¶
type PreFilterPlugin interface { Plugin // PreFilter is called at the beginning of the scheduling cycle. All PreFilter // plugins must return success or the pod will be rejected. PreFilter could optionally // return a PreFilterResult to influence which nodes to evaluate downstream. This is useful // for cases where it is possible to determine the subset of nodes to process in O(1) time. // When it returns Skip status, returned PreFilterResult and other fields in status are just ignored, // and coupled Filter plugin/PreFilterExtensions() will be skipped in this scheduling cycle. PreFilter(ctx context.Context, state *CycleState, p *v1.Pod) (*PreFilterResult, *Status) // PreFilterExtensions returns a PreFilterExtensions interface if the plugin implements one, // or nil if it does not. A Pre-filter plugin can provide extensions to incrementally // modify its pre-processed info. The framework guarantees that the extensions // AddPod/RemovePod will only be called after PreFilter, possibly on a cloned // CycleState, and may call those functions more than once before calling // Filter again on a specific node. PreFilterExtensions() PreFilterExtensions }
PreFilterPlugin is an interface that must be implemented by "PreFilter" plugins. These plugins are called at the beginning of the scheduling cycle.
type PreFilterResult ¶ added in v1.24.0
type PreFilterResult struct { // The set of nodes that should be considered downstream; if nil then // all nodes are eligible. NodeNames sets.String }
PreFilterResult wraps needed info for scheduler framework to act upon PreFilter phase.
func (*PreFilterResult) AllNodes ¶ added in v1.24.0
func (p *PreFilterResult) AllNodes() bool
func (*PreFilterResult) Merge ¶ added in v1.24.0
func (p *PreFilterResult) Merge(in *PreFilterResult) *PreFilterResult
type PreScorePlugin ¶
type PreScorePlugin interface { Plugin // PreScore is called by the scheduling framework after a list of nodes // passed the filtering phase. All prescore plugins must return success or // the pod will be rejected // When it returns Skip status, other fields in status are just ignored, // and coupled Score plugin will be skipped in this scheduling cycle. PreScore(ctx context.Context, state *CycleState, pod *v1.Pod, nodes []*v1.Node) *Status }
PreScorePlugin is an interface for "PreScore" plugin. PreScore is an informational extension point. Plugins will be called with a list of nodes that passed the filtering phase. A plugin may use this data to update internal state or to generate logs/metrics.
type ProtocolPort ¶
ProtocolPort represents a protocol port pair, e.g. tcp:80.
func NewProtocolPort ¶
func NewProtocolPort(protocol string, port int32) *ProtocolPort
NewProtocolPort creates a ProtocolPort instance.
type QueueSortPlugin ¶
type QueueSortPlugin interface { Plugin // Less are used to sort pods in the scheduling queue. Less(*QueuedPodInfo, *QueuedPodInfo) bool }
QueueSortPlugin is an interface that must be implemented by "QueueSort" plugins. These plugins are used to sort pods in the scheduling queue. Only one queue sort plugin may be enabled at a time.
type QueuedPodInfo ¶
type QueuedPodInfo struct { *PodInfo // The time pod added to the scheduling queue. Timestamp time.Time // Number of schedule attempts before successfully scheduled. // It's used to record the # attempts metric. Attempts int // The time when the pod is added to the queue for the first time. The pod may be added // back to the queue multiple times before it's successfully scheduled. // It shouldn't be updated once initialized. It's used to record the e2e scheduling // latency for a pod. InitialAttemptTimestamp time.Time // If a Pod failed in a scheduling cycle, record the plugin names it failed by. UnschedulablePlugins sets.String // Whether the Pod is scheduling gated (by PreEnqueuePlugins) or not. Gated bool }
QueuedPodInfo is a Pod wrapper with additional information related to the pod's status in the scheduling queue, such as the timestamp when it's added to the queue.
func (*QueuedPodInfo) DeepCopy ¶
func (pqi *QueuedPodInfo) DeepCopy() *QueuedPodInfo
DeepCopy returns a deep copy of the QueuedPodInfo object.
type ReservePlugin ¶
type ReservePlugin interface { Plugin // Reserve is called by the scheduling framework when the scheduler cache is // updated. If this method returns a failed Status, the scheduler will call // the Unreserve method for all enabled ReservePlugins. Reserve(ctx context.Context, state *CycleState, p *v1.Pod, nodeName string) *Status // Unreserve is called by the scheduling framework when a reserved pod was // rejected, an error occurred during reservation of subsequent plugins, or // in a later phase. The Unreserve method implementation must be idempotent // and may be called by the scheduler even if the corresponding Reserve // method for the same plugin was not called. Unreserve(ctx context.Context, state *CycleState, p *v1.Pod, nodeName string) }
ReservePlugin is an interface for plugins with Reserve and Unreserve methods. These are meant to update the state of the plugin. This concept used to be called 'assume' in the original scheduler. These plugins should return only Success or Error in Status.code. However, the scheduler accepts other valid codes as well. Anything other than Success will lead to rejection of the pod.
type Resource ¶
type Resource struct { MilliCPU int64 Memory int64 EphemeralStorage int64 // We store allowedPodNumber (which is Node.Status.Allocatable.Pods().Value()) // explicitly as int, to avoid conversions and improve performance. AllowedPodNumber int // ScalarResources ScalarResources map[v1.ResourceName]int64 }
Resource is a collection of compute resource.
func NewResource ¶
func NewResource(rl v1.ResourceList) *Resource
NewResource creates a Resource from ResourceList
func (*Resource) Add ¶
func (r *Resource) Add(rl v1.ResourceList)
Add adds ResourceList into Resource.
func (*Resource) AddScalar ¶
func (r *Resource) AddScalar(name v1.ResourceName, quantity int64)
AddScalar adds a resource by a scalar value of this resource.
func (*Resource) SetMaxResource ¶
func (r *Resource) SetMaxResource(rl v1.ResourceList)
SetMaxResource compares with ResourceList and takes max value for each Resource.
type ScoreExtensions ¶
type ScoreExtensions interface { // NormalizeScore is called for all node scores produced by the same plugin's "Score" // method. A successful run of NormalizeScore will update the scores list and return // a success status. NormalizeScore(ctx context.Context, state *CycleState, p *v1.Pod, scores NodeScoreList) *Status }
ScoreExtensions is an interface for Score extended functionality.
type ScorePlugin ¶
type ScorePlugin interface { Plugin // Score is called on each filtered node. It must return success and an integer // indicating the rank of the node. All scoring plugins must return success or // the pod will be rejected. Score(ctx context.Context, state *CycleState, p *v1.Pod, nodeName string) (int64, *Status) // ScoreExtensions returns a ScoreExtensions interface if it implements one, or nil if does not. ScoreExtensions() ScoreExtensions }
ScorePlugin is an interface that must be implemented by "Score" plugins to rank nodes that passed the filtering phase.
type StateData ¶
type StateData interface { // Clone is an interface to make a copy of StateData. For performance reasons, // clone should make shallow copies for members (e.g., slices or maps) that are not // impacted by PreFilter's optional AddPod/RemovePod methods. Clone() StateData }
StateData is a generic type for arbitrary data stored in CycleState.
type StateKey ¶
type StateKey string
StateKey is the type of keys stored in CycleState.
var PodsToActivateKey StateKey = "kubernetes.io/pods-to-activate"
PodsToActivateKey is a reserved state key for stashing pods. If the stashed pods are present in unschedulablePods or backoffQ,they will be activated (i.e., moved to activeQ) in two phases: - end of a scheduling cycle if it succeeds (will be cleared from `PodsToActivate` if activated) - end of a binding cycle if it succeeds
type Status ¶
type Status struct {
// contains filtered or unexported fields
}
Status indicates the result of running a plugin. It consists of a code, a message, (optionally) an error, and a plugin name it fails by. When the status code is not Success, the reasons should explain why. And, when code is Success, all the other fields should be empty. NOTE: A nil Status is also considered as Success.
func (*Status) AppendReason ¶
AppendReason appends given reason to the Status.
func (*Status) AsError ¶
AsError returns nil if the status is a success, a wait or a skip; otherwise returns an "error" object with a concatenated message on reasons of the Status.
func (*Status) Equal ¶ added in v1.21.0
Equal checks equality of two statuses. This is useful for testing with cmp.Equal.
func (*Status) FailedPlugin ¶ added in v1.21.0
FailedPlugin returns the failed plugin name.
func (*Status) IsSkip ¶ added in v1.25.0
IsSkip returns true if and only if "Status" is non-nil and its Code is "Skip".
func (*Status) IsSuccess ¶
IsSuccess returns true if and only if "Status" is nil or Code is "Success".
func (*Status) IsUnschedulable ¶
IsUnschedulable returns true if "Status" is Unschedulable (Unschedulable or UnschedulableAndUnresolvable).
func (*Status) IsWait ¶ added in v1.25.0
IsWait returns true if and only if "Status" is non-nil and its Code is "Wait".
func (*Status) SetFailedPlugin ¶ added in v1.21.0
SetFailedPlugin sets the given plugin name to s.failedPlugin.
func (*Status) WithFailedPlugin ¶ added in v1.21.0
WithFailedPlugin sets the given plugin name to s.failedPlugin, and returns the given status object.
type StorageInfoLister ¶ added in v1.25.0
type StorageInfoLister interface { // IsPVCUsedByPods returns true/false on whether the PVC is used by one or more scheduled pods, // keyed in the format "namespace/name". IsPVCUsedByPods(key string) bool }
StorageInfoLister interface represents anything that handles storage-related operations and resources.
type WaitingPod ¶
type WaitingPod interface { // GetPod returns a reference to the waiting pod. GetPod() *v1.Pod // GetPendingPlugins returns a list of pending Permit plugin's name. GetPendingPlugins() []string // Allow declares the waiting pod is allowed to be scheduled by the plugin named as "pluginName". // If this is the last remaining plugin to allow, then a success signal is delivered // to unblock the pod. Allow(pluginName string) // Reject declares the waiting pod unschedulable. Reject(pluginName, msg string) }
WaitingPod represents a pod currently waiting in the permit phase.
type WeightedAffinityTerm ¶
type WeightedAffinityTerm struct { AffinityTerm Weight int32 }
WeightedAffinityTerm is a "processed" representation of v1.WeightedAffinityTerm.