kube-scheduler Configuration (v1beta2)

Resource Types

• DefaultPreemptionArgs
• InterPodAffinityArgs
• KubeSchedulerConfiguration
• NodeAffinityArgs
• NodeResourcesBalancedAllocationArgs
• NodeResourcesFitArgs
• PodTopologySpreadArgs
• VolumeBindingArgs

DefaultPreemptionArgs

DefaultPreemptionArgs holds arguments used to configure the DefaultPreemption plugin.

Field	Description
apiVersion string	kubescheduler.config.k8s.io/v1beta2
kind string	DefaultPreemptionArgs
minCandidateNodesPercentage [Required] int32	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.
minCandidateNodesAbsolute [Required] 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.

InterPodAffinityArgs

InterPodAffinityArgs holds arguments used to configure the InterPodAffinity plugin.

Field	Description
apiVersion string	kubescheduler.config.k8s.io/v1beta2
kind string	InterPodAffinityArgs
hardPodAffinityWeight [Required] int32	HardPodAffinityWeight is the scoring weight for existing pods with a matching hard affinity to the incoming pod.

KubeSchedulerConfiguration

KubeSchedulerConfiguration configures a scheduler

Field	Description
apiVersion string	kubescheduler.config.k8s.io/v1beta2
kind string	KubeSchedulerConfiguration
parallelism [Required] int32	Parallelism defines the amount of parallelism in algorithms for scheduling a Pods. Must be greater than 0. Defaults to 16
leaderElection [Required] LeaderElectionConfiguration	LeaderElection defines the configuration of leader election client.
clientConnection [Required] ClientConnectionConfiguration	ClientConnection specifies the kubeconfig file and client connection settings for the proxy server to use when communicating with the apiserver.
healthzBindAddress [Required] string	Note: Both HealthzBindAddress and MetricsBindAddress fields are deprecated. Only empty address or port 0 is allowed. Anything else will fail validation. HealthzBindAddress is the IP address and port for the health check server to serve on.
metricsBindAddress [Required] string	MetricsBindAddress is the IP address and port for the metrics server to serve on.
DebuggingConfiguration [Required] DebuggingConfiguration	(Members of DebuggingConfiguration are embedded into this type.) DebuggingConfiguration holds configuration for Debugging related features TODO: We might wanna make this a substruct like Debugging componentbaseconfigv1alpha1.DebuggingConfiguration
percentageOfNodesToScore [Required] int32	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.
podInitialBackoffSeconds [Required] int64	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.
podMaxBackoffSeconds [Required] int64	PodMaxBackoffSeconds is the max backoff for unschedulable pods. If specified, it must be greater than podInitialBackoffSeconds. If this value is null, the default value (10s) will be used.
profiles [Required] []KubeSchedulerProfile	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.
extenders [Required] []Extender	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.

NodeAffinityArgs

NodeAffinityArgs holds arguments to configure the NodeAffinity plugin.

Field	Description
apiVersion string	kubescheduler.config.k8s.io/v1beta2
kind string	NodeAffinityArgs
addedAffinity core/v1.NodeAffinity	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.

NodeResourcesBalancedAllocationArgs

NodeResourcesBalancedAllocationArgs holds arguments used to configure NodeResourcesBalancedAllocation plugin.

Field	Description
apiVersion string	kubescheduler.config.k8s.io/v1beta2
kind string	NodeResourcesBalancedAllocationArgs
resources [Required] []ResourceSpec	Resources to be managed, the default is "cpu" and "memory" if not specified.

NodeResourcesFitArgs

NodeResourcesFitArgs holds arguments used to configure the NodeResourcesFit plugin.

Field	Description
apiVersion string	kubescheduler.config.k8s.io/v1beta2
kind string	NodeResourcesFitArgs
ignoredResources [Required] []string	IgnoredResources is the list of resources that NodeResources fit filter should ignore. This doesn't apply to scoring.
ignoredResourceGroups [Required] []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 '/'. This doesn't apply to scoring.
scoringStrategy [Required] ScoringStrategy	ScoringStrategy selects the node resource scoring strategy. The default strategy is LeastAllocated with an equal "cpu" and "memory" weight.

