v1alpha1

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

	Spec   ConnectionSpec   `json:"spec,omitempty"`
	Status ConnectionStatus `json:"status,omitempty"`
}

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

type ConnectionSpec struct {
	// Required value. Available values:
	//   * s3
	//   * gcs
	//   * azureblob
	//   * git
	//   * docker
	Type ConnectionType `json:"type"`
	// URI. It is required value
	URI string `json:"uri"`
	// AWS region or GCP project
	Region string `json:"region,omitempty"`
	// Username
	Username string `json:"username,omitempty"`
	// Password
	Password string `json:"password,omitempty"`
	// Service account role
	Role string `json:"role,omitempty"`
	// Key ID
	KeyID string `json:"keyID,omitempty"`
	// SSH or service account secret
	KeySecret string `json:"keySecret,omitempty"`
	// SSH public key
	PublicKey string `json:"publicKey,omitempty"`
	// VCS reference
	Reference string `json:"reference,omitempty"`
	// Custom description
	Description string `json:"description,omitempty"`
	// Custom web UI link
	WebUILink string `json:"webUILink,omitempty"`
}

type ConnectionStatus struct {
	// Kubernetes secret name
	SecretName *string `json:"secretName,omitempty"`
	// Kubernetes service account
	ServiceAccountName *string `json:"serviceAccount,omitempty"`
}

type ConnectionType string

type DataBindingDir struct {
	// Connection name for data
	Connection string `json:"connName"`
	// Local training path
	LocalPath string `json:"localPath"`
	// Overwrite remote data path in connection
	RemotePath string `json:"remotePath,omitempty"`
}

type EnvironmentVariable struct {
	// Name of an environment variable
	Name string `json:"name"`
	// Value of an environment variable
	Value string `json:"value"`
}

type JsonSchema struct {
	Properties string   `json:"properties"`
	Required   []string `json:"required,omitempty"`
}

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

	Spec   ModelDeploymentSpec   `json:"spec,omitempty"`
	Status ModelDeploymentStatus `json:"status,omitempty"`
}

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

type ModelDeploymentSpec struct {
	// Model Docker image
	Image string `json:"image"`
	// Resources for model deployment
	// The same format like k8s uses for pod resources.
	Resources *ResourceRequirements `json:"resources,omitempty"`
	// Annotations for model pods.
	Annotations map[string]string `json:"annotations,omitempty"`
	// Minimum number of pods for model. By default the min replicas parameter equals 0.
	MinReplicas *int32 `json:"minReplicas,omitempty"`
	// Maximum number of pods for model. By default the max replicas parameter equals 1.
	MaxReplicas *int32 `json:"maxReplicas,omitempty"`
	// Initial delay for liveness probe of model pod
	LivenessProbeInitialDelay *int32 `json:"livenessProbeInitialDelay,omitempty"`
	// Initial delay for readiness probe of model pod
	ReadinessProbeInitialDelay *int32 `json:"readinessProbeInitialDelay,omitempty"`
	// Initial delay for readiness probe of model pod
	RoleName *string `json:"roleName,omitempty"`
	// If pulling of your image requires authorization, then you should specify the connection id
	ImagePullConnectionID *string `json:"imagePullConnID,omitempty"`
}

type ModelDeploymentState string

type ModelDeploymentStatus struct {
	// The state of a model deployment.
	//   "Processing" - A model was not deployed. Because some parameters of the
	//                  custom resource are wrong. For example, there is not a model
	//                  image in a Docker registry.
	//   "Ready" - A model was deployed successfully.
	State ModelDeploymentState `json:"state,omitempty"`
	// The model k8s deployment name
	Deployment string `json:"deployment,omitempty"`
	// The model k8s service name
	Service string `json:"service,omitempty"`
	// The model k8s service name
	ServiceURL string `json:"serviceURL,omitempty"`
	// Number of available pods
	AvailableReplicas int32 `json:"availableReplicas"`
	// Expected number of pods under current load
	Replicas int32 `json:"replicas"`
	// Last applied ready knative revision
	LastRevisionName string `json:"lastRevisionName,omitempty"`
	// Time when credentials was updated
	LastCredsUpdatedTime *metav1.Time `json:"lastUpdatedTime,omitempty"`
}

type ModelDeploymentTarget struct {
	// Model Deployment name
	Name string `json:"mdName"`
	// The proportion of traffic to be forwarded to the Model Deployment.
	Weight *int32 `json:"weight,omitempty"`
}

type ModelIdentity struct {
	// Model name
	Name string `json:"name"`
	// Model version
	Version string `json:"version"`
	// Template of output artifact name
	ArtifactNameTemplate string `json:"artifactNameTemplate,omitempty"`
}

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

	Spec   ModelPackagingSpec   `json:"spec,omitempty"`
	Status ModelPackagingStatus `json:"status,omitempty"`
}

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

type ModelPackagingResult struct {
	// Name of a result. It can be docker image, path to s3 artifact and so on
	Name string `json:"name"`
	// Specific value
	Value string `json:"value"`
}

type ModelPackagingSpec struct {
	ArtifactName *string               `json:"artifactName,omitempty"`
	Type         string                `json:"type"`
	Image        string                `json:"image,omitempty"`
	Arguments    string                `json:"arguments,omitempty"`
	Targets      []Target              `json:"targets,omitempty"`
	Resources    *ResourceRequirements `json:"resources,omitempty"`
}

type ModelPackagingState string

