...

Package config

import "k8s.io/kubernetes/pkg/scheduler/apis/config"
Overview
Index
Subdirectories

Overview ▾

Index ▾

Constants
Variables
type DefaultPreemptionArgs
    func (in *DefaultPreemptionArgs) DeepCopy() *DefaultPreemptionArgs
    func (in *DefaultPreemptionArgs) DeepCopyInto(out *DefaultPreemptionArgs)
    func (in *DefaultPreemptionArgs) DeepCopyObject() runtime.Object
type Extender
    func (in *Extender) DeepCopy() *Extender
    func (in *Extender) DeepCopyInto(out *Extender)
type ExtenderManagedResource
    func (in *ExtenderManagedResource) DeepCopy() *ExtenderManagedResource
    func (in *ExtenderManagedResource) DeepCopyInto(out *ExtenderManagedResource)
type ExtenderTLSConfig
    func (in *ExtenderTLSConfig) DeepCopy() *ExtenderTLSConfig
    func (in *ExtenderTLSConfig) DeepCopyInto(out *ExtenderTLSConfig)
type InterPodAffinityArgs
    func (in *InterPodAffinityArgs) DeepCopy() *InterPodAffinityArgs
    func (in *InterPodAffinityArgs) DeepCopyInto(out *InterPodAffinityArgs)
    func (in *InterPodAffinityArgs) DeepCopyObject() runtime.Object
type KubeSchedulerConfiguration
    func (in *KubeSchedulerConfiguration) DeepCopy() *KubeSchedulerConfiguration
    func (in *KubeSchedulerConfiguration) DeepCopyInto(out *KubeSchedulerConfiguration)
    func (in *KubeSchedulerConfiguration) DeepCopyObject() runtime.Object
type KubeSchedulerProfile
    func (in *KubeSchedulerProfile) DeepCopy() *KubeSchedulerProfile
    func (in *KubeSchedulerProfile) DeepCopyInto(out *KubeSchedulerProfile)
type NodeAffinityArgs
    func (in *NodeAffinityArgs) DeepCopy() *NodeAffinityArgs
    func (in *NodeAffinityArgs) DeepCopyInto(out *NodeAffinityArgs)
    func (in *NodeAffinityArgs) DeepCopyObject() runtime.Object
type NodeResourcesBalancedAllocationArgs
    func (in *NodeResourcesBalancedAllocationArgs) DeepCopy() *NodeResourcesBalancedAllocationArgs
    func (in *NodeResourcesBalancedAllocationArgs) DeepCopyInto(out *NodeResourcesBalancedAllocationArgs)
    func (in *NodeResourcesBalancedAllocationArgs) DeepCopyObject() runtime.Object
type NodeResourcesFitArgs
    func (in *NodeResourcesFitArgs) DeepCopy() *NodeResourcesFitArgs
    func (in *NodeResourcesFitArgs) DeepCopyInto(out *NodeResourcesFitArgs)
    func (in *NodeResourcesFitArgs) DeepCopyObject() runtime.Object
type Plugin
    func (in *Plugin) DeepCopy() *Plugin
    func (in *Plugin) DeepCopyInto(out *Plugin)
type PluginConfig
    func (in *PluginConfig) DeepCopy() *PluginConfig
    func (in *PluginConfig) DeepCopyInto(out *PluginConfig)
type PluginSet
    func (in *PluginSet) DeepCopy() *PluginSet
    func (in *PluginSet) DeepCopyInto(out *PluginSet)
type Plugins
    func (in *Plugins) DeepCopy() *Plugins
    func (in *Plugins) DeepCopyInto(out *Plugins)
    func (p *Plugins) Names() []string
type PodTopologySpreadArgs
    func (in *PodTopologySpreadArgs) DeepCopy() *PodTopologySpreadArgs
    func (in *PodTopologySpreadArgs) DeepCopyInto(out *PodTopologySpreadArgs)
    func (in *PodTopologySpreadArgs) DeepCopyObject() runtime.Object
type PodTopologySpreadConstraintsDefaulting
type RequestedToCapacityRatioParam
    func (in *RequestedToCapacityRatioParam) DeepCopy() *RequestedToCapacityRatioParam
    func (in *RequestedToCapacityRatioParam) DeepCopyInto(out *RequestedToCapacityRatioParam)
