v1

type ArbiterSpec struct {
	Enable bool `json:"enable,omitempty"`
	// DisableMasterNodeToleration can be used to turn off the arbiter mon toleration for the master node taint.
	DisableMasterNodeToleration bool                          `json:"disableMasterNodeToleration,omitempty"`
	ArbiterMonPVCTemplate       *corev1.PersistentVolumeClaim `json:"arbiterMonPVCTemplate,omitempty"`
}

type BackingStorageClass struct {
	metav1.ObjectMeta `json:"metadata,omitempty"`
	// Provisioner indicates the type of the provisioner.
	// +optional
	Provisioner string `json:"provisioner,omitempty"`

	// Parameters holds the parameters for the provisioner that should
	// create volumes of this storage class.
	// +optional
	Parameters map[string]string `json:"parameters,omitempty"`
}

type CSIDriverSpec struct {
	// ReadAffinity defines the read affinity settings for CSI driver.
	// +kubebuilder:validation:Optional
	ReadAffinity *rookCephv1.ReadAffinitySpec `json:"readAffinity,omitempty"`
}

type ComponentImageStatus struct {
	DesiredImage string `json:"desiredImage,omitempty"`
	ActualImage  string `json:"actualImage,omitempty"`
}

type EncryptionSpec struct {
	// deprecated from OCS 4.10 onwards, acting as a dummy,
	// UI will keep sending this flag for backward compatibility (OCP 4.10 + OCS 4.9)
	// +optional
	Enable bool `json:"enable,omitempty"`
	// +optional
	ClusterWide bool `json:"clusterWide,omitempty"`
	// +optional
	StorageClass bool `json:"storageClass,omitempty"`
	// StorageClassName specifies the name of the storage class created for ceph encrypted block pools
	// +kubebuilder:validation:MaxLength=253
	// +kubebuilder:validation:Pattern=^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
	StorageClassName     string                   `json:"storageClassName,omitempty"`
	KeyManagementService KeyManagementServiceSpec `json:"kms,omitempty"`
	// KeyRotation defines options for Key Rotation.
	// +optional
	KeyRotation KeyRotationSpec `json:"keyRotation,omitempty"`
}

type ExcludedAlert struct {
	// AlertName is the name of the alert to exclude
	AlertName string `json:"alertName"`
	// ExcludedAt is the timestamp when the alert was excluded
	ExcludedAt metav1.Time `json:"excludedAt"`
	// Severity is the severity of the alert to exclude. Valid
	// values are "critical", "warning", and "info".
	Severity string `json:"severity,omitempty"`
}

type ExternalPGSpec struct {
	// PGSecret stores the secret name which contains connection string of the Postgres server
	// +optional
	PGSecretName string `json:"pgSecretName,omitempty"`
	// AllowSelfSignedCerts will allow the Postgres server to use self signed certificates to authenticate
	// +optional
	AllowSelfSignedCerts bool `json:"allowSelfSignedCerts,omitempty"`
	// EnableTLS will allow the postgres server to connect via TLS/SSL
	// +optional
	EnableTLS bool `json:"enableTls,omitempty"`
	// TLSSecret stores the secret name which contains the client side certificates if enabled
	// +optional
	TLSSecretName string `json:"tlsSecretName,omitempty"`
}

type ExternalStorageClusterSpec struct {
	// +optional
	Enable bool `json:"enable,omitempty"`
}

type ExternalStorageKind string

type ImagesStatus struct {
	Ceph       *ComponentImageStatus `json:"ceph,omitempty"`
	NooBaaCore *ComponentImageStatus `json:"noobaaCore,omitempty"`
	NooBaaDB   *ComponentImageStatus `json:"noobaaDB,omitempty"`
}

type KMSServerConnectionStatus struct {
	KMSServerAddress         string `json:"kmsServerAddress,omitempty"`
	KMSServerConnectionError string `json:"kmsServerConnectionError,omitempty"`
}

type KeyManagementServiceSpec struct {
	// +optional
	Enable bool `json:"enable,omitempty"`
}

type KeyRotationSpec struct {
	// Enable represents whether the key rotation is enabled.
	// +optional
	Enable *bool `json:"enable,omitempty"`
	// Schedule represents the cron schedule for key rotation.
	// +optional
	// +kubebuilder:default="@weekly"
	Schedule string `json:"schedule,omitempty"`
}

