v1alpha1

type AZBlobStorage struct {
	// The data will be stored in the container.
	// +required
	Container string `json:"container"`

	// The secret of storing the credentials of account name and account key.
	// The secret should contain keys named `account-name` and `account-key`.
	// The secret must be the same namespace with the GreptimeDBCluster resource.
	// +optional
	SecretName string `json:"secretName,omitempty"`

	// The Blob directory path.
	// +required
	Root string `json:"root"`

	// The Blob Storage endpoint.
	// +optional
	Endpoint string `json:"endpoint,omitempty"`
}

type BackendStorage struct {
	// EtcdStorage is the specification for etcd storage for meta.
	// +optional
	EtcdStorage *EtcdStorage `json:"etcd,omitempty"`

	// MySQLStorage is the specification for MySQL storage for meta.
	// +optional
	MySQLStorage *MySQLStorage `json:"mysql,omitempty"`

	// PostgreSQLStorage is the specification for PostgreSQL storage for meta.
	// +optional
	PostgreSQLStorage *PostgreSQLStorage `json:"postgresql,omitempty"`
}

type CacheStorage struct {
	// Storage is the storage specification for the cache.
	// If the storage is not specified, the cache will use DatanodeStorageSpec.
	// +optional
	FileStorage *FileStorage `json:"fs,omitempty"`

	// CacheCapacity is the capacity of the cache.
	// +optional
	CacheCapacity string `json:"cacheCapacity,omitempty"`
}

type ComponentSpec struct {
	// The number of replicas of the components.
	// +optional
	// +kubebuilder:validation:Minimum=0
	Replicas *int32 `json:"replicas,omitempty"`

	// The content of the configuration file of the component in TOML format.
	// +optional
	Config string `json:"config,omitempty"`

	// Template defines the pod template for the component, if not specified, the pod template will use the default value.
	// +optional
	Template *PodTemplateSpec `json:"template,omitempty"`

	// Logging defines the logging configuration for the component.
	// +optional
	Logging *LoggingSpec `json:"logging,omitempty"`

	// Tracing defines the tracing configuration for the component.
	// +optional
	Tracing *TracingSpec `json:"tracing,omitempty"`
}

