v1alpha1

type AutoscaleForCapacity struct {
	// MinClustersBelowCapacityCeiling defines the minimum required number of
	// clusters that are both currently active and able to scale up.
	// +kubebuilder:validation:Minimum=1
	MinClustersBelowCapacityCeiling int `json:"minClustersBelowCapacityCeiling"`
	// MaxClusters defines the maximum number of clusters that can be used to
	// run the workload. If zero or not specified, no maximum is enforced.
	MaxClusters int `json:"maxClusters,omitempty"`
	// WorkloadDetails describes the deployment which is being autoscaled as
	// part of the workload. This information is used to query metrics from each
	// target cluster about the deployment's current ability to scale up/down on
	// that cluster.
	WorkloadDetails *WorkloadDetails `json:"workloadDetails,omitempty"`
	// Indicates that the controller should assume clusters in the SCALING_IN
	// state will be proactively drained by a draining system.
	// TODO: this is hacky, we should revisit it
	UseDraining bool `json:"useDraining,omitempty"`
}

type GroupVersionKind struct {
	Group   string `json:"group"`
	Version string `json:"version"`
	Kind    string `json:"kind"`
}

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

	Spec   MultiKubernetesClusterBindingSpec   `json:"spec,omitempty"`
	Status MultiKubernetesClusterBindingStatus `json:"status,omitempty"`
}

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

type MultiKubernetesClusterBindingSpec struct {
	SourceRef    SourceRef    `json:"sourceRef"`
	PlacementRef PlacementRef `json:"placementRef"`
}

type MultiKubernetesClusterBindingStatus struct {
}

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

	Spec   MultiKubernetesClusterPlacementSpec   `json:"spec,omitempty"`
	Status MultiKubernetesClusterPlacementStatus `json:"status,omitempty"`
}

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

type MultiKubernetesClusterPlacementSpec struct {
	// ClusterSelectorRules defines a pipeline of rules which consume an ordered list
	// of clusters and output an ordered list of clusters to generate the list of
	// current target clusters.
	ClusterSelectorRules []PlacementClusterSelectorRule `json:"clusterSelectorRules"`
	// Scaling defines the scaling configuration of the placement. If not specified,
	// the placement will use all eligible clusters.
	Scaling Scaling `json:"scaling,omitempty"`
}

type MultiKubernetesClusterPlacementStatus struct {
	// Clusters is the list of clusters consumed by the workload delivery system
	Clusters               []PlacementCluster `json:"clusters,omitempty"`
	LastAdditionTime       metav1.Time        `json:"lastAdditionTime,omitempty"`
	LastClusterRemovalTime metav1.Time        `json:"lastClusterRemovalTime,omitempty"`
}

type PlacementCluster struct {
	Name               string                `json:"name"`
	Namespace          string                `json:"namespace,omitempty"`
	State              PlacementClusterState `json:"state"`
	LastTransitionTime metav1.Time           `json:"lastTransitionTime"`
	// Whether the cluster is currently at its capacity ceiling. For informational/debugging purposes only. TODO: remove this
	AtCapacityCeiling *bool `json:"atCapacityCeiling,omitempty"`
	// TODO: To make draining pluggable, this should likely be a separate CRD owned by a separate controller
	Draining *PlacementClusterDraining `json:"draining,omitempty"`
}

type PlacementClusterDraining struct {
	// Desired maximum replicas for a draining cluster. The drainer plugin should
	// reconcile the HPA's max replicas field to this value.
	DesiredMaxReplicas int `json:"desiredMaxReplicas"`
	// The last time DesiredMaxReplicas was decreased.
	LastReplicaCountDecrease metav1.Time `json:"lastReplicaCountDecrease"`
	// For informational/debugging purposes only. TODO: remove this
	CurrentReplicaCount int `json:"currentReplicaCount,omitempty"`
}

type PlacementClusterSelectorRule struct {
	// Type specifies the rule type and may be one of:
	// - all-clusters: all clusters (as defined by the ClusterProfiles)
	// - cluster-list: a user-provided comma-separated ordered list of clusters in
	//   the format cluster-inventory-ns/cluster-name (for each cluster, a
	//   ClusterProfile with the given name must exist in the given namespace)
	// - cluster-name-regex: a user-provided regular expression to match cluster
	//   names against (the available cluster names for matching are defined by
	//   the ClusterProfiles)
	Type PlacementClusterSelectorRuleType `json:"type"`
	// Arguments are specific to each rule type. Here are example usages for the
	// supported arguments:
	// - cluster-list:
	//   clusters: "cluster-inventory-ns/cluster1,cluster-inventory-ns/cluster2,cluster-inventory-ns/cluster3"
	// - cluster-name-regex
	//   regex: "cluster-inventory-ns/cluster\d+"
	Arguments map[string]string `json:"arguments,omitempty"`
}

type PlacementClusterSelectorRuleType string

type PlacementClusterState string

type PlacementRef struct {
	Name string `json:"name"`
}

type Scaling struct {
	// AutoscaleForCapacity defines the configuration for scaling based on ability to obtain capacity.
	AutoscaleForCapacity *AutoscaleForCapacity `json:"autoscaleForCapacity,omitempty"`
}

type SourceRef struct {
	Name             string           `json:"name"`
	GroupVersionKind GroupVersionKind `json:"groupVersionKind"`
	ContentPath      string           `json:"contentPath"`
}

type WorkloadDetails struct {
	// Namespace is the namespace of the workload to be placed.
	Namespace string `json:"namespace,omitempty"`
	// DeploymentName is the name of the deployment to be placed.
	DeploymentName string `json:"deploymentName"`
	// HPAName is the name of the HPA to be placed.
	HPAName string `json:"hpaName"`
}