type LastExpansionStatus struct {
	// StartTime is the time stamp of the last run start of the storage scaling
	// +optional
	StartTime metav1.Time `json:"startTime,omitempty"`
	// CompletionTime is the time stamp of the last run completion of the storage scaling
	// +optional
	CompletionTime metav1.Time `json:"completionTime,omitempty"`
	// The start OSD size is the original size of the OSDs before the expansion in progress is completed.
	// After the expansion is completed, this would be updated to the expected OSD size.
	// Used for vertical scaling of OSDs.
	// +optional
	StartOsdSize resource.Quantity `json:"startOsdSize,omitempty"`
	// The ExpectedOsdSize is the size that the auto-expansion has decided to set.
	// This will be set on the storageCLuster CR as the desired size of the OSDs.
	// Used for vertical scaling of OSDs.
	// +optional
	ExpectedOsdSize resource.Quantity `json:"expectedOsdSize,omitempty"`
	// The start OSD count is the original count of the OSDs before the expansion in progress is completed.
	// After the expansion is completed, this would be updated to the expected OSD count.
	// Used for horizontal scaling of OSDs.
	// +optional
	StartOsdCount uint16 `json:"startOsdCount,omitempty"`
	// The Expected OSD count is the count that the auto-expansion has decided to set.
	// This will be set on the storageCluster CR as the desired count of the OSDs.
	// Used for horizontal scaling of OSDs.
	// +optional
	ExpectedOsdCount uint16 `json:"expectedOsdCount,omitempty"`
	// StartStorageCapacity is the original storage capacity of the storage cluster before the expansion in progress is completed.
	StartStorageCapacity resource.Quantity `json:"startStorageCapacity,omitempty"`
	// ExpectedStorageCapacity is the expected storage capacity of the storage cluster after the expansion in progress is completed.
	ExpectedStorageCapacity resource.Quantity `json:"expectedStorageCapacity,omitempty"`
}

type ManageCephBlockPools struct {
	ReconcileStrategy string `json:"reconcileStrategy,omitempty"`
	// if set to true, the storageClass created for cephBlockPools will be annotated as the default for the whole cluster
	DefaultStorageClass bool `json:"defaultStorageClass,omitempty"`
	// StorageClassName specifies the name of the storage class created for ceph block pools
	// +kubebuilder:validation:MaxLength=253
	// +kubebuilder:validation:Pattern=^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
	StorageClassName string `json:"storageClassName,omitempty"`
	// VirtualizationStorageClassName specifies the name of the storage class created for ceph block pools
	// for virtualization environment
	// +kubebuilder:validation:MaxLength=253
	// +kubebuilder:validation:Pattern=^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
	VirtualizationStorageClassName string `json:"virtualizationStorageClassName,omitempty"`
	// if set to true, the virtualization storageClass will be annotated as the default for kubevirt workloads
	DefaultVirtualizationStorageClass bool `json:"defaultVirtualizationStorageClass,omitempty"`
	// PoolSpec specifies the pool specification for the default cephBlockPool
	PoolSpec *rookCephv1.PoolSpec `json:"poolSpec,omitempty"`
	// ErasureCodedMetadataPool specifies the  metadata pool for erasure coded pools if the pool is erasure coded
	// it has to be unique pool name and the operator will create the pool with replica 3.
	// This is required as rbd needs a separate metadata pool when using erasure coding for data pool.
	// +kubebuilder:validation:XValidation:message="erasureCodedMetadataPool is immutable once set",rule="oldSelf == ” || self == oldSelf"
	// +optional
	ErasureCodedMetadataPool string `json:"erasureCodedMetadataPool,omitempty"`
}

