mirror of
https://github.com/open-cluster-management-io/ocm.git
synced 2026-05-06 17:27:08 +00:00
2f4ff9f424
* add metrics for placement Signed-off-by: haoqing0110 <qhao@redhat.com> * record plugin metrics in schedule() Signed-off-by: haoqing0110 <qhao@redhat.com> * add plugin type Signed-off-by: haoqing0110 <qhao@redhat.com> --------- Signed-off-by: haoqing0110 <qhao@redhat.com>
98 lines
3.3 KiB
Go
98 lines
3.3 KiB
Go
package plugins
|
|
|
|
import (
|
|
"context"
|
|
"math"
|
|
"time"
|
|
|
|
"k8s.io/client-go/tools/events"
|
|
|
|
clusterclient "open-cluster-management.io/api/client/cluster/clientset/versioned"
|
|
clusterlisterv1 "open-cluster-management.io/api/client/cluster/listers/cluster/v1"
|
|
clusterlisterv1alpha1 "open-cluster-management.io/api/client/cluster/listers/cluster/v1alpha1"
|
|
clusterlisterv1beta1 "open-cluster-management.io/api/client/cluster/listers/cluster/v1beta1"
|
|
clusterapiv1 "open-cluster-management.io/api/cluster/v1"
|
|
clusterapiv1beta1 "open-cluster-management.io/api/cluster/v1beta1"
|
|
|
|
"open-cluster-management.io/ocm/pkg/placement/controllers/framework"
|
|
"open-cluster-management.io/ocm/pkg/placement/controllers/metrics"
|
|
)
|
|
|
|
const (
|
|
// MaxClusterScore is the maximum score a Prioritizer plugin is expected to return.
|
|
MaxClusterScore int64 = 100
|
|
|
|
// MinClusterScore is the minimum score a Prioritizer plugin is expected to return.
|
|
MinClusterScore int64 = -100
|
|
|
|
// MaxTotalScore is the maximum total score.
|
|
MaxTotalScore int64 = math.MaxInt64
|
|
)
|
|
|
|
// Plugin is the parent type for all the scheduling plugins.
|
|
type Plugin interface {
|
|
Name() string
|
|
// Description of the plugin
|
|
Description() string
|
|
// RequeueAfter returns the requeue time interval of the placement
|
|
RequeueAfter(ctx context.Context, placement *clusterapiv1beta1.Placement) (PluginRequeueResult, *framework.Status)
|
|
}
|
|
|
|
// Filter defines a filter plugin that filter unsatisfied cluster.
|
|
type Filter interface {
|
|
Plugin
|
|
|
|
// Filter returns a list of clusters satisfying the certain condition.
|
|
Filter(ctx context.Context, placement *clusterapiv1beta1.Placement, clusters []*clusterapiv1.ManagedCluster) (PluginFilterResult, *framework.Status)
|
|
}
|
|
|
|
// Prioritizer defines a prioritizer plugin that score each cluster. The score is normalized
|
|
// as a floating between 0 and 1.
|
|
type Prioritizer interface {
|
|
Plugin
|
|
|
|
// Score gives the score to a list of the clusters, it returns a map with the key as
|
|
// the cluster name.
|
|
Score(ctx context.Context, placement *clusterapiv1beta1.Placement, clusters []*clusterapiv1.ManagedCluster) (PluginScoreResult, *framework.Status)
|
|
}
|
|
|
|
// Handle provides data and some tools that plugins can use. It is
|
|
// passed to the plugin factories at the time of plugin initialization.
|
|
type Handle interface {
|
|
// DecisionLister lists all decisions
|
|
DecisionLister() clusterlisterv1beta1.PlacementDecisionLister
|
|
|
|
// ScoreLister lists all AddOnPlacementScores
|
|
ScoreLister() clusterlisterv1alpha1.AddOnPlacementScoreLister
|
|
|
|
// ClusterLister lists all ManagedClusters
|
|
ClusterLister() clusterlisterv1.ManagedClusterLister
|
|
|
|
// ClusterClient returns the cluster client
|
|
ClusterClient() clusterclient.Interface
|
|
|
|
// EventRecorder returns an event recorder.
|
|
EventRecorder() events.EventRecorder
|
|
|
|
// MetricsRecorder record the metrics for plugins
|
|
MetricsRecorder() *metrics.ScheduleMetrics
|
|
}
|
|
|
|
// PluginFilterResult contains the details of a filter plugin result.
|
|
type PluginFilterResult struct {
|
|
// Filtered contains the filtered ManagedCluster.
|
|
Filtered []*clusterapiv1.ManagedCluster
|
|
}
|
|
|
|
// PluginScoreResult contains the details of a score plugin result.
|
|
type PluginScoreResult struct {
|
|
// Scores contains the ManagedCluster scores.
|
|
Scores map[string]int64
|
|
}
|
|
|
|
// PluginRequeueResult contains the requeue result of a placement.
|
|
type PluginRequeueResult struct {
|
|
// RequeueTime contains the expect requeue time.
|
|
RequeueTime *time.Time
|
|
}
|