v1alpha1

type Affinity struct {
	// +optional
	PodGroupAffinity *PodGroupAffinity `json:"podGroupAffinity,omitempty"`

	// +optional
	PodGroupAntiAffinity *PodGroupAntiAffinity `json:"podGroupAntiAffinity,omitempty"`
}

type PodGroup struct {
	metav1.TypeMeta `json:",inline"`
	// Standard object's metadata.
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Specification of the desired behavior of the pod group.
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
	Spec PodGroupSpec `json:"spec,omitempty"`

	// Status represents the current information about a pod group.
	// This data may not be up to date.
	// +optional
	Status PodGroupStatus `json:"status,omitempty"`
}

type PodGroupAffinity struct {
	// Required represents a set of affinity terms, all of them MUST be satisfied
	// +optional
	Required []PodGroupAffinityTerm `json:"required,omitempty"`

	// Preferred represents a set of affinity terms that don't necessarily have to be satisfied.
	// But we need to try to satisfy
	// +optional
	Preferred []PodGroupAffinityTerm `json:"preferred,omitempty"`

	// SortRules indicates how the nodeGroups, aggregated by required or
	// preferred affinity, are sorted. The rule's index in slice is the sort
	// sequence. If this is not defined, we will sort nodeGroups in default sort rule.
	// +optional
	SortRules []SortRule `json:"sortRules,omitempty"`

	// NodeSelector specifies the requirements that must be met for the
	// podGroup's pods to fit on the nodes.
	// +optional
	NodeSelector *v1.NodeSelector `json:"nodeSelector,omitempty"`
}

type PodGroupAffinityTerm struct {
	// TopologyKey is the specific topology name that all related tasks should be scheduled to
	// Empty topologyKey is not allowed.
	TopologyKey string `json:"topologyKey,omitempty"`
}

type PodGroupAntiAffinity struct {
	// Required represents a set of affinity terms, all of them MUST NOT be satisfied
	// +optional
	Required []PodGroupAffinityTerm `json:"required,omitempty"`

	// Preferred represents a set of affinity terms that we need to try not to satisfy them
	// +optional
	Preferred []PodGroupAffinityTerm `json:"preferred,omitempty"`
}

type PodGroupCondition struct {
	// Phase is the current phase of PodGroup
	Phase PodGroupPhase `json:"phase,omitempty"`

	// Status is the status of the condition.
	Status v1.ConditionStatus `json:"status,omitempty"`

	// Last time the phase transitioned from another to current phase.
	// +optional
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`

	// Unique, one-word, CamelCase reason for the phase's last transition.
	// +optional
	Reason string `json:"reason,omitempty"`

	// Human-readable message indicating details about last transition.
	// +optional
	Message string `json:"message,omitempty"`
}

type PodGroupConditionDetail string

type PodGroupList struct {
	metav1.TypeMeta `json:",inline"`
	// Standard list metadata
	// +optional
	metav1.ListMeta `json:"metadata,omitempty"`

	// Items is the list of PodGroup
	Items []PodGroup `json:"items"`
}

type PodGroupPhase string

type PodGroupSpec struct {
	// MinMember defines the minimal number of members/tasks to run the pod group;
	// if there's not enough resources to start all tasks, the scheduler
	// will not start anyone.
	MinMember int32 `json:"minMember,omitempty"`

	// If specified, indicates the PodGroup's priority. "system-node-critical" and
	// "system-cluster-critical" are two special reserved keywords which indicate the highest priorities.
	// Any other name must be defined by creating a PriorityClass object with that name.
	// If not specified, the PodGroup priority will be default.
	// If default priority class doesn't exist, the PodGroup priority will be zero.
	// +optional
	PriorityClassName string `json:"priorityClassName,omitempty"`

	// ScheduleTimeoutSeconds defines the maximal time of tasks to wait before run the pod group;
	// +optional
	ScheduleTimeoutSeconds *int32 `json:"scheduleTimeoutSeconds,omitempty"`

	// Application indicates the podGroup belongs to a logical Application
	// This will be used for coordinate with features like drf and faire share.
	// +optional
	Application string `json:"application,omitempty"`

	// Affinity shows the affinity/anti-affinity rules that scheduler needs to follow
	// when scheduling instances of this pod group.
	// +optional
	Affinity *Affinity `json:"affinity,omitempty"`
}

type PodGroupStatus struct {
	// Current phase of PodGroup.
	Phase PodGroupPhase `json:"phase,omitempty"`

	// The conditions of PodGroup.
	// +optional
	Conditions []PodGroupCondition `json:"conditions,omitempty"`

	// OccupiedBy marks the workload (e.g., deployment, job) name that occupy the PodGroup.
	// It is empty if not initialized.
	OccupiedBy string `json:"occupiedBy,omitempty"`

	// The number of actively pending pods.
	// +optional
	Pending int32 `json:"pending,omitempty"`

	// The number of actively running pods.
	// +optional
	Running int32 `json:"running,omitempty"`

	// The number of pods which reached phase Succeeded.
	// +optional
	Succeeded int32 `json:"succeeded,omitempty"`

	// The number of pods which reached phase Failed.
	// +optional
	Failed int32 `json:"failed,omitempty"`

	// ScheduleStartTime of the pod group
	ScheduleStartTime *metav1.Time `json:"scheduleStartTime,omitempty"`
}

type Scheduler struct {
	metav1.TypeMeta `json:",inline"`
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Spec defines the behavior of a Scheduler.
	// +optional
	Spec SchedulerSpec `json:"spec,omitempty"`

	// Status represents the current information about a Scheduler. This data may not be up
	// to date.
	// +optional
	Status SchedulerStatus `json:"status,omitempty"`
}

type SchedulerAggregatedMetricsStatus struct {

	// pending pods in the pending queue
	// +optional
	PendingPods *int `json:"pendingPods,omitempty"`
}

type SchedulerList struct {
	metav1.TypeMeta `json:",inline"`

	// Standard list metadata
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
	// +optional
	metav1.ListMeta `json:"metadata,omitempty"`

	// items is the list of Schedulers
	Items []Scheduler `json:"items"`
}

type SchedulerPhase string

type SchedulerSpec struct {
}

type SchedulerStatus struct {
	// +optional
	Phase SchedulerPhase `json:"phase,omitempty"`
	// LastUpdateTime is the latest update time.
	// It should be first time initialized when this crd is created
	// +optional
	LastUpdateTime *metav1.Time `json:"lastUpdateTime,omitempty"`

	// CurrentHost is the host the current scheduler leader runs on
	// +optional
	CurrentHost string `json:"currentHost,omitempty"`

	// TODO: populate more info here
	// TODO: investigate whether we need a separate API object for this
	// +optional
	MetricsStatus *SchedulerAggregatedMetricsStatus `json:"metricsStatus,omitempty"`

	// SchedulerNodePartitionName is the name of NodePartition which contains all the nodes in this scheduler's partition
	// +optional
	SchedulerNodePartitionName string `json:"schedulerNodePartitionName,omitempty"`
}

type SortDimension string

type SortOrder string

type SortResource string

type SortRule struct {
	// Resource defines the resource name for sorting.
	Resource SortResource `json:"resource"`

	// Dimension may be Capacity or Available for the moment.
	// We allow this field to be empty for backward compatibility.
	Dimension SortDimension `json:"dimension,omitempty"`

	// Order may be either Ascending or Descending
	Order SortOrder `json:"order"`
}