type Condition struct {
	// Type of deployment condition.
	Type ConditionType `json:"type"`

	// Status of the condition, one of True, False, Unknown.
	Status corev1.ConditionStatus `json:"status"`

	// The last time this condition was updated.
	LastUpdateTime metav1.Time `json:"lastUpdateTime,omitempty"`

	// Last time the condition transitioned from one status to another.
	// +optional
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`

	// The reason for the condition's last transition.
	// +optional
	Reason string `json:"reason,omitempty"`

	// A human-readable message indicating details about the transition.
	// +optional
	Message string `json:"message,omitempty"`
}

type ConditionType string

type ConfigMergeStrategy string

type DatanodeSpec struct {
	ComponentSpec `json:",inline"`

	// Name is the name of the datanode.
	// +optional
	Name string `json:"name,omitempty"`

	// RPCPort is the gRPC port of the datanode.
	// +kubebuilder:validation:Minimum=0
	// +kubebuilder:validation:Maximum=65535
	// +optional
	RPCPort int32 `json:"rpcPort,omitempty"`

	// HTTPPort is the HTTP port of the datanode.
	// +kubebuilder:validation:Minimum=0
	// +kubebuilder:validation:Maximum=65535
	// +optional
	HTTPPort int32 `json:"httpPort,omitempty"`

	// Storage is the default file storage of the datanode. For example, WAL, cache, index etc.
	// +optional
	Storage *DatanodeStorageSpec `json:"storage,omitempty"`

	// RollingUpdate is the rolling update configuration. We always use `RollingUpdate` strategy.
	// +optional
	RollingUpdate *appsv1.RollingUpdateStatefulSetStrategy `json:"rollingUpdate,omitempty"`
}

type DatanodeStatus struct {
	// Replicas is the number of replicas of the datanode.
	Replicas int32 `json:"replicas"`

	// ReadyReplicas is the number of ready replicas of the datanode.
	ReadyReplicas int32 `json:"readyReplicas"`
}

type DatanodeStorageSpec struct {
	// DataHome is the home directory of the data.
	DataHome string `json:"dataHome,omitempty"`

	// FileStorage is the file storage configuration.
	// +optional
	FileStorage *FileStorage `json:"fs,omitempty"`
}

type EtcdStorage struct {
	// The endpoints of the etcd cluster.
	// +required
	Endpoints []string `json:"endpoints"`

	// EnableCheckEtcdService indicates whether to check etcd cluster health when starting meta.
	// +optional
	EnableCheckEtcdService bool `json:"enableCheckEtcdService,omitempty"`

	// StoreKeyPrefix is the prefix of the key in the etcd. We can use it to isolate the data of different clusters.
	// +optional
	StoreKeyPrefix string `json:"storeKeyPrefix,omitempty"`
}

type FileStorage struct {
	// Name is the name of the PVC that will be created.
	// +optional
	Name string `json:"name,omitempty"`

	// UseEmptyDir is a flag to indicate whether to use an empty dir. If true, the PVC will not be created and the whole storage of datanode will be cleaned up when the datanode restarts.
	// +optional
	UseEmptyDir *bool `json:"useEmptyDir,omitempty"`

	// StorageClassName is the name of the StorageClass to use for the PVC.
	// +optional
	StorageClassName *string `json:"storageClassName,omitempty"`

	// StorageSize is the size of the storage.
	// +optional
	// +kubebuilder:validation:Pattern=(^([+-]?[0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$)
	StorageSize string `json:"storageSize,omitempty"`

	// MountPath is the path where the storage will be mounted in the container.
	// +optional
	MountPath string `json:"mountPath,omitempty"`

	// StorageRetainPolicy is the policy of the storage. It can be `Retain` or `Delete`.
	// +optional
	// +kubebuilder:validation:Enum:={"Retain", "Delete"}
	StorageRetainPolicy StorageRetainPolicyType `json:"storageRetainPolicy,omitempty"`

	// Labels is the labels for the PVC.
	// +optional
	Labels map[string]string `json:"labels,omitempty"`

	// Annotations is the annotations for the PVC.
	// +optional
	Annotations map[string]string `json:"annotations,omitempty"`
}

type FileStorageAccessor interface {
	GetName() string
	GetStorageClassName() *string
	GetSize() string
	GetMountPath() string
	GetPolicy() StorageRetainPolicyType
	GetLabels() map[string]string
	GetAnnotations() map[string]string
}

type FlownodeSpec struct {
	ComponentSpec `json:",inline"`

	// The gRPC port of the flownode.
	// +kubebuilder:validation:Minimum=0
	// +kubebuilder:validation:Maximum=65535
	// +optional
	RPCPort int32 `json:"rpcPort,omitempty"`

	// The HTTP port of the flownode.
	// +kubebuilder:validation:Minimum=0
	// +kubebuilder:validation:Maximum=65535
	// +optional
	HTTPPort int32 `json:"httpPort,omitempty"`

	// RollingUpdate is the rolling update configuration. We always use `RollingUpdate` strategy.
	// +optional
	RollingUpdate *appsv1.RollingUpdateStatefulSetStrategy `json:"rollingUpdate,omitempty"`
}

type FlownodeStatus struct {
	// Replicas is the number of replicas of the flownode.
	Replicas int32 `json:"replicas"`

	// ReadyReplicas is the number of ready replicas of the flownode.
	ReadyReplicas int32 `json:"readyReplicas"`
}

type FrontendSpec struct {
	ComponentSpec `json:",inline"`

	// Name is the name of the frontend.
	// +optional
	Name string `json:"name,omitempty"`

	// RPCPort is the gRPC port of the frontend.
	// +kubebuilder:validation:Minimum=0
	// +kubebuilder:validation:Maximum=65535
	// +optional
	RPCPort int32 `json:"rpcPort,omitempty"`

	// HTTPPort is the HTTP port of the frontend.
	// +kubebuilder:validation:Minimum=0
	// +kubebuilder:validation:Maximum=65535
	// +optional
	HTTPPort int32 `json:"httpPort,omitempty"`

	// MySQLPort is the MySQL port of the frontend.
	// +kubebuilder:validation:Minimum=0
	// +kubebuilder:validation:Maximum=65535
	// +optional
	MySQLPort int32 `json:"mysqlPort,omitempty"`

	// PostgreSQLPort is the PostgreSQL port of the frontend.
	// +kubebuilder:validation:Minimum=0
	// +kubebuilder:validation:Maximum=65535
	// +optional
	PostgreSQLPort int32 `json:"postgreSQLPort,omitempty"`

	// InternalPort is the internal gRPC port of the frontend.
	// +kubebuilder:validation:Minimum=0
	// +kubebuilder:validation:Maximum=65535
	// +optional
	InternalPort *int32 `json:"internalPort,omitempty"`

	// Service is the service configuration of the frontend.
	// +optional
	Service *ServiceSpec `json:"service,omitempty"`

	// TLS is the TLS configuration of the frontend.
	// +optional
	TLS *TLSSpec `json:"tls,omitempty"`

	// RollingUpdate is the rolling update configuration. We always use `RollingUpdate` strategyt.
	// +optional
	RollingUpdate *appsv1.RollingUpdateDeployment `json:"rollingUpdate,omitempty"`

	// SlowQuery is the slow query configuration.
	// +optional
	SlowQuery *SlowQuery `json:"slowQuery,omitempty"`
}

type FrontendStatus struct {
	// Replicas is the number of replicas of the frontend.
	Replicas int32 `json:"replicas"`

	// ReadyReplicas is the number of ready replicas of the frontend.
	ReadyReplicas int32 `json:"readyReplicas"`
}

type GCSStorage struct {
	// The data will be stored in the bucket.
	// +required
	Bucket string `json:"bucket"`

	// The gcs directory path.
	// +required
	Root string `json:"root"`

	// The secret of storing Credentials for gcs service OAuth2 authentication.
	// The secret should contain keys named `service-account-key`.
	// The secret must be the same namespace with the GreptimeDBCluster resource.
	// +optional
	SecretName string `json:"secretName,omitempty"`

	// The scope for gcs.
	// +optional
	Scope string `json:"scope,omitempty"`

	// The endpoint URI of gcs service.
	// +optional
	Endpoint string `json:"endpoint,omitempty"`
}

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

	// Spec is the specification of the desired state of the GreptimeDBCluster.
	Spec GreptimeDBClusterSpec `json:"spec,omitempty"`

	// Status is the most recently observed status of the GreptimeDBCluster.
	Status GreptimeDBClusterStatus `json:"status,omitempty"`
}

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

type GreptimeDBClusterSpec struct {
	// Base is the base pod template for all components and can be overridden by template of individual component.
	// +optional
	Base *PodTemplateSpec `json:"base,omitempty"`

	// Frontend is the specification of frontend node.
	// +optional
	Frontend *FrontendSpec `json:"frontend,omitempty"`

	// Meta is the specification of meta node.
	// +optional
	Meta *MetaSpec `json:"meta,omitempty"`

	// Datanode is the specification of datanode node.
	// +optional
	Datanode *DatanodeSpec `json:"datanode,omitempty"`

	// DatanodeGroups is a group of datanode statefulsets.
	// +optional
	DatanodeGroups []*DatanodeSpec `json:"datanodeGroups,omitempty"`

	// Flownode is the specification of flownode node.
	// +optional
	Flownode *FlownodeSpec `json:"flownode,omitempty"`

	// FrontendGroups is groups of frontend node.
	// +optional
	FrontendGroups []*FrontendSpec `json:"frontendGroups,omitempty"`

	// HTTPPort is the HTTP port of the greptimedb cluster.
	// +kubebuilder:validation:Minimum=0
	// +kubebuilder:validation:Maximum=65535
	// +optional
	HTTPPort int32 `json:"httpPort,omitempty"`

	// RPCPort is the RPC port of the greptimedb cluster.
	// +kubebuilder:validation:Minimum=0
	// +kubebuilder:validation:Maximum=65535
	// +optional
	RPCPort int32 `json:"rpcPort,omitempty"`

	// MySQLPort is the MySQL port of the greptimedb cluster.
	// +kubebuilder:validation:Minimum=0
	// +kubebuilder:validation:Maximum=65535
	// +optional
	MySQLPort int32 `json:"mysqlPort,omitempty"`

	// PostgreSQLPort is the PostgreSQL port of the greptimedb cluster.
	// +kubebuilder:validation:Minimum=0
	// +kubebuilder:validation:Maximum=65535
	// +optional
	PostgreSQLPort int32 `json:"postgreSQLPort,omitempty"`

	// PrometheusMonitor is the specification for creating PodMonitor or ServiceMonitor.
	// +optional
	PrometheusMonitor *PrometheusMonitorSpec `json:"prometheusMonitor,omitempty"`

	// Version is the version of greptimedb.
	// +optional
	Version string `json:"version,omitempty"`

	// Initializer is the init container to set up components configurations before running the container.
	// +optional
	Initializer *InitializerSpec `json:"initializer,omitempty"`

	// ObjectStorageProvider is the storage provider for the greptimedb cluster.
	// +optional
	ObjectStorageProvider *ObjectStorageProviderSpec `json:"objectStorage,omitempty"`

	// WALProvider is the WAL provider for the greptimedb cluster.
	// +optional
	WALProvider *WALProviderSpec `json:"wal,omitempty"`

	// The global logging configuration for all components. It can be overridden by the logging configuration of individual component.
	// +optional
	Logging *LoggingSpec `json:"logging,omitempty"`

	// Monitoring is the specification for monitor bootstrapping. It will create a standalone greptimedb instance to monitor the cluster.
	// +optional
	Monitoring *MonitoringSpec `json:"monitoring,omitempty"`

	// Ingress is the Ingress configuration of the frontend.
	// +optional
	Ingress *IngressSpec `json:"ingress,omitempty"`

	// The global tracing configuration for all components. It can be overridden by the tracing configuration of individual component.
	// +optional
	Tracing *TracingSpec `json:"tracing,omitempty"`

	// ConfigMergeStrategy is the strategy for merging the input config with the config that generated by the operator.
	// +optional
	ConfigMergeStrategy ConfigMergeStrategy `json:"configMergeStrategy,omitempty"`
}

type GreptimeDBClusterStatus struct {
	// Frontend is the status of frontend node.
	// +optional
	Frontend FrontendStatus `json:"frontend,omitempty"`

	// Meta is the status of meta node.
	// +optional
	Meta MetaStatus `json:"meta,omitempty"`

	// Datanode is the status of datanode node.
	// +optional
	Datanode DatanodeStatus `json:"datanode,omitempty"`

	// Flownode is the status of flownode node.
	// +optional
	Flownode FlownodeStatus `json:"flownode,omitempty"`

	// The status of the monitoring service.
	// +optional
	Monitoring MonitoringStatus `json:"monitoring,omitempty"`

	// Version is the version of greptimedb.
	// +optional
	Version string `json:"version,omitempty"`

	// ClusterPhase is the phase of the greptimedb cluster.
	// +optional
	ClusterPhase Phase `json:"clusterPhase,omitempty"`

	// Conditions is an array of current conditions.
	// +optional
	Conditions []Condition `json:"conditions,omitempty"`

	// ObservedGeneration is the last observed generation.
	// +optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
}

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

	// Spec is the specification of the desired state of the GreptimeDBStandalone.
	Spec GreptimeDBStandaloneSpec `json:"spec,omitempty"`

	// Status is the most recently observed status of the GreptimeDBStandalone.
	Status GreptimeDBStandaloneStatus `json:"status,omitempty"`
}

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

type GreptimeDBStandaloneSpec struct {
	// Base is the base pod template for all components and can be overridden by template of individual component.
	// +optional
	Base *PodTemplateSpec `json:"base,omitempty"`

	// Service is the service configuration of greptimedb.
	// +optional
	Service *ServiceSpec `json:"service,omitempty"`

	// The TLS configurations of the greptimedb.
	// +optional
	TLS *TLSSpec `json:"tls,omitempty"`

	// HTTPPort is the port of the greptimedb http service.
	// +kubebuilder:validation:Minimum=0
	// +kubebuilder:validation:Maximum=65535
	// +optional
	HTTPPort int32 `json:"httpPort,omitempty"`

	// RPCPort is the port of the greptimedb rpc service.
	// +kubebuilder:validation:Minimum=0
	// +kubebuilder:validation:Maximum=65535
	// +optional
	RPCPort int32 `json:"rpcPort,omitempty"`

	// MySQLPort is the port of the greptimedb mysql service.
	// +kubebuilder:validation:Minimum=0
	// +kubebuilder:validation:Maximum=65535
	// +optional
	MySQLPort int32 `json:"mysqlPort,omitempty"`

	// PostgreSQLPort is the port of the greptimedb postgresql service.
	// +kubebuilder:validation:Minimum=0
	// +kubebuilder:validation:Maximum=65535
	// +optional
	PostgreSQLPort int32 `json:"postgreSQLPort,omitempty"`

	// PrometheusMonitor is the specification for creating PodMonitor or ServiceMonitor.
	// +optional
	PrometheusMonitor *PrometheusMonitorSpec `json:"prometheusMonitor,omitempty"`

	// Version is the version of the greptimedb.
	// +optional
	Version string `json:"version,omitempty"`

	// Initializer is the init container to set up components configurations before running the container.
	// +optional
	Initializer *InitializerSpec `json:"initializer,omitempty"`

	// ObjectStorageProvider is the storage provider for the greptimedb cluster.
	// +optional
	ObjectStorageProvider *ObjectStorageProviderSpec `json:"objectStorage,omitempty"`

	// DatanodeStorage is the default file storage of the datanode. For example, WAL, cache, index etc.
	// +optional
	DatanodeStorage *DatanodeStorageSpec `json:"datanodeStorage,omitempty"`

	// WALProvider is the WAL provider for the greptimedb cluster.
	// +optional
	WALProvider *WALProviderSpec `json:"wal,omitempty"`

	// The content of the configuration file of the component in TOML format.
	// +optional
	Config string `json:"config,omitempty"`

	// Logging defines the logging configuration for the component.
	// +optional
	Logging *LoggingSpec `json:"logging,omitempty"`

	// RollingUpdate is the rolling update configuration. We always use `RollingUpdate` strategy.
	// +optional
	RollingUpdate *appsv1.RollingUpdateStatefulSetStrategy `json:"rollingUpdate,omitempty"`

	// SlowQuery is the slow query configuration.
	// +optional
	SlowQuery *SlowQuery `json:"slowQuery,omitempty"`

	// Tracing defines the tracing configuration for the component.
	// +optional
	Tracing *TracingSpec `json:"tracing,omitempty"`

	// ConfigMergeStrategy is the strategy for merging the input config with the config that generated by the operator.
	// +optional
	ConfigMergeStrategy ConfigMergeStrategy `json:"configMergeStrategy,omitempty"`
}

type GreptimeDBStandaloneStatus struct {
	// Version is the version of the greptimedb.
	// +optional
	Version string `json:"version,omitempty"`

	// StandalonePhase is the phase of the greptimedb standalone.
	// +optional
	StandalonePhase Phase `json:"standalonePhase,omitempty"`

	// Conditions represent the latest available observations of an object's current state.
	// +optional
	Conditions []Condition `json:"conditions,omitempty"`

	// ObservedGeneration is the most recent generation observed for this GreptimeDBStandalone.
	// +optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
}

type IngressBackend struct {
	// Name is the referenced frontend name.
	// +optional
	Name string `json:"name,omitempty"`

	// Path is matched against the path of an incoming request.
	// +optional
	Path string `json:"path,omitempty"`

	// PathType determines the interpretation of the path matching.
	// +optional
	PathType *networkingv1.PathType `json:"pathType,omitempty"`
}

type IngressRule struct {
	// Host is the fully qualified domain name of a network host.
	// +optional
	Host string `json:"host,omitempty"`

	// IngressBackend is the Ingress backend configuration.
	// +optional
	IngressBackend []IngressBackend `json:"backends,omitempty"`
}

type IngressSpec struct {
	// Annotations is the annotations for the ingress.
	// +optional
	Annotations map[string]string `json:"annotations,omitempty"`

	// Labels is the labels for the ingress.
	// +optional
	Labels map[string]string `json:"labels,omitempty"`

	// IngressClassName is the name of an IngressClass.
	// +optional
	IngressClassName *string `json:"ingressClassName,omitempty"`

	// IngressRule is a list of host rules used to configure the Ingress.
	// +optional
	Rules []IngressRule `json:"rules,omitempty"`

	// TLS is the Ingress TLS configuration.
	// +optional
	TLS []networkingv1.IngressTLS `json:"tls,omitempty"`
}

type InitializerSpec struct {
	// The image of the initializer.
	// +optional
	Image string `json:"image,omitempty"`
}

type KafkaWAL struct {
	// BrokerEndpoints is the list of Kafka broker endpoints.
	// +required
	BrokerEndpoints []string `json:"brokerEndpoints"`
}

type LogFormat string

type LogPipeline struct {
	// The content of the pipeline configuration file in YAML format.
	// +optional
	Data string `json:"data,omitempty"`
}

type LoggingLevel string

type LoggingSpec struct {
	// Level is the level of the logging.
	// +optional
	// +kubebuilder:validation:Enum:={"info", "error", "warn", "debug"}
	Level LoggingLevel `json:"level,omitempty"`

	// Filters is the filters of the logging.
	// User can use [EnvFilter](https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html) to filter the logging.
	// We can use `target[span{field=value}]=level` to filter the logging by target and span field.
	// For example, "mito2=debug" will filter the logging of target `mito2` to `debug` level.
	// +optional
	Filters []string `json:"filters,omitempty"`

	// LogsDir is the directory path of the logs.
	// +optional
	LogsDir string `json:"logsDir,omitempty"`

	// PersistentWithData indicates whether to persist the log with the datanode data storage. It **ONLY** works for the datanode component.
	// If false, the log will be stored in ephemeral storage.
	// +optional
	PersistentWithData *bool `json:"persistentWithData,omitempty"`

	// OnlyLogToStdout indicates whether to only log to stdout. If true, the log will not be stored in the storage even if the storage is configured.
	// +optional
	OnlyLogToStdout *bool `json:"onlyLogToStdout,omitempty"`

	// Format is the format of the logging.
	// +optional
	// +kubebuilder:validation:Enum:={"json", "text"}
	Format LogFormat `json:"format,omitempty"`
}

type LogsCollectionSpec struct {
	// The specification of the log pipeline.
	// +optional
	Pipeline *LogPipeline `json:"pipeline,omitempty"`
}

type MainContainerSpec struct {
	// The main container image name of the component.
	// +optional
	Image string `json:"image,omitempty"`

	// The resource requirements of the main container.
	// +optional
	Resources corev1.ResourceRequirements `json:"resources,omitempty"`

	// Entrypoint array. Not executed within a shell.
	// The container image's ENTRYPOINT is used if this is not provided.
	// Variable references `$(VAR_NAME)` are expanded using the container's environment. If a variable
	// cannot be resolved, the reference in the input string will be unchanged. Double `$$` are reduced
	// to a single `$`, which allows for escaping the `$(VAR_NAME)` syntax: i.e. `$$(VAR_NAME)` will
	// produce the string literal `$(VAR_NAME)`. Escaped references will never be expanded, regardless
	// of whether the variable exists or not. Cannot be updated.
	// More info: `https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell`
	// Command field is from `corev1.Container.Command`.
	// +optional
	Command []string `json:"command,omitempty"`

	// Arguments to the entrypoint.
	// The container image's CMD is used if this is not provided.
	// Variable references `$(VAR_NAME)` are expanded using the container's environment. If a variable
	// cannot be resolved, the reference in the input string will be unchanged. Double `$$` are reduced
	// to a single `$`, which allows for escaping the `$(VAR_NAME)` syntax: i.e. `$$(VAR_NAME)` will
	// produce the string literal `$(VAR_NAME)`. Escaped references will never be expanded, regardless
	// of whether the variable exists or not. Cannot be updated.
	// More info: `https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell`
	// Args field is from `corev1.Container.Args`.
	// +optional
	Args []string `json:"args,omitempty"`

	// ExtraArgs specifies additional command-line arguments for the container entrypoint.
	// These arguments will be appended to the default command line.
	// +optional
	ExtraArgs []string `json:"extraArgs,omitempty"`

	// Container's working directory.
	// If not specified, the container runtime's default will be used, which
	// might be configured in the container image.
	// Cannot be updated.
	// WorkingDir field is from `corev1.Container.WorkingDir`.
	// +optional
	WorkingDir string `json:"workingDir,omitempty"`

	// List of environment variables to set in the container.
	// Cannot be updated.
	// Env field is from `corev1.Container.Env`.
	// +optional
	Env []corev1.EnvVar `json:"env,omitempty"`

	// Periodic probe of container liveness.
	// Container will be restarted if the probe fails.
	// More info: `https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes`
	// LivenessProbe field is from `corev1.Container.LivenessProbe`.
	// +optional
	LivenessProbe *corev1.Probe `json:"livenessProbe,omitempty"`

	// Periodic probe of container service readiness.
	// Container will be removed from service endpoints if the probe fails.
	// ReadinessProbe field is from `corev1.Container.LivenessProbe`.
	// More info: `https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes`
	// +optional
	ReadinessProbe *corev1.Probe `json:"readinessProbe,omitempty"`

	// StartupProbe indicates that the Pod has successfully initialized.
	// If specified, no other probes are executed until this completes successfully.
	// If this probe fails, the Pod will be restarted, just as if the livenessProbe failed.
	// This can be used to provide different probe parameters at the beginning of a Pod's lifecycle,
	// when it might take a long time to load data or warm a cache, than during steady-state operation.
	// This cannot be updated.
	// More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
	// +optional
	StartupProbe *corev1.Probe `json:"startupProbe,omitempty"`

	// Actions that the management system should take in response to container lifecycle events.
	// Cannot be updated.
	// Lifecycle field is from `corev1.Container.Lifecycle`.
	// +optional
	Lifecycle *corev1.Lifecycle `json:"lifecycle,omitempty"`

	// Image pull policy.
	// One of `Always`, `Never`, `IfNotPresent`.
	// Defaults to `Always` if `:latest` tag is specified, or IfNotPresent otherwise.
	// Cannot be updated.
	// More info: `https://kubernetes.io/docs/concepts/containers/images#updating-images`
	// ImagePullPolicy field is from `corev1.Container.ImagePullPolicy`.
	// +optional
	ImagePullPolicy corev1.PullPolicy `json:"imagePullPolicy,omitempty"`

	// Pod volumes to mount into the container's filesystem.
	// Cannot be updated.
	// +optional
	VolumeMounts []corev1.VolumeMount `json:"volumeMounts,omitempty"`

	// SecurityContext holds container-level security attributes and common settings.
	// +optional
	SecurityContext *corev1.SecurityContext `json:"securityContext,omitempty"`
}

