v1alpha1

type AggrFn string

type ConfigVar struct {
	// Configuration name
	Name string `json:"name"`
	// Configuration value
	// +optional
	// +nullable
	Value string `json:"value,omitempty"`
	// Configuration value from secret
	// +optional
	// +nullable
	// +operator-sdk:csv:customresourcedefinitions:type=spec,xDescriptors={"urn:alm:descriptor:io.kubernetes:Secret"}
	SecretKeyRef *corev1.SecretKeySelector `json:"secretKeyRef,omitempty"`
}

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

	Spec   DataSourceSpec   `json:"spec,omitempty"`
	Status DataSourceStatus `json:"status,omitempty"`
}

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

type DataSourceSpec struct {
	// Kind of the DataSource
	// +kubebuilder:validation:Required
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Data Source Kind"
	Kind string `json:"kind"`

	// Config of the DataSource
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Config"
	Config []ConfigVar `json:"config"`

	// KeyFields are the fields that are used to identify the data source of a single data row.
	// +kubebuilder:validation:Required
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Key Fields"
	KeyFields []string `json:"keyFields"`

	// TimestampField is the field that is used to identify the timestamp of a single data row.
	// +optional
	// +nullable
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Timestamp Field"
	TimestampField string `json:"timestampField,omitempty"`

	// Resources defines the required resources for a single container(underlying implementation) of this DataSource.
	// Notice that this is not applicable for every DataSource, but only for those who implement an External Runner.
	//
	// More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
	// +optional
	// +nullable
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Resources",xDescriptors={"urn:alm:descriptor:com.tectonic.ui:resourceRequirements"}
	Resources corev1.ResourceRequirements `json:"resources,omitempty"`

	// Replicas defines the number of desired pods. This is a pointer to distinguish between explicit
	// zero and not specified. Defaults to 1.
	// +optional
	// +nullable
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Replicas",xDescriptors={"urn:alm:descriptor:com.tectonic.ui:podCount"}
	Replicas *int32 `json:"replicas,omitempty"`

	// Schema defines the schema of the data source.
	// +kubebuilder:pruning:PreserveUnknownFields
	// +kubebuilder:validation:Schemaless
	// +optional
	// +nullable
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Schema"
	Schema json.RawMessage `json:"schema,omitempty"`
}

type DataSourceStatus struct {
	// Features includes a list of references for the Feature that uses this DataSource
	// +optional
	// +nullable
	// +operator-sdk:csv:customresourcedefinitions:type=status
	Features []ResourceReference `json:"features,omitempty"`

	// +operator-sdk:csv:customresourcedefinitions:type=status
	Replicas *int32 `json:"replicas,omitempty"`
}

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

	Spec   FeatureSpec   `json:"spec,omitempty"`
	Status FeatureStatus `json:"status,omitempty"`
}

type FeatureBuilder struct {
	// Kind defines the type of Builder to use to build the feature-value.
	// The kind is usually auto-detected from the data-source, but can be overridden.
	// +optional
	// +nullable
	Kind string `json:"kind,omitempty"`

	// Aggr defines an aggregation on top of the underlying feature-value. Aggregations will be calculated on time-of-request.
	// Users can specify here multiple functions to calculate the aggregation.
	// +optional
	// +nullable
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Aggregations"
	Aggr []AggrFn `json:"aggr,omitempty"`

	// AggrGranularity defines the granularity of the aggregation.
	// +optional
	// +nullable
	AggrGranularity metav1.Duration `json:"aggrGranularity,omitempty"`

	// Runtime defines the runtime virtualenv to use for running the python computation.
	// +optional
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="RuntimeManager"
	Runtime string `json:"runtime,omitempty"`

	// Packages defines the list of python packages to install in the runtime virtualenv.
	// +optional
	// +nullable
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Packages"
	Packages []string `json:"packages,omitempty"`

	// Code defines a Python processing code to use to build the feature-value.
	// +kubebuilder:validation:Required
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Python Expression"
	Code string `json:"code"`

	// Embedded custom configuration of the Builder to use to build the feature-value.
	// +kubebuilder:pruning:PreserveUnknownFields
	// +kubebuilder:validation:Schemaless
	Raw json.RawMessage `json:",inline"`
}

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

type FeatureSpec struct {
	// Primitive defines the type of the underlying feature-value that a Feature should respond with.
	// +kubebuilder:validation:Required
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Primitive Type"
	Primitive PrimitiveType `json:"primitive"`

	// Freshness defines the age of a feature-value(time since the value has set) to consider as *fresh*.
	// Fresh values doesn't require re-ingestion
	// +kubebuilder:validation:Required
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Freshness"
	Freshness metav1.Duration `json:"freshness"`

	// Staleness defines the age of a feature-value(time since the value has set) to consider as *stale*.
	// Stale values are not fit for usage, therefore will not be returned and will REQUIRE re-ingestion.
	// +kubebuilder:validation:Required
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Staleness"
	Staleness metav1.Duration `json:"staleness"`

	// Timeout defines the maximum ingestion time allowed to calculate the feature value.
	// +optional
	// +nullable
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Timeout"
	Timeout metav1.Duration `json:"timeout"`

	// KeepPrevious defines the number of previous values to keep in the history.
	// +optional
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Keep Previous"
	KeepPrevious *KeepPrevious `json:"keepPrevious,omitempty"`

	// Keys defines the list of keys that are required to calculate the feature value.
	// +kubebuilder:validation:Required
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Keys"
	Keys []string `json:"keys"`

	// DataSource is a reference for the DataSource that this Feature is associated with
	// +optional
	// +nullable
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Data Source"
	DataSource *ResourceReference `json:"dataSource,omitempty"`

	// Builder defines a building-block to use to build the feature-value
	// +kubebuilder:validation:Required
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Builder"
	Builder FeatureBuilder `json:"builder"`
}

