v1alpha1

type AccessMode string

type DataLoadStatus struct {
	// +kubebuilder:validation:Optional
	Round int32 `json:"round,omitempty"`
	// +kubebuilder:validation:Optional
	JobName string `json:"jobName,omitempty"`
	// +kubebuilder:validation:Optional
	StartTime metav1.Time `json:"startTime,omitempty"`
	// +kubebuilder:validation:Optional
	EndTime metav1.Time `json:"endTime,omitempty"`
	// +kubebuilder:validation:Optional
	Succeed bool `json:"succeed,omitempty"`
}

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

	Spec   DatasetSpec   `json:"spec,omitempty"`
	Status DatasetStatus `json:"status,omitempty"`
}

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

type DatasetSource struct {
	// +kubebuilder:validation:Enum=GIT;S3;HTTP;PVC;NFS;CONDA;REFERENCE;HUGGING_FACE;MODEL_SCOPE;DATABASE;HADOOP;MANUAL
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable"
	Type DatasetType `json:"type"`
	// +kubebuilder:validation:Required
	// uri is the location of the dataset.
	// each type of dataset source has its own format of uri:
	// - GIT: http[s]://<host>/<owner>/<repo>[.git] or git://<host>/<owner>/<repo>[.git]
	// - S3: s3://<bucket>/<path/to/directory>
	// - HTTP: http[s]://<host>/<path/to/directory>?<query>
	// - PVC: pvc://<name>/<path/to/directory>
	// - NFS: nfs://<host>/<path/to/directory>
	// - CONDA: conda://<name>?[python=<python_version>]
	// - REFERENCE: dataset://<namespace>/<dataset>
	// - HUGGING_FACE: huggingface://<repoName>?[repoType=<repoType>]
	// - MODEL_SCOPE: modelscope://<namespace>/<model>
	// - DATABASE: database://<ip>:<port>
	// - HADOOP: hdfs://<ip>:<port>
	// - MANUAL: manual://
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable"
	URI string `json:"uri"`
	// +kubebuilder:validation:Optional
	// +kubebuilder:pruning:PreserveUnknownFields
	// options is a map of key-value pairs that can be used to specify additional options for the dataset source, e.g. {"branch": "master"}
	// supported keys for each type of dataset source are:
	// - GIT: branch, commit, depth, submodules
	// - S3: region, endpoint, provider, syncMode
	// - HTTP: any key-value pair will be passed to the underlying http client as http headers
	// - PVC:
	// - NFS:
	// - CONDA: requirements.txt, environment.yaml
	// - REFERENCE:
	// - HUGGING_FACE: repo, repoType, endpoint, include, exclude, revision
	// - MODEL_SCOPE: repo, repoType, include, exclude, revision
	// * Note: syncMode can be "sync" (default) or "copy". "sync" removes files in destination that don't exist in source, "copy" only adds/updates files without removing existing ones.
	// - DATABASE: type(currently only support MySQL, other database types may be supported in the future.), host, port, dbName, tables(in the dbName), exportFormat(currently only support csv)
	// - HADOOP: coreSiteXml and hdfsSiteXml, sourcePath, username
	// - MANUAL:
	Options map[string]string `json:"options,omitempty"`
}

type DatasetSpec struct {
	// Share indicates whether the model is shareable with others.
	// When set to true, the model can be shared according to the specified selector.
	// +kubebuilder:validation:Optional
	Share bool `json:"share,omitempty"`
	// ShareToNamespaceSelector defines a label selector to specify the namespaces
	// to which the model can be shared. Only namespaces that match the selector will have access to the model.
	// If Share is true and ShareToNamespaceSelector is empty, that means all namespaces can access this.
	// +kubebuilder:validation:Optional
	ShareToNamespaceSelector *metav1.LabelSelector `json:"shareToNamespaceSelector,omitempty"`
	// ShareAccess assigns the effective access mode to namespaces which consume
	// this Dataset through a REFERENCE Dataset. A nil value is intentionally
	// distinct from an empty value: nil preserves the legacy read-only sharing
	// behaviour.
	// +kubebuilder:validation:Optional
	ShareAccess *ShareAccess `json:"shareAccess,omitempty"`
	// +kubebuilder:validation:Required
	// source is the source of the dataset.
	Source DatasetSource `json:"source"`
	// +kubebuilder:validation:Optional
	// secretRef is the name of the secret that contains credentials for accessing the dataset source.
	SecretRef string `json:"secretRef,omitempty"`
	// +kubebuilder:validation:Optional
	// mountOptions is the options for mounting the dataset.
	MountOptions MountOptions `json:"mountOptions,omitempty"`
	// +kubebuilder:validation:Optional
	// +kubebuilder:validation:XValidation:rule="self > 0 && self - oldSelf <= 1",message="dataSyncRound can only be incremented by 1"
	// +kubebuilder:default=1
	// dataSyncRound is the number of data sync rounds to be performed."
	DataSyncRound int32 `json:"dataSyncRound,omitempty"`
	// +kubebuilder:validation:Optional
	VolumeClaimTemplate v1.PersistentVolumeClaim `json:"volumeClaimTemplate,omitempty"`
	// +kubebuilder:validation:Optional
	// volumeClaimRef is the reference to an existing PVC.
	VolumeClaimRef *VolumeClaimRef `json:"volumeClaimRef,omitempty"`
	// DataWarmUpResources is the resources required for data warmUp.
	// +kubebuilder:validation:Optional
	DataWarmUpResources v1.ResourceRequirements `json:"resources,omitempty"`
}