type MetaSpec struct {
	ComponentSpec `json:",inline"`

	// RPCPort is the gRPC port of the meta.
	// +kubebuilder:validation:Minimum=0
	// +kubebuilder:validation:Maximum=65535
	// +optional
	RPCPort int32 `json:"rpcPort,omitempty"`

	// HTTPPort is the HTTP port of the meta.
	// +kubebuilder:validation:Minimum=0
	// +kubebuilder:validation:Maximum=65535
	// +optional
	HTTPPort int32 `json:"httpPort,omitempty"`

	// BackendStorage is the specification for the backend storage for meta.
	// +optional
	BackendStorage *BackendStorage `json:"backendStorage,omitempty"`

	// EtcdEndpoints is the endpoints of the etcd cluster.
	// +optional
	// +kubebuilder:deprecatedversion:warning="EtcdEndpoints is deprecated and will be removed in a future version. Please use BackendStorage instead."
	EtcdEndpoints []string `json:"etcdEndpoints,omitempty"`

	// EnableCheckEtcdService indicates whether to check etcd cluster health when starting meta.
	// +optional
	// +kubebuilder:deprecatedversion:warning="EnableCheckEtcdService is deprecated and will be removed in a future version. Please use BackendStorage instead."
	EnableCheckEtcdService bool `json:"enableCheckEtcdService,omitempty"`

	// EnableRegionFailover indicates whether to enable region failover.
	// +optional
	EnableRegionFailover *bool `json:"enableRegionFailover,omitempty"`

	// StoreKeyPrefix is the prefix of the key in the etcd. We can use it to isolate the data of different clusters.
	// +optional
	// +kubebuilder:deprecatedversion:warning="StoreKeyPrefix is deprecated and will be removed in a future version. Please use BackendStorage instead."
	StoreKeyPrefix string `json:"storeKeyPrefix,omitempty"`

	// RollingUpdate is the rolling update configuration. We always use `RollingUpdate` strategyt.
	// +optional
	RollingUpdate *appsv1.RollingUpdateDeployment `json:"rollingUpdate,omitempty"`
}