type ManageCephCluster struct {
	ReconcileStrategy string `json:"reconcileStrategy,omitempty"`
	// +kubebuilder:validation:Enum=1;2
	MgrCount int `json:"mgrCount,omitempty"`
	// +kubebuilder:validation:Enum=3;5
	MonCount int `json:"monCount,omitempty"`
	// WaitTimeoutForHealthyOSDInMinutes defines the time the operator would wait before an OSD can be stopped for upgrade or restart.
	// If `continueUpgradeAfterChecksEvenIfNotHealthy` is `false` and the timeout exceeds and OSD is not ok to stop, then the operator
	// would skip upgrade for the current OSD and proceed with the next one.
	// If `continueUpgradeAfterChecksEvenIfNotHealthy` is `true`, then operator would continue with the upgrade of an OSD even if its
	// not ok to stop after the timeout.
	// This timeout won't be applied if `skipUpgradeChecks` is `true`.
	// The default wait timeout is 10 minutes.
	WaitTimeoutForHealthyOSDInMinutes time.Duration `json:"waitTimeoutForHealthyOSDInMinutes,omitempty"`
	// Whether or not upgrade should continue even if a check fails
	// This means Ceph's status could be degraded and we don't recommend upgrading but you might decide otherwise
	// Use at your OWN risk
	SkipUpgradeChecks bool `json:"skipUpgradeChecks,omitempty"`
	// Whether or not continue if PGs are not clean during an upgrade
	ContinueUpgradeAfterChecksEvenIfNotHealthy *bool `json:"continueUpgradeAfterChecksEvenIfNotHealthy,omitempty"`
	// Whether or not requires PGs are clean before an OSD upgrade. If set to `true` OSD upgrade process won't start until PGs are healthy.
	// This configuration will be ignored if `skipUpgradeChecks` is `true`.
	UpgradeOSDRequiresHealthyPGs bool `json:"upgradeOSDRequiresHealthyPGs,omitempty"`
	// A duration in minutes that determines how long an entire failureDomain like `region/zone/host` will be held in `noout` (in addition to the
	// default DOWN/OUT interval) when it is draining. This is only relevant when  `managePodBudgets` is `true` in cephCluster CR.
	// The default value is `30` minutes.
	OsdMaintenanceTimeout time.Duration `json:"osdMaintenanceTimeout,omitempty"`
	// NearFullRatio is the ratio at which the cluster is considered nearly full and will raise a ceph health warning. Default is 0.75.
	// +kubebuilder:validation:Minimum=0.0
	// +kubebuilder:validation:Maximum=1.0
	// +nullable
	NearFullRatio *float64 `json:"nearFullRatio,omitempty"`
	// BackfillFullRatio is the ratio at which the cluster is too full for backfill. Backfill will be disabled if above this threshold. Default is 0.80.
	// +kubebuilder:validation:Minimum=0.0
	// +kubebuilder:validation:Maximum=1.0
	// +nullable
	BackfillFullRatio *float64 `json:"backfillFullRatio,omitempty"`
	// FullRatio is the ratio at which the cluster is considered full and ceph will stop accepting writes. Default is 0.85.
	// +kubebuilder:validation:Minimum=0.0
	// +kubebuilder:validation:Maximum=1.0
	// +nullable
	FullRatio *float64 `json:"fullRatio,omitempty"`

	// Whether to allow updating the device class after the OSD is initially provisioned
	AllowDeviceClassUpdate bool `json:"allowDeviceClassUpdate,omitempty"`

	// CephClusterHealthCheckSpec represent the healthcheck for Ceph daemons
	HealthCheck *rookCephv1.CephClusterHealthCheckSpec `json:"healthCheck,omitempty"`

	// Ceph Config options
	CephConfig map[string]map[string]string `json:"cephConfig,omitempty"`

	// CleanupPolicy defines the cleanup policy for the Rook Ceph cluster.
	// +optional
	CleanupPolicy *rookCephv1.CleanupPolicySpec `json:"cleanupPolicy,omitempty"`
}

type ManageCephConfig struct {
	ReconcileStrategy string `json:"reconcileStrategy,omitempty"`
}

type ManageCephDashboard struct {
	Enable bool `json:"enable,omitempty"`
	// serve the dashboard using SSL
	SSL bool `json:"ssl,omitempty"`
}

type ManageCephFilesystems struct {
	ReconcileStrategy     string `json:"reconcileStrategy,omitempty"`
	ActiveMetadataServers int    `json:"activeMetadataServers,omitempty"`
	// StorageClassName specifies the name of the storage class created for cephfs
	// +kubebuilder:validation:MaxLength=253
	// +kubebuilder:validation:Pattern=^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
	StorageClassName string `json:"storageClassName,omitempty"`
	// MetadataPoolSpec specifies the pool specification for the default cephFS metadata pool
	MetadataPoolSpec *rookCephv1.PoolSpec `json:"metadataPoolSpec,omitempty"`
	// DataPoolSpec specifies the pool specification for the default cephfs data pool
	DataPoolSpec *rookCephv1.PoolSpec `json:"dataPoolSpec,omitempty"`
	// AdditionalDataPools specifies list of additional named cephfs data pools
	AdditionalDataPools []rookCephv1.NamedPoolSpec `json:"additionalDataPools,omitempty"`
	// DefaultStorageClassDataPoolName specifies the name of the data pool which will be used in the storage class if multiple data pools are defined
	// It is used to distinguish between the ec and replicated data pools when both are defined in the same filesystem
	// if not specified, the operator will use the replicated pool as the default data pool for the storage class
	// can't be changed after creation, if not specified, the operator will use the first data pool in the list of additional data pools as the default data pool for the storage class
	// +kubebuilder:validation:XValidation:message="defaultStorageClassDataPoolName is immutable",rule="self == oldSelf"
	// +optional
	DefaultStorageClassDataPoolName string `json:"defaultStorageClassDataPoolName,omitempty"`
}

type ManageCephNonResilientPools struct {
	Enable bool `json:"enable,omitempty"`
	// Count is the number of devices in this set
	// +kubebuilder:validation:Minimum=1
	Count int `json:"count,omitempty"`
	// ResourceRequirements (requests/limits) for the devices
	Resources *corev1.ResourceRequirements `json:"resources,omitempty"`
	// VolumeClaimTemplates is a PVC template for the underlying storage devices
	VolumeClaimTemplate *corev1.PersistentVolumeClaim `json:"volumeClaimTemplate,omitempty"`
	// StorageClassName specifies the name of the storage class created for ceph non-resilient pools
	// +kubebuilder:validation:MaxLength=253
	// +kubebuilder:validation:Pattern=^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
	StorageClassName string `json:"storageClassName,omitempty"`
	// Parameters is a list of properties to enable on the non-resilient cephBlockPools
	// +kubebuilder:pruning:PreserveUnknownFields
	// +optional
	// +nullable
	Parameters map[string]string `json:"parameters,omitempty"`
}