type DatasetStatus struct {
	// +kubebuilder:validation:Optional
	// +kubebuilder:default=PENDING
	Phase DatasetStatusPhase `json:"phase,omitempty"`
	// +kubebuilder:validation:Optional
	Conditions []metav1.Condition `json:"conditions,omitempty"`
	// +kubebuilder:validation:Optional
	InProcessing bool `json:"inProcessing,omitempty"`
	// +kubebuilder:validation:Optional
	InProcessingRound int32 `json:"inProcessingRound,omitempty"`
	// +kubebuilder:validation:Optional
	// lastSucceedRound is the number of the last data sync round.
	LastSucceedRound int32 `json:"lastSucceedRound,omitempty"`
	// +kubebuilder:validation:Optional
	// syncRoundStatuses is a list of data sync round statuses.
	// each data sync round status contains the information of the data sync round.
	// we only keep the data sync round statuses of the last 5 data sync rounds.
	SyncRoundStatuses []DataLoadStatus `json:"syncRoundStatuses,omitempty"`
	// +kubebuilder:validation:Optional
	// pvcName is the deterministic target PVC name for the Dataset. Its
	// presence does not imply that the PVC exists or is ready; use the PVC
	// condition to determine availability.
	PVCName string `json:"pvcName,omitempty"`
	// +kubebuilder:validation:Optional
	// readOnly indicates whether the dataset is mounted as read-only.
	ReadOnly bool `json:"readOnly,omitempty"`
	// mountSources is the direct-to-root source chain from the last successful
	// MountPolicy resolution for a REFERENCE Dataset. It deliberately excludes this
	// Dataset's own PVC; that PVC is checked from status.pvcName at verification time.
	// A MountPolicy=False condition retains this binding as an anti-rebind identity pin;
	// consumers must never treat it as current authorization.
	MountSources []MountSource `json:"mountSources,omitempty"`
	LastSyncTime metav1.Time   `json:"lastSyncTime,omitempty"`
}

type DatasetStatusPhase string

type DatasetType string

type MountOptions struct {
	// +kubebuilder:validation:Optional
	// +kubebuilder:default="/"
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable"
	// path is the path to the directory to be mounted.
	// if set to "/", the dataset will be mounted to the root of the dest volume.
	// if set to a non-empty string, the dataset will be mounted to a subdirectory of the dest volume.
	Path string `json:"path,omitempty"`
	// +kubebuilder:validation:Optional
	// +kubebuilder:default="0774"
	// +kubebuilder:validation:Pattern="^[0-7]{3,4}$"
	// mode is the permission mode of the mounted directory.
	Mode string `json:"mode,omitempty"`
	// +kubebuilder:validation:Optional
	// +kubebuilder:default=1000
	// uid is the user id of the mounted directory.
	UID int64 `json:"uid,omitempty"`
	// +kubebuilder:validation:Optional
	// +kubebuilder:default=1000
	// gid is the group id of the mounted directory.
	GID int64 `json:"gid,omitempty"`
}

type MountSource struct {
	Namespace string `json:"namespace"`
	Name      string `json:"name"`
	UID       string `json:"uid"`
	PVCName   string `json:"pvcName"`
	PVCUID    string `json:"pvcUID"`
	PVName    string `json:"pvName"`
	PVUID     string `json:"pvUID"`
}

type ShareAccess struct {
	// +kubebuilder:validation:MinItems=1
	Rules []ShareAccessRule `json:"rules"`
}

type ShareAccessRule struct {
	// NamespaceSelector selects target namespaces. Empty selectors are not valid:
	// an explicit rule must name at least one label requirement.
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:XValidation:rule="size(self.matchLabels) > 0 || size(self.matchExpressions) > 0",message="namespaceSelector must not be empty"
	NamespaceSelector metav1.LabelSelector `json:"namespaceSelector"`
	// +kubebuilder:validation:Enum=ReadOnly;ReadWrite
	AccessMode AccessMode `json:"accessMode"`
}

type VolumeClaimRef struct {
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinLength=1
	// +kubebuilder:validation:MaxLength=253
	// +kubebuilder:validation:Pattern="^[a-z0-9]([-a-z0-9]{0,61}[a-z0-9])?([.][a-z0-9]([-a-z0-9]{0,61}[a-z0-9])?)*$"
	// name is the name of the pvc.
	Name string `json:"name"`

	// +kubebuilder:validation:Optional
	// subPath is the subPath of the pvc.
	SubPath string `json:"subPath,omitempty"`
}