Documentation
¶
Overview ¶
Package v1 contains scheduler plugin API objects.
Index ¶
- Variables
- type ExtenderArgs
- type ExtenderBindingArgs
- type ExtenderBindingResult
- type ExtenderConfig
- type ExtenderFilterResult
- type FailedNodesMap
- type HostPriority
- type HostPriorityList
- type LabelPreference
- type LabelsPresence
- type Policy
- type PredicateArgument
- type PredicatePolicy
- type PriorityArgument
- type PriorityPolicy
- type ServiceAffinity
- type ServiceAntiAffinity
Constants ¶
This section is empty.
Variables ¶
var ( // TODO: move SchemeBuilder with zz_generated.deepcopy.go to k8s.io/api. // localSchemeBuilder and AddToScheme will stay in k8s.io/kubernetes. SchemeBuilder runtime.SchemeBuilder 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 ExtenderArgs ¶ added in v1.3.0
type ExtenderArgs struct { // Pod being scheduled Pod apiv1.Pod `json:"pod"` // List of candidate nodes where the pod can be scheduled; to be populated // only if ExtenderConfig.NodeCacheCapable == false Nodes *apiv1.NodeList `json:"nodes,omitempty"` // List of candidate node names where the pod can be scheduled; to be // populated only if ExtenderConfig.NodeCacheCapable == true NodeNames *[]string `json:"nodenames,omitempty"` }
ExtenderArgs represents the arguments needed by the extender to filter/prioritize nodes for a pod.
func (*ExtenderArgs) DeepCopy ¶ added in v1.8.8
func (in *ExtenderArgs) DeepCopy() *ExtenderArgs
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ExtenderArgs.
func (*ExtenderArgs) DeepCopyInto ¶ added in v1.8.8
func (in *ExtenderArgs) DeepCopyInto(out *ExtenderArgs)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ExtenderBindingArgs ¶ added in v1.7.0
type ExtenderBindingArgs struct { // PodName is the name of the pod being bound PodName string // PodNamespace is the namespace of the pod being bound PodNamespace string // PodUID is the UID of the pod being bound PodUID types.UID // Node selected by the scheduler Node string }
ExtenderBindingArgs represents the arguments to an extender for binding a pod to a node.
func (*ExtenderBindingArgs) DeepCopy ¶ added in v1.8.8
func (in *ExtenderBindingArgs) DeepCopy() *ExtenderBindingArgs
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ExtenderBindingArgs.
func (*ExtenderBindingArgs) DeepCopyInto ¶ added in v1.8.8
func (in *ExtenderBindingArgs) DeepCopyInto(out *ExtenderBindingArgs)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ExtenderBindingResult ¶ added in v1.7.0
type ExtenderBindingResult struct { // Error message indicating failure Error string }
ExtenderBindingResult represents the result of binding of a pod to a node from an extender.
func (*ExtenderBindingResult) DeepCopy ¶ added in v1.8.8
func (in *ExtenderBindingResult) DeepCopy() *ExtenderBindingResult
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ExtenderBindingResult.
func (*ExtenderBindingResult) DeepCopyInto ¶ added in v1.8.8
func (in *ExtenderBindingResult) DeepCopyInto(out *ExtenderBindingResult)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ExtenderConfig ¶ added in v1.3.0
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 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 int `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 // 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 *restclient.TLSClientConfig `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"` }
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 ¶ added in v1.8.8
func (in *ExtenderConfig) DeepCopy() *ExtenderConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ExtenderConfig.
func (*ExtenderConfig) DeepCopyInto ¶ added in v1.8.8
func (in *ExtenderConfig) DeepCopyInto(out *ExtenderConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ExtenderFilterResult ¶ added in v1.3.0
type ExtenderFilterResult struct { // Filtered set of nodes where the pod can be scheduled; to be populated // only if ExtenderConfig.NodeCacheCapable == false Nodes *apiv1.NodeList `json:"nodes,omitempty"` // Filtered set of nodes where the pod can be scheduled; to be populated // only if ExtenderConfig.NodeCacheCapable == true NodeNames *[]string `json:"nodenames,omitempty"` // Filtered out nodes where the pod can't be scheduled and the failure messages FailedNodes FailedNodesMap `json:"failedNodes,omitempty"` // Error message indicating failure Error string `json:"error,omitempty"` }
ExtenderFilterResult represents the results of a filter call to an extender
func (*ExtenderFilterResult) DeepCopy ¶ added in v1.8.8
func (in *ExtenderFilterResult) DeepCopy() *ExtenderFilterResult
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ExtenderFilterResult.
func (*ExtenderFilterResult) DeepCopyInto ¶ added in v1.8.8
func (in *ExtenderFilterResult) DeepCopyInto(out *ExtenderFilterResult)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type FailedNodesMap ¶ added in v1.4.5
FailedNodesMap represents the filtered out nodes, with node names and failure messages
type HostPriority ¶ added in v1.3.0
type HostPriority struct { // Name of the host Host string `json:"host"` // Score associated with the host Score int `json:"score"` }
HostPriority represents the priority of scheduling to a particular host, higher priority is better.
func (*HostPriority) DeepCopy ¶ added in v1.8.8
func (in *HostPriority) DeepCopy() *HostPriority
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HostPriority.
func (*HostPriority) DeepCopyInto ¶ added in v1.8.8
func (in *HostPriority) DeepCopyInto(out *HostPriority)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HostPriorityList ¶ added in v1.3.0
type HostPriorityList []HostPriority
func (HostPriorityList) Len ¶ added in v1.3.0
func (h HostPriorityList) Len() int
func (HostPriorityList) Less ¶ added in v1.3.0
func (h HostPriorityList) Less(i, j int) bool
func (HostPriorityList) Swap ¶ added in v1.3.0
func (h HostPriorityList) Swap(i, j int)
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 ¶ added in v1.8.8
func (in *LabelPreference) DeepCopy() *LabelPreference
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LabelPreference.
func (*LabelPreference) DeepCopyInto ¶ added in v1.8.8
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 ¶ added in v1.8.8
func (in *LabelsPresence) DeepCopy() *LabelsPresence
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LabelsPresence.
func (*LabelsPresence) DeepCopyInto ¶ added in v1.8.8
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 int `json:"hardPodAffinitySymmetricWeight"` }
func (*Policy) DeepCopy ¶ added in v1.8.8
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Policy.
func (*Policy) DeepCopyInto ¶ added in v1.8.8
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Policy) DeepCopyObject ¶ added in v1.8.8
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 ¶ added in v1.8.8
func (in *PredicateArgument) DeepCopy() *PredicateArgument
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PredicateArgument.
func (*PredicateArgument) DeepCopyInto ¶ added in v1.8.8
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"` }
func (*PredicatePolicy) DeepCopy ¶ added in v1.8.8
func (in *PredicatePolicy) DeepCopy() *PredicatePolicy
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PredicatePolicy.
func (*PredicatePolicy) DeepCopyInto ¶ added in v1.8.8
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"` }
PriorityArgument represents the arguments to configure priority functions in scheduler policy configuration. Only one of its members may be specified
func (*PriorityArgument) DeepCopy ¶ added in v1.8.8
func (in *PriorityArgument) DeepCopy() *PriorityArgument
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PriorityArgument.
func (*PriorityArgument) DeepCopyInto ¶ added in v1.8.8
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 int `json:"weight"` // Holds the parameters to configure the given priority function Argument *PriorityArgument `json:"argument"` }
func (*PriorityPolicy) DeepCopy ¶ added in v1.8.8
func (in *PriorityPolicy) DeepCopy() *PriorityPolicy
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PriorityPolicy.
func (*PriorityPolicy) DeepCopyInto ¶ added in v1.8.8
func (in *PriorityPolicy) DeepCopyInto(out *PriorityPolicy)
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 ¶ added in v1.8.8
func (in *ServiceAffinity) DeepCopy() *ServiceAffinity
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServiceAffinity.
func (*ServiceAffinity) DeepCopyInto ¶ added in v1.8.8
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 ¶ added in v1.8.8
func (in *ServiceAntiAffinity) DeepCopy() *ServiceAntiAffinity
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServiceAntiAffinity.
func (*ServiceAntiAffinity) DeepCopyInto ¶ added in v1.8.8
func (in *ServiceAntiAffinity) DeepCopyInto(out *ServiceAntiAffinity)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.