Documentation
¶
Overview ¶
Package merge defines the interface for merging scheduling constraints from a pod's spec with those defined in a SchedulingClass custom resource.
The flow is:
- Read the pod's annotation "scheduler.cozystack.io/scheduling-class" to identify the SchedulingClass CR.
- Fetch the SchedulingClass resource from the cluster.
- Merge the CR's constraints with the pod's own spec-level constraints. For inter-pod affinity terms and topology spread constraints, any nil LabelSelector is auto-populated from the pod's cozystack lineage labels (configurable via --default-label-selector-keys). All configured keys must be present on the pod; if any key is missing, no default selector is applied.
- Return the merged result for use by the scheduling plugin.
Index ¶
Constants ¶
const ( ApplicationGroupLabel = "apps.cozystack.io/application.group" ApplicationKindLabel = "apps.cozystack.io/application.kind" ApplicationNameLabel = "apps.cozystack.io/application.name" )
Canonical label keys set by the cozystack lineage webhook to identify an application. Mirrored from github.com/cozystack/cozystack/pkg/apis/apps/v1alpha1.
const SchedulingClassAnnotation = v1alpha1.SchedulingClassAnnotation
SchedulingClassAnnotation is re-exported from the API types package for convenience.
Variables ¶
var DefaultLabelSelectorKeys []string
DefaultLabelSelectorKeys holds the pod label keys used to auto-populate an empty LabelSelector in SchedulingClass affinity and topology spread terms. It is set at startup via --default-label-selector-keys and captured into the merger struct at init time. Do not read after SharedMerger has been called.
Functions ¶
This section is empty.
Types ¶
type ConstraintMerger ¶
type ConstraintMerger interface {
// MergeInterPodAffinity returns the merged inter-pod affinity terms for the
// given pod. It reads the pod's annotation to find the SchedulingClass CR,
// parses both the pod spec and CR terms, and returns the combined result.
// If no SchedulingClass annotation is present, it returns nil.
MergeInterPodAffinity(pod *v1.Pod) (*InterPodAffinityTerms, error)
// MergeNodeAffinity returns the merged node affinity for the given pod.
// It combines pod.Spec.NodeSelector, pod.Spec.Affinity.NodeAffinity, and
// the SchedulingClass CR's node affinity terms.
// If no SchedulingClass annotation is present, it returns nil (use pod spec as-is).
MergeNodeAffinity(pod *v1.Pod) (*NodeAffinityTerms, error)
// MergeTopologySpreadConstraints returns the merged topology spread constraints.
// It appends the CR's constraints to those from pod.Spec.TopologySpreadConstraints.
// If no SchedulingClass annotation is present, it returns nil (use pod spec as-is).
MergeTopologySpreadConstraints(pod *v1.Pod) (*TopologySpreadTerms, error)
}
ConstraintMerger fetches a SchedulingClass CR for a pod and merges its constraints with those already present on the pod spec. For affinity and topology spread terms with nil LabelSelectors, it auto-populates them from the pod's lineage labels when all configured label keys are present.
func SharedMerger ¶
SharedMerger returns a shared ConstraintMerger backed by a dynamic informer for SchedulingClass resources. Safe to call from multiple goroutines.
type InterPodAffinityTerms ¶
type InterPodAffinityTerms struct {
RequiredAffinityTerms []framework.AffinityTerm
RequiredAntiAffinityTerms []framework.AffinityTerm
PreferredAffinityTerms []framework.WeightedAffinityTerm
PreferredAntiAffinityTerms []framework.WeightedAffinityTerm
}
InterPodAffinityTerms holds the merged set of inter-pod affinity and anti-affinity terms for a single pod, combining pod spec and SchedulingClass.
type NodeAffinityTerms ¶
type NodeAffinityTerms struct {
// NodeSelector is the merged result of pod.Spec.NodeSelector and the CR's
// node selector requirements. It is nil if neither source has any.
NodeSelector map[string]string
// RequiredNodeAffinity is the merged node selector from both the pod spec
// and the SchedulingClass CR.
RequiredNodeAffinity *v1.NodeSelector
// PreferredNodeAffinity is the merged list of preferred scheduling terms.
PreferredNodeAffinity []v1.PreferredSchedulingTerm
}
NodeAffinityTerms holds the merged set of node affinity terms for a single pod, combining pod spec and SchedulingClass.
type TopologySpreadTerms ¶
type TopologySpreadTerms struct {
Constraints []v1.TopologySpreadConstraint
}
TopologySpreadTerms holds the merged set of topology spread constraints for a single pod, combining pod spec and SchedulingClass.
Source Files