config

type ClusterDefinition struct {
	// TenancyCount determines how many ClusterRequests may point to the same Cluster.
	// Has no effect if the tenancy in the Cluster template is set to "Exclusive".
	// Must be equal to or greater than 0 otherwise, with 0 meaning "unlimited".
	TenancyCount int `json:"tenancyCount,omitempty"`

	Template          ClusterTemplate       `json:"template"`
	Selector          *metav1.LabelSelector `json:"selector,omitempty"`
	CompletedSelector labels.Selector       `json:"-"`
}

type ClusterTemplate struct {
	metav1.ObjectMeta `json:"metadata"`
	Spec              clustersv1alpha1.ClusterSpec `json:"spec"`
}

type Completable interface {
	// Complete performs any required transformations on the configuration,
	// e.g. filling a map[string]X field from an []X field with keys.
	// It is expected to modify the configuration in place.
	// The fieldPath parameter can be used to create error messages.
	Complete(fldPath *field.Path) error
}

type CompletedSchedulerSelectors struct {
	Clusters labels.Selector
	Requests labels.Selector
}

type Config struct {

	// Scheduler is the configuration for the cluster scheduler.
	Scheduler *SchedulerConfig `json:"scheduler,omitempty"`
}

type Defaultable interface {
	// Default sets default values for the configuration.
	// It is expected to modify the configuration in place.
	// The fieldPath parameter can be used to create error messages.
	Default(fldPath *field.Path) error
}

type SchedulerConfig struct {
	// Scope determines whether the scheduler considers all clusters or only the ones in the same namespace as the ClusterRequest.
	// Defaults to "Namespaced".
	Scope SchedulerScope `json:"scope"`

	// Strategy determines how the scheduler chooses between multiple fitting clusters:
	// - Random: chooses a random cluster
	// - Simple: chooses the first cluster in the list
	// - Balanced: chooses the cluster with the least number of requests (first one in case of a tie)
	// Defaults to "Balanced".
	Strategy Strategy `json:"strategy"`

	// +optional
	Selectors *SchedulerSelectors `json:"selectors,omitempty"`
	// Note that CompletedSelectors.Clusters holds the global cluster selector.
	// During Complete(), the local selector is merged with the global one (or set to the global one if nil).
	// This means that always the local completed selector should be used, unless the task is not tied to a specific ClusterDefinition.
	CompletedSelectors CompletedSchedulerSelectors `json:"-"`

	PurposeMappings map[string]*ClusterDefinition `json:"purposeMappings"`
}

type SchedulerScope string

type SchedulerSelectors struct {
	Clusters *metav1.LabelSelector `json:"clusters,omitempty"`
	Requests *metav1.LabelSelector `json:"requests,omitempty"`
}

type Strategy string

type Validatable interface {
	// Validate validates the configuration.
	// It should return an error if the configuration is invalid.
	// It is not supposed to modify the configuration in any way.
	// The fieldPath parameter can be used to create error messages.
	Validate(fldPath *field.Path) error
}