v1alpha1

type ClusterSizingConfiguration struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   ClusterSizingConfigurationSpec   `json:"spec,omitempty"`
	Status ClusterSizingConfigurationStatus `json:"status,omitempty"`
}

type ClusterSizingConfigurationList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []ClusterSizingConfiguration `json:"items"`
}

type ClusterSizingConfigurationSpec struct {

	// Sizes holds the different t-shirt size classes into which guest clusters will be sorted.
	// Each size class applies to guest clusters using node count criteria; it is required that
	// the entire interval between [0,+inf) be covered by the set of sizes provided here.
	Sizes []SizeConfiguration `json:"sizes,omitempty"`

	// Concurrency defines the bounds of allowed behavior for clusters transitioning between sizes.
	// Transitions will require that request-serving pods be re-scheduled between nodes, so each
	// transition incurs a small user-facing cost as well as a cost to the management cluster. Use
	// the concurrency configuration options to manage how many transitions can be occurring.
	// If unset, a sensible default will be provided.
	Concurrency ConcurrencyConfiguration `json:"concurrency,omitempty"`

	// TransitionDelay configures how quickly the system reacts to clusters transitioning between size classes.
	// It may be advantageous, for instance, to have a near-instant scale-down for clusters that begin to
	// use fewer resources, but allow for some lag on scale-up to ensure that the use is sustained before
	// incurring the larger cost for scale-up.
	TransitionDelay TransitionDelayConfiguration `json:"transitionDelay,omitempty"`
}

type ClusterSizingConfigurationStatus struct {

	// Conditions contain details about the various aspects of cluster sizing.
	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"`
}

type ConcurrencyConfiguration struct {

	// SlidingWindow is the window over which the concurrency bound is enforced.
	SlidingWindow metav1.Duration `json:"slidingWindow,omitempty"`

	// Limit is the maximum allowed number of cluster size transitions during the sliding window.
	Limit int32 `json:"limit,omitempty"`
}

type Effects struct {

	// KASGoMemLimit is the value to set for the $GOMEMLIMIT of the Kube APIServer container
	KASGoMemLimit *resource.Quantity `json:"kasGoMemLimit,omitempty"`

	// ControlPlanePriorityClassName is the priority class to use for most control plane pods
	ControlPlanePriorityClassName *string `json:"controlPlanePriorityClassName,omitempty"`

	// EtcdPriorityClassName is the priority class to use for etcd pods
	EtcdPriorityClassName *string `json:"etcdPriorityClassName,omitempty"`

	// APICriticalPriorityClassName is the priority class for pods in the API request serving path.
	// This includes Kube API Server, OpenShift APIServer, etc.
	APICriticalPriorityClassName *string `json:"APICriticalPriorityClassName,omitempty"`

	// +kubebuilder:validation:Optional
	// ResourceRequests allows specifying resource requests for control plane pods.
	ResourceRequests []ResourceRequest `json:"resourceRequests,omitempty"`
}

type Management struct {

	// Placeholders configures the number of dummy workloads that will be scheduled irrespective of
	// HostedClusters in order to keep a set of nodes ready to accept new cluster creation and scheduling.
	Placeholders int `json:"placeholders,omitempty"`
}

type NodeCountCriteria struct {

	// From is the inclusive lower limit to node count for a cluster to be considered a particular size.
	From uint32 `json:"from"`

	// To is the inclusive upper limit to node count for a cluster to be considered a particular size.
	// If unset, this size class will match clusters of all sizes greater than the lower limit.
	To *uint32 `json:"to,omitempty"`
}

type ResourceRequest struct {
	// +kubebuilder:validation:Required
	// DeploymentName is the name of the deployment to which the resource request applies.
	DeploymentName string `json:"deploymentName"`

	// +kubebuilder:validation:Required
	// ContainerName is the name of the container to which the resource request applies.
	ContainerName string `json:"containerName"`

	// +kubebuilder:validation:Optional
	// Memory is the amount of memory to request for the container.
	Memory *resource.Quantity `json:"memory,omitempty"`

	// +kubebuilder:validation:Optional
	// CPU is the amount of CPU to request for the container.
	CPU *resource.Quantity `json:"cpu,omitempty"`
}

type SizeConfiguration struct {

	// Name is the t-shirt size name.
	Name string `json:"name"`

	// Criteria defines the node count range for clusters to fall into this t-shirt size class.
	Criteria NodeCountCriteria `json:"criteria"`

	// Effects define the effects on a cluster being considered part of this t-shirt size class.
	Effects *Effects `json:"effects,omitempty"`

	// Management configures the management aspects of this size class on the management plane.
	Management *Management `json:"management,omitempty"`
}

type TransitionDelayConfiguration struct {

	// Increase defines the minimum period of time to wait between a cluster's size increasing and
	// the t-shirt size assigned to it being updated to reflect the new size.
	Increase metav1.Duration `json:"increase,omitempty"`

	// Decrease defines the minimum period of time to wait between a cluster's size decreasing and
	// the t-shirt size assigned to it being updated to reflect the new size.
	Decrease metav1.Duration `json:"decrease,omitempty"`
}