models

type Alert struct {
	Model

	Environment       string  `json:"environment" validate:"required"`
	Team              string  `json:"team" validate:"required"`
	Service           string  `json:"service"`
	Metric            Metric  `json:"metric" validate:"oneof=throughput latency95p error_rate cpu_util memory_util"`
	WarningThreshold  float64 `json:"warning_threshold"`
	CriticalThreshold float64 `json:"critical_threshold"`
	// Duration to wait after the threshold is violated before firing the alert.
	// The duration format is a sequence of decimal numbers followed by a time unit suffix.
	// For instance: 5m
	Duration string `json:"duration" validate:"required"`
}

type AutoscalingMetric string

type AutoscalingPolicy struct {
	Metric AutoscalingMetric `json:"metric" validate:"required,oneof=concurrency rps cpu memory"`
	// Target is the target value of the metric that should be reached to add a new replica.
	// It is expected that the autoscaling target is an absolute value for concurrency / rps
	// while it is a % value (of the requested value) for cpu / memory.
	Target string `json:"target" validate:"required,number"`
}

type BigQueryConfig struct {
	// BigQuery table to write to, as a fully qualified BQ Table string.
	// e.g. project.dataset.table
	Table string `json:"table"`
	// Service account secret name (correct to merlin) for writing to BQ.
	ServiceAccountSecret string `json:"service_account_secret"`
	// Whether to perform batch or streaming writes.
	BatchLoad bool `json:"batch_load"`
}

type DefaultTrafficRule struct {
	Routes []string `json:"routes" validate:"required,notBlank"`
}

type Enricher struct {
	Model
	// Fully qualified docker image string used by the enricher, in the
	// format registry/repository:version.
	Image string `json:"image"`
	// Resource requests  for the deployment of the enricher.
	ResourceRequest *ResourceRequest `json:"resource_request"`
	// Autoscaling policy for the enricher
	AutoscalingPolicy *AutoscalingPolicy `json:"autoscaling_policy" validate:"omitempty,dive"`
	// Endpoint to query.
	Endpoint string `json:"endpoint"`
	// Request timeout as a valid quantity string.
	Timeout string `json:"timeout"`
	// Port to query.
	Port int `json:"port"`
	// Environment variables to inject into the pod.
	Env EnvVars `json:"env"`
	// (optional) ServiceAccount specifies the name of the secret registered in the MLP project containing the service
	// account. The service account will be mounted into the container and the env variable
	// GOOGLE_APPLICATION_CREDENTIALS will point to the service account file.
	ServiceAccount string `json:"service_account"`
}

type Ensembler struct {
	Model
	Type           EnsemblerType            `json:"type" validate:"required"`
	StandardConfig *EnsemblerStandardConfig `json:"standard_config"` // Ensembler config when Type is "standard"
	DockerConfig   *EnsemblerDockerConfig   `json:"docker_config"`   // Ensembler config when Type is "docker"
	PyfuncConfig   *EnsemblerPyfuncConfig   `json:"pyfunc_config"`   // Ensembler config when Type is "pyfunc"
}

type EnsemblerDockerConfig struct {
	Image string `json:"image" validate:"required"`
	// Resource requests for ensembler container deployed
	ResourceRequest *ResourceRequest `json:"resource_request" validate:"required"`
	// Autoscaling policy for the ensembler
	AutoscalingPolicy *AutoscalingPolicy `json:"autoscaling_policy" validate:"omitempty,dive"`
	// URL path for the endpoint, e.g "/"
	Endpoint string `json:"endpoint" validate:"required"`
	// Request timeout in duration format e.g. 60s
	Timeout string `json:"timeout" validate:"required"`
	// Port number the container listens to for requests
	Port int `json:"port" validate:"required"`
	// Environment variables to set in the container
	Env EnvVars `json:"env" validate:"required"`
	// secret name in MLP containing service account key
	ServiceAccount string `json:"service_account"`
}

type EnsemblerLike interface {
	GetID() ID
	GetProjectID() ID
	GetType() EnsemblerType
	GetName() string
	GetCreatedAt() time.Time
	GetUpdatedAt() time.Time

	SetProjectID(id ID)
	Patch(other EnsemblerLike) error
}

type EnsemblerPyfuncConfig struct {
	ProjectID   *ID `json:"project_id" validate:"required"`
	EnsemblerID *ID `json:"ensembler_id" validate:"required"`
	// Resource requests for ensembler container deployed
	ResourceRequest *ResourceRequest `json:"resource_request" validate:"required"`
	// Autoscaling policy for the ensembler
	AutoscalingPolicy *AutoscalingPolicy `json:"autoscaling_policy" validate:"omitempty,dive"`
	// Request timeout in duration format e.g. 60s
	Timeout string `json:"timeout" validate:"required"`
	// Environment variables to set in the container
	Env EnvVars `json:"env" validate:"required"`
}

