v1alpha1

type BenchmarkStatus struct {
	// Running shows the state of execution
	Running bool `json:"running"`
	// Completed shows the state of completion
	Completed bool `json:"completed"`
}

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

	Spec   DrillSpec       `json:"spec,omitempty"`
	Status BenchmarkStatus `json:"status,omitempty"`
}

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

type DrillSpec struct {
	// Image defines the drill docker image used for the benchmark
	Image ImageSpec `json:"image"`

	// BenchmarksVolume holds the content of benchmark files.
	// The key of the map specifies the filename and the value is the content
	// of the file. ConfigMap is created from the map which is mounted as
	// benchmarks directory to the benchmark pod.
	BenchmarksVolume map[string]string `json:"benchmarksVolume"`

	// BenchmarkFile is the entry point file (passed to --benchmark) specified to drill.
	BenchmarkFile string `json:"benchmarkFile"`

	// Options are appended to the options parameter set of drill
	// +optional
	Options string `json:"options,omitempty"`

	// PodConfig contains the configuration for the benchmark pod, including
	// pod labels and scheduling policies (affinity, toleration, node selector...)
	// +optional
	PodConfig PodConfigurationSpec `json:"podConfig,omitempty"`
}

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

	Spec   FioSpec         `json:"spec,omitempty"`
	Status BenchmarkStatus `json:"status,omitempty"`
}

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

type FioSpec struct {
	// Image defines the fio docker image used for the benchmark
	Image ImageSpec `json:"image"`

	// BuiltinJobFiles contains a list of fio job files that are already present
	// in the docker image
	// +optional
	BuiltinJobFiles []string `json:"builtinJobFiles,omitempty"`

	// CustomJobFiles contains a list of custom fio job files
	// The exact format of fio job files is documented here:
	// https://fio.readthedocs.io/en/latest/fio_doc.html#job-file-format
	// The job files defined here will be mounted to the fio benchmark container
	// +optional
	CustomJobFiles []string `json:"customJobFiles,omitempty"`

	// CmdLineArgs are appended to the predefined fio parameters
	// +optional
	CmdLineArgs string `json:"cmdLineArgs,omitempty"`

	// PodConfig contains the configuration for the benchmark pod, including
	// pod labels and scheduling policies (affinity, toleration, node selector...)
	// +optional
	PodConfig PodConfigurationSpec `json:"podConfig,omitempty"`

	// Volume contains the configuration for the volume that the fio job should
	// run on.
	Volume VolumeSpec `json:"volume"`
}

type ImageSpec struct {
	// Name is the Docker Image location including the tag
	Name string `json:"name"`

	// +optional
	PullPolicy PullPolicy `json:"pullPolicy,omitempty"`

	// PullSecret is an optional list of references to secrets
	// in the same namespace to use for pulling any of the images
	// +optional
	PullSecret string `json:"pullSecret,omitempty"`
}

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

	Spec   IopingSpec      `json:"spec,omitempty"`
	Status BenchmarkStatus `json:"status,omitempty"`
}

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

type IopingSpec struct {
	// Image defines the ioping docker image used for the benchmark
	Image ImageSpec `json:"image"`

	// Args are appended to the predefined ioping parameters
	// +optional
	Args string `json:"args,omitempty"`

	// PodConfig contains the configuration for the benchmark pod, including
	// pod labels and scheduling policies (affinity, toleration, node selector...)
	// +optional
	PodConfig PodConfigurationSpec `json:"podConfig,omitempty"`

	// Volume contains the configuration for the volume that the ioping job should
	// run on.
	Volume VolumeSpec `json:"volume"`
}

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

	Spec   Iperf3Spec      `json:"spec,omitempty"`
	Status BenchmarkStatus `json:"status,omitempty"`
}

type Iperf3ConfigurationSpec struct {
	PodConfigurationSpec `json:",inline"`

	// CmdLineArgs are appended to the predefined iperf3 parameters
	// +optional
	CmdLineArgs string `json:"cmdLineArgs,omitempty"`

	// HostNetwork requested for the iperf3 pod, if enabled the
	// hosts network namespace is used. Default to false.
	// +optional
	HostNetwork bool `json:"hostNetwork,omitempty"`
}

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

type Iperf3Spec struct {
	// Image defines the iperf3 docker image used for the benchmark
	Image ImageSpec `json:"image"`

	// ServerConfiguration contains the configuration of the iperf3 server
	// +optional
	ServerConfiguration Iperf3ConfigurationSpec `json:"serverConfiguration,omitempty"`

	// ClientConfiguration contains the configuration of the iperf3 client
	// +optional
	ClientConfiguration Iperf3ConfigurationSpec `json:"clientConfiguration,omitempty"`

	// UDP to use rather than TCP.
	// If enabled the '--udp' parameter is added to iperf command line args
	// +optional
	UDP bool `json:"udp,omitempty"`
}

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

	Spec   PgbenchSpec     `json:"spec,omitempty"`
	Status BenchmarkStatus `json:"status,omitempty"`
}

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

