v1

type ConfigMapRef struct {
	// Name of the `ConfigMap`
	Name string `json:"name,omitempty"`
	// ConfigMap key containing the Stroom configuration data
	ItemName string `json:"itemName,omitempty"`
}

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

	Spec   DatabaseBackupSpec   `json:"spec,omitempty"`
	Status DatabaseBackupStatus `json:"status,omitempty"`
}

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

type DatabaseBackupSpec struct {
	// +kubebuilder:validation:Required
	Image           Image             `json:"image"`
	ImagePullPolicy corev1.PullPolicy `json:"imagePullPolicy,omitempty"`
	// DatabaseServerRef contains either the details of a DatabaseServer resource, or the TCP connection details of
	// an external MySQL database
	// +kubebuilder:validation:Required
	DatabaseServerRef DatabaseServerRef `json:"databaseServerRef"`
	// Backup the specified database names. If unspecified, all user databases are backed up
	DatabaseNames []string `json:"databaseNames,omitempty"`
	// File system location to store the backup files
	TargetVolume corev1.VolumeSource `json:"volume"`
	// Cron schedule that determines how often backups are to be performed
	Schedule string `json:"schedule"`
}

type DatabaseBackupStatus struct {
}

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

	Spec   DatabaseServerSpec   `json:"spec,omitempty"`
	Status DatabaseServerStatus `json:"status,omitempty"`

	// Set by the controller when a StroomCluster binds to the DatabaseServer.
	// This is used to prevent the DatabaseServer from being deleted while its paired StroomCluster still exists.
	// +optional
	StroomClusterRef ResourceRef `json:"stroomClusterRef,omitempty"`
}

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

type DatabaseServerRef struct {
	// If specified, point to an operator-managed DatabaseServer object
	// +optional
	ServerRef ResourceRef `json:"serverRef,omitempty"`
	// Alternatively, if the following parameters are provided, point directly to a DB by its TCP address.
	// This allows external database instances to be used in place of an operator-managed one.
	ServerAddress ServerAddress `json:"serverAddress,omitempty"`
	// UserName is the name of the Stroom database user to use when connecting to the server.
	// A corresponding key should exist in the provided Secret referenced by SecretName.
	// +kubebuilder:default:=stroomuser
	UserName string `json:"userName,omitempty"`
}

type DatabaseServerSpec struct {
	Image           Image             `json:"image"`
	ImagePullPolicy corev1.PullPolicy `json:"imagePullPolicy,omitempty"`
	// Names of the databases to be created on startup (if they don't already exist)
	DatabaseNames []string `json:"databaseNames"`
	// Any additional configuration lines to append to the MySQL server configuration file `/etc/my.cnf`
	AdditionalConfig      []string                         `json:"additionalConfig,omitempty"`
	Resources             corev1.ResourceRequirements      `json:"resources"`
	VolumeClaim           corev1.PersistentVolumeClaimSpec `json:"volumeClaim"`
	ReadinessProbeTimings ProbeTimings                     `json:"readinessProbeTimings,omitempty"`
	LivenessProbeTimings  ProbeTimings                     `json:"livenessProbeTimings,omitempty"`
	PodAnnotations        map[string]string                `json:"podAnnotations,omitempty"`
	PodSecurityContext    corev1.PodSecurityContext        `json:"podSecurityContext,omitempty"`
	SecurityContext       corev1.SecurityContext           `json:"securityContext,omitempty"`
	NodeSelector          map[string]string                `json:"nodeSelector,omitempty"`
	Tolerations           []corev1.Toleration              `json:"tolerations,omitempty"`
	Affinity              corev1.Affinity                  `json:"affinity,omitempty"`
}

type DatabaseServerStatus struct {
	State   string `json:"state"`
	Address string `json:"address"`
	Port    int32  `json:"port"`
}

type Image struct {
	// +kubebuilder:validation:MinLength=1
	Repository string `json:"repository"`
	Tag        string `json:"tag,omitempty"`
}