type MetaStatus struct {
	// Replicas is the number of replicas of the meta.
	Replicas int32 `json:"replicas"`

	// ReadyReplicas is the number of ready replicas of the meta.
	ReadyReplicas int32 `json:"readyReplicas"`

	// EtcdEndpoints is the endpoints of the etcd cluster.
	// +optional
	EtcdEndpoints []string `json:"etcdEndpoints,omitempty"`

	// MaintenanceMode is the maintenance mode of the meta.
	MaintenanceMode bool `json:"maintenanceMode"`
}

type MonitoringSpec struct {
	// Enabled indicates whether to enable the monitoring service.
	// +required
	Enabled bool `json:"enabled"`

	// The specification of the standalone greptimedb instance.
	// +optional
	Standalone *GreptimeDBStandaloneSpec `json:"standalone,omitempty"`

	// The specification of cluster logs collection.
	// +optional
	LogsCollection *LogsCollectionSpec `json:"logsCollection,omitempty"`

	// The specification of the vector instance.
	// +optional
	Vector *VectorSpec `json:"vector,omitempty"`
}

type MonitoringStatus struct {
	// InternalDNSName is the internal DNS name of the monitoring service. For example, 'mycluster-standalone-monitor.default.svc.cluster.local'.
	// +optional
	InternalDNSName string `json:"internalDNSName,omitempty"`
}