type ManageCephObjectStoreUsers struct {
	ReconcileStrategy string `json:"reconcileStrategy,omitempty"`
}

type ManageCephObjectStores struct {
	ReconcileStrategy string `json:"reconcileStrategy,omitempty"`
	GatewayInstances  int    `json:"gatewayInstances,omitempty"`
	DisableRoute      bool   `json:"disableRoute,omitempty"`
	// DisableHttp, if true, will prevent creation of insecure ceph RGW http route. It will also delete any
	// existing insecure ceph RGW http route.
	DisableHttp       bool  `json:"disableHttp,omitempty"`
	HostNetwork       *bool `json:"hostNetwork,omitempty"`
	GatewayPort       int   `json:"gatewayPort,omitempty"`
	GatewaySecurePort int   `json:"gatewaySecurePort,omitempty"`
	// Enables STS authentication for RGW
	// +kubebuilder:default=true
	EnableSTS bool `json:"enableSTS,omitempty"`
	// StorageClassName specifies the name of the storage class created for ceph obc's
	// +kubebuilder:validation:MaxLength=253
	// +kubebuilder:validation:Pattern=^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
	StorageClassName string `json:"storageClassName,omitempty"`
	// MetadataPoolSpec specifies the pool specification for the default cephObjectStore metadata pool
	MetadataPoolSpec *rookCephv1.PoolSpec `json:"metadataPoolSpec,omitempty"`
	// DataPoolSpec specifies the pool specification for the default cephObjectStore data pool
	DataPoolSpec *rookCephv1.PoolSpec `json:"dataPoolSpec,omitempty"`
}

type ManageCephRBDMirror struct {
	ReconcileStrategy string `json:"reconcileStrategy,omitempty"`
	// +kubebuilder:validation:Minimum=1
	DaemonCount int `json:"daemonCount,omitempty"`
}

type ManageCephToolbox struct {
	ReconcileStrategy string `json:"reconcileStrategy,omitempty"`
}

type ManagedResourcesSpec struct {
	CephCluster           ManageCephCluster           `json:"cephCluster,omitempty"`
	CephDashboard         ManageCephDashboard         `json:"cephDashboard,omitempty"`
	CephBlockPools        ManageCephBlockPools        `json:"cephBlockPools,omitempty"`
	CephNonResilientPools ManageCephNonResilientPools `json:"cephNonResilientPools,omitempty"`
	CephFilesystems       ManageCephFilesystems       `json:"cephFilesystems,omitempty"`
	CephObjectStores      ManageCephObjectStores      `json:"cephObjectStores,omitempty"`
	CephObjectStoreUsers  ManageCephObjectStoreUsers  `json:"cephObjectStoreUsers,omitempty"`
	CephToolbox           ManageCephToolbox           `json:"cephToolbox,omitempty"`
	CephRBDMirror         ManageCephRBDMirror         `json:"cephRBDMirror,omitempty"`
}

type MirroringSpec struct {
	// If true, data mirroring is enabled for the StorageCluster.
	// This configuration will only be applied to resources (such as CephBlockPool)
	// managed by the operator.
	// It is optional and defaults to false.
	// +optional
	Enabled bool `json:"enabled,omitempty"`

	// PeerSecretNames represents the Kubernetes Secret names of rbd-mirror peers tokens
	// +optional
	PeerSecretNames []string `json:"peerSecretNames,omitempty"`
}

type MonitoringSpec struct {
	ReconcileStrategy string `json:"reconcileStrategy,omitempty"`
	// Labels to add to monitoring resources created by operator.
	// These labels are used as LabelSelector for Prometheus
	Labels map[string]string `json:"labels,omitempty"`
	// DisableBlackboxExporter disables deployment of Blackbox Exporter for network health checks
	// +optional
	DisableBlackboxExporter bool `json:"disableBlackboxExporter,omitempty"`
	// ExcludedAlerts lists alerts to exclude from ODF health score calculation.
	// Alerts still fire in Prometheus but are excluded from health score.
	// +optional
	ExcludedAlerts []ExcludedAlert `json:"excludedAlerts,omitempty"`
}