type PgbenchSpec struct {
	// Image defines the docker image used for the benchmark
	Image ImageSpec `json:"image"`

	// Postgres contains the configuration parameters for the PostgreSQL database
	// that will run the benchmark
	Postgres PostgresSpec `json:"postgres"`

	// InitArgs contains the command line arguments passed to the init container
	// +optional
	InitArgs string `json:"initArgs,omitempty"`

	// Args contains the command line arguments passed to the main pgbench container
	// +optional
	Args string `json:"args,omitempty"`

	// PodConfig contains the configuration for the benchmark pod, including
	// pod labels and scheduling policies (affinity, toleration, node selector...)
	// +optional
	PodConfig PodConfigurationSpec `json:"podConfig,omitempty"`
}

type PodConfigurationSpec struct {
	// PodLabels are added to the pod as labels.
	// +optional
	PodLabels map[string]string `json:"podLabels,omitempty"`

	// PodScheduling contains options to determine which
	// node the pod should be scheduled on
	// +optional
	PodScheduling PodSchedulingSpec `json:"podScheduling,omitempty"`

	// Resources required by the benchmark pod container
	// More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
	// +optional
	Resources corev1.ResourceRequirements `json:"resources,omitempty"`
}

type PodSchedulingSpec struct {
	// Affinity is a group of affinity scheduling rules.
	// +optional
	Affinity *corev1.Affinity `json:"affinity,omitempty"`

	// If specified, the pod's tolerations.
	// +optional
	Tolerations []corev1.Toleration `json:"tolerations,omitempty"`

	// A node selector represents the union of the results of
	// one or more label queries over a set of nodes; that is,
	// it represents the OR of the selectors represented by the
	// node selector terms.
	// +optional
	NodeSelector map[string]string `json:"nodeSelector,omitempty"`

	// NodeName is a request to schedule this pod onto a specific node. If it is non-empty,
	// the scheduler simply schedules this pod onto that node, assuming that it fits resource
	// requirements.
	// +optional
	NodeName string `json:"nodeName,omitempty"`
}

type PostgresSpec struct {
	// Host is the name of host to connect to
	Host string `json:"host"`

	// Port number to connect to at the server host
	Port int `json:"port"`

	// User is the PostgreSQL user name to connect as
	User string `json:"user"`

	// Password is to be used if the server demands password authentication
	Password string `json:"password"`

	// Database is name of the database
	Database string `json:"database"`
}

type PullPolicy string

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

	Spec   QperfSpec       `json:"spec,omitempty"`
	Status BenchmarkStatus `json:"status,omitempty"`
}

type QperfConfigurationSpec struct {
	PodConfigurationSpec `json:",inline"`

	// HostNetwork requested for the qperf pod, if enabled the
	// hosts network namespace is used. Default to false.
	// +optional
	HostNetwork bool `json:"hostNetwork,omitempty"`
}

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

type QperfSpec struct {
	// Image defines the qperf docker image used for the benchmark
	Image ImageSpec `json:"image"`

	// Options are options for the qperf binary
	// +optional
	Options string `json:"options,omitempty"`

	// Tests are the tests that we would like to run
	Tests []string `json:"tests"`

	// ServerConfiguration contains the configuration of the qperf server
	// +optional
	ServerConfiguration QperfConfigurationSpec `json:"serverConfiguration,omitempty"`

	// ClientConfiguration contains the configuration of the qperf client
	// +optional
	ClientConfiguration QperfConfigurationSpec `json:"clientConfiguration,omitempty"`
}

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

	Spec   SysbenchSpec    `json:"spec,omitempty"`
	Status BenchmarkStatus `json:"status,omitempty"`
}

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

type SysbenchSpec struct {
	// Image defines the sysbench docker image used for the benchmark
	Image ImageSpec `json:"image"`

	// PodConfig contains the configuration for the benchmark pod, including
	// pod labels and scheduling policies (affinity, toleration, node selector...)
	// +optional
	PodConfig PodConfigurationSpec `json:"podConfig,inline"`

	// Options is a list of zero or more command line options starting with '--'.
	// +optional
	Options string `json:"options,omitempty"`

	// TestName is the name of a built-in test (e.g. `fileio`, `memory`, `cpu`, etc.), or a name of one of the bundled
	// Lua scripts (e.g. `oltp_read_only`), or a path to a custom Lua script.
	TestName string `json:"testName"`

	// Command is an optional argument that will be passed by sysbench to the built-in test or script specified with
	// TestName. Command defines the action that must be performed by the test. The list of available commands depends
	// on a particular test. Some tests also implement their own custom commands.
	// +optional
	Command string `json:"command,omitempty"`
}

type VolumeSpec struct {
	// VolumeSource represents the source of the volume, e.g. EmptyDir,
	// HostPath, Ceph, PersistentVolumeClaim, etc.
	// PersistentVolumeClaim.claimName can be set to point to an already
	// existing PVC or could be set to 'GENERATED'. When set to 'GENERATED'
	// The PVC will be created based on the PersistentVolumeClaimSpec provided
	// to the VolumeSpec.
	VolumeSource corev1.VolumeSource `json:"volumeSource"`

	// PersistentVolumeClaimSpec describes the persistent volume claim that will be
	// created and used by the pod. If specified, the VolumeSource.PersistentVolumeClaim's
	// claimName must be set to 'GENERATED'
	// +optional
	PersistentVolumeClaimSpec *corev1.PersistentVolumeClaimSpec `json:"persistentVolumeClaimSpec,omitempty"`
}