type FeatureStatus struct {
	// FQN is the Fully Qualified Name for the Feature
	// +operator-sdk:csv:customresourcedefinitions:type=status
	FQN string `json:"fqn"`

	// State is the current state of the Feature
	Ready bool `json:"ready"`

	// Dependencies is the list of dependencies for the Feature
	// +optional
	// +nullable
	Dependencies []ResourceReference `json:"dependencies,omitempty"`
}

type KeepPrevious struct {
	// Versions defines the number of previous values to keep in the history.
	// +kubebuilder:validation:Required
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Versions"
	Versions uint `json:"versions"`

	// Over defines the maximum time period to keep a previous values in the history since the last update.
	// You can specify `0` to keep the value until the next update.
	// +kubebuilder:validation:Required
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Over"
	Over metav1.Duration `json:"over"`
}

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

	Spec   ModelSpec   `json:"spec,omitempty"`
	Status ModelStatus `json:"status,omitempty"`
}

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

type ModelServer string

type ModelSpec struct {
	// Freshness defines the age of a prediction-result(time since the value has set) to consider as *fresh*.
	// Fresh values doesn't require re-ingestion
	// +kubebuilder:validation:Required
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Freshness"
	Freshness metav1.Duration `json:"freshness"`

	// Staleness defines the age of a prediction-result(time since the value has set) to consider as *stale*.
	// Stale values are not fit for usage, therefore will not be returned and will REQUIRE re-ingestion.
	// +kubebuilder:validation:Required
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Staleness"
	Staleness metav1.Duration `json:"staleness"`

	// Timeout defines the maximum ingestion time allowed to calculate the prediction.
	// +optional
	// +nullable
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Timeout"
	Timeout metav1.Duration `json:"timeout"`

	// Features is the list of feature FQNs that are enabled for a given feature set
	// +kubebuilder:validation:MinItems=2
	// +kubebuilder:validation:Required
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Features"
	Features []string `json:"features"`

	// KeyFeature is the feature FQN that is used to align the rest of the features with their timestamp.
	// If this is unset, the first feature in the list will be used.
	// +optional
	// +nullable
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Key Feature FQN"
	KeyFeature string `json:"keyFeature,omitempty"`

	// Labels is a list of feature FQNs that are used to label the prediction result.
	// +optional
	// +nullable
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Labels"
	Labels []string `json:"labels,omitempty"`

	// Keys defines the list of keys that are required to calculate the feature values.
	// +kubebuilder:validation:Required
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Keys"
	Keys []string `json:"keys"`

	// ModelFramework is the framework used to train the model.
	// +kubebuilder:validation:Required
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Model Framework"
	ModelFramework string `json:"modelFramework"`

	// ModelFrameworkVersion is the version of the framework used to train the model.
	// +kubebuilder:validation:Required
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Model Framework Version"
	ModelFrameworkVersion string `json:"modelFrameworkVersion"`

	// StorageURI is the URI of the model storage.
	// +optional
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Storage URI"
	StorageURI string `json:"storageURI"`

	// ModelImage is the image used to serve the model.
	// +optional
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Model Image"
	ModelImage string `json:"modelImage"`

	// ModelServer is the server used to serve the model.
	// +kubebuilder:validation:Required
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Model Server"
	ModelServer ModelServer `json:"modelServer"`

	// InferenceConfig is the additional configuration used for the model server.
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Config"
	// +optional
	InferenceConfig []ConfigVar `json:"inferenceConfig"`

	// TrainingCode defines the code used to train the model.
	// +optional
	// +nullable
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Python Expression"
	TrainingCode string `json:"trainingCode"`
}

type ModelStatus struct {
	// FQN is the Fully Qualified Name for the Model
	// +operator-sdk:csv:customresourcedefinitions:type=status
	FQN string `json:"fqn"`
}

type ParsedConfig map[string]string

type PrimitiveType string

type ResourceReference struct {
	// Name is unique within a namespace to reference a resource.
	// +kubebuilder:validation:Required
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Resource's Name"
	Name string `json:"name,omitempty" protobuf:"bytes,1,opt,name=name"`

	// Namespace defines the space within which the resource name must be unique.
	// +optional
	// +nullable
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Resource's Namespace"
	Namespace string `json:"namespace,omitempty" protobuf:"bytes,2,opt,name=namespace"`
}