type MultiCloudGatewaySpec struct {
	// ReconcileStrategy specifies whether to reconcile NooBaa CRs. Valid
	// values are "manage", "standalone", "ignore" (same as "standalone"),
	// and "" (same as "manage").
	ReconcileStrategy string `json:"reconcileStrategy,omitempty"`

	// DbStorageClassName specifies the default storage class
	// for nooba-db pods
	// +optional
	DbStorageClassName string `json:"dbStorageClassName,omitempty"`

	// DBBackup (optional) configure automatic scheduled backups of noobaa database volume.
	// +optional
	DbBackup *nbv1.DBBackupSpec `json:"dbBackup,omitempty"`

	// DBRecovery (optional) configure database recovery from snapshot
	// +optional
	DbRecovery *nbv1.DBRecoverySpec `json:"dbRecovery,omitempty"`

	// Endpoints (optional) sets configuration info for the noobaa endpoint
	// deployment.
	// +optional
	Endpoints *nbv1.EndpointsSpec `json:"endpoints,omitempty"`

	// Autoscaler (optional) sets configuration for NooBaa endpoint autoscaling.
	// +optional
	Autoscaler *nbv1.AutoscalerSpec `json:"autoscaler,omitempty"`

	// DisableLoadBalancerService (optional) sets the service type to ClusterIP instead of LoadBalancer
	// +nullable
	// +optional
	DisableLoadBalancerService bool `json:"disableLoadBalancerService,omitempty"`

	// DisableRoutes (optional) disables the reconciliation of openshift route resources in the cluster
	// +nullable
	// +optional
	DisableRoutes bool `json:"disableRoutes,omitempty"`

	// Allows Noobaa to connect to an external Postgres server
	// +optional
	ExternalPgConfig *ExternalPGSpec `json:"externalPgConfig,omitempty"`

	// DenyHTTP (optional) if given will deny access to the NooBaa S3 service using HTTP (only HTTPS)
	// +optional
	DenyHTTP bool `json:"denyHTTP,omitempty"`

	// PerformanceProfile (optional) selects a bundle of resource and count
	// settings for the NooBaa core, db and endpoint components.
	// When unset, defaults to "default".
	// Explicit per-component resources in StorageClusterSpec.Resources take precedence over the profile.
	// +optional
	// +kubebuilder:validation:Enum=default;mixed-workload;small-objects
	PerformanceProfile nbv1.PerformanceProfileType `json:"performanceProfile,omitempty"`
}

type NFSSpec struct {
	// Enable specifies whether to enable NFS.
	// +optional
	Enable bool `json:"enable,omitempty"`
	// ExternalEndpoint specifies the externally resolvable IP or the DNS name to use
	// for NFS Ganesha server in NFS StorageClass. If specified, internal client will
	// also use this same address.
	// +optional
	ExternalEndpoint string `json:"externalEndpoint,omitempty"`
	// StorageClassName specifies the name of the storage class created for NFS
	// +kubebuilder:validation:MaxLength=253
	// +kubebuilder:validation:Pattern=^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
	StorageClassName string `json:"storageClassName,omitempty"`
	// LogLevel set logging level
	// Log levels: NIV_NULL | NIV_FATAL | NIV_MAJ | NIV_CRIT | NIV_WARN | NIV_EVENT | NIV_INFO | NIV_DEBUG | NIV_MID_DEBUG | NIV_FULL_DEBUG | NB_LOG_LEVEL
	// +optional
	LogLevel          string `json:"logLevel,omitempty"`
	ReconcileStrategy string `json:"reconcileStrategy,omitempty"`
}

type NodeTopologyMap struct {
	// Labels is a map of topology label keys
	// (e.g. "topology.kubernetes.io/zone") to a set of values for those
	// keys.
	// +optional
	// +nullable
	Labels map[string]TopologyLabelValues `json:"labels,omitempty"`

	// ArbiterLocation is the chosen location in the failure domain for placing the arbiter resources.
	// When the failure domain is not provided as an input, ocs-operator determines the failure domain.
	ArbiterLocation string `json:"arbiterLocation,omitempty"`
}

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

	Spec   OCSInitializationSpec   `json:"spec,omitempty"`
	Status OCSInitializationStatus `json:"status,omitempty"`
}

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

type OCSInitializationSpec struct{}

type OCSInitializationStatus struct {
	// Phase describes the Phase of OCSInitialization
	// This is used by OLM UI to provide status information
	// to the user
	Phase string `json:"phase,omitempty"`

	// Conditions describes the state of the OCSInitialization resource.
	// +optional
	Conditions []conditionsv1.Condition `json:"conditions,omitempty"`

	// RelatedObjects is a list of objects created and maintained by this
	// operator. Object references will be added to this list after they have
	// been created AND found in the cluster.
	// +optional
	RelatedObjects []corev1.ObjectReference `json:"relatedObjects,omitempty"`
	ErrorMessage   string                   `json:"errorMessage,omitempty"`
	SCCsCreated    bool                     `json:"sCCsCreated,omitempty"`
}

type OverprovisionControlSpec struct {
	StorageClassName string                               `json:"storageClassName,omitempty"`
	QuotaName        string                               `json:"quotaName,omitempty"`
	Capacity         resource.Quantity                    `json:"capacity,omitempty"`
	Selector         quotav1.ClusterResourceQuotaSelector `json:"selector,omitempty"`
}

type PeerInfo struct {
	StorageClusterUid string `json:"storageClusterUid,omitempty"`
}

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

	Spec   StorageAutoScalerSpec   `json:"spec,omitempty"`
	Status StorageAutoScalerStatus `json:"status,omitempty"`
}

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

