Package: kubescheduler.config.k8s.io/v1

Resource Types:

Policy

Policy describes a struct for a policy resource used in api.

Field Description
apiVersion
string
kubescheduler.config.k8s.io/v1
kind
string
Policy
predicates *
[]PredicatePolicy

Holds the information to configure the fit predicate functions

priorities *
[]PriorityPolicy

Holds the information to configure the priority functions

extenders *
[]LegacyExtender

Holds the information to communicate with the extender(s)

hardPodAffinitySymmetricWeight *
int32

RequiredDuringScheduling affinity is not symmetric, but there is an implicit PreferredDuringScheduling affinity rule corresponding to every RequiredDuringScheduling affinity rule. HardPodAffinitySymmetricWeight represents the weight of implicit PreferredDuringScheduling affinity rule, in the range 1-100.

alwaysCheckAllPredicates *
bool

When AlwaysCheckAllPredicates is set to true, scheduler checks all the configured predicates even after one or more of them fails. When the flag is set to false, scheduler skips checking the rest of the predicates after it finds one predicate that failed.

ExtenderManagedResource

(Appears in: LegacyExtender)

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

Field Description
name *
string

Name is the extended resource name.

ignoredByScheduler *
bool

IgnoredByScheduler indicates whether kube-scheduler should ignore this resource when applying predicates.

ExtenderTLSConfig

(Appears in: LegacyExtender)

ExtenderTLSConfig contains settings to enable TLS with extender

Field Description
insecure *
bool

Server should be accessed without verifying the TLS certificate. For testing only.

serverName *
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 *
string

Server requires TLS client certificate authentication

keyFile *
string

Server requires TLS client certificate authentication

caFile *
string

Trusted root certificates for server

certData *
[]byte

CertData holds PEM-encoded bytes (typically read from a client certificate file). CertData takes precedence over CertFile

keyData *
[]byte

KeyData holds PEM-encoded bytes (typically read from a client certificate key file). KeyData takes precedence over KeyFile

caData *
[]byte

CAData holds PEM-encoded bytes (typically read from a root certificates bundle). CAData takes precedence over CAFile

LabelPreference

(Appears in: PriorityArgument)

LabelPreference holds the parameters that are used to configure the corresponding priority function

Field Description
label *
string

Used to identify node "groups"

presence *
bool

This is a boolean flag If true, higher priority is given to nodes that have the label If false, higher priority is given to nodes that do not have the label

LabelsPresence

(Appears in: PredicateArgument)

LabelsPresence holds the parameters that are used to configure the corresponding predicate in scheduler policy configuration.

Field Description
labels *
[]string

The list of labels that identify node "groups" All of the labels should be either present (or absent) for the node to be considered a fit for hosting the pod

presence *
bool

The boolean flag that indicates whether the labels should be present or absent from the node

LegacyExtender

(Appears in: Policy)

LegacyExtender 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 *
string

URLPrefix at which the extender is available

filterVerb *
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 *
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 *
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 *
int64

The numeric multiplier for the node scores that the prioritize call generates. The weight should be a positive integer

bindVerb *
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 *
bool

EnableHTTPS specifies whether https should be used to communicate with the extender

tlsConfig *
ExtenderTLSConfig

TLSConfig specifies the transport layer security config

httpTimeout *
time.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 *
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 *
bool

Ignorable specifies if the extender is ignorable, i.e. scheduling should not fail when the extender returns an error or is not reachable.

PredicateArgument

(Appears in: PredicatePolicy)

PredicateArgument represents the arguments to configure predicate functions in scheduler policy configuration. Only one of its members may be specified

Field Description
serviceAffinity *
ServiceAffinity

The predicate that provides affinity for pods belonging to a service It uses a label to identify nodes that belong to the same "group"

labelsPresence *
LabelsPresence

The predicate that checks whether a particular node has a certain label defined or not, regardless of value

PredicatePolicy

(Appears in: Policy)

PredicatePolicy describes a struct of a predicate policy.

Field Description
name *
string

Identifier of the predicate policy For a custom predicate, the name can be user-defined For the Kubernetes provided predicates, the name is the identifier of the pre-defined predicate

argument *
PredicateArgument

Holds the parameters to configure the given predicate

PriorityArgument

(Appears in: PriorityPolicy)

PriorityArgument represents the arguments to configure priority functions in scheduler policy configuration. Only one of its members may be specified

Field Description
serviceAntiAffinity *
ServiceAntiAffinity

The priority function that ensures a good spread (anti-affinity) for pods belonging to a service It uses a label to identify nodes that belong to the same "group"

labelPreference *
LabelPreference

The priority function that checks whether a particular node has a certain label defined or not, regardless of value

requestedToCapacityRatioArguments *
RequestedToCapacityRatioArguments

The RequestedToCapacityRatio priority function is parametrized with function shape.

PriorityPolicy

(Appears in: Policy)

PriorityPolicy describes a struct of a priority policy.

Field Description
name *
string

Identifier of the priority policy For a custom priority, the name can be user-defined For the Kubernetes provided priority functions, the name is the identifier of the pre-defined priority function

weight *
int64

The numeric multiplier for the node scores that the priority function generates The weight should be non-zero and can be a positive or a negative integer

argument *
PriorityArgument

Holds the parameters to configure the given priority function

RequestedToCapacityRatioArguments

(Appears in: PriorityArgument)

RequestedToCapacityRatioArguments holds arguments specific to RequestedToCapacityRatio priority function.

Field Description
shape *
[]UtilizationShapePoint

Array of point defining priority function shape.

resources *
[]ResourceSpec

ResourceSpec

(Appears in: RequestedToCapacityRatioArguments)

ResourceSpec represents single resource and weight for bin packing of priority RequestedToCapacityRatioArguments.

Field Description
name *
string

Name of the resource to be managed by RequestedToCapacityRatio function.

weight *
int64

Weight of the resource.

ServiceAffinity

(Appears in: PredicateArgument)

ServiceAffinity holds the parameters that are used to configure the corresponding predicate in scheduler policy configuration.

Field Description
labels *
[]string

The list of labels that identify node "groups" All of the labels should match for the node to be considered a fit for hosting the pod

ServiceAntiAffinity

(Appears in: PriorityArgument)

ServiceAntiAffinity holds the parameters that are used to configure the corresponding priority function

Field Description
label *
string

Used to identify node "groups"

UtilizationShapePoint

(Appears in: RequestedToCapacityRatioArguments)

UtilizationShapePoint represents single point of priority function shape.

Field Description
utilization *
int32

Utilization (x axis). Valid values are 0 to 100. Fully utilized node maps to 100.

score *
int32

Score assigned to given utilization (y axis). Valid values are 0 to 10.


Generated with gendoc on git commit 7231496