PodTopologySpreadArgs

PodTopologySpreadArgs holds arguments used to configure the PodTopologySpread plugin.

Field	Description
apiVersion string	kubescheduler.config.k8s.io/v1beta2
kind string	PodTopologySpreadArgs
defaultConstraints []core/v1.TopologySpreadConstraint	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".
defaultingType PodTopologySpreadConstraintsDefaulting	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 "List" if feature gate DefaultPodTopologySpread is disabled and to "System" if enabled.

VolumeBindingArgs

VolumeBindingArgs holds arguments used to configure the VolumeBinding plugin.

Field	Description
apiVersion string	kubescheduler.config.k8s.io/v1beta2
kind string	VolumeBindingArgs
bindTimeoutSeconds [Required] int64	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 (600) will be used.
shape []UtilizationShapePoint	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.

Extender

Appears in:

• KubeSchedulerConfiguration

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.

Field	Description
urlPrefix [Required] string	URLPrefix at which the extender is available
filterVerb [Required] string	Verb for the filter call, empty if not supported. This verb is appended to the URLPrefix when issuing the filter call to extender.
preemptVerb [Required] string	Verb for the preempt call, empty if not supported. This verb is appended to the URLPrefix when issuing the preempt call to extender.
prioritizeVerb [Required] string	Verb for the prioritize call, empty if not supported. This verb is appended to the URLPrefix when issuing the prioritize call to extender.
weight [Required] int64	The numeric multiplier for the node scores that the prioritize call generates. The weight should be a positive integer
bindVerb [Required] string	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.
enableHTTPS [Required] bool	EnableHTTPS specifies whether https should be used to communicate with the extender
tlsConfig [Required] ExtenderTLSConfig	TLSConfig specifies the transport layer security config
httpTimeout [Required] meta/v1.Duration	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.
nodeCacheCapable [Required] bool	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
managedResources []ExtenderManagedResource	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.
ignorable [Required] bool	Ignorable specifies if the extender is ignorable, i.e. scheduling should not fail when the extender returns an error or is not reachable.

ExtenderManagedResource

Appears in:

• Extender

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

Field	Description
name [Required] string	Name is the extended resource name.
ignoredByScheduler [Required] bool	IgnoredByScheduler indicates whether kube-scheduler should ignore this resource when applying predicates.

ExtenderTLSConfig

Appears in:

• Extender

ExtenderTLSConfig contains settings to enable TLS with extender

Field	Description
insecure [Required] bool	Server should be accessed without verifying the TLS certificate. For testing only.
serverName [Required] string	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.
certFile [Required] string	Server requires TLS client certificate authentication
keyFile [Required] string	Server requires TLS client certificate authentication
caFile [Required] string	Trusted root certificates for server
certData [Required] []byte	CertData holds PEM-encoded bytes (typically read from a client certificate file). CertData takes precedence over CertFile
keyData [Required] []byte	KeyData holds PEM-encoded bytes (typically read from a client certificate key file). KeyData takes precedence over KeyFile
caData [Required] []byte	CAData holds PEM-encoded bytes (typically read from a root certificates bundle). CAData takes precedence over CAFile

KubeSchedulerProfile

Appears in:

• KubeSchedulerConfiguration

KubeSchedulerProfile is a scheduling profile.

Field	Description
schedulerName [Required] string	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.
plugins [Required] Plugins	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.
pluginConfig [Required] []PluginConfig	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.

Plugin

Appears in:

• PluginSet

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

Field	Description
name [Required] string	Name defines the name of plugin
weight [Required] int32	Weight defines the weight of plugin, only used for Score plugins.

PluginConfig

Appears in:

• KubeSchedulerProfile

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.

