# kube-scheduler Configuration (v1)

kube-scheduler Configuration (v1)Resource TypesDefaultPreemptionArgsInterPodAffinityArgsKubeSchedulerConfigurationNodeAffinityArgsNodeResourcesBalancedAllocationArgsNodeResourcesFitArgsPodTopologySpreadArgsVolumeBindingArgsClientConnectionConfigurationAppears in:KubeSchedulerConfigurationClientConnectionConfiguration contains details for constructing a client.FieldDescriptionkubeconfig [Required]stringkubeconfig is the path to a KubeConfig file.acceptContentTypes [Required]stringacceptContentTypes 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]stringcontentType is the content type used when sending data to the server from this client.qps [Required]float32qps controls the number of queries per second allowed for this connection.burst [Required]int32burst allows extra queries to accumulate when a client is exceeding its rate.DebuggingConfigurationAppears in:KubeSchedulerConfigurationDebuggingConfiguration holds configuration for Debugging related features.FieldDescriptionenableProfiling [Required]boolenableProfiling enables profiling via web interface host:port/debug/pprof/enableContentionProfiling [Required]boolenableContentionProfiling enables block profiling, if enableProfiling is true.LeaderElectionConfigurationAppears in:KubeSchedulerConfigurationLeaderElectionConfiguration defines the configuration of leader election clients for components that can run with leader election enabled.FieldDescriptionleaderElect [Required]boolleaderElect 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.DurationleaseDuration 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.DurationrenewDeadline 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.DurationretryPeriod 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]stringresourceLock indicates the resource object type that will be used to lock during leader election cycles.resourceName [Required]stringresourceName indicates the name of resource object that will be used to lock during leader election cycles.resourceNamespace [Required]stringresourceName indicates the namespace of resource object that will be used to lock during leader election cycles.DefaultPreemptionArgsDefaultPreemptionArgs holds arguments used to configure the DefaultPreemption plugin.FieldDescriptionapiVersionstringkubescheduler.config.k8s.io/v1kindstringDefaultPreemptionArgsminCandidateNodesPercentage [Required]int32MinCandidateNodesPercentage 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]int32MinCandidateNodesAbsolute 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.InterPodAffinityArgsInterPodAffinityArgs holds arguments used to configure the InterPodAffinity plugin.FieldDescriptionapiVersionstringkubescheduler.config.k8s.io/v1kindstringInterPodAffinityArgshardPodAffinityWeight [Required]int32HardPodAffinityWeight is the scoring weight for existing pods with a matching hard affinity to the incoming pod.ignorePreferredTermsOfExistingPods [Required]boolIgnorePreferredTermsOfExistingPods configures the scheduler to ignore existing pods' preferred affinity rules when scoring candidate nodes, unless the incoming pod has inter-pod affinities.KubeSchedulerConfigurationKubeSchedulerConfiguration configures a schedulerFieldDescriptionapiVersionstringkubescheduler.config.k8s.io/v1kindstringKubeSchedulerConfigurationparallelism [Required]int32Parallelism defines the amount of parallelism in algorithms for scheduling a Pods. Must be greater than 0. Defaults to 16leaderElection [Required]LeaderElectionConfigurationLeaderElection defines the configuration of leader election client.clientConnection [Required]ClientConnectionConfigurationClientConnection specifies the kubeconfig file and client connection settings for the proxy server to use when communicating with the apiserver.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.DebuggingConfigurationpercentageOfNodesToScore [Required]int32PercentageOfNodesToScore 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.podInitialBackoffSeconds [Required]int64PodInitialBackoffSeconds 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]int64PodMaxBackoffSeconds 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][]KubeSchedulerProfileProfiles 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][]ExtenderExtenders 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.delayCacheUntilActive [Required]boolDelayCacheUntilActive 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.NodeAffinityArgsNodeAffinityArgs holds arguments to configure the NodeAffinity plugin.FieldDescriptionapiVersionstringkubescheduler.config.k8s.io/v1kindstringNodeAffinityArgsaddedAffinitycore/v1.NodeAffinityAddedAffinity 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.NodeResourcesBalancedAllocationArgsNodeResourcesBalancedAllocationArgs holds arguments used to configure NodeResourcesBalancedAllocation plugin.FieldDescriptionapiVersionstringkubescheduler.config.k8s.io/v1kindstringNodeResourcesBalancedAllocationArgsresources [Required][]ResourceSpecResources to be managed, the default is "cpu" and "memory" if not specified.NodeResourcesFitArgsNodeResourcesFitArgs holds arguments used to configure the NodeResourcesFit plugin.FieldDescriptionapiVersionstringkubescheduler.config.k8s.io/v1kindstringNodeResourcesFitArgsignoredResources [Required][]stringIgnoredResources is the list of resources that NodeResources fit filter should ignore. This doesn't apply to scoring.ignoredResourceGroups [Required][]stringIgnoredResourceGroups 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]ScoringStrategyScoringStrategy selects the node resource scoring strategy. The default strategy is LeastAllocated with an equal "cpu" and "memory" weight.PodTopologySpreadArgsPodTopologySpreadArgs holds arguments used to configure the PodTopologySpread plugin.FieldDescriptionapiVersionstringkubescheduler.config.k8s.io/v1kindstringPodTopologySpreadArgsdefaultConstraints[]core/v1.TopologySpreadConstraintDefaultConstraints 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".defaultingTypePodTopologySpreadConstraintsDefaultingDefaultingType 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".VolumeBindingArgsVolumeBindingArgs holds arguments used to configure the VolumeBinding plugin.FieldDescriptionapiVersionstringkubescheduler.config.k8s.io/v1kindstringVolumeBindingArgsbindTimeoutSeconds [Required]int64BindTimeoutSeconds 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[]UtilizationShapePointShape specifies the points defining the score function shape, which is used to score nodes based on the utilization of 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:10 for 0 utilization0 for 100 utilization All points must be sorted in increasing order by utilization.ExtenderAppears in:KubeSchedulerConfigurationExtender 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.FieldDescriptionurlPrefix [Required]stringURLPrefix at which the extender is availablefilterVerb [Required]stringVerb for the filter call, empty if not supported. This verb is appended to the URLPrefix when issuing the filter call to extender.preemptVerb [Required]stringVerb for the preempt call, empty if not supported. This verb is appended to the URLPrefix when issuing the preempt call to extender.prioritizeVerb [Required]stringVerb for the prioritize call, empty if not supported. This verb is appended to the URLPrefix when issuing the prioritize call to extender.weight [Required]int64The numeric multiplier for the node scores that the prioritize call generates. The weight should be a positive integerbindVerb [Required]stringVerb 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]boolEnableHTTPS specifies whether https should be used to communicate with the extendertlsConfig [Required]ExtenderTLSConfigTLSConfig specifies the transport layer security confighttpTimeout [Required]meta/v1.DurationHTTPTimeout 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]boolNodeCacheCapable 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 clustermanagedResources[]ExtenderManagedResourceManagedResources 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]boolIgnorable specifies if the extender is ignorable, i.e. scheduling should not fail when the extender returns an error or is not reachable.ExtenderManagedResourceAppears in:ExtenderExtenderManagedResource describes the arguments of extended resources managed by an extender.FieldDescriptionname [Required]stringName is the extended resource name.ignoredByScheduler [Required]boolIgnoredByScheduler indicates whether kube-scheduler should ignore this resource when applying predicates.ExtenderTLSConfigAppears in:ExtenderExtenderTLSConfig contains settings to enable TLS with extenderFieldDescriptioninsecure [Required]boolServer should be accessed without verifying the TLS certificate. For testing only.serverName [Required]stringServerName 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]stringServer requires TLS client certificate authenticationkeyFile [Required]stringServer requires TLS client certificate authenticationcaFile [Required]stringTrusted root certificates for servercertData [Required][]byteCertData holds PEM-encoded bytes (typically read from a client certificate file). CertData takes precedence over CertFilekeyData [Required][]byteKeyData holds PEM-encoded bytes (typically read from a client certificate key file). KeyData takes precedence over KeyFilecaData [Required][]byteCAData holds PEM-encoded bytes (typically read from a root certificates bundle). CAData takes precedence over CAFileKubeSchedulerProfileAppears in:KubeSchedulerConfigurationKubeSchedulerProfile is a scheduling profile.FieldDescriptionschedulerName [Required]stringSchedulerName 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.percentageOfNodesToScore [Required]int32PercentageOfNodesToScore 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.plugins [Required]PluginsPlugins 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][]PluginConfigPluginConfig 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.PluginAppears in:PluginSetPlugin specifies a plugin name and its weight when applicable. Weight is used only for Score plugins.FieldDescriptionname [Required]stringName defines the name of pluginweight [Required]int32Weight defines the weight of plugin, only used for Score plugins.PluginConfigAppears in:KubeSchedulerProfilePluginConfig 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.FieldDescriptionname [Required]stringName defines the name of plugin being configuredargs [Required]k8s.io/apimachinery/pkg/runtime.RawExtensionArgs defines the arguments passed to the plugins at the time of initialization. Args can have arbitrary structure.PluginSetAppears in:PluginsPluginSet 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.FieldDescriptionenabled [Required][]PluginEnabled 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][]PluginDisabled specifies default plugins that should be disabled. When all default plugins need to be disabled, an array containing only one "*" should be provided.PluginsAppears in:KubeSchedulerProfilePlugins 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.FieldDescriptionpreEnqueue [Required]PluginSetPreEnqueue is a list of plugins that should be invoked before adding pods to the scheduling queue.queueSort [Required]PluginSetQueueSort is a list of plugins that should be invoked when sorting pods in the scheduling queue.preFilter [Required]PluginSetPreFilter is a list of plugins that should be invoked at "PreFilter" extension point of the scheduling framework.filter [Required]PluginSetFilter is a list of plugins that should be invoked when filtering out nodes that cannot run the Pod.postFilter [Required]PluginSetPostFilter is a list of plugins that are invoked after filtering phase, but only when no feasible nodes were found for the pod.preScore [Required]PluginSetPreScore is a list of plugins that are invoked before scoring.score [Required]PluginSetScore is a list of plugins that should be invoked when ranking nodes that have passed the filtering phase.reserve [Required]PluginSetReserve is a list of plugins invoked when reserving/unreserving resources after a node is assigned to run the pod.permit [Required]PluginSetPermit is a list of plugins that control binding of a Pod. These plugins can prevent or delay binding of a Pod.preBind [Required]PluginSetPreBind is a list of plugins that should be invoked before a pod is bound.bind [Required]PluginSetBind 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]PluginSetPostBind is a list of plugins that should be invoked after a pod is successfully bound.multiPoint [Required]PluginSetMultiPoint is a simplified config section to enable plugins for all valid extension points. Plugins enabled through MultiPoint will automatically register for every individual extension point the plugin has implemented. Disabling a plugin through MultiPoint disables that behavior. The same is true for disabling "*" through MultiPoint (no default plugins will be automatically registered). Plugins can still be disabled through their individual extension points.In terms of precedence, plugin config follows this basic hierarchySpecific extension pointsExplicitly configured MultiPoint pluginsThe set of default plugins, as MultiPoint plugins This implies that a higher precedence plugin will run first and overwrite any settings within MultiPoint. Explicitly user-configured plugins also take a higher precedence over default plugins. Within this hierarchy, an Enabled setting takes precedence over Disabled. For example, if a plugin is set in both multiPoint.Enabled and multiPoint.Disabled, the plugin will be enabled. Similarly, including multiPoint.Disabled = '*' and multiPoint.Enabled = pluginA will still register that specific plugin through MultiPoint. This follows the same behavior as all other extension point configurations.PodTopologySpreadConstraintsDefaulting(Alias of string)Appears in:PodTopologySpreadArgsPodTopologySpreadConstraintsDefaulting defines how to set default constraints for the PodTopologySpread plugin.RequestedToCapacityRatioParamAppears in:ScoringStrategyRequestedToCapacityRatioParam define RequestedToCapacityRatio parametersFieldDescriptionshape [Required][]UtilizationShapePointShape is a list of points defining the scoring function shape.ResourceSpecAppears in:NodeResourcesBalancedAllocationArgsScoringStrategyResourceSpec represents a single resource.FieldDescriptionname [Required]stringName of the resource.weight [Required]int64Weight of the resource.ScoringStrategyAppears in:NodeResourcesFitArgsScoringStrategy define ScoringStrategyType for node resource pluginFieldDescriptiontype [Required]ScoringStrategyTypeType selects which strategy to run.resources [Required][]ResourceSpecResources 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]RequestedToCapacityRatioParamArguments specific to RequestedToCapacityRatio strategy.ScoringStrategyType(Alias of string)Appears in:ScoringStrategyScoringStrategyType the type of scoring strategy used in NodeResourcesFit plugin.UtilizationShapePointAppears in:VolumeBindingArgsRequestedToCapacityRatioParamUtilizationShapePoint represents single point of priority function shape.FieldDescriptionutilization [Required]int32Utilization (x axis). Valid values are 0 to 100. Fully utilized node maps to 100.score [Required]int32Score assigned to given utilization (y axis). Valid values are 0 to 10.This page is automatically generated.If you plan to report an issue with this page, mention that the page is auto-generated in your issue description. The fix may need to happen elsewhere in the Kubernetes project.