type ResourceSpec
    func (in *ResourceSpec) DeepCopy() *ResourceSpec
    func (in *ResourceSpec) DeepCopyInto(out *ResourceSpec)
type ScoringStrategy
    func (in *ScoringStrategy) DeepCopy() *ScoringStrategy
    func (in *ScoringStrategy) DeepCopyInto(out *ScoringStrategy)
type ScoringStrategyType
type UtilizationShapePoint
    func (in *UtilizationShapePoint) DeepCopy() *UtilizationShapePoint
    func (in *UtilizationShapePoint) DeepCopyInto(out *UtilizationShapePoint)
type VolumeBindingArgs
    func (in *VolumeBindingArgs) DeepCopy() *VolumeBindingArgs
    func (in *VolumeBindingArgs) DeepCopyInto(out *VolumeBindingArgs)
    func (in *VolumeBindingArgs) DeepCopyObject() runtime.Object

Package files

doc.go register.go types.go types_pluginargs.go zz_generated.deepcopy.go

Constants

* NOTE: The following variables and methods are intentionally left out of the staging mirror.

const (
    // DefaultPercentageOfNodesToScore defines the percentage of nodes of all nodes
    // that once found feasible, the scheduler stops looking for more nodes.
    // A value of 0 means adaptive, meaning the scheduler figures out a proper default.
    DefaultPercentageOfNodesToScore = 0

    // MaxCustomPriorityScore is the max score UtilizationShapePoint expects.
    MaxCustomPriorityScore int64 = 10

    // MaxTotalScore is the maximum total score.
    MaxTotalScore int64 = math.MaxInt64

    // MaxWeight defines the max weight value allowed for custom PriorityPolicy
    MaxWeight = MaxTotalScore / MaxCustomPriorityScore
)
const (
    // DefaultKubeSchedulerPort is the default port for the scheduler status server.
    // May be overridden by a flag at startup.
    DefaultKubeSchedulerPort = 10259
)

GroupName is the group name used in this package

const GroupName = "kubescheduler.config.k8s.io"

Variables

var (
    // SchemeBuilder is the scheme builder with scheme init functions to run for this API package
    SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
    // AddToScheme is a global function that registers this API group & version to a scheme
    AddToScheme = SchemeBuilder.AddToScheme
)

SchemeGroupVersion is group version used to register these objects

var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}

type DefaultPreemptionArgs

DefaultPreemptionArgs holds arguments used to configure the DefaultPreemption plugin.

type DefaultPreemptionArgs struct {
    metav1.TypeMeta

    // MinCandidateNodesPercentage is the minimum number of candidates to
    // shortlist when dry running preemption as a percentage of number of nodes.
    // Must be in the range [0, 100]. Defaults to 10% of the cluster size if
    // unspecified.
    MinCandidateNodesPercentage int32
    // MinCandidateNodesAbsolute is the absolute minimum number of candidates to
    // shortlist. The likely number of candidates enumerated for dry running
    // preemption is given by the formula:
    // numCandidates = max(numNodes * minCandidateNodesPercentage, minCandidateNodesAbsolute)
    // We say "likely" because there are other factors such as PDB violations
    // that play a role in the number of candidates shortlisted. Must be at least
    // 0 nodes. Defaults to 100 nodes if unspecified.
    MinCandidateNodesAbsolute int32
}

func (*DefaultPreemptionArgs) DeepCopy

func (in *DefaultPreemptionArgs) DeepCopy() *DefaultPreemptionArgs

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DefaultPreemptionArgs.

func (*DefaultPreemptionArgs) DeepCopyInto

func (in *DefaultPreemptionArgs) DeepCopyInto(out *DefaultPreemptionArgs)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*DefaultPreemptionArgs) DeepCopyObject

func (in *DefaultPreemptionArgs) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type Extender

Extender holds the parameters used to communicate with the extender. If a verb is unspecified/empty, it is assumed that the extender chose not to provide that extension.