type MySQLStorage struct {
	// Host is the host of the MySQL database.
	// +required
	Host string `json:"host"`

	// Port is the port of the MySQL database.
	// +kubebuilder:validation:Minimum=0
	// +kubebuilder:validation:Maximum=65535
	Port int32 `json:"port"`

	// CredentialsSecretName is the name of the secret that contains the credentials for the MySQL database.
	// The secret must be in the same namespace with the greptime resource.
	// The secret must contain keys named `username` and `password`.
	// +required
	CredentialsSecretName string `json:"credentialsSecretName"`

	// Database is the name of the MySQL database.
	// +optional
	Database string `json:"database,omitempty"`

	// Table is the name of the MySQL table.
	// +optional
	Table string `json:"table,omitempty"`
}

type OSSStorage struct {
	// The data will be stored in the bucket.
	// +required
	Bucket string `json:"bucket"`

	// The region of the bucket.
	// +required
	Region string `json:"region"`

	// The secret of storing the credentials of access key id and access key secret.
	// The secret should contain keys named `access-key-id` and `access-key-secret`.
	// The secret must be the same namespace with the GreptimeDBCluster resource.
	// +optional
	SecretName string `json:"secretName,omitempty"`

	// The OSS directory path.
	// +required
	Root string `json:"root"`

	// The endpoint of the bucket.
	// +optional
	Endpoint string `json:"endpoint,omitempty"`
}