type IngressSettings struct {
	// DNS name at which the application will be reached (e.g. stroom.example.com)
	HostName string `json:"hostName"`
	// Name of the TLS `Secret` containing the private key and server certificate for the `Ingress`
	SecretName string `json:"secretName"`
	// Ingress class name (e.g. nginx)
	ClassName string `json:"className,omitempty"`
}

type JvmMemoryOptions struct {
	// +kubebuilder:validation:Minimum=1
	// +kubebuilder:validation:Maximum=100
	InitialPercentage int `json:"initialPercentage"`
	// +kubebuilder:validation:Minimum=1
	// +kubebuilder:validation:Maximum=100
	MaxPercentage int `json:"maxPercentage"`
}

type LogSenderSettings struct {
	// If `true`, Stroom internal audit and application logs are sent to the Stroom `Ingress` for ingestion
	// +kubebuilder:default:=false
	Enabled bool `json:"enabled"`
	// +kubebuilder:validation:Required
	Image           Image             `json:"image"`
	ImagePullPolicy corev1.PullPolicy `json:"imagePullPolicy,omitempty"`
	// Override the container security context
	SecurityContext corev1.SecurityContext `json:"securityContext,omitempty"`
	// Configure an alternate destination for events to be shipped to. If omitted, events are posted to the local cluster.
	DestinationUrl string `json:"destinationUrl,omitempty"`
	// Name of the `Environment` to set in feed metadata. If omitted, the cluster name is used (converted to UPPERCASE).
	EnvironmentName string `json:"environmentName,omitempty"`
	// Name of the `System` to set in feed metadata
	SystemName string                      `json:"systemName,omitempty"`
	Resources  corev1.ResourceRequirements `json:"resources,omitempty"`
}

type NodeRole string

type NodeSet struct {
	// Name uniquely identifies the NodeSet within a StroomCluster. Should be a short name like "prod".
	//
	// The NodeSet name determines the name of the Stroom node, which follows the format:
	// `stroom-<cluster name>-node-<nodeset name>-<pod ordinal>`.
	//
	// For example, the first Stroom node in StroomCluster `dev`, NodeSet `data` will be named:
	// `stroom-dev-node-data-0`.
	Name string `json:"name"`
	// Number of replicas (discrete Stroom nodes) to deploy in the NodeSet
	// +kubebuilder:validation:Minimum=1
	Count int32 `json:"count"`
	// Role of each node in the NodeSet. ProcessingNodeRole nodes are limited to receiving and processing data,
	// while FrontendNodeRole nodes host the Stroom.
	//
	// If this property is omitted, nodes in the NodeSet will assume both Processing and Frontend roles.
	Role NodeRole `json:"role,omitempty"`
	// LocalDataVolumeClaim provides persistent storage for each Stroom node's data
	LocalDataVolumeClaim corev1.PersistentVolumeClaimSpec `json:"localDataVolumeClaim"`
	// Resources determine how much CPU and memory each individual Stroom node Pod within the NodeSet requests and is
	// limited to.
	Resources corev1.ResourceRequirements `json:"resources"`
	// MemoryOptions define JVM memory parameters
	MemoryOptions JvmMemoryOptions `json:"memoryOptions"`
	// IngressEnabled determines whether this node receives requests via the created Kubernetes Ingresses. Usually this
	// should be `true`, unless there is a need for a NodeSet to be pure processing-only nodes, which cannot receive data.
	// +kubebuilder:default:=true
	IngressEnabled bool `json:"ingressEnabled,omitempty"`
	// IngressAnnotations is an optional map of annotations to apply to the NodeSet's Ingress. These override any
	// default annotations provided by the controller.
	IngressAnnotations map[string]string `json:"ingressAnnotations,omitempty"`
	// StartupProbeTimings specify parameters for initial Pod startup. These should be set according to how long a node
	// typically takes to start up and respond to healthchecks.
	StartupProbeTimings ProbeTimings `json:"startupProbeTimings,omitempty"`
	// ReadinessProbeTimings determine the parameters for readiness probes. These help to protect nodes from overload,
	// removing them from service while they are non-responsive to healthchecks.
	ReadinessProbeTimings ProbeTimings `json:"readinessProbeTimings,omitempty"`
	// LivenessProbeTimings determine the parameters for liveness probes. If a Pod fails successive probes, it is
	// restarted.
	LivenessProbeTimings ProbeTimings `json:"livenessProbeTimings,omitempty"`
	// PodAnnotations are additional annotations to set for each NodeSet Pod
	PodAnnotations map[string]string `json:"podAnnotations,omitempty"`
	// PodSecurityContext applies to each NodeSet Pod
	PodSecurityContext corev1.PodSecurityContext `json:"podSecurityContext,omitempty"`
	// SecurityContext overrides the PodSecurityContext at the container level
	SecurityContext corev1.SecurityContext `json:"securityContext,omitempty"`
	// NodeSelector allows for NodeSet Pods to be deployed to a particular node, or set of nodes, by the specified labels
	NodeSelector map[string]string   `json:"nodeSelector,omitempty"`
	Tolerations  []corev1.Toleration `json:"tolerations,omitempty"`
	Affinity     corev1.Affinity     `json:"affinity,omitempty"`
}