Field	Description
name [Required] string	Name defines the name of plugin being configured
args [Required] k8s.io/apimachinery/pkg/runtime.RawExtension	Args defines the arguments passed to the plugins at the time of initialization. Args can have arbitrary structure.

PluginSet

Appears in:

• Plugins

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.

Field	Description
enabled [Required] []Plugin	Enabled specifies plugins that should be enabled in addition to default plugins. If the default plugin is also configured in the scheduler config file, the weight of plugin will be overridden accordingly. These are called after default plugins and in the same order specified here.
disabled [Required] []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.

Plugins

Appears in:

• KubeSchedulerProfile

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.

Field	Description
queueSort [Required] PluginSet	QueueSort is a list of plugins that should be invoked when sorting pods in the scheduling queue.
preFilter [Required] PluginSet	PreFilter is a list of plugins that should be invoked at "PreFilter" extension point of the scheduling framework.
filter [Required] PluginSet	Filter is a list of plugins that should be invoked when filtering out nodes that cannot run the Pod.
postFilter [Required] PluginSet	PostFilter is a list of plugins that are invoked after filtering phase, but only when no feasible nodes were found for the pod.
preScore [Required] PluginSet	PreScore is a list of plugins that are invoked before scoring.
score [Required] PluginSet	Score is a list of plugins that should be invoked when ranking nodes that have passed the filtering phase.
reserve [Required] PluginSet	Reserve is a list of plugins invoked when reserving/unreserving resources after a node is assigned to run the pod.
permit [Required] PluginSet	Permit is a list of plugins that control binding of a Pod. These plugins can prevent or delay binding of a Pod.
preBind [Required] PluginSet	PreBind is a list of plugins that should be invoked before a pod is bound.
bind [Required] 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.
postBind [Required] PluginSet	PostBind is a list of plugins that should be invoked after a pod is successfully bound.
multiPoint [Required] PluginSet	MultiPoint is a simplified config section to enable plugins for all valid extension points.

PodTopologySpreadConstraintsDefaulting

(Alias of string)

Appears in:

• PodTopologySpreadArgs

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

RequestedToCapacityRatioParam

Appears in:

• ScoringStrategy

RequestedToCapacityRatioParam define RequestedToCapacityRatio parameters

Field	Description
shape [Required] []UtilizationShapePoint	Shape is a list of points defining the scoring function shape.

ResourceSpec

Appears in:

• NodeResourcesBalancedAllocationArgs
• ScoringStrategy

ResourceSpec represents a single resource.

Field	Description
name [Required] string	Name of the resource.
weight [Required] int64	Weight of the resource.

ScoringStrategy

Appears in:

• NodeResourcesFitArgs

ScoringStrategy define ScoringStrategyType for node resource plugin

Field	Description
type [Required] ScoringStrategyType	Type selects which strategy to run.
resources [Required] []ResourceSpec	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.
requestedToCapacityRatio [Required] RequestedToCapacityRatioParam	Arguments specific to RequestedToCapacityRatio strategy.

ScoringStrategyType

(Alias of string)

Appears in:

• ScoringStrategy

ScoringStrategyType the type of scoring strategy used in NodeResourcesFit plugin.

UtilizationShapePoint

Appears in:

• VolumeBindingArgs
• RequestedToCapacityRatioParam

UtilizationShapePoint represents single point of priority function shape.

Field	Description
utilization [Required] int32	Utilization (x axis). Valid values are 0 to 100. Fully utilized node maps to 100.
score [Required] int32	Score assigned to given utilization (y axis). Valid values are 0 to 10.

ClientConnectionConfiguration

Appears in:

• KubeSchedulerConfiguration

ClientConnectionConfiguration contains details for constructing a client.