type Extender struct {
    // URLPrefix at which the extender is available
    URLPrefix string
    // Verb for the filter call, empty if not supported. This verb is appended to the URLPrefix when issuing the filter call to extender.
    FilterVerb string
    // Verb for the preempt call, empty if not supported. This verb is appended to the URLPrefix when issuing the preempt call to extender.
    PreemptVerb string
    // Verb for the prioritize call, empty if not supported. This verb is appended to the URLPrefix when issuing the prioritize call to extender.
    PrioritizeVerb string
    // The numeric multiplier for the node scores that the prioritize call generates.
    // The weight should be a positive integer
    Weight int64
    // Verb for the bind call, empty if not supported. This verb is appended to the URLPrefix when issuing the bind call to extender.
    // If this method is implemented by the extender, it is the extender's responsibility to bind the pod to apiserver. Only one extender
    // can implement this function.
    BindVerb string
    // EnableHTTPS specifies whether https should be used to communicate with the extender
    EnableHTTPS bool
    // TLSConfig specifies the transport layer security config
    TLSConfig *ExtenderTLSConfig
    // HTTPTimeout specifies the timeout duration for a call to the extender. Filter timeout fails the scheduling of the pod. Prioritize
    // timeout is ignored, k8s/other extenders priorities are used to select the node.
    HTTPTimeout metav1.Duration
    // NodeCacheCapable specifies that the extender is capable of caching node information,
    // so the scheduler should only send minimal information about the eligible nodes
    // assuming that the extender already cached full details of all nodes in the cluster
    NodeCacheCapable bool
    // ManagedResources is a list of extended resources that are managed by
    // this extender.
    // - A pod will be sent to the extender on the Filter, Prioritize and Bind
    //   (if the extender is the binder) phases iff the pod requests at least
    //   one of the extended resources in this list. If empty or unspecified,
    //   all pods will be sent to this extender.
    // - If IgnoredByScheduler is set to true for a resource, kube-scheduler
    //   will skip checking the resource in predicates.
    // +optional
    ManagedResources []ExtenderManagedResource
    // Ignorable specifies if the extender is ignorable, i.e. scheduling should not
    // fail when the extender returns an error or is not reachable.
    Ignorable bool
}

func (*Extender) DeepCopy

func (in *Extender) DeepCopy() *Extender

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Extender.

func (*Extender) DeepCopyInto

func (in *Extender) DeepCopyInto(out *Extender)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ExtenderManagedResource

ExtenderManagedResource describes the arguments of extended resources managed by an extender.

type ExtenderManagedResource struct {
    // Name is the extended resource name.
    Name string
    // IgnoredByScheduler indicates whether kube-scheduler should ignore this
    // resource when applying predicates.
    IgnoredByScheduler bool
}

func (*ExtenderManagedResource) DeepCopy

func (in *ExtenderManagedResource) DeepCopy() *ExtenderManagedResource

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ExtenderManagedResource.

func (*ExtenderManagedResource) DeepCopyInto

func (in *ExtenderManagedResource) DeepCopyInto(out *ExtenderManagedResource)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ExtenderTLSConfig

ExtenderTLSConfig contains settings to enable TLS with extender

type ExtenderTLSConfig struct {
    // Server should be accessed without verifying the TLS certificate. For testing only.
    Insecure bool
    // ServerName is passed to the server for SNI and is used in the client to check server
    // certificates against. If ServerName is empty, the hostname used to contact the
    // server is used.
    ServerName string

    // Server requires TLS client certificate authentication
    CertFile string
    // Server requires TLS client certificate authentication
    KeyFile string
    // Trusted root certificates for server
    CAFile string

    // CertData holds PEM-encoded bytes (typically read from a client certificate file).
    // CertData takes precedence over CertFile
    CertData []byte
    // KeyData holds PEM-encoded bytes (typically read from a client certificate key file).
    // KeyData takes precedence over KeyFile
    KeyData []byte `datapolicy:"security-key"`
    // CAData holds PEM-encoded bytes (typically read from a root certificates bundle).
    // CAData takes precedence over CAFile
    CAData []byte
}

func (*ExtenderTLSConfig) DeepCopy

func (in *ExtenderTLSConfig) DeepCopy() *ExtenderTLSConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ExtenderTLSConfig.

func (*ExtenderTLSConfig) DeepCopyInto