type OpenIdConfiguration struct {
	// Name of the OpenID client
	ClientId string `json:"clientId"`
	// Details of the Secret containing the OpenID client secret
	ClientSecret SecretItem `json:"clientSecret"`
}

type ProbeTimings struct {
	// +kubebuilder:default:=5
	InitialDelaySeconds int32 `json:"initialDelaySeconds,omitempty"`
	// +kubebuilder:default:=5
	TimeoutSeconds int32 `json:"timeoutSeconds,omitempty"`
	// +kubebuilder:default:=5
	PeriodSeconds int32 `json:"periodSeconds,omitempty"`
	// +kubebuilder:default:=1
	SuccessThreshold int32 `json:"successThreshold,omitempty"`
	// +kubebuilder:default:=10
	FailureThreshold int32 `json:"failureThreshold,omitempty"`
}

type ResourceRef struct {
	Name      string `json:"name"`
	Namespace string `json:"namespace,omitempty"`
}

type SecretItem struct {
	SecretName string `json:"secretName"`
	Key        string `json:"key"`
}

type ServerAddress struct {
	// Host is the hostname or IP of the database server
	Host string `json:"host,omitempty"`
	// Port number the database server is listening on
	// +kubebuilder:default:=3306
	Port int32 `json:"port,omitempty"`
	// SecretName is the name of the secret containing the `password` of the database user `stroomuser`
	SecretName string `json:"secretName,omitempty"`
}

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

	Spec   StroomClusterSpec   `json:"spec,omitempty"`
	Status StroomClusterStatus `json:"status,omitempty"`
}

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