type ModelPackagingStatus struct {
	// Pod package for name
	PodName string `json:"podName,omitempty"`
	// Model Packaging State
	State ModelPackagingState `json:"state,omitempty"`
	// Pod exit code
	ExitCode *int32 `json:"exitCode,omitempty"`
	// Pod reason
	Reason *string `json:"reason,omitempty"`
	// Pod last log
	Message *string `json:"message,omitempty"`
	// List of packaing results
	Results []ModelPackagingResult `json:"results,omitempty"`
}

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

	Spec   ModelRouteSpec   `json:"spec,omitempty"`
	Status ModelRouteStatus `json:"status,omitempty"`
}

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

type ModelRouteSpec struct {
	// URL prefix for model deployment. For example: /custom/test
	// Prefix must start with slash
	// "/feedback" and "/model" are reserved for internal usage
	URLPrefix string `json:"urlPrefix"`
	// Mirror HTTP traffic to a another Model deployment in addition to forwarding
	// the requests to the model deployments.
	Mirror *string `json:"mirror,omitempty"`
	// A http rule can forward traffic to Model Deployments.
	ModelDeploymentTargets []ModelDeploymentTarget `json:"modelDeployments"`
}

type ModelRouteState string

type ModelRouteStatus struct {
	// Full url with prefix to a model deployment service
	EdgeURL string `json:"edgeUrl"`
	// State of Model Route
	State ModelRouteState `json:"state"`
}

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

	Spec   ModelTrainingSpec   `json:"spec,omitempty"`
	Status ModelTrainingStatus `json:"status,omitempty"`
}

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

type ModelTrainingSpec struct {
	// Model Identity
	Model ModelIdentity `json:"model"`
	// IntegrationName of toolchain
	Toolchain string `json:"toolchain"`
	// Custom environment variables that should be set before entrypoint invocation.
	CustomEnvs []EnvironmentVariable `json:"envs,omitempty"`
	// Model training hyperParameters in parameter:value format
	HyperParameters map[string]string `json:"hyperParameters,omitempty"`
	// Directory with model scripts/files in a git repository
	WorkDir string `json:"workDir,omitempty"`
	// Model training file. It can be python\bash script or jupiter notebook
	Entrypoint          string   `json:"entrypoint"`
	EntrypointArguments []string `json:"args,omitempty"`
	// Name of Connection resource. Must exists
	VCSName string `json:"vcsName"`
	// Train image
	Image string `json:"image,omitempty"`
	// VCS Reference
	Reference string `json:"reference,omitempty"`
	// Resources for model container
	// The same format like k8s uses for pod resources.
	Resources *ResourceRequirements `json:"resources,omitempty"`
	// Input data for a training
	Data []DataBindingDir `json:"data,omitempty"`
}

type ModelTrainingState string

type ModelTrainingStatus struct {
	// Pod package for name
	PodName string `json:"podName,omitempty"`
	// Model Packaging State
	State ModelTrainingState `json:"state,omitempty"`
	// Pod exit code
	ExitCode *int32 `json:"exitCode,omitempty"`
	// Pod reason
	Reason *string `json:"reason,omitempty"`
	// Pod last log
	Message *string `json:"message,omitempty"`
	// List of training results
	Artifacts []TrainingResult `json:"artifacts,omitempty"`
}

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

	Spec   PackagingIntegrationSpec   `json:"spec,omitempty"`
	Status PackagingIntegrationStatus `json:"status,omitempty"`
}

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

type PackagingIntegrationSpec struct {
	Entrypoint   string           `json:"entrypoint"`
	DefaultImage string           `json:"defaultImage,omitempty"`
	Privileged   bool             `json:"privileged,omitempty"`
	Schema       SchemaValidation `json:"schema"`
}

type PackagingIntegrationStatus struct {
}

type ResourceList struct {
	// Read more about GPU resource here https://kubernetes.io/docs/tasks/manage-gpus/scheduling-gpus/#using-device-plugins
	GPU *string `json:"gpu,omitempty"`
	// Read more about CPU resource here https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/#meaning-of-cpu
	CPU *string `json:"cpu,omitempty"`
	// Read more about memory resource here https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/#meaning-of-memory
	Memory *string `json:"memory,omitempty"`
}

type ResourceRequirements struct {
	// Limits describes the maximum amount of compute resources allowed.
	Limits *ResourceList `json:"limits,omitempty"`
	// Requests describes the minimum amount of compute resources required.
	Requests *ResourceList `json:"requests,omitempty"`
}

type SchemaValidation struct {
	Targets   []TargetSchema `json:"targets,omitempty"`
	Arguments JsonSchema     `json:"arguments"`
}

type Target struct {
	Name           string `json:"name"`
	ConnectionName string `json:"connectionName"`
}

type TargetSchema struct {
	Name            string   `json:"name"`
	ConnectionTypes []string `json:"connectionTypes"`
	Required        bool     `json:"required"`
}

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

	Spec   ToolchainIntegrationSpec   `json:"spec,omitempty"`
	Status ToolchainIntegrationStatus `json:"status,omitempty"`
}

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

type ToolchainIntegrationSpec struct {
	// Path to binary which starts a training process
	Entrypoint string `json:"entrypoint"`
	// Default training Docker image
	DefaultImage string `json:"defaultImage"`
	// Additional environments for a training process
	AdditionalEnvironments map[string]string `json:"additionalEnvironments,omitempty"`
}

type ToolchainIntegrationStatus struct {
}

type TrainingResult struct {
	// Mlflow run ID
	RunID string `json:"runId"`
	// Trained artifact name
	ArtifactName string `json:"artifactName"`
	// VCS commit
	CommitID string `json:"commitID"`
}