func (in *ExtenderTLSConfig) DeepCopyInto(out *ExtenderTLSConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type InterPodAffinityArgs

InterPodAffinityArgs holds arguments used to configure the InterPodAffinity plugin.

type InterPodAffinityArgs struct {
    metav1.TypeMeta

    // HardPodAffinityWeight is the scoring weight for existing pods with a
    // matching hard affinity to the incoming pod.
    HardPodAffinityWeight int32

    // IgnorePreferredTermsOfExistingPods configures the scheduler to ignore existing pods' preferred affinity
    // rules when scoring candidate nodes, unless the incoming pod has inter-pod affinities.
    IgnorePreferredTermsOfExistingPods bool
}

func (*InterPodAffinityArgs) DeepCopy

func (in *InterPodAffinityArgs) DeepCopy() *InterPodAffinityArgs

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new InterPodAffinityArgs.

func (*InterPodAffinityArgs) DeepCopyInto

func (in *InterPodAffinityArgs) DeepCopyInto(out *InterPodAffinityArgs)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*InterPodAffinityArgs) DeepCopyObject

func (in *InterPodAffinityArgs) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type KubeSchedulerConfiguration

KubeSchedulerConfiguration configures a scheduler

type KubeSchedulerConfiguration struct {
    // TypeMeta contains the API version and kind. In kube-scheduler, after
    // conversion from the versioned KubeSchedulerConfiguration type to this
    // internal type, we set the APIVersion field to the scheme group/version of
    // the type we converted from. This is done in cmd/kube-scheduler in two
    // places: (1) when loading config from a file, (2) generating the default
    // config. Based on the versioned type set in this field, we make decisions;
    // for example (1) during validation to check for usage of removed plugins,
    // (2) writing config to a file, (3) initialising the scheduler.
    metav1.TypeMeta

    // Parallelism defines the amount of parallelism in algorithms for scheduling a Pods. Must be greater than 0. Defaults to 16
    Parallelism int32

    // LeaderElection defines the configuration of leader election client.
    LeaderElection componentbaseconfig.LeaderElectionConfiguration

    // ClientConnection specifies the kubeconfig file and client connection
    // settings for the proxy server to use when communicating with the apiserver.
    ClientConnection componentbaseconfig.ClientConnectionConfiguration

    // DebuggingConfiguration holds configuration for Debugging related features
    // TODO: We might wanna make this a substruct like Debugging componentbaseconfig.DebuggingConfiguration
    componentbaseconfig.DebuggingConfiguration

    // PercentageOfNodesToScore is the percentage of all nodes that once found feasible
    // for running a pod, the scheduler stops its search for more feasible nodes in
    // the cluster. This helps improve scheduler's performance. Scheduler always tries to find
    // at least "minFeasibleNodesToFind" feasible nodes no matter what the value of this flag is.
    // Example: if the cluster size is 500 nodes and the value of this flag is 30,
    // then scheduler stops finding further feasible nodes once it finds 150 feasible ones.
    // When the value is 0, default percentage (5%--50% based on the size of the cluster) of the
    // nodes will be scored. It is overridden by profile level PercentageOfNodesToScore.
    PercentageOfNodesToScore *int32

    // PodInitialBackoffSeconds is the initial backoff for unschedulable pods.
    // If specified, it must be greater than 0. If this value is null, the default value (1s)
    // will be used.
    PodInitialBackoffSeconds int64

    // PodMaxBackoffSeconds is the max backoff for unschedulable pods.
    // If specified, it must be greater than or equal to podInitialBackoffSeconds. If this value is null,
    // the default value (10s) will be used.
    PodMaxBackoffSeconds int64

    // Profiles are scheduling profiles that kube-scheduler supports. Pods can
    // choose to be scheduled under a particular profile by setting its associated
    // scheduler name. Pods that don't specify any scheduler name are scheduled
    // with the "default-scheduler" profile, if present here.
    Profiles []KubeSchedulerProfile

    // Extenders are the list of scheduler extenders, each holding the values of how to communicate
    // with the extender. These extenders are shared by all scheduler profiles.
    Extenders []Extender

    // DelayCacheUntilActive specifies when to start caching. If this is true and leader election is enabled,
    // the scheduler will wait to fill informer caches until it is the leader. Doing so will have slower
    // failover with the benefit of lower memory overhead while waiting to become leader.
    // Defaults to false.
    DelayCacheUntilActive bool
}

