v1beta1

type AppWrapper struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
	Spec              AppWrapperSpec   `json:"spec"`
	Status            AppWrapperStatus `json:"status,omitempty"`
}

type AppWrapperCondition struct {
	// Type of AppWrapper condition.
	Type AppWrapperConditionType `json:"type"`
	// Status of the condition, one of True, False, Unknown.
	Status v1.ConditionStatus `json:"status"`
	// The last time this condition was updated.
	LastUpdateMicroTime metav1.MicroTime `json:"lastUpdateMicroTime,omitempty"`
	// Last time the condition transitioned from one status to another.
	LastTransitionMicroTime metav1.MicroTime `json:"lastTransitionMicroTime,omitempty"`
	// The reason for the condition's last transition.
	Reason string `json:"reason,omitempty"`
	// A human-readable message indicating details about the transition.
	Message string `json:"message,omitempty"`
}

type AppWrapperConditionType string

type AppWrapperGenericResource struct {
	// Replicas is the number of desired replicas
	DesiredAvailable int32 `json:"replicas,omitempty" protobuf:"bytes,2,opt,name=desiredavailable"`

	// The minimal available pods to run for this AppWrapper; the default value is nil
	MinAvailable *int32 `json:"minavailable,omitempty" protobuf:"bytes,3,opt,name=minavailable"`

	// The number of allocated replicas from this resource type
	// +optional
	Allocated int32 `json:"allocated"`

	// The priority of this resource
	// +optional
	Priority int32 `json:"priority"`

	// The increasing rate of priority value for this resource
	// +kubebuilder:validation:Type=number
	// +kubebuilder:validation:Format=float
	// +optional
	PrioritySlope float64 `json:"priorityslope"`

	// The template for the resource; it is now a raw text because we don't know for what resource
	// it should be instantiated
	// +optional
	// +kubebuilder:pruning:PreserveUnknownFields
	// +kubebuilder:validation:EmbeddedResource
	GenericTemplate runtime.RawExtension `json:"generictemplate"`

	// Optional section that specifies resource requirements for non-standard k8s resources,
	// follows same format as that of standard k8s resources.
	CustomPodResources []CustomPodResourceTemplate `json:"custompodresources,omitempty"`

	// Optional field that drives completion status of this AppWrapper.
	// This field within an item of an AppWrapper determines the full state of the AppWrapper.
	// The completionstatus field contains a list of conditions that make the associate item considered
	// completed, for instance:
	// - completion conditions could be "Complete" or "Failed".
	// The associated item's level .status.conditions[].type field is monitored for any one of these conditions.
	// Once all items with this option is set and the conditionstatus is met the entire AppWrapper state will be changed to one of the valid AppWrapper completion state.
	// Note:
	// - this is an AND operation for all items where this option is set.
	// See the list of AppWrapper states for a list of valid complete states.
	CompletionStatus string `json:"completionstatus,omitempty"`
}