type StorageAutoScalerPhase string

type StorageAutoScalerSpec struct {
	// StorageCluster is the name of the storage cluster for which the storage scaling is to be done.
	// +kubebuilder:validation:Required
	StorageCluster corev1.LocalObjectReference `json:"storageCluster,omitempty"`
	// DeviceClass is the name of the device class for which the storage scaling is to be done.
	// +kubebuilder:validation:Optional
	// +kubebuilder:default="ssd"
	DeviceClass string `json:"deviceClass,omitempty"`
	// StorageCapacityLimit is the total aggregate capacity limit for the storage scaling for the specific deviceClass and storagecluster.
	// +kubebuilder:validation:Required
	StorageCapacityLimit resource.Quantity `json:"storageCapacityLimit,omitempty"`
	// MaxOsdSize is the maximum size that Osd disk can be expanded to.
	// +kubebuilder:validation:Optional
	// +kubebuilder:default="8Ti"
	MaxOsdSize resource.Quantity `json:"maxOsdSize,omitempty"`
	// StorageScalingThresholdPercent is the threshold percentage of the storage capacity that triggers the auto-scaling of the OSDs.
	// Should be less than the OsdNearFullThresholdPercentage.
	// +kubebuilder:validation:Optional
	// +kubebuilder:default=70
	StorageScalingThresholdPercent int `json:"storageScalingThresholdPercent,omitempty"`
	// TimeoutSeconds is the time in seconds after which the storage auto-scaler will alert the user that the scaling operation has been failed.
	// +kubebuilder:validation:Optional
	// +kubebuilder:default=1800
	TimeoutSeconds int `json:"timeoutSeconds,omitempty"`
}

type StorageAutoScalerStatus struct {
	// Phase describes the Phase of StorageAutoScaler
	// +optional
	Phase StorageAutoScalerPhase `json:"phase,omitempty"`
	// Error is the error message in case the storage scaling operation has failed.
	// +optional
	// +nullable
	Error *TimestampedError `json:"error,omitempty"`
	// +optional
	// +nullable
	LastExpansion *LastExpansionStatus `json:"lastExpansion,omitempty"`
	// StorageCapacityLimitReached is the flag that indicates if the storage capacity limit has been reached.
	// +optional
	// +nullable
	StorageCapacityLimitReached *bool `json:"storageCapacityLimitReached,omitempty"`
}

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

	Spec   StorageClusterSpec   `json:"spec,omitempty"`
	Status StorageClusterStatus `json:"status,omitempty"`
}

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

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

	// +kubebuilder:validation:Required
	Spec   StorageClusterPeerSpec   `json:"spec,omitempty"`
	Status StorageClusterPeerStatus `json:"status,omitempty"`
}

type StorageClusterPeerFailureReason string

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

type StorageClusterPeerSpec struct {

	// ApiEndpoint is the URI of the ODF api server
	ApiEndpoint string `json:"apiEndpoint"`

	// OnboardingToken holds an identity information required by the local ODF cluster to onboard.
	OnboardingToken string `json:"onboardingToken"`
}

type StorageClusterPeerState string

type StorageClusterPeerStatus struct {
	State         StorageClusterPeerState         `json:"state,omitempty"`
	FailureReason StorageClusterPeerFailureReason `json:"failureReason,omitempty"`
	PeerInfo      *PeerInfo                       `json:"peerInfo"`
}