func (*KubeSchedulerConfiguration) DeepCopy

func (in *KubeSchedulerConfiguration) DeepCopy() *KubeSchedulerConfiguration

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KubeSchedulerConfiguration.

func (*KubeSchedulerConfiguration) DeepCopyInto

func (in *KubeSchedulerConfiguration) DeepCopyInto(out *KubeSchedulerConfiguration)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*KubeSchedulerConfiguration) DeepCopyObject

func (in *KubeSchedulerConfiguration) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type KubeSchedulerProfile

KubeSchedulerProfile is a scheduling profile.

type KubeSchedulerProfile struct {
    // SchedulerName is the name of the scheduler associated to this profile.
    // If SchedulerName matches with the pod's "spec.schedulerName", then the pod
    // is scheduled with this profile.
    SchedulerName string

    // PercentageOfNodesToScore is the percentage of all nodes that once found feasible
    // for running a pod, the scheduler stops its search for more feasible nodes in
    // the cluster. This helps improve scheduler's performance. Scheduler always tries to find
    // at least "minFeasibleNodesToFind" feasible nodes no matter what the value of this flag is.
    // Example: if the cluster size is 500 nodes and the value of this flag is 30,
    // then scheduler stops finding further feasible nodes once it finds 150 feasible ones.
    // When the value is 0, default percentage (5%--50% based on the size of the cluster) of the
    // nodes will be scored. It will override global PercentageOfNodesToScore. If it is empty,
    // global PercentageOfNodesToScore will be used.
    PercentageOfNodesToScore *int32

    // Plugins specify the set of plugins that should be enabled or disabled.
    // Enabled plugins are the ones that should be enabled in addition to the
    // default plugins. Disabled plugins are any of the default plugins that
    // should be disabled.
    // When no enabled or disabled plugin is specified for an extension point,
    // default plugins for that extension point will be used if there is any.
    // If a QueueSort plugin is specified, the same QueueSort Plugin and
    // PluginConfig must be specified for all profiles.
    Plugins *Plugins

    // PluginConfig is an optional set of custom plugin arguments for each plugin.
    // Omitting config args for a plugin is equivalent to using the default config
    // for that plugin.
    PluginConfig []PluginConfig
}

func (*KubeSchedulerProfile) DeepCopy

func (in *KubeSchedulerProfile) DeepCopy() *KubeSchedulerProfile

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KubeSchedulerProfile.

func (*KubeSchedulerProfile) DeepCopyInto

func (in *KubeSchedulerProfile) DeepCopyInto(out *KubeSchedulerProfile)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type NodeAffinityArgs

NodeAffinityArgs holds arguments to configure the NodeAffinity plugin.

type NodeAffinityArgs struct {
    metav1.TypeMeta

    // AddedAffinity is applied to all Pods additionally to the NodeAffinity
    // specified in the PodSpec. That is, Nodes need to satisfy AddedAffinity
    // AND .spec.NodeAffinity. AddedAffinity is empty by default (all Nodes
    // match).
    // When AddedAffinity is used, some Pods with affinity requirements that match
    // a specific Node (such as Daemonset Pods) might remain unschedulable.
    AddedAffinity *v1.NodeAffinity
}

func (*NodeAffinityArgs) DeepCopy

func (in *NodeAffinityArgs) DeepCopy() *NodeAffinityArgs

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NodeAffinityArgs.

func (*NodeAffinityArgs) DeepCopyInto

func (in *NodeAffinityArgs) DeepCopyInto(out *NodeAffinityArgs)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*NodeAffinityArgs) DeepCopyObject

func (in *NodeAffinityArgs) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type NodeResourcesBalancedAllocationArgs

NodeResourcesBalancedAllocationArgs holds arguments used to configure NodeResourcesBalancedAllocation plugin.

type NodeResourcesBalancedAllocationArgs struct {
    metav1.TypeMeta

    // Resources to be considered when scoring.
    // The default resource set includes "cpu" and "memory", only valid weight is 1.
    Resources []ResourceSpec
}

func (*NodeResourcesBalancedAllocationArgs) DeepCopy