type ObjectStorageProviderAccessor interface {
	GetS3Storage() *S3Storage
	GetGCSStorage() *GCSStorage
	GetOSSStorage() *OSSStorage
	GetAZBlobStorage() *AZBlobStorage
	GetCacheFileStorage() *FileStorage
	GetCacheStorage() *CacheStorage
}

type ObjectStorageProviderSpec struct {
	// S3 is the AWS S3 storage configuration.
	// +optional
	S3 *S3Storage `json:"s3,omitempty"`

	// OSS is the Aliyun OSS storage configuration.
	// +optional
	OSS *OSSStorage `json:"oss,omitempty"`

	// GCS is the Google cloud storage configuration.
	// +optional
	GCS *GCSStorage `json:"gcs,omitempty"`

	// AZBlob is the Azure Blob storage configuration.
	// +optional
	AZBlob *AZBlobStorage `json:"azblob,omitempty"`

	// Cache is the cache storage configuration for object storage.
	// +optional
	Cache *CacheStorage `json:"cache,omitempty"`
}

type Phase string

type PodTemplateSpec struct {
	// The annotations to be created to the pod.
	// +optional
	Annotations map[string]string `json:"annotations,omitempty"`

	// The labels to be created to the pod.
	// +optional
	Labels map[string]string `json:"labels,omitempty"`

	// MainContainer defines the specification of the main container of the pod.
	// +optional
	MainContainer *MainContainerSpec `json:"main,omitempty"`

	// SlimPodSpec defines the desired behavior of the pod.
	// +optional
	SlimPodSpec `json:",inline"`
}