type StorageClusterSpec struct {
	// LabelSelector is used to specify custom labels of nodes to run OCS on
	LabelSelector *metav1.LabelSelector `json:"labelSelector,omitempty"`
	// ExternalStorage is optional and defaults to false. When set to true, OCS will
	// connect to an external OCS Storage Cluster instead of provisioning one locally.
	ExternalStorage ExternalStorageClusterSpec `json:"externalStorage,omitempty"`
	// HostNetwork defaults to false.
	// Deprecated: This field is deprecated and will be removed in a future release.
	// Use spec.network.hostNetwork instead.
	HostNetwork bool `json:"hostNetwork,omitempty"`
	// Placement is optional and used to specify placements of OCS components(except csi) explicitly
	// The specified placement here will be selectively merged with the default placement for the components
	// For example, if only tolerations are specified, the default node affinity or TSC etc will be applied if applicable
	Placement rookCephv1.PlacementSpec `json:"placement,omitempty"`
	// Resources is optional and used to specify resource requirements for the OCS components(except csi) explicitly
	// The specified resource requirements will be selectively merged according to the type, with the defaults for the components
	// For example, if requests/limits only for CPU are specified, default limits & requests for memory would be applied to the component
	Resources map[string]corev1.ResourceRequirements `json:"resources,omitempty"`
	// Resource Profile can be used to choose from a set of predefined resource profiles for the ceph daemons.
	// We have 3 profiles
	// lean: suitable for clusters with limited resources,
	// balanced: suitable for most use cases,
	// performance: suitable for clusters with high amount of resources.
	// +kubebuilder:validation:Enum=lean;Lean;balanced;Balanced;performance;Performance
	ResourceProfile    string                        `json:"resourceProfile,omitempty"`
	Encryption         EncryptionSpec                `json:"encryption,omitempty"`
	StorageDeviceSets  []StorageDeviceSet            `json:"storageDeviceSets,omitempty"`
	MonPVCTemplate     *corev1.PersistentVolumeClaim `json:"monPVCTemplate,omitempty"`
	MonDataDirHostPath string                        `json:"monDataDirHostPath,omitempty"`
	MultiCloudGateway  *MultiCloudGatewaySpec        `json:"multiCloudGateway,omitempty"`
	NFS                *NFSSpec                      `json:"nfs,omitempty"`
	CSI                *CSIDriverSpec                `json:"csi,omitempty"`
	// Monitoring controls the configuration of resources for exposing OCS metrics
	Monitoring *MonitoringSpec `json:"monitoring,omitempty"`
	// Network represents cluster network settings
	Network *rookCephv1.NetworkSpec `json:"network,omitempty"`
	// ManagedResources specifies how to deal with auxiliary resources reconciled
	// with the StorageCluster
	ManagedResources ManagedResourcesSpec `json:"managedResources,omitempty"`
	// If enabled, sets the failureDomain to host, allowing devices to be
	// distributed evenly across all nodes, regardless of distribution in zones
	// or racks.
	FlexibleScaling bool `json:"flexibleScaling,omitempty"`
	// NodeTopologies specifies the nodes available for the storage cluster,
	// preferred failure domain and location for the arbiter resources. This is
	// optional for non-arbiter clusters. For arbiter clusters, the
	// arbiterLocation is required; failure domain and the node labels are
	// optional. When the failure domain and the node labels are missing, the
	// ocs-operator makes a best effort to determine them automatically.
	NodeTopologies *NodeTopologyMap `json:"nodeTopologies,omitempty"`
	// ArbiterSpec specifies the storage cluster options related to arbiter.
	// If Arbiter is enabled, ArbiterLocation in the NodeTopologies must be specified.
	Arbiter ArbiterSpec `json:"arbiter,omitempty"`
	// Mirroring specifies data mirroring configuration for the storage cluster.
	// This configuration will only be applied to resources managed by the operator.
	Mirroring *MirroringSpec `json:"mirroring,omitempty"`
	// OverprovisionControl specifies the allowed hard-limit PVs overprovisioning relative to
	// the effective usable storage capacity.
	OverprovisionControl []OverprovisionControlSpec `json:"overprovisionControl,omitempty"`

	// ProviderAPIServerServiceType Indicates the ServiceType for OCS Provider API Server Service.
	// The default ServiceType is derived from hostNetwork field.
	// +kubebuilder:validation:Enum=ClusterIP;NodePort;LoadBalancer
	ProviderAPIServerServiceType corev1.ServiceType `json:"providerAPIServerServiceType,omitempty"`

	// EnableCephTools toggles on whether or not the ceph tools pod
	// should be deployed.
	// Defaults to false
	// +optional
	EnableCephTools bool `json:"enableCephTools,omitempty"`

	// Logging represents loggings settings
	// +optional
	// +nullable
	LogCollector *rookCephv1.LogCollectorSpec `json:"logCollector,omitempty"`

	// BackingStorageClasses is a list of storage classes that will be
	// provisioned by the storagecluster controller to be used in
	// storageDeviceSets section of the CR.
	BackingStorageClasses []BackingStorageClass `json:"backingStorageClasses,omitempty"`
}

type StorageClusterStatus struct {
	// Version specifies the version of StorageCluster
	Version string `json:"version,omitempty"`

	// Phase describes the Phase of StorageCluster
	// This is used by OLM UI to provide status information
	// to the user
	Phase string `json:"phase,omitempty"`

	// Conditions describes the state of the StorageCluster resource.
	// +optional
	Conditions []conditionsv1.Condition `json:"conditions,omitempty"`

	// RelatedObjects is a list of objects created and maintained by this
	// operator. Object references will be added to this list after they have
	// been created AND found in the cluster.
	// +optional
	RelatedObjects []corev1.ObjectReference `json:"relatedObjects,omitempty"`

	// NodeTopologies is a list of topology labels on all nodes matching
	// the StorageCluster's placement selector.
	// +optional
	NodeTopologies *NodeTopologyMap `json:"nodeTopologies,omitempty"`

	// FailureDomain is the base CRUSH element Ceph will use to distribute
	// its data replicas for the default CephBlockPool
	// +optional
	FailureDomain string `json:"failureDomain,omitempty"`

	// FailureDomainKey is the specific key used to find the locations available
	// under a failure domain. For example topology.kubernetes.io/zone
	// +optional
	FailureDomainKey string `json:"failureDomainKey,omitempty"`

	// FailureDomainValues is the list of locations available for a failure
	// domain under the failure domain key.
	// +optional
	FailureDomainValues []string `json:"failureDomainValues,omitempty"`

	// LastAppliedResourceProfile is the resource profile that was last applied successfully & is currently in use.
	LastAppliedResourceProfile string `json:"lastAppliedResourceProfile,omitempty"`

	// StorageProviderEndpoint holds endpoint info on Provider cluster which is required
	// for consumer to establish connection with the storage providing cluster.
	StorageProviderEndpoint string `json:"storageProviderEndpoint,omitempty"`

	// ExternalSecretHash holds the checksum value of external secret data.
	ExternalSecretHash string `json:"externalSecretHash,omitempty"`

	// Images holds the image reconcile status for all images reconciled by the operator
	Images ImagesStatus `json:"images,omitempty"`

	// DefaultCephDeviceClass holds the default ceph device class to be used for the pools
	DefaultCephDeviceClass string `json:"defaultCephDeviceClass,omitempty"`

	// KMSServerConnection holds the connection state to the KMS server.
	KMSServerConnection KMSServerConnectionStatus `json:"kmsServerConnection,omitempty"`

	// CurrentMonCount holds the value of ceph mons configured in ceph cluster.
	CurrentMonCount int `json:"currentMonCount,omitempty"`
}

