Documentation
¶
Overview ¶
Package v1 contains scheduler API objects.
Index ¶
- Variables
- type ExtenderConfig
- type ExtenderManagedResource
- type ExtenderTLSConfig
- type LabelPreference
- type LabelsPresence
- type Policy
- type PredicateArgument
- type PredicatePolicy
- type PriorityArgument
- type PriorityPolicy
- type RequestedToCapacityRatioArguments
- type ResourceSpec
- type ServiceAffinity
- type ServiceAntiAffinity
- type UtilizationShapePoint
Constants ¶
This section is empty.
Variables ¶
var ( // SchemeBuilder is a v1 api scheme builder. SchemeBuilder runtime.SchemeBuilder // AddToScheme is used to add stored functions to scheme. AddToScheme = localSchemeBuilder.AddToScheme )
var SchemeGroupVersion = schema.GroupVersion{Group: "", Version: "v1"}
SchemeGroupVersion is group version used to register these objects TODO this should be in the "scheduler" group
Functions ¶
This section is empty.
Types ¶
type ExtenderConfig ¶
type ExtenderConfig struct {
// URLPrefix at which the extender is available
URLPrefix string `json:"urlPrefix"`
// 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 `json:"filterVerb,omitempty"`
// 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 `json:"preemptVerb,omitempty"`
// 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 `json:"prioritizeVerb,omitempty"`
// The numeric multiplier for the node scores that the prioritize call generates.
// The weight should be a positive integer
Weight int64 `json:"weight,omitempty"`
// 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 `json:"bindVerb,omitempty"`
// EnableHTTPS specifies whether https should be used to communicate with the extender
EnableHTTPS bool `json:"enableHttps,omitempty"`
// TLSConfig specifies the transport layer security config
TLSConfig *ExtenderTLSConfig `json:"tlsConfig,omitempty"`
// 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 time.Duration `json:"httpTimeout,omitempty"`
// 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 `json:"nodeCacheCapable,omitempty"`
// 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 `json:"managedResources,omitempty"`
// 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 `json:"ignorable,omitempty"`
}
ExtenderConfig 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.
func (*ExtenderConfig) DeepCopy ¶
func (in *ExtenderConfig) DeepCopy() *ExtenderConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ExtenderConfig.
func (*ExtenderConfig) DeepCopyInto ¶
func (in *ExtenderConfig) DeepCopyInto(out *ExtenderConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ExtenderConfig) UnmarshalJSON ¶
func (t *ExtenderConfig) UnmarshalJSON(b []byte) error
UnmarshalJSON implements the json.Unmarshaller interface. This preserves compatibility with incorrect case-insensitive configuration fields.
type ExtenderManagedResource ¶
type ExtenderManagedResource struct {
// Name is the extended resource name.
Name apiv1.ResourceName `json:"name"`
// IgnoredByScheduler indicates whether kube-scheduler should ignore this
// resource when applying predicates.
IgnoredByScheduler bool `json:"ignoredByScheduler,omitempty"`
}
ExtenderManagedResource describes the arguments of extended resources managed by an extender.
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 ¶
type ExtenderTLSConfig struct {
// Server should be accessed without verifying the TLS certificate. For testing only.
Insecure bool `json:"insecure,omitempty"`
// 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 `json:"serverName,omitempty"`
// Server requires TLS client certificate authentication
CertFile string `json:"certFile,omitempty"`
// Server requires TLS client certificate authentication
KeyFile string `json:"keyFile,omitempty"`
// Trusted root certificates for server
CAFile string `json:"caFile,omitempty"`
// CertData holds PEM-encoded bytes (typically read from a client certificate file).
// CertData takes precedence over CertFile
CertData []byte `json:"certData,omitempty"`
// KeyData holds PEM-encoded bytes (typically read from a client certificate key file).
// KeyData takes precedence over KeyFile
KeyData []byte `json:"keyData,omitempty"`
// CAData holds PEM-encoded bytes (typically read from a root certificates bundle).
// CAData takes precedence over CAFile
CAData []byte `json:"caData,omitempty"`
}
ExtenderTLSConfig contains settings to enable TLS with extender
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 LabelPreference ¶
type LabelPreference struct {
// Used to identify node "groups"
Label string `json:"label"`
// 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
Presence bool `json:"presence"`
}
LabelPreference holds the parameters that are used to configure the corresponding priority function
func (*LabelPreference) DeepCopy ¶
func (in *LabelPreference) DeepCopy() *LabelPreference
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LabelPreference.
func (*LabelPreference) DeepCopyInto ¶
func (in *LabelPreference) DeepCopyInto(out *LabelPreference)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type LabelsPresence ¶
type LabelsPresence struct {
// 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
Labels []string `json:"labels"`
// The boolean flag that indicates whether the labels should be present or absent from the node
Presence bool `json:"presence"`
}
LabelsPresence holds the parameters that are used to configure the corresponding predicate in scheduler policy configuration.
func (*LabelsPresence) DeepCopy ¶
func (in *LabelsPresence) DeepCopy() *LabelsPresence
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LabelsPresence.
func (*LabelsPresence) DeepCopyInto ¶
func (in *LabelsPresence) DeepCopyInto(out *LabelsPresence)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Policy ¶
type Policy struct {
metav1.TypeMeta `json:",inline"`
// Holds the information to configure the fit predicate functions
Predicates []PredicatePolicy `json:"predicates"`
// Holds the information to configure the priority functions
Priorities []PriorityPolicy `json:"priorities"`
// Holds the information to communicate with the extender(s)
ExtenderConfigs []ExtenderConfig `json:"extenders"`
// 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.
HardPodAffinitySymmetricWeight int32 `json:"hardPodAffinitySymmetricWeight"`
// 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.
AlwaysCheckAllPredicates bool `json:"alwaysCheckAllPredicates"`
}
Policy describes a struct for a policy resource used in api.
func (*Policy) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Policy.
func (*Policy) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Policy) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PredicateArgument ¶
type PredicateArgument struct {
// The predicate that provides affinity for pods belonging to a service
// It uses a label to identify nodes that belong to the same "group"
ServiceAffinity *ServiceAffinity `json:"serviceAffinity"`
// The predicate that checks whether a particular node has a certain label
// defined or not, regardless of value
LabelsPresence *LabelsPresence `json:"labelsPresence"`
}
PredicateArgument represents the arguments to configure predicate functions in scheduler policy configuration. Only one of its members may be specified
func (*PredicateArgument) DeepCopy ¶
func (in *PredicateArgument) DeepCopy() *PredicateArgument
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PredicateArgument.
func (*PredicateArgument) DeepCopyInto ¶
func (in *PredicateArgument) DeepCopyInto(out *PredicateArgument)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PredicatePolicy ¶
type PredicatePolicy struct {
// 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
Name string `json:"name"`
// Holds the parameters to configure the given predicate
Argument *PredicateArgument `json:"argument"`
}
PredicatePolicy describes a struct of a predicate policy.
func (*PredicatePolicy) DeepCopy ¶
func (in *PredicatePolicy) DeepCopy() *PredicatePolicy
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PredicatePolicy.
func (*PredicatePolicy) DeepCopyInto ¶
func (in *PredicatePolicy) DeepCopyInto(out *PredicatePolicy)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PriorityArgument ¶
type PriorityArgument struct {
// 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"
ServiceAntiAffinity *ServiceAntiAffinity `json:"serviceAntiAffinity"`
// The priority function that checks whether a particular node has a certain label
// defined or not, regardless of value
LabelPreference *LabelPreference `json:"labelPreference"`
// The RequestedToCapacityRatio priority function is parametrized with function shape.
RequestedToCapacityRatioArguments *RequestedToCapacityRatioArguments `json:"requestedToCapacityRatioArguments"`
}
PriorityArgument represents the arguments to configure priority functions in scheduler policy configuration. Only one of its members may be specified
func (*PriorityArgument) DeepCopy ¶
func (in *PriorityArgument) DeepCopy() *PriorityArgument
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PriorityArgument.
func (*PriorityArgument) DeepCopyInto ¶
func (in *PriorityArgument) DeepCopyInto(out *PriorityArgument)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PriorityPolicy ¶
type PriorityPolicy struct {
// 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
Name string `json:"name"`
// 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
Weight int64 `json:"weight"`
// Holds the parameters to configure the given priority function
Argument *PriorityArgument `json:"argument"`
}
PriorityPolicy describes a struct of a priority policy.
func (*PriorityPolicy) DeepCopy ¶
func (in *PriorityPolicy) DeepCopy() *PriorityPolicy
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PriorityPolicy.
func (*PriorityPolicy) DeepCopyInto ¶
func (in *PriorityPolicy) DeepCopyInto(out *PriorityPolicy)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RequestedToCapacityRatioArguments ¶
type RequestedToCapacityRatioArguments struct {
// Array of point defining priority function shape.
UtilizationShape []UtilizationShapePoint `json:"shape"`
Resources []ResourceSpec `json:"resources,omitempty"`
}
RequestedToCapacityRatioArguments holds arguments specific to RequestedToCapacityRatio priority function.
func (*RequestedToCapacityRatioArguments) DeepCopy ¶
func (in *RequestedToCapacityRatioArguments) DeepCopy() *RequestedToCapacityRatioArguments
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RequestedToCapacityRatioArguments.
func (*RequestedToCapacityRatioArguments) DeepCopyInto ¶
func (in *RequestedToCapacityRatioArguments) DeepCopyInto(out *RequestedToCapacityRatioArguments)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ResourceSpec ¶
type ResourceSpec struct {
// Name of the resource to be managed by RequestedToCapacityRatio function.
Name apiv1.ResourceName `json:"name"`
// Weight of the resource.
Weight int64 `json:"weight,omitempty"`
}
ResourceSpec represents single resource and weight for bin packing of priority RequestedToCapacityRatioArguments.
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 ServiceAffinity ¶
type ServiceAffinity struct {
// 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
Labels []string `json:"labels"`
}
ServiceAffinity holds the parameters that are used to configure the corresponding predicate in scheduler policy configuration.
func (*ServiceAffinity) DeepCopy ¶
func (in *ServiceAffinity) DeepCopy() *ServiceAffinity
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServiceAffinity.
func (*ServiceAffinity) DeepCopyInto ¶
func (in *ServiceAffinity) DeepCopyInto(out *ServiceAffinity)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ServiceAntiAffinity ¶
type ServiceAntiAffinity struct {
// Used to identify node "groups"
Label string `json:"label"`
}
ServiceAntiAffinity holds the parameters that are used to configure the corresponding priority function
func (*ServiceAntiAffinity) DeepCopy ¶
func (in *ServiceAntiAffinity) DeepCopy() *ServiceAntiAffinity
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServiceAntiAffinity.
func (*ServiceAntiAffinity) DeepCopyInto ¶
func (in *ServiceAntiAffinity) DeepCopyInto(out *ServiceAntiAffinity)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type UtilizationShapePoint ¶
type UtilizationShapePoint struct {
// Utilization (x axis). Valid values are 0 to 100. Fully utilized node maps to 100.
Utilization int32 `json:"utilization"`
// Score assigned to given utilization (y axis). Valid values are 0 to 10.
Score int32 `json:"score"`
}
UtilizationShapePoint represents single point of priority function shape.
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.