apis

type Plugin struct {
	// Name defines the name of plugin
	Name string `yaml:"name,omitempty"`
	// Weight defines the weight of plugin, only used for Score plugins.
	Weight int32 `yaml:"weight,omitempty"`
}

type PluginConfig struct {
	// Name defines the name of plugin being configured
	Name string `yaml:"name,omitempty"`
	// Args defines the arguments passed to the plugins at the time of initialization. Args can have arbitrary structure.
	Args *RawExtension `yaml:"args,omitempty"`
}

type PluginSet struct {
	// Enabled specifies plugins that should be enabled in addition to default plugins.
	// These are called after default plugins and in the same order specified here.
	Enabled []Plugin `yaml:"enabled,omitempty"`
	// Disabled specifies default plugins that should be disabled.
	// When all default plugins need to be disabled, an array containing only one "*" should be provided.
	Disabled []Plugin `yaml:"disabled,omitempty"`
}

type Plugins struct {
	// PreFilter is a list of plugins that should be invoked at "PreFilter" extension point of the scheduling framework.
	PreFilter PluginSet `yaml:"preFilter,omitempty"`

	// Filter is a list of plugins that should be invoked when filtering out clusters that cannot run the Subscription.
	Filter PluginSet `yaml:"filter,omitempty"`

	// PostFilter is a list of plugins that are invoked after filtering phase, no matter whether filtering succeeds or not.
	PostFilter PluginSet `yaml:"postFilter,omitempty"`

	// PrePredict is a list of plugins that are invoked before predicting.
	PrePredict PluginSet `yaml:"prePredict,omitempty"`

	// Predict is a list of plugins that should be invoked when predicting max available replicas for clusters that have passed the filtering phase.
	Predict PluginSet `yaml:"predict,omitempty"`

	// PreScore is a list of plugins that are invoked before scoring.
	PreScore PluginSet `yaml:"preScore,omitempty"`

	// Score is a list of plugins that should be invoked when ranking clusters that have passed the filtering phase.
	Score PluginSet `yaml:"score,omitempty"`

	// PreAssign is a list of plugins that are invoked before assigning.
	PreAssign PluginSet `yaml:"preAssign,omitempty"`

	// Assign is a list of plugins that should be invoked when assigning replicas.
	Assign PluginSet `yaml:"assign,omitempty"`

	// Reserve is a list of plugins invoked when reserving/unreserving resources
	// after a cluster is assigned to run the Subscription.
	Reserve PluginSet `yaml:"reserve,omitempty"`

	// Permit is a list of plugins that control binding of a Subscription. These plugins can prevent or delay binding of a Subscription.
	Permit PluginSet `yaml:"permit,omitempty"`

	// PreBind is a list of plugins that should be invoked before a Subscription is bound.
	PreBind PluginSet `yaml:"preBind,omitempty"`

	// Bind is a list of plugins that should be invoked at "Bind" extension point of the scheduling framework.
	// The scheduler call these plugins in order. Scheduler skips the rest of these plugins as soon as one returns success.
	Bind PluginSet `yaml:"bind,omitempty"`

	// PostBind is a list of plugins that should be invoked after a Subscription is successfully bound.
	PostBind PluginSet `yaml:"postBind,omitempty"`
}

type RawExtension struct {
	Raw []byte `yaml:"raw,omitempty"`
}

type SchedulerConfiguration struct {
	metav1.TypeMeta

	// Profiles are scheduling profiles that clusternet-scheduler supports. subscription can
	// choose to be scheduled under a particular profile by setting its associated
	// scheduler name. subscription that don't specify any scheduler name are scheduled
	// with the "default" profile, if present here.
	Profiles []SchedulerProfile `yaml:"profiles,omitempty"`

	// PercentageOfClustersToScore is the percentage of all clusters that once found feasible
	// for running a subscription, the scheduler stops its search for more feasible clusters.
	// This helps improve scheduler's performance. Scheduler always tries to find
	// at least "minFeasibleClustersToFind" feasible clusters no matter what the value of this flag is.
	// Example: if the total size is 500 clusters and the value of this flag is 30,
	// then scheduler stops finding further feasible clusters once it finds 150 feasible clusters.
	// When the value is 0, default percentage (5%--50% based on the size of the clusters) of the
	// clusters will be scored. It is overridden by profile level PercentageOfClustersToScore.
	PercentageOfClustersToScore *int32 `json:"percentageOfClustersToScore,omitempty"`

	// PercentageOfClustersToTolerate is the percentage of all feasible clusters that once found not responsive
	// when scheduling a subscription.
	// Currently, this flag is only used in dynamic scheduling.
	// When the predictor fails to get result for a feasible cluster, the scheduler framework will tolerate such
	// exception and continue getting scheduling results for other feasible clusters.
	// The predicting replicas for those failed or unresponsive clusters will be set to nil (0).
	// This helps improve scheduler's performance on dynamic scheduling with predictors.
	// Example: if the number of feasible clusters for a subscription with dynamic scheduling strategy is 100 and the
	// value of this flag is 10, then the predictor in the scheduling algorithm will ignore at most 10 failed
	// predicting results. If there are more than 10 failures, this scheduling should be marked as failure.
	PercentageOfClustersToTolerate *int32 `json:"percentageOfClustersToTolerate,omitempty"`
}

type SchedulerProfile struct {
	// SchedulerName is the name of the scheduler associated to this profile.
	// If SchedulerName matches with the pod's "spec.schedulerName", then the pod
	// is scheduled with this profile.
	SchedulerName string `yaml:"schedulerName,omitempty"`

	// Plugins specify the set of plugins that should be enabled or disabled.
	// Enabled plugins are the ones that should be enabled in addition to the
	// default plugins. Disabled plugins are any of the default plugins that
	// should be disabled.
	// When no enabled or disabled plugin is specified for an extension point,
	// default plugins for that extension point will be used if there is any.
	Plugins *Plugins `yaml:"plugins,omitempty"`

	// PluginConfig is an optional set of custom plugin arguments for each plugin.
	// Omitting config args for a plugin is equivalent to using the default config
	// for that plugin.
	PluginConfig []PluginConfig `yaml:"pluginConfig,omitempty"`
}