v1alpha1

type ObjectReference struct {
	// APIVersion represents the API version of the target resource.
	// +required
	APIVersion string `json:"apiVersion"`

	// Kind represents the Kind of the target resource.
	// +required
	Kind string `json:"kind"`

	// Name of the target resource.
	// +required
	Name string `json:"name"`

	// Namespace of the target resource.
	// Default is empty, which means it is a non-namespacescoped resource.
	// +optional
	Namespace string `json:"namespace,omitempty"`
}

type ObservedWorkload struct {
	// Workload the observed resource.
	// +required
	Workload ObjectReference `json:"workload"`

	// Result the observed rebalance result of resource.
	// +optional
	Result RebalanceResult `json:"result,omitempty"`

	// Reason represents a machine-readable description of why this resource rebalanced failed.
	// +optional
	Reason RebalanceFailedReason `json:"reason,omitempty"`
}

type RebalanceFailedReason string

type RebalanceResult string

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

	// Spec represents the specification of the desired behavior of WorkloadRebalancer.
	// +required
	Spec WorkloadRebalancerSpec `json:"spec"`

	// Status represents the status of WorkloadRebalancer.
	// +optional
	Status WorkloadRebalancerStatus `json:"status,omitempty"`
}

type WorkloadRebalancerList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	// Items holds a list of WorkloadRebalancer.
	Items []WorkloadRebalancer `json:"items"`
}

type WorkloadRebalancerSpec struct {
	// Workloads used to specify the list of expected resource.
	// Nil or empty list is not allowed.
	// +kubebuilder:validation:MinItems=1
	// +required
	Workloads []ObjectReference `json:"workloads"`

	// TTLSecondsAfterFinished limits the lifetime of a WorkloadRebalancer that has finished execution (means each
	// target workload is finished with result of Successful or Failed).
	// If this field is set, ttlSecondsAfterFinished after the WorkloadRebalancer finishes, it is eligible to be automatically deleted.
	// If this field is unset, the WorkloadRebalancer won't be automatically deleted.
	// If this field is set to zero, the WorkloadRebalancer becomes eligible to be deleted immediately after it finishes.
	// +optional
	TTLSecondsAfterFinished *int32 `json:"ttlSecondsAfterFinished,omitempty"`
}

type WorkloadRebalancerStatus struct {
	// ObservedWorkloads contains information about the execution states and messages of target resources.
	// +optional
	ObservedWorkloads []ObservedWorkload `json:"observedWorkloads,omitempty"`

	// ObservedGeneration is the generation(.metadata.generation) observed by the controller.
	// If ObservedGeneration is less than the generation in metadata means the controller hasn't confirmed
	// the rebalance result or hasn't done the rebalance yet.
	// +optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`

	// FinishTime represents the finish time of rebalancer.
	// +optional
	FinishTime *metav1.Time `json:"finishTime,omitempty"`
}