type StorageDeviceSet struct {
	Name string `json:"name"`
	// Count is the number of devices in each StorageClassDeviceSet
	// +kubebuilder:validation:Minimum=1
	Count int `json:"count"`

	// Replica is the number of StorageClassDeviceSets for this
	// StorageDeviceSet
	// +kubebuilder:validation:Minimum=1
	// +optional
	Replica int `json:"replica,omitempty"`

	// DeviceType is the value of device type in
	// this StorageDeviceSet. It can have one of the
	// three values (SSD, HDD, NVMe)
	// +kubebuilder:validation:Enum=SSD;ssd;HDD;hdd;NVMe;NVME;nvme
	// +optional
	DeviceType string `json:"deviceType,omitempty"`

	// DeviceClass is an optional, fine-grained property of DeviceType.
	// If non empty, it defines the 'crushDeviceClass' value as used by ceph's
	// CRUSH map. If empty, then operator will set 'crushDeviceClass' to SSD and
	// 'TuneFastDeviceClass' to true
	// +optional
	DeviceClass string `json:"deviceClass,omitempty"`

	// InitialWeight is an optional explicit OSD weight value in TiB units.
	// If non empty, it defines the 'CrushInitialWeight' value which is
	// assigned to ceph OSD upon init
	// +kubebuilder:validation:Pattern=`^([0-9]*[.])?[0-9]+(Ti[B])$`
	// +optional
	InitialWeight string `json:"initialWeight,omitempty"`

	// PrimaryAffinity is an optional OSD primary-affinity value within the
	// range [0,1). This value influence the way Ceph's CRUSH selection of
	// primary OSDs. Lower value reduce performance bottlenecks (especially
	// on read operations). If not set, default value is 1.
	// https://docs.ceph.com/en/latest/rados/operations/crush-map/#primary-affinity
	// +kubebuilder:validation:Pattern=`^0.[0-9]+$`
	// +optional
	PrimaryAffinity string `json:"primaryAffinity,omitempty"`

	// Portable says whether the OSDs in this device set can move between
	// nodes. This is ignored if Placement is not set
	// +optional
	Portable bool `json:"portable,omitempty"`

	Resources           corev1.ResourceRequirements   `json:"resources,omitempty"`
	PreparePlacement    rookCephv1.Placement          `json:"preparePlacement,omitempty"`
	Placement           rookCephv1.Placement          `json:"placement,omitempty"`
	Config              StorageDeviceSetConfig        `json:"config,omitempty"`
	DataPVCTemplate     corev1.PersistentVolumeClaim  `json:"dataPVCTemplate"`
	MetadataPVCTemplate *corev1.PersistentVolumeClaim `json:"metadataPVCTemplate,omitempty"`
	WalPVCTemplate      *corev1.PersistentVolumeClaim `json:"walPVCTemplate,omitempty"`

	// Whether to encrypt the deviceSet or not
	// +optional
	Encrypted *bool `json:"encrypted,omitempty"`
}

type StorageDeviceSetConfig struct {
	// TuneSlowDeviceClass tunes the OSD when running on a slow Device Class
	// +optional
	TuneSlowDeviceClass bool `json:"tuneSlowDeviceClass,omitempty"`

	// TuneFastDeviceClass tunes the OSD when running on a fast Device Class
	// +optional
	TuneFastDeviceClass bool `json:"tuneFastDeviceClass,omitempty"`
}

type TimestampedError struct {
	// Message is the error message in case the storage scaling operation has failed.
	Message string `json:"message,omitempty"`
	// Timestamp is the time stamp when the error occurred.
	Timestamp metav1.Time `json:"timestamp,omitempty"`
}

type TopologyLabelValues []string