type StroomClusterSpec struct {
	// +kubebuilder:validation:Required
	Image           Image             `json:"image"`
	ImagePullPolicy corev1.PullPolicy `json:"imagePullPolicy,omitempty"`
	// DatabaseServerRef contains either the details of a DatabaseServer resource, or the TCP connection details of
	// an external MySQL database
	// +kubebuilder:validation:Required
	DatabaseServerRef DatabaseServerRef `json:"databaseServerRef"`
	// Name of the main Stroom database, usually `stroom`
	// +kubebuilder:default:="stroom"
	// +kubebuilder:validation:MinLength=1
	AppDatabaseName string `json:"appDatabaseName"`
	// Name of the statistics database, usually `stats`
	// +kubebuilder:default:="stats"
	// +kubebuilder:validation:MinLength=1
	StatsDatabaseName string `json:"statsDatabaseName"`
	// Override the Stroom configuration provided to each node, by providing the name of an existing `ConfigMap`
	// in the same namespace as the `StroomCluster`
	ConfigMapRef ConfigMapRef `json:"configMapRef,omitempty"`
	// Configures OpenID to enable operator components to query the Stroom API
	OpenId OpenIdConfiguration `json:"openId"`
	// +kubebuilder:validation:Required
	Ingress IngressSettings `json:"ingress"`
	// Pod management policy to use when deploying or scaling the StroomCluster
	PodManagementPolicy v1.PodManagementPolicyType `json:"podManagementPolicy,omitempty"`
	// Amount of time granted to nodes to drain their active tasks before being terminated
	// +kubebuilder:default:=60
	NodeTerminationPeriodSecs int64 `json:"nodeTerminationPeriodSecs"`
	// Delete Stroom node `PersistentVolumeClaim`s in accordance with this policy
	VolumeClaimDeletePolicy VolumeClaimDeletePolicy `json:"volumeClaimDeletePolicy,omitempty"`

	// Each NodeSet is a functional grouping of Stroom nodes with a particular role, within the cluster.
	// It is recommended two NodeSets should be provided: one for storing and processing data and a separate one for
	// serving the Stroom front-end.
	// +kubebuilder:validation:MinItems=1
	NodeSets []NodeSet `json:"nodeSets"`

	// Additional Java Virtual Machine (JVM) options to use. Example of a valid entry: `-Xms1g`
	ExtraJvmOpts []string `json:"extraJvmOpts,omitempty"`
	// Additional environment variables provided to each NodeSet pod
	ExtraEnv []corev1.EnvVar `json:"extraEnv,omitempty"`
	// Additional volumes to be mounted in each NodeSet pod
	ExtraVolumes      []corev1.Volume      `json:"extraVolumes,omitempty"`
	ExtraVolumeMounts []corev1.VolumeMount `json:"extraVolumeMounts,omitempty"`

	// Configures the mechanism that posts internal audit and logging to Stroom
	LogSender LogSenderSettings `json:"logSender,omitempty"`
}

type StroomClusterStatus struct {
	Nodes []string `json:"nodes,omitempty"`
}

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

	Spec   StroomTaskAutoscalerSpec   `json:"spec,omitempty"`
	Status StroomTaskAutoscalerStatus `json:"status,omitempty"`
}

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

type StroomTaskAutoscalerSpec struct {
	// The target StroomCluster to apply autoscaling to
	StroomClusterRef ResourceRef `json:"stroomClusterRef"`

	// Name of the Stroom node task to auto-scale. Usually "Data Processor".
	// +kubebuilder:validation:Required
	TaskName string `json:"taskName"`

	// How often (in minutes) adjustments are made to the number of Stroom node tasks
	// +kubebuilder:default:=1
	// +kubebuilder:validation:Minimum:=1
	AdjustmentIntervalMins int `json:"adjustmentIntervalMins,omitempty"`

	// Sliding window (in minutes) over which to calculate CPU usage vs. the threshold parameters
	// +kubebuilder:default:=1
	// +kubebuilder:validation:Minimum:=1
	MetricsSlidingWindowMins int `json:"metricsSlidingWindowMins,omitempty"`

	// Minimum CPU usage threshold before the number of tasks is adjusted upwards
	// +kubebuilder:default:=50
	MinCpuPercent int `json:"minCpuPercent,omitempty"`

	// Maximum CPU usage threshold before the number of tasks is adjusted downwards
	// +kubebuilder:default:=90
	MaxCpuPercent int `json:"maxCpuPercent,omitempty"`

	// Minimum number of tasks auto-scaler may set the node limit to
	// +kubebuilder:default:=1
	MinTaskLimit int `json:"minTaskLimit,omitempty"`

	// Maximum number of tasks auto-scaler may set the node limit to
	// +kubebuilder:default:=20
	MaxTaskLimit int `json:"maxTaskLimit,omitempty"`

	// Number of tasks to add/subtract each adjustment interval, based on usage
	// +kubebuilder:default:=1
	// +kubebuilder:validation:Minimum:=1
	StepAmount int `json:"stepAmount,omitempty"`
}

type StroomTaskAutoscalerStatus struct {
}

type VolumeClaimDeletePolicy string