Field	Description
kubeconfig [Required] string	kubeconfig is the path to a KubeConfig file.
acceptContentTypes [Required] string	acceptContentTypes defines the Accept header sent by clients when connecting to a server, overriding the default value of 'application/json'. This field will control all connections to the server used by a particular client.
contentType [Required] string	contentType is the content type used when sending data to the server from this client.
qps [Required] float32	qps controls the number of queries per second allowed for this connection.
burst [Required] int32	burst allows extra queries to accumulate when a client is exceeding its rate.

DebuggingConfiguration

Appears in:

• KubeSchedulerConfiguration

DebuggingConfiguration holds configuration for Debugging related features.

Field	Description
enableProfiling [Required] bool	enableProfiling enables profiling via web interface host:port/debug/pprof/
enableContentionProfiling [Required] bool	enableContentionProfiling enables lock contention profiling, if enableProfiling is true.

FormatOptions

Appears in:

• LoggingConfiguration

FormatOptions contains options for the different logging formats.

Field	Description
json [Required] JSONOptions	[Experimental] JSON contains options for logging format "json".

JSONOptions

Appears in:

• FormatOptions

JSONOptions contains options for logging format "json".

Field	Description
splitStream [Required] bool	[Experimental] SplitStream redirects error messages to stderr while info messages go to stdout, with buffering. The default is to write both to stdout, without buffering.
infoBufferSize [Required] k8s.io/apimachinery/pkg/api/resource.QuantityValue	[Experimental] InfoBufferSize sets the size of the info stream when using split streams. The default is zero, which disables buffering.

LeaderElectionConfiguration

Appears in:

• KubeSchedulerConfiguration

LeaderElectionConfiguration defines the configuration of leader election clients for components that can run with leader election enabled.

Field	Description
leaderElect [Required] bool	leaderElect enables a leader election client to gain leadership before executing the main loop. Enable this when running replicated components for high availability.
leaseDuration [Required] meta/v1.Duration	leaseDuration is the duration that non-leader candidates will wait after observing a leadership renewal until attempting to acquire leadership of a led but unrenewed leader slot. This is effectively the maximum duration that a leader can be stopped before it is replaced by another candidate. This is only applicable if leader election is enabled.
renewDeadline [Required] meta/v1.Duration	renewDeadline is the interval between attempts by the acting master to renew a leadership slot before it stops leading. This must be less than or equal to the lease duration. This is only applicable if leader election is enabled.
retryPeriod [Required] meta/v1.Duration	retryPeriod is the duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled.
resourceLock [Required] string	resourceLock indicates the resource object type that will be used to lock during leader election cycles.
resourceName [Required] string	resourceName indicates the name of resource object that will be used to lock during leader election cycles.
resourceNamespace [Required] string	resourceName indicates the namespace of resource object that will be used to lock during leader election cycles.

LoggingConfiguration

Appears in:

• KubeletConfiguration

LoggingConfiguration contains logging options Refer Logs Options for more information.

Field	Description
format [Required] string	Format Flag specifies the structure of log messages. default value of format is `text`
flushFrequency [Required] time.Duration	Maximum number of seconds between log flushes. Ignored if the selected logging backend writes log messages without buffering.
verbosity [Required] uint32	Verbosity is the threshold that determines which log messages are logged. Default is zero which logs only the most important messages. Higher values enable additional messages. Error messages are always logged.
vmodule [Required] VModuleConfiguration	VModule overrides the verbosity threshold for individual files. Only supported for "text" log format.
sanitization [Required] bool	[Experimental] When enabled prevents logging of fields tagged as sensitive (passwords, keys, tokens). Runtime log sanitization may introduce significant computation overhead and therefore should not be enabled in production.`)
options [Required] FormatOptions	[Experimental] Options holds additional parameters that are specific to the different logging formats. Only the options for the selected format get used, but all of them get validated.

VModuleConfiguration

(Alias of []k8s.io/component-base/config/v1alpha1.VModuleItem)

Appears in:

• LoggingConfiguration

VModuleConfiguration is a collection of individual file names or patterns and the corresponding verbosity threshold.