v1beta1

type CertificateSecret struct {
	// Name of secret in the local namespace
	// +operator-sdk:csv:customresourcedefinitions:type=spec,xDescriptors={"urn:alm:descriptor:io.kubernetes:Secret"}
	SecretName string `json:"secretName"`
	// Key within secret containing the certificate
	// +optional
	CertificateKey *string `json:"certificateKey,omitempty"`
}

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

	Spec   CryostatSpec   `json:"spec,omitempty"`
	Status CryostatStatus `json:"status,omitempty"`
}

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

type CryostatSpec struct {
	// Deploy a pared-down Cryostat instance with no Grafana dashboard or jfr-datasource
	// and no web-client UI.
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Minimal Deployment",xDescriptors={"urn:alm:descriptor:com.tectonic.ui:booleanSwitch"}
	Minimal bool `json:"minimal"`
	// List of TLS certificates to trust when connecting to targets
	// +optional
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Trusted TLS Certificates"
	TrustedCertSecrets []CertificateSecret `json:"trustedCertSecrets,omitempty"`
	// Options to customize the storage for Flight Recordings and Templates
	// +optional
	// +operator-sdk:csv:customresourcedefinitions:type=spec
	StorageOptions *StorageConfiguration `json:"storageOptions,omitempty"`
	// Options to control how the operator exposes the application over a network
	// +optional
	NetworkOptions *NetworkConfigurationList `json:"networkOptions,omitempty"`
}

type CryostatStatus struct {
	// +operator-sdk:csv:customresourcedefinitions:type=status,xDescriptors={"urn:alm:descriptor:org.w3:link"}
	ApplicationURL string `json:"applicationUrl"`
}

type EventInfo struct {
	// The ID used by JFR to uniquely identify this event type
	TypeID string `json:"typeId"`
	// Human-readable name for this type of event
	Name string `json:"name"`
	// A description detailing what this event does
	Description string `json:"description"`
	// A hierarchical category used to organize related event types
	// +listType=atomic
	Category []string `json:"category"`
	// Options that may be used to tune this event. This map is indexed
	// by the option IDs.
	Options map[string]OptionDescriptor `json:"options"`
}

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

	Spec   FlightRecorderSpec   `json:"spec,omitempty"`
	Status FlightRecorderStatus `json:"status,omitempty"`
}

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

type FlightRecorderSpec struct {
	// Recordings that match this selector belong to this FlightRecorder
	// +operator-sdk:csv:customresourcedefinitions:type=spec
	RecordingSelector *metav1.LabelSelector `json:"recordingSelector"`
	// If JMX authentication is enabled for this FlightRecorder's JVM, specify the credentials in a secret
	// and reference it here
	// +optional
	// +operator-sdk:csv:customresourcedefinitions:type=spec
	JMXCredentials *JMXAuthSecret `json:"jmxCredentials,omitempty"`
}

type FlightRecorderStatus struct {
	// Listing of events available in the target JVM
	// +operator-sdk:csv:customresourcedefinitions:type=status
	// +listType=atomic
	Events []EventInfo `json:"events"`
	// Listing of templates available in the target JVM
	// +operator-sdk:csv:customresourcedefinitions:type=status
	// +listType=atomic
	Templates []TemplateInfo `json:"templates"`
	// Reference to the pod/service that this object controls JFR for
	// +operator-sdk:csv:customresourcedefinitions:type=status
	Target *corev1.ObjectReference `json:"target"`
	// JMX port for target JVM
	// +operator-sdk:csv:customresourcedefinitions:type=status,xDescriptors={"urn:alm:descriptor:text"}
	// +kubebuilder:validation:Minimum=0
	Port int32 `json:"port"`
}

type JMXAuthSecret struct {
	// Name of secret in the local namespace
	SecretName string `json:"secretName"`
	// Key within secret containing the username, defaults to DefaultUsernameKey
	// +optional
	UsernameKey *string `json:"usernameKey,omitempty"`
	// Key within secret containing the password, defaults to DefaultPasswordKey
	// +optional
	PasswordKey *string `json:"passwordKey,omitempty"`
}

type NetworkConfiguration struct {
	// Configuration for an ingress object.
	// Currently subpaths are not supported, so unique hosts must be specified
	// (if a single external IP is being used) to differentiate between ingresses/services
	// +optional
	IngressSpec *netv1.IngressSpec `json:"ingressSpec,omitempty"`
	// Annotations to add to the ingress during its creation.
	// +optional
	Annotations map[string]string `json:"annotations,omitempty"`
	// Labels to add to the ingress during its creation.
	// The label with key "app" is reserved for use by the operator.
	// +optional
	Labels map[string]string `json:"labels,omitempty"`
}

type NetworkConfigurationList struct {
	// Specifications for ingress that exposes the cryostat service
	// (which serves the cryostat web-client)
	// +optional
	CoreConfig *NetworkConfiguration `json:"coreConfig,omitempty"`
	// Specifications for ingress that exposes the cryostat-command service
	// (which serves the websocket command channel)
	// +optional
	CommandConfig *NetworkConfiguration `json:"commandConfig,omitempty"`
	// Specifications for ingress that exposes the cryostat-grafana service
	// (which serves the grafana dashboard)
	// +optional
	GrafanaConfig *NetworkConfiguration `json:"grafanaConfig,omitempty"`
}