type AppWrapperList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`
	Items           []AppWrapper `json:"items"`
}

type AppWrapperResourceList struct {
	// +optional
	GenericItems []AppWrapperGenericResource `json:"GenericItems"`
}

type AppWrapperService struct {
	Spec v1.ServiceSpec `json:"spec"`
}

type AppWrapperSpec struct {
	// +optional
	Priority int32 `json:"priority,omitempty"`

	// +kubebuilder:validation:Type=number
	// +kubebuilder:validation:Format=float
	// +optional
	PrioritySlope float64 `json:"priorityslope,omitempty"`

	// +optional
	Service       AppWrapperService      `json:"service"`
	AggrResources AppWrapperResourceList `json:"resources"`

	Selector *metav1.LabelSelector `json:"selector,omitempty" protobuf:"bytes,1,opt,name=selector"`

	// SchedSpec specifies the parameters used for scheduling generic items wrapped inside AppWrappers.
	// It defines the policy for requeuing jobs based on the number of running pods.
	SchedSpec SchedulingSpecTemplate `json:"schedulingSpec,omitempty" protobuf:"bytes,2,opt,name=schedulingSpec"`
}

type AppWrapperState string

type AppWrapperStatus struct {
	// The number of pending pods.
	// +optional
	Pending int32 `json:"pending,omitempty" protobuf:"bytes,1,opt,name=pending"`

	// +optional
	Running int32 `json:"running,omitempty" protobuf:"bytes,1,opt,name=running"`

	// The number of resources which reached phase Succeeded.
	// +optional
	Succeeded int32 `json:"Succeeded,omitempty" protobuf:"bytes,2,opt,name=succeeded"`

	// The number of resources which reached phase Failed.
	// +optional
	Failed int32 `json:"failed,omitempty" protobuf:"bytes,3,opt,name=failed"`

	// The minimal available resources to run for this AppWrapper (is this different from the MinAvailable from JobStatus)
	// +optional
	MinAvailable int32 `json:"template,omitempty" protobuf:"bytes,4,opt,name=template"`

	// Can run?
	CanRun bool `json:"canrun,omitempty" protobuf:"bytes,1,opt,name=canrun"`

	// Is Dispatched?
	IsDispatched bool `json:"isdispatched,omitempty" protobuf:"bytes,1,opt,name=isdispatched"`

	// State - Pending, Running, Failed, Deleted
	State AppWrapperState `json:"state,omitempty"`

	Message string `json:"message,omitempty"`

	// System defined Priority
	// +kubebuilder:validation:Type=number
	// +kubebuilder:validation:Format=float
	SystemPriority float64 `json:"systempriority,omitempty"`

	// State of QueueJob - Init, Queueing, HeadOfLine, Rejoining, ...
	QueueJobState AppWrapperConditionType `json:"queuejobstate,omitempty"`

	// Microsecond level timestamp when controller first sees QueueJob (by Informer)
	ControllerFirstTimestamp metav1.MicroTime `json:"controllerfirsttimestamp,omitempty"`

	// Microsecond level timestamp when controller first dispatches the AppWrapper
	ControllerFirstDispatchTimestamp metav1.MicroTime `json:"controllerfirstdispatchtimestamp,omitempty"`

	// Tell Informer to ignore this update message (do not generate a controller event)
	FilterIgnore bool `json:"filterignore,omitempty"`

	// Indicate sender of this message (extremely useful for debugging)
	Sender string `json:"sender,omitempty"`

	// Indicate if message is a duplicate (for Informer to recognize duplicate messages)
	Local bool `json:"local,omitempty"`

	// Represents the latest available observations of the AppWrapper's current condition.
	Conditions []AppWrapperCondition `json:"conditions,omitempty"`

	// Represents the latest available observations of pods belonging to the AppWrapper.
	PendingPodConditions []PendingPodSpec `json:"pendingpodconditions,omitempty"`

	// The number of CPU consumed by all pods belonging to the AppWrapper.
	TotalCPU int32 `json:"totalcpu,omitempty"`

	// The amount of memory consumed by all pods belonging to the AppWrapper.
	TotalMemory int32 `json:"totalmemory,omitempty"`

	// The total number of GPUs consumed by all pods belonging to the AppWrapper.
	TotalGPU int32 `json:"totalgpu,omitempty"`

	// Field to keep track of total number of seconds spent in requeueing
	RequeueingTimeInSeconds int `json:"requeueingTimeInSeconds,omitempty"`

	// Field to keep track of how many times a requeuing event has been triggered
	NumberOfRequeueings int `json:"numberOfRequeueings,omitempty"`
}

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

type ClusterSchedulingSpec struct {
	Clusters        []ClusterReference    `json:"clusters,omitempty"`
	ClusterSelector *metav1.LabelSelector `json:"clusterSelector,omitempty"`
}

type CustomPodResourceTemplate struct {
	Replicas int `json:"replicas"`
	// todo: replace with
	// Containers []Container Contain v1.ResourceRequirements
	Requests v1.ResourceList `json:"requests"`

	// +optional
	Limits v1.ResourceList `json:"limits"`
}

type DispatchDurationSpec struct {
	Expected int  `json:"expected,omitempty"`
	Limit    int  `json:"limit,omitempty"`
	Overrun  bool `json:"overrun,omitempty"`
}

type DispatchingWindowSpec struct {
	Start ScheduleTimeSpec `json:"start,omitempty"`
	End   ScheduleTimeSpec `json:"end,omitempty"`
}

type PendingPodSpec struct {
	PodName    string            `json:"podname,omitempty"`
	Conditions []v1.PodCondition `json:"conditions,omitempty"`
}

type RequeuingTemplate struct {
	// Value to keep track of the initial wait time.
	// Users cannot set this as it is taken from 'timeInSeconds'.
	InitialTimeInSeconds int `json:"initialTimeInSeconds,omitempty" protobuf:"bytes,1,rep,name=initialTimeInSeconds"`
	// Initial waiting time before requeuing conditions are checked. This value is
	// specified by the user, but it may grow as requeuing events happen.
	// +kubebuilder:default=300
	TimeInSeconds int `json:"timeInSeconds,omitempty" protobuf:"bytes,2,rep,name=timeInSeconds"`
	// Maximum waiting time for requeuing checks.
	// +kubebuilder:default=0
	MaxTimeInSeconds int `json:"maxTimeInSeconds,omitempty" protobuf:"bytes,3,rep,name=maxTimeInSeconds"`
	// Growth strategy to increase the waiting time between requeuing checks.
	// The values available are 'exponential', 'linear', or 'none'.
	// For example, 'exponential' growth would double the 'timeInSeconds' value
	// every time a requeuing event is triggered.
	// If the string value is misspelled or not one of the possible options,
	// the growth behavior is defaulted to 'none'.
	// +kubebuilder:default=exponential
	GrowthType string `json:"growthType,omitempty" protobuf:"bytes,4,rep,name=growthType"`
	// Field to keep track of how many times a requeuing event has been triggered.
	// +kubebuilder:default=0
	NumRequeuings int `json:"numRequeuings,omitempty" protobuf:"bytes,5,rep,name=numRequeuings"`
	// Maximum number of requeuing events allowed. Once this value is reached (e.g.,
	// 'numRequeuings = maxNumRequeuings', no more requeuing checks are performed and the generic
	// items are stopped and removed from the cluster (AppWrapper remains deployed).
	// +kubebuilder:default=0
	MaxNumRequeuings int `json:"maxNumRequeuings,omitempty" protobuf:"bytes,6,rep,name=maxNumRequeuings"`
}

type ResourceName string

type ResourceType string

type ScheduleTimeSpec struct {
	Min     metav1.Time `json:"minTimestamp,omitempty"`
	Desired metav1.Time `json:"desiredTimestamp,omitempty"`
	Max     metav1.Time `json:"maxTimestamp,omitempty"`
}

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

	Spec SchedulingSpecTemplate `json:"spec,omitempty" protobuf:"bytes,1,rep,name=spec"`
}

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

	Items []SchedulingSpec `json:"items"`
}

type SchedulingSpecTemplate struct {
	NodeSelector map[string]string `json:"nodeSelector,omitempty" protobuf:"bytes,1,rep,name=nodeSelector"`
	// Expected number of pods in running and/or completed state.
	// Requeuing is triggered when the number of running/completed pods is not equal to this value.
	// When not specified, requeuing is disabled and no check is performed.
	MinAvailable int `json:"minAvailable,omitempty" protobuf:"bytes,2,rep,name=minAvailable"`
	// Specification of the requeuing strategy based on waiting time.
	// Values in this field control how often the pod check should happen,
	// and if requeuing has reached its maximum number of times.
	Requeuing RequeuingTemplate `json:"requeuing,omitempty" protobuf:"bytes,1,rep,name=requeuing"`
	// Wall clock duration time of appwrapper in seconds.
	DispatchDuration DispatchDurationSpec `json:"dispatchDuration,omitempty"`
}