func (in *NodeResourcesBalancedAllocationArgs) DeepCopy() *NodeResourcesBalancedAllocationArgs

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NodeResourcesBalancedAllocationArgs.

func (*NodeResourcesBalancedAllocationArgs) DeepCopyInto

func (in *NodeResourcesBalancedAllocationArgs) DeepCopyInto(out *NodeResourcesBalancedAllocationArgs)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*NodeResourcesBalancedAllocationArgs) DeepCopyObject

func (in *NodeResourcesBalancedAllocationArgs) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type NodeResourcesFitArgs

NodeResourcesFitArgs holds arguments used to configure the NodeResourcesFit plugin.

type NodeResourcesFitArgs struct {
    metav1.TypeMeta

    // IgnoredResources is the list of resources that NodeResources fit filter
    // should ignore.
    IgnoredResources []string
    // IgnoredResourceGroups defines the list of resource groups that NodeResources fit filter should ignore.
    // e.g. if group is ["example.com"], it will ignore all resource names that begin
    // with "example.com", such as "example.com/aaa" and "example.com/bbb".
    // A resource group name can't contain '/'.
    IgnoredResourceGroups []string

    // ScoringStrategy selects the node resource scoring strategy.
    ScoringStrategy *ScoringStrategy
}

func (*NodeResourcesFitArgs) DeepCopy

func (in *NodeResourcesFitArgs) DeepCopy() *NodeResourcesFitArgs

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NodeResourcesFitArgs.

func (*NodeResourcesFitArgs) DeepCopyInto

func (in *NodeResourcesFitArgs) DeepCopyInto(out *NodeResourcesFitArgs)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*NodeResourcesFitArgs) DeepCopyObject

func (in *NodeResourcesFitArgs) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type Plugin

Plugin specifies a plugin name and its weight when applicable. Weight is used only for Score plugins.

type Plugin struct {
    // Name defines the name of plugin
    Name string
    // Weight defines the weight of plugin, only used for Score plugins.
    Weight int32
}

func (*Plugin) DeepCopy

func (in *Plugin) DeepCopy() *Plugin

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Plugin.

func (*Plugin) DeepCopyInto

func (in *Plugin) DeepCopyInto(out *Plugin)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PluginConfig

PluginConfig specifies arguments that should be passed to a plugin at the time of initialization. A plugin that is invoked at multiple extension points is initialized once. Args can have arbitrary structure. It is up to the plugin to process these Args.

type PluginConfig struct {
    // Name defines the name of plugin being configured
    Name string
    // Args defines the arguments passed to the plugins at the time of initialization. Args can have arbitrary structure.
    Args runtime.Object
}

func (*PluginConfig) DeepCopy

func (in *PluginConfig) DeepCopy() *PluginConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PluginConfig.

func (*PluginConfig) DeepCopyInto

