v1alpha1

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

	// Resources are references to application resources to consider in the generation of the experiment.
	// These strings are the same format as used by Kustomize.
	Resources konjure.Resources `json:"resources,omitempty"`

	// Parameters specifies additional details about the experiment parameters.
	Parameters []Parameters `json:"parameters,omitempty"`

	// Ingress specifies how to find the entry point to the application.
	Ingress *Ingress `json:"ingress,omitempty"`

	// The list of scenarios to optimize the application for.
	Scenarios []Scenario `json:"scenarios,omitempty"`

	// The list of objectives to optimize the application for.
	Objectives []Objective `json:"objectives,omitempty"`

	// StormForger allows you to configure StormForger to apply load on your application.
	StormForger *StormForger `json:"stormForger,omitempty"`

	// A count of the initial objectives, internally used to in name generation.
	InitialObjectiveCount int `json:"-"`
}

type ContainerResources struct {
	// Label selector of Kubernetes objects to consider when generating container resources patches.
	Selector string `json:"selector,omitempty"`
	// The names of the resources to optimize. Defaults to ["memory", "cpu"].
	Resources []corev1.ResourceName `json:"resources,omitempty"`
}

type CustomScenario struct {
	// Enables Prometheus Push Gateway support for objectives that require it.
	// The `PUSHGATEWAY_URL` environment variable will be added to all
	// containers when the trial job starts.
	UsePushGateway bool `json:"pushGateway,omitempty"`
	// The default specification of a pod to use for executing a trial.
	PodTemplate *corev1.PodTemplateSpec `json:"podTemplate,omitempty"`
	// Additional delay before starting the trial pod.
	InitialDelaySeconds int32 `json:"initialDelaySeconds,omitempty"`
	// The estimated amount of time the trial should last.
	ApproximateRuntimeSeconds int32 `json:"approximateRuntimeSeconds,omitempty"`
	// Override the image of the first container in the trial pod.
	Image string `json:"image,omitempty"`
}

type DatadogGoal struct {
	// The [Datadog](https://docs.datadoghq.com/tracing/trace_search_and_analytics/query_syntax/) query to execute.
	Query string `json:"query"`
	// The aggregator to use on the query results (one of: avg, last, max, min, sum).
	Aggregator string `json:"aggregator,omitempty"`
	// Flag indicating the goal of optimization should be to maximize a metric.
	Maximize bool `json:"maximize,omitempty"`
}

type DurationGoal struct {
	// The duration to optimize. Can be one of the following values: `trial`.
	DurationType
}

type DurationType string

type ErrorRateGoal struct {
	// The error rate to optimize. Can be one of the following values: `requests`.
	ErrorRateType
}

type ErrorRateType string

type Goal struct {
	// The name of the goal. If no specific configuration is supplied, the name is
	// used to derive a configuration. For example, any valid latency (prefixed or
	// suffixed with "latency") will configure a default latency goal.
	Name string `json:"name,omitempty"`
	// The upper bound for the objective.
	Max *resource.Quantity `json:"max,omitempty"`
	// The lower bound for the objective.
	Min *resource.Quantity `json:"min,omitempty"`
	// Flag indicating that this objective should optimized instead of monitored (default: true).
	Optimize *bool `json:"optimize,omitempty"`

	// Requests is used to optimize the resources consumed by an application.
	Requests *RequestsGoal `json:"requests,omitempty"`
	// Latency is used to optimize the responsiveness of an application.
	Latency *LatencyGoal `json:"latency,omitempty"`
	// ErrorRate is used to optimize the failure rate of an application.
	ErrorRate *ErrorRateGoal `json:"errorRate,omitempty"`
	// Duration is used to optimize the elapsed time of an application performing a fixed amount of work.
	Duration *DurationGoal `json:"duration,omitempty"`
	// Prometheus is used to optimize against a Prometheus metric.
	Prometheus *PrometheusGoal `json:"prometheus,omitempty"`
	// Datadog is used to optimize against a Datadog metric.
	Datadog *DatadogGoal `json:"datadog,omitempty"`

	// Internal use field for marking objectives as having been implemented. For example,
	// it may be impossible to optimize for some objectives based on the current state.
	Implemented bool `json:"-"`
}