type PostgreSQLStorage struct {
	// Host is the host of the PostgreSQL database.
	// +required
	Host string `json:"host"`

	// Port is the port of the PostgreSQL database.
	// +kubebuilder:validation:Minimum=0
	// +kubebuilder:validation:Maximum=65535
	Port int32 `json:"port"`

	// CredentialsSecretName is the name of the secret that contains the credentials for the PostgreSQL database.
	// The secret must be in the same namespace with the greptime resource.
	// The secret must contain keys named `username` and `password`.
	// +required
	CredentialsSecretName string `json:"credentialsSecretName"`

	// Database is the name of the PostgreSQL database.
	// +optional
	Database string `json:"database,omitempty"`

	// Table is the name of the PostgreSQL table.
	// +optional
	Table string `json:"table,omitempty"`

	// ElectionLockID it the lock id in PostgreSQL for election.
	ElectionLockID uint64 `json:"electionLockID,omitempty"`
}

type PrometheusMonitorSpec struct {
	// Enabled indicates whether the PodMonitor is enabled.
	// +required
	Enabled bool `json:"enabled"`

	// Labels is the labels for the PodMonitor.
	// +optional
	Labels map[string]string `json:"labels"`

	// Interval is the scape interval for the PodMonitor.
	// +optional
	Interval string `json:"interval,omitempty"`
}

type RaftEngineWAL struct {
	// FileStorage is the file storage configuration for the raft-engine WAL.
	// If the file storage is not specified, WAL will use DatanodeStorageSpec.
	// +optional
	FileStorage *FileStorage `json:"fs,omitempty"`
}

type RoleKind string

type RoleSpec interface {
	// GetName returns the spec name if it has. It will return empty string if the spec has no name.
	GetName() string

	// GetRoleKind returns the role kind.
	GetRoleKind() RoleKind
}

type S3Storage struct {
	// The data will be stored in the bucket.
	// +required
	Bucket string `json:"bucket"`

	// The region of the bucket.
	// +required
	Region string `json:"region"`

	// The secret of storing the credentials of access key id and secret access key.
	// The secret should contain keys named `access-key-id` and `secret-access-key`.
	// The secret must be the same namespace with the GreptimeDBCluster resource.
	// +optional
	SecretName string `json:"secretName,omitempty"`

	// The S3 directory path.
	// +required
	Root string `json:"root"`

	// The endpoint of the bucket.
	// +optional
	Endpoint string `json:"endpoint,omitempty"`

	// Enable virtual host style so that OpenDAL will send API requests in virtual host style instead of path style.
	// By default, OpenDAL will send API to 'https://s3.us-east-1.amazonaws.com/${BUCKET_NAME}'.
	// If EnableVirtualHostStyle is true, OpenDAL will send API to 'https://${BUCKET_NAME}.s3.us-east-1.amazonaws.com'.
	// +optional
	EnableVirtualHostStyle bool `json:"enableVirtualHostStyle,omitempty"`
}

type ServiceSpec struct {
	// Type is the type of the service.
	// +optional
	Type corev1.ServiceType `json:"type,omitempty"`

	// Annotations is the annotations for the service.
	// +optional
	Annotations map[string]string `json:"annotations,omitempty"`

	// Labels is the labels for the service.
	// +optional
	Labels map[string]string `json:"labels,omitempty"`

	// LoadBalancerClass is the class of the load balancer.
	// +optional
	LoadBalancerClass *string `json:"loadBalancerClass,omitempty"`
}

