client

Documentation

Index

• Constants
• func EstablishConnection(kubeClient kubernetes.Interface, serviceInfo SchedulerEstimatorServiceInfo, ...) error
• func GetReplicaEstimators() map[string]ReplicaEstimator
• func GetUnschedulableReplicaEstimators() map[string]UnschedulableReplicaEstimator
• func RegisterSchedulerEstimator(se *SchedulerEstimator)
• type GeneralEstimator
  • func NewGeneralEstimator() *GeneralEstimator
  • func (ge *GeneralEstimator) MaxAvailableReplicas(_ context.Context, clusters []*clusterv1alpha1.Cluster, ...) ([]workv1alpha2.TargetCluster, error)
• type ReplicaEstimator
• type SchedulerEstimator
  • func NewSchedulerEstimator(cache *SchedulerEstimatorCache, timeout time.Duration) *SchedulerEstimator
  • func (se *SchedulerEstimator) GetUnschedulableReplicas(parentCtx context.Context, clusters []string, ...) ([]workv1alpha2.TargetCluster, error)
  • func (se *SchedulerEstimator) MaxAvailableReplicas(parentCtx context.Context, clusters []*clusterv1alpha1.Cluster, ...) ([]workv1alpha2.TargetCluster, error)
• type SchedulerEstimatorCache
  • func NewSchedulerEstimatorCache() *SchedulerEstimatorCache
  • func (c *SchedulerEstimatorCache) AddCluster(name string, connection *grpc.ClientConn, ...)
  • func (c *SchedulerEstimatorCache) DeleteCluster(name string)
  • func (c *SchedulerEstimatorCache) GetClient(name string) (estimatorservice.EstimatorClient, error)
  • func (c *SchedulerEstimatorCache) IsEstimatorExist(name string) bool
• type SchedulerEstimatorServiceInfo
• type UnschedulableReplicaEstimator

Constants

const UnauthenticReplica = -1

UnauthenticReplica is special replica number returned by estimator in case of estimator can't calculate the available replicas. The scheduler should discard the estimator's result and back-off to rely on other estimator's result.

Functions

func EstablishConnection

func EstablishConnection(kubeClient kubernetes.Interface, serviceInfo SchedulerEstimatorServiceInfo, estimatorCache *SchedulerEstimatorCache, grpcConfig *grpcconnection.ClientConfig) error

EstablishConnection establishes a new gRPC connection with the specified cluster scheduler estimator.

func GetReplicaEstimators

func GetReplicaEstimators() map[string]ReplicaEstimator

GetReplicaEstimators returns all replica estimators.

func GetUnschedulableReplicaEstimators

func GetUnschedulableReplicaEstimators() map[string]UnschedulableReplicaEstimator

GetUnschedulableReplicaEstimators returns all unschedulable replica estimators.

func RegisterSchedulerEstimator

func RegisterSchedulerEstimator(se *SchedulerEstimator)

RegisterSchedulerEstimator will register a SchedulerEstimator.

Types

type GeneralEstimator

type GeneralEstimator struct{}

GeneralEstimator is a normal estimator in terms of cluster ResourceSummary.

func NewGeneralEstimator

func NewGeneralEstimator() *GeneralEstimator

NewGeneralEstimator builds a new GeneralEstimator.

func (*GeneralEstimator) MaxAvailableReplicas

func (ge *GeneralEstimator) MaxAvailableReplicas(_ context.Context, clusters []*clusterv1alpha1.Cluster, replicaRequirements *workv1alpha2.ReplicaRequirements) ([]workv1alpha2.TargetCluster, error)

MaxAvailableReplicas estimates the maximum replicas that can be applied to the target cluster by cluster ResourceSummary.

type ReplicaEstimator

type ReplicaEstimator interface {
	MaxAvailableReplicas(ctx context.Context, clusters []*clusterv1alpha1.Cluster, replicaRequirements *workv1alpha2.ReplicaRequirements) ([]workv1alpha2.TargetCluster, error)
}

ReplicaEstimator is an estimator which estimates the maximum replicas that can be applied to the target cluster.

type SchedulerEstimator

type SchedulerEstimator struct {
	// contains filtered or unexported fields
}

SchedulerEstimator is an estimator that calls karmada-scheduler-estimator for estimation.

func NewSchedulerEstimator

func NewSchedulerEstimator(cache *SchedulerEstimatorCache, timeout time.Duration) *SchedulerEstimator

NewSchedulerEstimator builds a new SchedulerEstimator.

func (*SchedulerEstimator) GetUnschedulableReplicas

func (se *SchedulerEstimator) GetUnschedulableReplicas(
	parentCtx context.Context,
	clusters []string,
	reference *workv1alpha2.ObjectReference,
	unscheduableThreshold time.Duration,
) ([]workv1alpha2.TargetCluster, error)

GetUnschedulableReplicas gets the unschedulable replicas which belong to a specified workload by calling karmada-scheduler-estimator.

func (*SchedulerEstimator) MaxAvailableReplicas

func (se *SchedulerEstimator) MaxAvailableReplicas(
	parentCtx context.Context,
	clusters []*clusterv1alpha1.Cluster,
	replicaRequirements *workv1alpha2.ReplicaRequirements,
) ([]workv1alpha2.TargetCluster, error)

MaxAvailableReplicas estimates the maximum replicas that can be applied to the target cluster by calling karmada-scheduler-estimator.

type SchedulerEstimatorCache

type SchedulerEstimatorCache struct {
	// contains filtered or unexported fields
}

SchedulerEstimatorCache is a cache that stores gRPC clients of all the cluster accurate scheduler estimator.

func NewSchedulerEstimatorCache

func NewSchedulerEstimatorCache() *SchedulerEstimatorCache

NewSchedulerEstimatorCache returns an accurate scheduler estimator cache.

func (*SchedulerEstimatorCache) AddCluster

func (c *SchedulerEstimatorCache) AddCluster(name string, connection *grpc.ClientConn, client estimatorservice.EstimatorClient)

AddCluster adds a grpc connection and associated client into the cache.

func (*SchedulerEstimatorCache) DeleteCluster

func (c *SchedulerEstimatorCache) DeleteCluster(name string)

DeleteCluster closes the connection and deletes it from the cache.

func (*SchedulerEstimatorCache) GetClient

func (c *SchedulerEstimatorCache) GetClient(name string) (estimatorservice.EstimatorClient, error)

GetClient returns the gRPC client of a cluster accurate replica estimator.

func (*SchedulerEstimatorCache) IsEstimatorExist

func (c *SchedulerEstimatorCache) IsEstimatorExist(name string) bool

IsEstimatorExist checks whether the cluster estimator exists in the cache.

type SchedulerEstimatorServiceInfo

type SchedulerEstimatorServiceInfo struct {
	Name       string
	NamePrefix string
	Namespace  string
}

SchedulerEstimatorServiceInfo contains information needed to discover and connect to a scheduler estimator service.

type UnschedulableReplicaEstimator

type UnschedulableReplicaEstimator interface {
	GetUnschedulableReplicas(ctx context.Context, clusters []string, reference *workv1alpha2.ObjectReference, unschedulableThreshold time.Duration) ([]workv1alpha2.TargetCluster, error)
}

UnschedulableReplicaEstimator is an estimator which estimates the unschedulable replicas which belong to a specified workload.