type OptionDescriptor struct {
	// Human-readable name for this option
	Name string `json:"name"`
	// A description of what this option does
	Description string `json:"description"`
	// The value implicitly used when this option isn't specified
	DefaultValue string `json:"defaultValue"`
}

type PersistentVolumeClaimConfig struct {
	// Annotations to add to the Persistent Volume Claim during its creation.
	// +optional
	Annotations map[string]string `json:"annotations,omitempty"`
	// Labels to add to the Persistent Volume Claim during its creation.
	// The label with key "app" is reserved for use by the operator.
	// +optional
	Labels map[string]string `json:"labels,omitempty"`
	// Spec for a Persistent Volume Claim, whose options will override the
	// defaults used by the operator. Unless overriden, the PVC will be
	// created with the default Storage Class and 500MiB of storage.
	// Once the operator has created the PVC, changes to this field have
	// no effect.
	// +optional
	// +operator-sdk:csv:customresourcedefinitions:type=spec
	Spec *corev1.PersistentVolumeClaimSpec `json:"spec,omitempty"`
}

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

	Spec   RecordingSpec   `json:"spec,omitempty"`
	Status RecordingStatus `json:"status,omitempty"`
}

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

type RecordingSpec struct {
	// Name of the recording to be created.
	// +operator-sdk:csv:customresourcedefinitions:type=spec
	Name string `json:"name"`

	// A list of event options to use when creating the recording.
	// These are used to enable and fine-tune individual events.
	// Examples: "jdk.ExecutionSample:enabled=true", "jdk.ExecutionSample:period=200ms"
	// +operator-sdk:csv:customresourcedefinitions:type=spec,xDescriptors={"urn:alm:descriptor:com.tectonic.ui:text"}
	// +listType=atomic
	EventOptions []string `json:"eventOptions"`
	// The requested total duration of the recording, a zero value will record indefinitely.
	// +operator-sdk:csv:customresourcedefinitions:type=spec,xDescriptors={"urn:alm:descriptor:com.tectonic.ui:number"}
	Duration metav1.Duration `json:"duration"`

	// +optional
	State *RecordingState `json:"state,omitempty"`
	// Whether this recording should be saved to persistent storage. If true, the JFR file will be retained until
	// this object is deleted. If false, the JFR file will be deleted when its corresponding JVM exits.
	// +operator-sdk:csv:customresourcedefinitions:type=spec,xDescriptors={"urn:alm:descriptor:com.tectonic.ui:checkbox"}
	Archive bool `json:"archive"`
	// Reference to the FlightRecorder object that corresponds to this Recording
	// +operator-sdk:csv:customresourcedefinitions:type=spec
	FlightRecorder *corev1.LocalObjectReference `json:"flightRecorder"`
}

type RecordingState string

type RecordingStatus struct {
	// Current state of the recording.
	// +kubebuilder:validation:Enum=CREATED;RUNNING;STOPPING;STOPPED
	// +operator-sdk:csv:customresourcedefinitions:type=status,xDescriptors={"urn:alm:descriptor:text"}
	// +optional
	State *RecordingState `json:"state,omitempty"`
	// The date/time when the recording started.
	// +operator-sdk:csv:customresourcedefinitions:type=status,xDescriptors={"urn:alm:descriptor:text"}
	// +optional
	StartTime metav1.Time `json:"startTime,omitempty"`
	// The duration of the recording specified during creation.
	// +operator-sdk:csv:customresourcedefinitions:type=status,xDescriptors={"urn:alm:descriptor:text"}
	// +optional
	Duration metav1.Duration `json:"duration,omitempty"`
	// A URL to download the JFR file for the recording.
	// +operator-sdk:csv:customresourcedefinitions:type=status,xDescriptors={"urn:alm:descriptor:org.w3:link"}
	// +optional
	DownloadURL *string `json:"downloadURL,omitempty"`
	// A URL to download the autogenerated HTML report for the recording
	// +operator-sdk:csv:customresourcedefinitions:type=status,xDescriptors={"urn:alm:descriptor:org.w3:link"}
	// +optional
	ReportURL *string `json:"reportURL,omitempty"`
}

type StorageConfiguration struct {
	// Configuration for the Persistent Volume Claim to be created
	// by the operator.
	// +optional
	// +operator-sdk:csv:customresourcedefinitions:type=spec
	PVC *PersistentVolumeClaimConfig `json:"pvc,omitempty"`
}

type TemplateInfo struct {
	// The name of the template
	Name string `json:"name"`
	// A description of the template and its performance impact
	Description string `json:"description"`
	// The organization which has provided the template
	Provider string `json:"provider"`
	// The type of template, which is either "TARGET" for built-in templates,
	// or "CUSTOM" for user created templates
	// +kubebuilder:validation:Enum=TARGET;CUSTOM
	Type TemplateType `json:"type"`
}

type TemplateType string