v1alpha1

type CleanPodPolicy string

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

	// Spec is the spec for FLApp
	// +optional
	Spec FLAppSpec `json:"spec"`
	// Status is the status for FLApp
	// +optional
	Status FLAppStatus `json:"status"`
}

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

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

type FLAppSpec struct {
	// Specifies the duration (in seconds) since startTime during which the job can remain active
	// before it is terminated. Must be a positive integer.
	// This setting applies only to pods where restartPolicy is OnFailure or Always.
	// +optional
	// Defaults to infinite
	ActiveDeadlineSeconds *int64 `json:"activeDeadlineSeconds,omitempty"`

	// Number of retries before marking this job as failed.
	// +optional
	// Defaults to 5.
	BackoffLimit *int32 `json:"backoffLimit,omitempty"`

	// Defines the policy for cleaning up pods after the FLApp completes.
	// +optional
	// Defaults to All.
	CleanPodPolicy *CleanPodPolicy `json:"cleanPodPolicy,omitempty"`

	// Defines the TTL for cleaning up finished FLApps (temporary
	// before kubernetes adds the cleanup controller).
	// It may take extra ReconcilePeriod seconds for the cleanup, since
	// reconcile gets called periodically.
	// +optional
	// Defaults to infinite.
	// TODO: CompletionTime is required for this field
	TTLSecondsAfterFinished *int32 `json:"ttlSecondsAfterFinished,omitempty"`

	// Defines replica spec for replica type
	FLReplicaSpecs FLReplicaSpecs `json:"flReplicaSpecs"`

	// Defines the role of FLApp
	// +kubebuilder:validation:Pattern=(^Leader$)|(^Follower\d*$)
	Role string `json:"role"`

	// Defines all the controllers involved in the app
	PeerSpecs PeerSpecs `json:"peerSpecs"`

	// IngressSpec defines the ingress created by controller
	// +optional
	IngressSpec *IngressSpec `json:"ingressSpec,omitempty"`
}

type FLAppStatus struct {
	// FLState is the current state of the entire job
	// Defaults to New.
	AppState FLState `json:"appState"`
	// A map of FLReplicaType to FLReplicaStatus
	FLReplicaStatus FLReplicaStatus `json:"flReplicaStatus"`
	// Represents time when the job was completed. It is not guaranteed to
	// be set in happens-before order across separate operations.
	// It is represented in RFC3339 form and is in UTC.
	// +nullable
	CompletionTime *metav1.Time `json:"completionTime"`
}

type FLReplicaSpecs map[FLReplicaType]ReplicaSpec

type FLReplicaStatus map[FLReplicaType]ReplicaStatus

type FLReplicaType string

type FLState string

type IngressSpec struct {
	// ExtraHostSuffix is the suffix appended to FLApp hostname
	ExtraHostSuffix string `json:"extraHostSuffix"`

	// ClientAuthSecretName is the name for Ingress client-auth
	ClientAuthSecretName string `json:"clientAuthSecretName"`

	// secretName is the name for Ingress TLS secrets
	SecretName string `json:"secretName"`

	// IngressClassName is the Ingress-class name
	IngressClassName string `json:"ingressClassName"`
}

type PeerSpec struct {
	// PeerURL is the url of the involved controller
	PeerURL string `json:"peerURL"`
	// Authority is the GRPC Authority in the request
	// +optional
	Authority string `json:"authority,omitempty"`
	// The extra GRPC header in the request
	// +optional
	ExtraHeaders map[string]string `json:"extraHeaders,omitempty"`
}

type PeerSpecs map[string]PeerSpec

type ReplicaSpec struct {
	// Replicas is the desired number of replicas of the given template.
	// +optional
	// Defaults to 0.
	Replicas *int32 `json:"replicas,omitempty"`
	// Pair, when set to true, controller will try to pair it with peer controller.
	// +optional
	// Defaults to false.
	Pair *bool `json:"pair,omitempty"`
	// Template is the object that describes the pod that
	// will be created for this replica.
	Template v1.PodTemplateSpec `json:"template,omitempty"`
	// Restart policy for all replicas within the app.
	// One of Always, OnFailure, Never and ExitCode.
	// Default to OnFailure.
	RestartPolicy RestartPolicy `json:"restartPolicy,omitempty"`

	// ChiefResources describes the resource requirements of worker0.
	// +optional
	// Default to nil.
	ChiefResources *v1.ResourceRequirements `json:"chiefResources,omitempty"`
}

type ReplicaStatus struct {
	// Local is the set of ID allocated locally
	Local sets.String `json:"local"`

	// Remote is the set of ID allocated from the peer side
	Remote sets.String `json:"remote"`

	// Mapping is the mapping from a local ID to remote ID
	Mapping map[string]string `json:"mapping"`

	// The actively running pods.
	Active sets.String `json:"active"`

	// The pods which reached phase Succeeded.
	Succeeded sets.String `json:"succeeded"`

	// The pods which reached phase Failed.
	Failed sets.String `json:"failed"`
}

type RestartPolicy string