type Ingress struct {
	// The URL used to access the application from outside the cluster.
	URL string `json:"url,omitempty"`
}

type LatencyGoal struct {
	// The latency to optimize. Can be one of the following values:
	// `minimum` (or `min`), `maximum` (or `max`), `mean` (or `average`, `avg`),
	// `percentile_50` (or `p50`, `median`, `med`), `percentile_95` (or `p95`),
	// `percentile_99` (or `p99`).
	LatencyType
}

type LatencyType string

type LocustScenario struct {
	// Path to a Python module file to import.
	Locustfile string `json:"locustfile,omitempty"`
	// Number of concurrent Locust users.
	Users *int `json:"users,omitempty"`
	// The rate per second in which users are spawned.
	SpawnRate *int `json:"spawnRate,omitempty"`
	// Stop after the specified amount of time.
	RunTime *metav1.Duration `json:"runTime,omitempty"`
}

type Objective struct {
	// The name of the objective. If omitted, a default name will be generated
	// based on the goals.
	Name string `json:"name,omitempty"`
	// The list of goals for the objective.
	Goals []Goal `json:"goals,omitempty"`
}

type Parameters struct {
	// Information related to the discovery of container resources parameters like CPU and memory.
	ContainerResources *ContainerResources `json:"containerResources,omitempty"`
	// Information related to the discovery of replica parameters.
	Replicas *Replicas `json:"replicas,omitempty"`
}

type PrometheusGoal struct {
	// The PromQL query to execute; the result of this query MUST be a scalar value.
	Query string `json:"query"`
	// The URL of the Prometheus deployment, leave blank to leverage a Prometheus instance
	// whose lifecycle it tied to the trial.
	URL string `json:"url,omitempty"`
	// Flag indicating the goal of optimization should be to maximize a metric.
	Maximize bool `json:"maximize,omitempty"`
}

type Replicas struct {
	// Label selector of Kubernetes objects to consider when generating replica patches.
	Selector string `json:"selector,omitempty"`
}

type RequestsGoal struct {
	// Label selector of the pods which should be considered when collecting cost information.
	Selector string `json:"selector,omitempty"`
	// Weights are used to determine which container resources should be optimized.
	Weights corev1.ResourceList `json:"weights,omitempty"`
}

type Scenario struct {
	// The name of scenario.
	Name string `json:"name,omitempty"`
	// StormForger configuration for the scenario.
	StormForger *StormForgerScenario `json:"stormforger,omitempty"`
	// Locust configuration for the scenario.
	Locust *LocustScenario `json:"locust,omitempty"`
	// Custom configuration for the scenario.
	Custom *CustomScenario `json:"custom,omitempty"`
}

type StormForger struct {
	// The name of the StormForger organization.
	Organization string `json:"org,omitempty"`
	// Configuration for the StormForger service account.
	AccessToken *StormForgerAccessToken `json:"accessToken,omitempty"`
}

type StormForgerAccessToken struct {
	// The path to the file that contains the service account access token.
	File string `json:"file,omitempty"`
	// A literal token value, this should only be used for testing as it is not secure.
	Literal string `json:"literal,omitempty"`
	// Reference to an existing secret key that contains the access token.
	SecretKeyRef *corev1.SecretKeySelector `json:"secretKeyRef,omitempty"`
}

type StormForgerScenario struct {
	// The test case can be used to specify an existing test case in the StormForger API or
	// it can be used to override the generated test case name when specified in conjunction
	// with the local test case file. The organization is optional if it is configured globally.
	TestCase string `json:"testCase,omitempty"`
	// Path to a local test case file used to define a new test case in the StormForger API.
	TestCaseFile string `json:"testCaseFile,omitempty"`
}