func (in *PluginConfig) DeepCopyInto(out *PluginConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PluginSet

PluginSet specifies enabled and disabled plugins for an extension point. If an array is empty, missing, or nil, default plugins at that extension point will be used.

type PluginSet struct {
    // Enabled specifies plugins that should be enabled in addition to default plugins.
    // These are called after default plugins and in the same order specified here.
    Enabled []Plugin
    // Disabled specifies default plugins that should be disabled.
    // When all default plugins need to be disabled, an array containing only one "*" should be provided.
    Disabled []Plugin
}

func (*PluginSet) DeepCopy

func (in *PluginSet) DeepCopy() *PluginSet

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PluginSet.

func (*PluginSet) DeepCopyInto

func (in *PluginSet) DeepCopyInto(out *PluginSet)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Plugins

Plugins include multiple extension points. When specified, the list of plugins for a particular extension point are the only ones enabled. If an extension point is omitted from the config, then the default set of plugins is used for that extension point. Enabled plugins are called in the order specified here, after default plugins. If they need to be invoked before default plugins, default plugins must be disabled and re-enabled here in desired order.

type Plugins struct {
    // PreEnqueue is a list of plugins that should be invoked before adding pods to the scheduling queue.
    PreEnqueue PluginSet

    // QueueSort is a list of plugins that should be invoked when sorting pods in the scheduling queue.
    QueueSort PluginSet

    // PreFilter is a list of plugins that should be invoked at "PreFilter" extension point of the scheduling framework.
    PreFilter PluginSet

    // Filter is a list of plugins that should be invoked when filtering out nodes that cannot run the Pod.
    Filter PluginSet

    // PostFilter is a list of plugins that are invoked after filtering phase, but only when no feasible nodes were found for the pod.
    PostFilter PluginSet

    // PreScore is a list of plugins that are invoked before scoring.
    PreScore PluginSet

    // Score is a list of plugins that should be invoked when ranking nodes that have passed the filtering phase.
    Score PluginSet

    // Reserve is a list of plugins invoked when reserving/unreserving resources
    // after a node is assigned to run the pod.
    Reserve PluginSet

    // Permit is a list of plugins that control binding of a Pod. These plugins can prevent or delay binding of a Pod.
    Permit PluginSet

    // PreBind is a list of plugins that should be invoked before a pod is bound.
    PreBind PluginSet

    // Bind is a list of plugins that should be invoked at "Bind" extension point of the scheduling framework.
    // The scheduler call these plugins in order. Scheduler skips the rest of these plugins as soon as one returns success.
    Bind PluginSet

    // PostBind is a list of plugins that should be invoked after a pod is successfully bound.
    PostBind PluginSet

    // MultiPoint is a simplified config field for enabling plugins for all valid extension points
    MultiPoint PluginSet
}

func (*Plugins) DeepCopy

func (in *Plugins) DeepCopy() *Plugins

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Plugins.

func (*Plugins) DeepCopyInto

func (in *Plugins) DeepCopyInto(out *Plugins)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Plugins) Names

func (p *Plugins) Names() []string

Names returns the list of enabled plugin names.

type PodTopologySpreadArgs

PodTopologySpreadArgs holds arguments used to configure the PodTopologySpread plugin.

type PodTopologySpreadArgs struct {
    metav1.TypeMeta

    // DefaultConstraints defines topology spread constraints to be applied to
    // Pods that don't define any in `pod.spec.topologySpreadConstraints`.
    // `.defaultConstraints[*].labelSelectors` must be empty, as they are
    // deduced from the Pod's membership to Services, ReplicationControllers,
    // ReplicaSets or StatefulSets.
    // When not empty, .defaultingType must be "List".
    DefaultConstraints []v1.TopologySpreadConstraint

    // DefaultingType determines how .defaultConstraints are deduced. Can be one
    // of "System" or "List".
    //
    // - "System": Use kubernetes defined constraints that spread Pods among
    //   Nodes and Zones.
    // - "List": Use constraints defined in .defaultConstraints.
    //
    // Defaults to "System".
    // +optional
    DefaultingType PodTopologySpreadConstraintsDefaulting
}

func (*PodTopologySpreadArgs) DeepCopy

func (in *PodTopologySpreadArgs) DeepCopy() *PodTopologySpreadArgs

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PodTopologySpreadArgs.

func (*PodTopologySpreadArgs) DeepCopyInto

func (in *PodTopologySpreadArgs) DeepCopyInto(out *PodTopologySpreadArgs)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*PodTopologySpreadArgs) DeepCopyObject

func (in *PodTopologySpreadArgs) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type PodTopologySpreadConstraintsDefaulting

PodTopologySpreadConstraintsDefaulting defines how to set default constraints for the PodTopologySpread plugin.

type PodTopologySpreadConstraintsDefaulting string
const (
    // SystemDefaulting instructs to use the kubernetes defined default.
    SystemDefaulting PodTopologySpreadConstraintsDefaulting = "System"
    // ListDefaulting instructs to use the config provided default.
    ListDefaulting PodTopologySpreadConstraintsDefaulting = "List"
)

type RequestedToCapacityRatioParam

RequestedToCapacityRatioParam define RequestedToCapacityRatio parameters

type RequestedToCapacityRatioParam struct {
    // Shape is a list of points defining the scoring function shape.
    Shape []UtilizationShapePoint
}

func (*RequestedToCapacityRatioParam) DeepCopy

func (in *RequestedToCapacityRatioParam) DeepCopy() *RequestedToCapacityRatioParam

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RequestedToCapacityRatioParam.

func (*RequestedToCapacityRatioParam) DeepCopyInto