type SlimPodSpec struct {
	// NodeSelector is a selector which must be true for the pod to fit on a node.
	// Selector which must match a node's labels for the pod to be scheduled on that node.
	// More info: `https://kubernetes.io/docs/concepts/configuration/assign-pod-node/`
	// NodeSelector field is from `corev1.PodSpec.NodeSelector`.
	// +optional
	NodeSelector map[string]string `json:"nodeSelector,omitempty"`

	// List of initialization containers belonging to the pod.
	// Init containers are executed in order prior to containers being started. If any
	// init container fails, the pod is considered to have failed and is handled according
	// to its restartPolicy. The name for an init container or normal container must be
	// unique among all containers.
	// Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes.
	// The resourceRequirements of an init container are taken into account during scheduling
	// by finding the highest request/limit for each resource type, and then using the max of
	// that value or the sum of the normal containers. Limits are applied to init containers
	// in a similar fashion.
	// Init containers cannot currently be added or removed.
	// Cannot be updated.
	// More info: `https://kubernetes.io/docs/concepts/workloads/pods/init-containers/`
	// InitContainers field is from `corev1.PodSpec.InitContainers`.
	// +optional
	InitContainers []corev1.Container `json:"initContainers,omitempty"`

	// Restart policy for all containers within the pod.
	// One of `Always`, `OnFailure`, `Never`.
	// Default to `Always`.
	// More info: `https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy`
	// RestartPolicy field is from `corev1.PodSpec.RestartPolicy`.
	// +optional
	RestartPolicy corev1.RestartPolicy `json:"restartPolicy,omitempty"`

	// Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request.
	// Value must be non-negative integer. The value zero indicates stop immediately via
	// the kill signal (no opportunity to shut down).
	// If this value is nil, the default grace period will be used instead.
	// The grace period is the duration in seconds after the processes running in the pod are sent
	// a termination signal and the time when the processes are forcibly halted with a kill signal.
	// Set this value longer than the expected cleanup time for your process.
	// Defaults to 30 seconds.
	// TerminationGracePeriodSeconds field is from `corev1.PodSpec.TerminationGracePeriodSeconds`.
	// +optional
	TerminationGracePeriodSeconds *int64 `json:"terminationGracePeriodSeconds,omitempty"`

	// Optional duration in seconds the pod may be active on the node relative to
	// StartTime before the system will actively try to mark it failed and kill associated containers.
	// Value must be a positive integer.
	// ActiveDeadlineSeconds field is from `corev1.PodSpec.ActiveDeadlineSeconds`.
	// +optional
	ActiveDeadlineSeconds *int64 `json:"activeDeadlineSeconds,omitempty"`

	// Set DNS policy for the pod.
	// Defaults to `ClusterFirst`.
	// Valid values are `ClusterFirstWithHostNet`, `ClusterFirst`, `Default` or `None`.
	// DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy.
	// To have DNS options set along with hostNetwork, you have to specify DNS policy
	// explicitly to `ClusterFirstWithHostNet`.
	// DNSPolicy field is from `corev1.PodSpec.DNSPolicy`.
	// +optional
	DNSPolicy corev1.DNSPolicy `json:"dnsPolicy,omitempty"`

	// ServiceAccountName is the name of the ServiceAccount to use to run this pod.
	// More info: `https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/`
	// ServiceAccountName field is from `corev1.PodSpec.ServiceAccountName`.
	// +optional
	ServiceAccountName string `json:"serviceAccountName,omitempty"`

	// Host networking requested for this pod. Use the host's network namespace.
	// If this option is set, the ports that will be used must be specified.
	// Default to `false`.
	// HostNetwork field is from `corev1.PodSpec.HostNetwork`.
	// +optional
	HostNetwork bool `json:"hostNetwork,omitempty"`

	// ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec.
	// If specified, these secrets will be passed to individual puller implementations for them to use.
	// More info: `https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod`
	// ImagePullSecrets field is from `corev1.PodSpec.ImagePullSecrets`.
	// +optional
	ImagePullSecrets []corev1.LocalObjectReference `json:"imagePullSecrets,omitempty"`

	// If specified, the pod's scheduling constraints
	// Affinity field is from `corev1.PodSpec.Affinity`.
	// +optional
	Affinity *corev1.Affinity `json:"affinity,omitempty"`

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

	// If specified, the pod will be dispatched by specified scheduler.
	// If not specified, the pod will be dispatched by default scheduler.
	// SchedulerName field is from `corev1.PodSpec.SchedulerName`.
	// +optional
	SchedulerName string `json:"schedulerName,omitempty"`

	// For most time, there is one main container in a pod(`frontend`/`meta`/`datanode`/`flownode`).
	// If specified, additional containers will be added to the pod as sidecar containers.
	// +optional
	AdditionalContainers []corev1.Container `json:"additionalContainers,omitempty"`

	// List of volumes that can be mounted by containers belonging to the pod.
	// +optional
	Volumes []corev1.Volume `json:"volumes,omitempty"`

	// SecurityContext holds pod-level security attributes and common container settings.
	// +optional
	SecurityContext *corev1.PodSecurityContext `json:"securityContext,omitempty"`
}

type SlowQuery struct {
	// Enabled indicates whether the slow query is enabled.
	// +optional
	Enabled bool `json:"enabled,omitempty"`

	// RecordType is the type of the slow query record. Default to `system_table`.
	// +optional
	RecordType SlowQueryRecordType `json:"recordType,omitempty"`

	// Threshold is the threshold of the slow query. Default to `30s`.
	// +optional
	// +kubebuilder:validation:Pattern="^([0-9]+(\\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$"
	Threshold string `json:"threshold,omitempty"`

	// SampleRatio is the sampling ratio of slow query log. The value should be in the range of (0, 1]. Default to `1.0`.
	// +optional
	// +kubebuilder:validation:Pattern=`^(0?\.\d+|1(\.0+)?)$`
	// +kubebuilder:validation:Type=string
	SampleRatio string `json:"sampleRatio,omitempty"`

	// TTL is the TTL of the slow query log. Default to `90d`.
	// +optional
	// +kubebuilder:validation:Pattern="^([0-9]+(\\.[0-9]+)?(ns|us|µs|ms|s|m|h|d))+$"
	TTL string `json:"ttl,omitempty"`
}

type SlowQueryRecordType string

type StorageRetainPolicyType string

type TLSSpec struct {
	// SecretName is the name of the secret that contains the TLS certificates.
	// The secret must be in the same namespace with the greptime resource.
	// The secret must contain keys named `tls.crt` and `tls.key`.
	// +required
	SecretName string `json:"secretName"`
}

type TracingSpec struct {
	// Enabled indicates whether to enable OTLP tracing.
	// +optional
	Enabled *bool `json:"enabled,omitempty"`

	// Endpoint it the OTLP tracing endpoint.
	// +optional
	Endpoint string `json:"endpoint,omitempty"`

	// SampleRatio is the percentage of tracing will be sampled and exported.
	// Valid range `[0, 1]`, 1 means all traces are sampled, 0 means all traces are not sampled, the default value is 1.
	SampleRatio string `json:"sampleRatio,omitempty"`
}

type VectorSpec struct {
	// The image of the vector instance.
	// +optional
	Image string `json:"image,omitempty"`

	// The resources of the vector instance.
	// +optional
	Resources corev1.ResourceRequirements `json:"resources,omitempty"`
}

type WALProviderSpec struct {
	// RaftEngineWAL is the specification for local WAL that uses raft-engine.
	// +optional
	RaftEngineWAL *RaftEngineWAL `json:"raftEngine,omitempty"`

	// KafkaWAL is the specification for remote WAL that uses Kafka.
	// +optional
	KafkaWAL *KafkaWAL `json:"kafka,omitempty"`
}