Documentation
¶
Overview ¶
Package scheduler contains a generic Scheduler interface and several implementations.
Index ¶
- Constants
- func EmptyMetadataProducer(pod *v1.Pod, nodeNameToInfo map[string]*schedulercache.NodeInfo) interface{}
- type ControllerLister
- type EmptyControllerLister
- type EmptyReplicaSetLister
- type EmptyStatefulSetLister
- type FitPredicate
- type GetEquivalencePodFunc
- type MetadataProducer
- type NodeLister
- type PodLister
- type PredicateFailureReason
- type PredicateMetadata
- type PredicateMetadataProducer
- type PriorityConfig
- type PriorityFunction
- type PriorityMapFunction
- type PriorityReduceFunction
- type ReplicaSetLister
- type ScheduleAlgorithm
- type SchedulerExtender
- type ServiceLister
- type StatefulSetLister
Constants ¶
const ( // When feature-gate for TaintBasedEvictions=true flag is enabled, // TaintNodeNotReady would be automatically added by node controller // when node is not ready, and removed when node becomes ready. TaintNodeNotReady = "node.kubernetes.io/not-ready" // DeprecatedTaintNodeNotReady is the deprecated version of TaintNodeNotReady. // It is deprecated since 1.9 DeprecatedTaintNodeNotReady = "node.alpha.kubernetes.io/notReady" // When feature-gate for TaintBasedEvictions=true flag is enabled, // TaintNodeUnreachable would be automatically added by node controller // when node becomes unreachable (corresponding to NodeReady status ConditionUnknown) // and removed when node becomes reachable (NodeReady status ConditionTrue). TaintNodeUnreachable = "node.kubernetes.io/unreachable" // DeprecatedTaintNodeUnreachable is the deprecated version of TaintNodeUnreachable. // It is deprecated since 1.9 DeprecatedTaintNodeUnreachable = "node.alpha.kubernetes.io/unreachable" // When feature-gate for TaintBasedEvictions=true flag is enabled, // TaintNodeOutOfDisk would be automatically added by node controller // when node becomes out of disk, and removed when node has enough disk. TaintNodeOutOfDisk = "node.kubernetes.io/out-of-disk" // When feature-gate for TaintBasedEvictions=true flag is enabled, // TaintNodeMemoryPressure would be automatically added by node controller // when node has memory pressure, and removed when node has enough memory. TaintNodeMemoryPressure = "node.kubernetes.io/memory-pressure" // When feature-gate for TaintBasedEvictions=true flag is enabled, // TaintNodeDiskPressure would be automatically added by node controller // when node has disk pressure, and removed when node has enough disk. TaintNodeDiskPressure = "node.kubernetes.io/disk-pressure" // TaintNodeNetworkUnavailable would be automatically added by node controller // when node's network is unavailable, and removed when network becomes ready. TaintNodeNetworkUnavailable = "node.kubernetes.io/network-unavailable" // When kubelet is started with the "external" cloud provider, then // it sets this taint on a node to mark it as unusable, until a controller // from the cloud-controller-manager intitializes this node, and then removes // the taint TaintExternalCloudProvider = "node.cloudprovider.kubernetes.io/uninitialized" )
Variables ¶
This section is empty.
Functions ¶
func EmptyMetadataProducer ¶ added in v1.5.1
func EmptyMetadataProducer(pod *v1.Pod, nodeNameToInfo map[string]*schedulercache.NodeInfo) interface{}
EmptyMetadataProducer returns a no-op MetadataProducer type.
Types ¶
type ControllerLister ¶ added in v1.2.3
type ControllerLister interface { // Lists all the replication controllers List(labels.Selector) ([]*v1.ReplicationController, error) // Gets the services for the given pod GetPodControllers(*v1.Pod) ([]*v1.ReplicationController, error) }
ControllerLister interface represents anything that can produce a list of ReplicationController; the list is consumed by a scheduler.
type EmptyControllerLister ¶ added in v1.2.3
type EmptyControllerLister struct{}
EmptyControllerLister implements ControllerLister on []v1.ReplicationController returning empty data
func (EmptyControllerLister) GetPodControllers ¶ added in v1.2.3
func (f EmptyControllerLister) GetPodControllers(pod *v1.Pod) (controllers []*v1.ReplicationController, err error)
GetPodControllers returns nil
func (EmptyControllerLister) List ¶ added in v1.2.3
func (f EmptyControllerLister) List(labels.Selector) ([]*v1.ReplicationController, error)
List returns nil
type EmptyReplicaSetLister ¶ added in v1.2.3
type EmptyReplicaSetLister struct{}
EmptyReplicaSetLister implements ReplicaSetLister on []extensions.ReplicaSet returning empty data
func (EmptyReplicaSetLister) GetPodReplicaSets ¶ added in v1.2.3
func (f EmptyReplicaSetLister) GetPodReplicaSets(pod *v1.Pod) (rss []*extensions.ReplicaSet, err error)
GetPodReplicaSets returns nil
type EmptyStatefulSetLister ¶ added in v1.6.0
type EmptyStatefulSetLister struct{}
EmptyStatefulSetLister implements StatefulSetLister on []apps.StatefulSet returning empty data.
func (EmptyStatefulSetLister) GetPodStatefulSets ¶ added in v1.6.0
func (f EmptyStatefulSetLister) GetPodStatefulSets(pod *v1.Pod) (sss []*apps.StatefulSet, err error)
GetPodStatefulSets of EmptyStatefulSetLister returns nil.
type FitPredicate ¶
type FitPredicate func(pod *v1.Pod, meta PredicateMetadata, nodeInfo *schedulercache.NodeInfo) (bool, []PredicateFailureReason, error)
FitPredicate is a function that indicates if a pod fits into an existing node. The failure information is given by the error.
type GetEquivalencePodFunc ¶ added in v1.5.1
type MetadataProducer ¶ added in v1.5.1
type MetadataProducer func(pod *v1.Pod, nodeNameToInfo map[string]*schedulercache.NodeInfo) interface{}
MetadataProducer is a function that computes metadata for a given pod. This is now used for only for priority functions. For predicates please use PredicateMetadataProducer. TODO: Rename this once we have a specific type for priority metadata producer.
type NodeLister ¶ added in v1.2.3
type NodeLister interface { // We explicitly return []*v1.Node, instead of v1.NodeList, to avoid // performing expensive copies that are unneeded. List() ([]*v1.Node, error) }
NodeLister interface represents anything that can list nodes for a scheduler.
type PodLister ¶
type PodLister interface { // We explicitly return []*v1.Pod, instead of v1.PodList, to avoid // performing expensive copies that are unneeded. List(labels.Selector) ([]*v1.Pod, error) // This is similar to "List()", but the returned slice does not // contain pods that don't pass `podFilter`. FilteredList(podFilter schedulercache.PodFilter, selector labels.Selector) ([]*v1.Pod, error) }
PodLister interface represents anything that can list pods for a scheduler.
type PredicateFailureReason ¶ added in v1.4.2
type PredicateFailureReason interface {
GetReason() string
}
type PredicateMetadata ¶ added in v1.8.0
type PredicateMetadata interface { ShallowCopy() PredicateMetadata AddPod(addedPod *v1.Pod, nodeInfo *schedulercache.NodeInfo) error RemovePod(deletedPod *v1.Pod) error }
func EmptyPredicateMetadataProducer ¶ added in v1.8.0
func EmptyPredicateMetadataProducer(pod *v1.Pod, nodeNameToInfo map[string]*schedulercache.NodeInfo) PredicateMetadata
EmptyPredicateMetadataProducer returns a no-op MetadataProducer type.
type PredicateMetadataProducer ¶ added in v1.8.0
type PredicateMetadataProducer func(pod *v1.Pod, nodeNameToInfo map[string]*schedulercache.NodeInfo) PredicateMetadata
PredicateMetadataProducer is a function that computes predicate metadata for a given pod.
type PriorityConfig ¶
type PriorityConfig struct { Name string Map PriorityMapFunction Reduce PriorityReduceFunction // TODO: Remove it after migrating all functions to // Map-Reduce pattern. Function PriorityFunction Weight int }
type PriorityFunction ¶
type PriorityFunction func(pod *v1.Pod, nodeNameToInfo map[string]*schedulercache.NodeInfo, nodes []*v1.Node) (schedulerapi.HostPriorityList, error)
DEPRECATED Use Map-Reduce pattern for priority functions.
type PriorityMapFunction ¶ added in v1.5.1
type PriorityMapFunction func(pod *v1.Pod, meta interface{}, nodeInfo *schedulercache.NodeInfo) (schedulerapi.HostPriority, error)
PriorityMapFunction is a function that computes per-node results for a given node. TODO: Figure out the exact API of this method. TODO: Change interface{} to a specific type.
type PriorityReduceFunction ¶ added in v1.5.1
type PriorityReduceFunction func(pod *v1.Pod, meta interface{}, nodeNameToInfo map[string]*schedulercache.NodeInfo, result schedulerapi.HostPriorityList) error
PriorityReduceFunction is a function that aggregated per-node results and computes final scores for all nodes. TODO: Figure out the exact API of this method. TODO: Change interface{} to a specific type.
type ReplicaSetLister ¶ added in v1.2.3
type ReplicaSetLister interface { // Gets the replicasets for the given pod GetPodReplicaSets(*v1.Pod) ([]*extensions.ReplicaSet, error) }
ReplicaSetLister interface represents anything that can produce a list of ReplicaSet; the list is consumed by a scheduler.
type ScheduleAlgorithm ¶
type ScheduleAlgorithm interface { Schedule(*v1.Pod, NodeLister) (selectedMachine string, err error) // Preempt receives scheduling errors for a pod and tries to create room for // the pod by preempting lower priority pods if possible. // It returns the node where preemption happened, a list of preempted pods, a // list of pods whose nominated node name should be removed, and error if any. Preempt(*v1.Pod, NodeLister, error) (selectedNode *v1.Node, preemptedPods []*v1.Pod, cleanupNominatedPods []*v1.Pod, err error) // Predicates() returns a pointer to a map of predicate functions. This is // exposed for testing. Predicates() map[string]FitPredicate // Prioritizers returns a slice of priority config. This is exposed for // testing. Prioritizers() []PriorityConfig }
ScheduleAlgorithm is an interface implemented by things that know how to schedule pods onto machines.
type SchedulerExtender ¶ added in v1.2.3
type SchedulerExtender interface { // 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. Filter(pod *v1.Pod, nodes []*v1.Node, nodeNameToInfo map[string]*schedulercache.NodeInfo) (filteredNodes []*v1.Node, failedNodesMap schedulerapi.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 *schedulerapi.HostPriorityList, weight int, 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 }
SchedulerExtender 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 ServiceLister ¶
type ServiceLister interface { // Lists all the services List(labels.Selector) ([]*v1.Service, error) // Gets the services for the given pod GetPodServices(*v1.Pod) ([]*v1.Service, error) }
ServiceLister interface represents anything that can produce a list of services; the list is consumed by a scheduler.
type StatefulSetLister ¶ added in v1.6.0
type StatefulSetLister interface { // Gets the StatefulSet for the given pod. GetPodStatefulSets(*v1.Pod) ([]*apps.StatefulSet, error) }
StatefulSetLister interface represents anything that can produce a list of StatefulSet; the list is consumed by a scheduler.