func (in *RequestedToCapacityRatioParam) DeepCopyInto(out *RequestedToCapacityRatioParam)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ResourceSpec

ResourceSpec represents single resource.

type ResourceSpec struct {
    // Name of the resource.
    Name string
    // Weight of the resource.
    Weight int64
}

func (*ResourceSpec) DeepCopy

func (in *ResourceSpec) DeepCopy() *ResourceSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceSpec.

func (*ResourceSpec) DeepCopyInto

func (in *ResourceSpec) DeepCopyInto(out *ResourceSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ScoringStrategy

ScoringStrategy define ScoringStrategyType for node resource plugin

type ScoringStrategy struct {
    // Type selects which strategy to run.
    Type ScoringStrategyType

    // Resources to consider when scoring.
    // The default resource set includes "cpu" and "memory" with an equal weight.
    // Allowed weights go from 1 to 100.
    // Weight defaults to 1 if not specified or explicitly set to 0.
    Resources []ResourceSpec

    // Arguments specific to RequestedToCapacityRatio strategy.
    RequestedToCapacityRatio *RequestedToCapacityRatioParam
}

func (*ScoringStrategy) DeepCopy

func (in *ScoringStrategy) DeepCopy() *ScoringStrategy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ScoringStrategy.

func (*ScoringStrategy) DeepCopyInto

func (in *ScoringStrategy) DeepCopyInto(out *ScoringStrategy)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ScoringStrategyType

ScoringStrategyType the type of scoring strategy used in NodeResourcesFit plugin.

type ScoringStrategyType string
const (
    // LeastAllocated strategy prioritizes nodes with least allocated resources.
    LeastAllocated ScoringStrategyType = "LeastAllocated"
    // MostAllocated strategy prioritizes nodes with most allocated resources.
    MostAllocated ScoringStrategyType = "MostAllocated"
    // RequestedToCapacityRatio strategy allows specifying a custom shape function
    // to score nodes based on the request to capacity ratio.
    RequestedToCapacityRatio ScoringStrategyType = "RequestedToCapacityRatio"
)

type UtilizationShapePoint

UtilizationShapePoint represents a single point of a priority function shape.

type UtilizationShapePoint struct {
    // Utilization (x axis). Valid values are 0 to 100. Fully utilized node maps to 100.
    Utilization int32
    // Score assigned to a given utilization (y axis). Valid values are 0 to 10.
    Score int32
}

func (*UtilizationShapePoint) DeepCopy

func (in *UtilizationShapePoint) DeepCopy() *UtilizationShapePoint

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UtilizationShapePoint.

func (*UtilizationShapePoint) DeepCopyInto

func (in *UtilizationShapePoint) DeepCopyInto(out *UtilizationShapePoint)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VolumeBindingArgs

VolumeBindingArgs holds arguments used to configure the VolumeBinding plugin.

type VolumeBindingArgs struct {
    metav1.TypeMeta

    // BindTimeoutSeconds is the timeout in seconds in volume binding operation.
    // Value must be non-negative integer. The value zero indicates no waiting.
    // If this value is nil, the default value will be used.
    BindTimeoutSeconds int64

    // Shape specifies the points defining the score function shape, which is
    // used to score nodes based on the utilization of statically provisioned
    // PVs. The utilization is calculated by dividing the total requested
    // storage of the pod by the total capacity of feasible PVs on each node.
    // Each point contains utilization (ranges from 0 to 100) and its
    // associated score (ranges from 0 to 10). You can turn the priority by
    // specifying different scores for different utilization numbers.
    // The default shape points are:
    // 1) 0 for 0 utilization
    // 2) 10 for 100 utilization
    // All points must be sorted in increasing order by utilization.
    // +featureGate=VolumeCapacityPriority
    // +optional
    Shape []UtilizationShapePoint
}

func (*VolumeBindingArgs) DeepCopy

func (in *VolumeBindingArgs) DeepCopy() *VolumeBindingArgs

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeBindingArgs.

func (*VolumeBindingArgs) DeepCopyInto

func (in *VolumeBindingArgs) DeepCopyInto(out *VolumeBindingArgs)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*VolumeBindingArgs) DeepCopyObject

func (in *VolumeBindingArgs) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

Subdirectories