type EnsemblerStandardConfig struct {
	// LazyRouting dictates whether the routes should be called lazily, based on the results
	// of the experiment engine. If true, the experiment engine will be called first and only
	// the selected route will be invoked - this is more cost efficient. If false, the routing
	// will be executed in parallel with the call to the experiment engine and therefore, faster
	// e2e execution time.
	LazyRouting        bool                `json:"lazy_routing"`
	ExperimentMappings []ExperimentMapping `json:"experiment_mappings" validate:"dive"`
	RouteNamePath      string              `json:"route_name_path"`
}

type EnsemblerType string

type EnsemblingJob struct {
	Model
	Name            string       `json:"name"`
	EnsemblerID     ID           `json:"ensembler_id" validate:"required"`
	ProjectID       ID           `json:"project_id"`
	EnvironmentName string       `json:"environment_name"`
	InfraConfig     *InfraConfig `json:"infra_config" validate:"required"`
	JobConfig       *JobConfig   `json:"job_config" validate:"required"`
	RetryCount      int          `json:"-" gorm:"default:0"`
	Status          Status       `json:"status" gorm:"default:pending"`
	Error           string       `json:"error"`
	MonitoringURL   string       `json:"monitoring_url" gorm:"-"`
	RunID           int          `json:"-"`
}

type EnvVar struct {
	// Name of the environment variable.
	Name string `json:"name"`

	// Value of the environment variable.
	// Defaults to "".
	Value string `json:"value"`
}

type EnvVars []*EnvVar

type Event struct {
	Model

	// Router id this event is for
	RouterID ID      `json:"-"`
	Router   *Router `json:"-"`

	// Version of router that triggered this deployment event.
	// May not necessarily pertain to the resource described by the event,
	// e.g. for removal of old versions, version will point to the new version
	// that triggered the event.
	Version uint `json:"version"`

	// EventType type of event
	EventType EventType `json:"event_type"`

	// Stage of deployment/undeployment
	Stage EventStage `json:"stage"`

	// Message describing the event
	Message string `json:"message"`
}

type EventStage string

type EventType string

type ExperimentEngine struct {
	// Type of Experiment Engine
	Type string `json:"type"`
	// PluginConfig (Optional) contains necessary configuration, if experiment engine
	// is implemented as RPC plugin
	PluginConfig *config.ExperimentEnginePluginConfig `json:"plugin_config,omitempty"`
	// ServiceAccount contains the service account file path that points to the service account
	// key that the experiment engine may require
	ServiceAccountKeyFilePath *string `json:"service_account_key_file_path,omitempty"`
	// Config contains the configs for the selected experiment engine (other than "nop").
	// For standard experiment engine managers, the config can be unmarshalled into
	// manager.TuringExperimentConfig type.
	Config json.RawMessage `json:"config,omitempty"`
}

type ExperimentMapping struct {
	Experiment string `json:"experiment" validate:"required"` // Experiment name from the experiment engine
	Treatment  string `json:"treatment" validate:"required"`  // Treatment name for the experiment
	Route      string `json:"route" validate:"required"`      // Route ID to select for the experiment treatment
}

type GenericEnsembler struct {
	Model
	// ProjectID id of the project this ensembler belongs to,
	// as retrieved from the MLP API.
	ProjectID ID `json:"project_id" gorm:"column:project_id"`

	Type EnsemblerType `json:"type" gorm:"column:type" validate:"required,oneof=pyfunc"`

	Name string `json:"name" gorm:"column:name" validate:"required,hostname_rfc1123,lte=20,gte=3"`
}

type ID uint

type InfraConfig struct {
	openapi.EnsemblerInfraConfig
}

type JobConfig openapi.EnsemblerConfig

type KafkaConfig struct {
	// List of brokers for the kafka to write logs to
	Brokers string `json:"brokers"`
	// Topic to write logs to
	Topic string `json:"topic"`
	// Serialization Format used for the messages
	SerializationFormat SerializationFormat `json:"serialization_format"`
}

type LogConfig struct {
	// LogLevel of the router.
	LogLevel routerConfig.LogLevel `json:"log_level"`
	// Enable custom metrics for the router. Defaults to false.
	CustomMetricsEnabled bool `json:"custom_metrics_enabled"`
	// Enable debug logs for Fiber. Defaults to false.
	FiberDebugLogEnabled bool `json:"fiber_debug_log_enabled"`
	// Enable Jaeger tracing.
	JaegerEnabled bool `json:"jaeger_enabled"`
	// Result Logger type. The associated config must not be null.
	ResultLoggerType ResultLogger `json:"result_logger_type"`
	// Configuration necessary to log results to BigQuery. Cannot be empty if
	// ResultLoggerType is set to "bigquery".
	BigQueryConfig *BigQueryConfig `json:"bigquery_config,omitempty"`
	// Configuration necessary to log results to kafka. Cannot be empty if
	// ResultLoggerType is set to "kafka"
	KafkaConfig *KafkaConfig `json:"kafka_config,omitempty"`
}

type Metric string

