core

Documentation

Index

• Constants
• func AssignReplicas(clusters []*clusterv1alpha1.Cluster, spec *workv1alpha2.ResourceBindingSpec, ...) ([]workv1alpha2.TargetCluster, error)
• func SelectClusters(clustersScore framework.ClusterScoreList, placement *policyv1alpha1.Placement, ...) ([]*clusterv1alpha1.Cluster, error)
• type ScheduleAlgorithm
  • func NewGenericScheduler(schedCache cache.Cache, registry runtime.Registry) (ScheduleAlgorithm, error)
• type ScheduleAlgorithmOption
• type ScheduleResult
• type TargetClustersList
  • func (a TargetClustersList) Len() int
  • func (a TargetClustersList) Less(i, j int) bool
  • func (a TargetClustersList) Swap(i, j int)

Constants

const (
	// DuplicatedStrategy indicates each candidate member cluster will directly apply the original replicas.
	DuplicatedStrategy = "Duplicated"
	// AggregatedStrategy indicates dividing replicas among clusters as few as possible and
	// taking clusters' available replicas into consideration as well.
	AggregatedStrategy = "Aggregated"
	// StaticWeightStrategy indicates dividing replicas by static weight according to WeightPreference.
	StaticWeightStrategy = "StaticWeight"
	// DynamicWeightStrategy indicates dividing replicas by dynamic weight according to WeightPreference.
	DynamicWeightStrategy = "DynamicWeight"
)

const (
	// Steady represents a steady, incremental approach to re-assign replicas
	// across clusters. It aims to maintain the exist replicas distribution as
	// closely as possible, only making minimal adjustments when necessary.
	// It minimizes disruptions and preserves the balance across clusters.
	Steady assignmentMode = "Steady"

	// Fresh means that disregards the previous assignment entirely and
	// seeks to establish an entirely new replica distribution across clusters.
	// It is willing to accept significant changes even if it involves disruption.
	Fresh assignmentMode = "Fresh"
)

Functions

func AssignReplicas

func AssignReplicas(
	clusters []*clusterv1alpha1.Cluster,
	spec *workv1alpha2.ResourceBindingSpec,
	status *workv1alpha2.ResourceBindingStatus,
) ([]workv1alpha2.TargetCluster, error)

AssignReplicas assigns replicas to clusters based on the placement and resource binding spec.

func SelectClusters

func SelectClusters(clustersScore framework.ClusterScoreList,
	placement *policyv1alpha1.Placement, spec *workv1alpha2.ResourceBindingSpec) ([]*clusterv1alpha1.Cluster, error)

SelectClusters selects clusters based on the placement and resource binding spec.

Types

type ScheduleAlgorithm

type ScheduleAlgorithm interface {
	Schedule(context.Context, *workv1alpha2.ResourceBindingSpec, *workv1alpha2.ResourceBindingStatus, *ScheduleAlgorithmOption) (scheduleResult ScheduleResult, err error)
}

ScheduleAlgorithm is the interface that should be implemented to schedule a resource to the target clusters.

func NewGenericScheduler

func NewGenericScheduler(
	schedCache cache.Cache,
	registry runtime.Registry,
) (ScheduleAlgorithm, error)

NewGenericScheduler creates a genericScheduler object.

type ScheduleAlgorithmOption

type ScheduleAlgorithmOption struct {
	EnableEmptyWorkloadPropagation bool
}

ScheduleAlgorithmOption represents the option for ScheduleAlgorithm.

type ScheduleResult

type ScheduleResult struct {
	SuggestedClusters []workv1alpha2.TargetCluster
}

ScheduleResult includes the clusters selected.

type TargetClustersList

type TargetClustersList []workv1alpha2.TargetCluster

TargetClustersList is a slice of TargetCluster that implements sort.Interface to sort by Value.

func (TargetClustersList) Len

func (a TargetClustersList) Len() int

func (TargetClustersList) Less

func (a TargetClustersList) Less(i, j int) bool

func (TargetClustersList) Swap

func (a TargetClustersList) Swap(i, j int)