type Model struct {
	// Id of the entity
	ID ID `json:"id"`
	// Created timestamp. Populated when the object is saved to the db.
	CreatedAt time.Time `json:"created_at"`
	// Last updated timestamp. Updated when the object is updated in the db.
	UpdatedAt time.Time `json:"updated_at"`
}

type PyFuncEnsembler struct {
	*GenericEnsembler

	MlflowURL string `json:"mlflow_url" gorm:"-"`

	ExperimentID ID `json:"mlflow_experiment_id" gorm:"column:mlflow_experiment_id"`

	RunID string `json:"mlflow_run_id" gorm:"column:mlflow_run_id"`

	ArtifactURI string `json:"artifact_uri" gorm:"column:artifact_uri"`

	PythonVersion string `json:"python_version" gorm:"column:python_version"`
}

type ResourceRequest struct {
	// Minimum number of replica of inference service
	MinReplica int `json:"min_replica"`
	// Maximum number of replica of inference service
	MaxReplica int `json:"max_replica"`

	// CPU request of inference service
	CPURequest resource.Quantity `json:"cpu_request"`
	// Memory request of inference service
	MemoryRequest resource.Quantity `json:"memory_request"`
}

type ResultLogger string

type Route struct {
	// ID of the route
	ID string `json:"id"`
	// Type of the route
	Type string `json:"type"`
	// Endpoint to query
	Endpoint string `json:"endpoint"`
	// Annotations (optional) holds extra information about the route
	Annotations map[string]string `json:"annotations"`
	// Request timeout as a valid quantity string.
	Timeout string `json:"timeout"`
	// Grpc ServiceMethod name
	ServiceMethod string `json:"service_method,omitempty"`
}

type Router struct {
	Model
	// Project id of the project this router belongs to, as retrieved from
	// the MLP API.
	ProjectID ID `json:"project_id"`
	// Environment name of the environment this router belongs to, as retrieved
	// from the MLP API.
	EnvironmentName string `json:"environment_name"`
	// Name of the router. Must be unique within the given project and environment.
	Name string `json:"name"`
	// Status of the Router. Indicates the deployment status of the router.
	Status RouterStatus `json:"status"`
	// Endpoint URL where the currently deployed router version is accessible at
	Endpoint string `json:"endpoint,omitempty"`

	// The current version (may be deployed or undeployed)
	CurrRouterVersionID sql.NullInt32  `json:"-"`
	CurrRouterVersion   *RouterVersion `json:"config,omitempty" gorm:"foreignkey:CurrRouterVersionID"`

	// MonitoringURL is for all router versions
	MonitoringURL string `json:"monitoring_url" gorm:"-"`
}

type RouterResponse Router

type RouterStatus string

type RouterVersion struct {
	Model
	// Router this RouterVersion is associated with.
	RouterID ID      `json:"-"`
	Router   *Router `json:"router" gorm:"association_autoupdate:false"`

	// Version of Router configuration.
	Version uint `json:"version"`

	// Status of the RouterVersion. Indicates the deployment status of the configuration.
	Status RouterVersionStatus `json:"status"`
	// Last known error if the status is error
	Error string `json:"error,omitempty"`
	// Image of the router deployed
	Image string `json:"image"`
	// Downstream endpoints for the router
	Routes Routes `json:"routes"`
	// Default route
	DefaultRouteID string `json:"default_route_id"`
	// Default fallback rule for activating some routes with no request conditions.
	DefaultTrafficRule *DefaultTrafficRule `json:"default_traffic_rule,omitempty"`
	// Rules for activating some routes based on request conditions.
	TrafficRules TrafficRules `json:"rules,omitempty"`
	// Configuration for the experiment engine queried by the router.
	ExperimentEngine *ExperimentEngine `json:"experiment_engine"`
	// Resource requests for deployment
	ResourceRequest *ResourceRequest `json:"resource_request"`
	// Autoscaling policy for the deployment
	AutoscalingPolicy *AutoscalingPolicy `json:"autoscaling_policy"`
	// Request timeout as a valid quantity string
	Timeout string `json:"timeout"`
	// Router transport protocol
	Protocol routerConfig.Protocol `json:"protocol"`
	// Logging configuration for the router
	LogConfig *LogConfig `json:"log_config"`

	// The enricher used by the router
	EnricherID sql.NullInt32 `json:"-"`
	Enricher   *Enricher     `json:"enricher,omitempty"`

	// The ensembler used by the router
	EnsemblerID sql.NullInt32 `json:"-"`
	Ensembler   *Ensembler    `json:"ensembler,omitempty"`

	// Monitoring URL used in the monitoring tab
	MonitoringURL string `json:"monitoring_url" gorm:"-"`
}

type RouterVersionStatus string

type Routes []*Route

type SerializationFormat string

type Status string

type TrafficRule struct {
	Name       string                         `json:"name" validate:"required,notBlank"`
	Conditions []*router.TrafficRuleCondition `json:"conditions" validate:"required,notBlank,dive"`
	Routes     []string                       `json:"routes" validate:"required,notBlank"`
}

type TrafficRules []*TrafficRule