v1alpha1

type ChunkSizeCalculationPolicy string

type DeviceClass struct {
	// Name specifies a name for the device class
	// +kubebuilder:validation:MaxLength=245
	// +kubebuilder:validation:MinLength=1
	// +kubebuilder:validation:Pattern="^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"
	Name string `json:"name,omitempty"`

	// DeviceSelector contains the configuration to specify paths to the devices that you want to add to the LVM volume group, and force wipe the selected devices.
	// +optional
	DeviceSelector *DeviceSelector `json:"deviceSelector,omitempty"`

	// NodeSelector contains the configuration to choose the nodes on which you want to create the LVM volume group. If this field is not configured, all nodes without no-schedule taints are considered.
	// +optional
	NodeSelector *corev1.NodeSelector `json:"nodeSelector,omitempty"`

	// ThinPoolConfig contains the configuration to create a thin pool in the LVM volume group. If you exclude this field, logical volumes are thick provisioned.
	// +optional
	ThinPoolConfig *ThinPoolConfig `json:"thinPoolConfig,omitempty"`

	// Default is a flag to indicate that a device class is the default. You can configure only a single default device class.
	// +optional
	Default bool `json:"default,omitempty"`

	// FilesystemType sets the default filesystem type for persistent volumes created from this device class.
	// This determines the filesystem used when provisioning PVCs with volumeMode: Filesystem.
	// Select either `ext4` or `xfs`. This does not filter devices during discovery.
	// +kubebuilder:validation:Enum=xfs;ext4;""
	// +kubebuilder:default=xfs
	// +optional
	FilesystemType DeviceFilesystemType `json:"fstype,omitempty"`
}

type DeviceClassStatus struct {
	// Name is the name of the deviceclass
	Name string `json:"name,omitempty"`
	// NodeStatus tells if the deviceclass was created on the node
	NodeStatus []NodeStatus `json:"nodeStatus,omitempty"`
}

type DeviceDiscoveryPolicy string

type DeviceFilesystemType string

type DevicePath string

type DeviceSelector struct {

	// Paths specify the device paths.
	// +optional
	Paths []DevicePath `json:"paths,omitempty"`

	// OptionalPaths specify the optional device paths.
	// +optional
	OptionalPaths []DevicePath `json:"optionalPaths,omitempty"`

	// ForceWipeDevicesAndDestroyAllData is a flag to force wipe the selected devices.
	// This wipes the file signatures on the devices. Use this feature with caution.
	// Force wipe the devices only when you know that they do not contain any important data.
	// +optional
	ForceWipeDevicesAndDestroyAllData *bool `json:"forceWipeDevicesAndDestroyAllData,omitempty"`
}

type ExcludedDevice struct {
	// Name is the device that was filtered
	Name string `json:"name"`
	// Reasons are the human-readable reasons why the device was excluded from the volume group
	Reasons []string `json:"reasons"`
}

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

	Spec   LVMClusterSpec   `json:"spec,omitempty"`
	Status LVMClusterStatus `json:"status,omitempty"`
}

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

type LVMClusterSpec struct {

	// Tolerations to apply to nodes to act on
	// +optional
	Tolerations []corev1.Toleration `json:"tolerations,omitempty"`
	// Storage contains the device class configuration for local storage devices.
	// +Optional
	Storage Storage `json:"storage,omitempty"`
}

type LVMClusterStatus struct {

	// Ready describes if the LVMCluster is ready.
	// +optional
	Ready bool `json:"ready,omitempty"`

	// State describes the LVMCluster state.
	// +optional
	State LVMStateType `json:"state,omitempty"`

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

	// DeviceClassStatuses describes the status of all deviceClasses
	DeviceClassStatuses []DeviceClassStatus `json:"deviceClassStatuses,omitempty"`
}

type LVMStateType string

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

	Spec   LVMVolumeGroupSpec   `json:"spec,omitempty"`
	Status LVMVolumeGroupStatus `json:"status,omitempty"`
}

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

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

	Spec   LVMVolumeGroupNodeStatusSpec   `json:"spec,omitempty"`
	Status LVMVolumeGroupNodeStatusStatus `json:"status,omitempty"`
}

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

type LVMVolumeGroupNodeStatusSpec struct {
	// NodeStatus contains the per node status of the VG
	LVMVGStatus []VGStatus `json:"nodeStatus,omitempty"`
}

type LVMVolumeGroupNodeStatusStatus struct {
}

type LVMVolumeGroupSpec struct {
	// DeviceSelector is a set of rules that should match for a device to be included in this TopoLVMCluster
	// +optional
	DeviceSelector *DeviceSelector `json:"deviceSelector,omitempty"`

	// NodeSelector chooses nodes
	// +optional
	NodeSelector *corev1.NodeSelector `json:"nodeSelector,omitempty"`

	// ThinPoolConfig contains configurations for the thin-pool
	// +optional
	ThinPoolConfig *ThinPoolConfig `json:"thinPoolConfig,omitempty"`

	// Default is a flag to indicate whether the device-class is the default
	// +optional
	Default bool `json:"default,omitempty"`
}

type LVMVolumeGroupStatus struct {
}

type MetadataSizePolicy string

type NodeStatus struct {
	// Node is the name of the node
	Node     string `json:"node,omitempty"`
	VGStatus `json:",inline"`
}

type Storage struct {
	// DeviceClasses contains the configuration to assign the local storage devices to the LVM volume groups that you can use to provision persistent volume claims (PVCs).
	// +Optional
	DeviceClasses []DeviceClass `json:"deviceClasses,omitempty"`
}

type ThinPoolConfig struct {
	// Name specifies a name for the thin pool.
	// +kubebuilder:validation:Required
	// +required
	Name string `json:"name"`

	// SizePercent specifies the percentage of space in the LVM volume group for creating the thin pool.
	// If the size configuration is 100, the whole disk will be used.
	// By default, 90% of the disk is used for the thin pool to allow for data or metadata expansion later on.
	// +kubebuilder:default=90
	// +kubebuilder:validation:Minimum=10
	// +kubebuilder:validation:Maximum=100
	SizePercent int `json:"sizePercent,omitempty"`

	// OverProvisionRatio specifies a factor by which you can provision additional storage based on the available storage in the thin pool. To prevent over-provisioning through validation, set this field to 1.
	// +kubebuilder:validation:Minimum=1
	// +kubebuilder:validation:Required
	// +required
	OverprovisionRatio int `json:"overprovisionRatio"`

	// ChunkSizeCalculationPolicy specifies the policy to calculate the chunk size for the underlying volume.
	// When set to Host, the chunk size is calculated based on the lvm2 host setting on the node.
	// When set to Static, the chunk size is calculated based on the static size attribute provided within ChunkSize.
	// +kubebuilder:default=Static
	// +kubebuilder:validation:Enum=Host;Static
	// +optional
	ChunkSizeCalculationPolicy ChunkSizeCalculationPolicy `json:"chunkSizeCalculationPolicy,omitempty"`

	// ChunkSize specifies the statically calculated chunk size for the thin pool.
	// Thus, It is only used when the ChunkSizeCalculationPolicy is set to Static.
	// No ChunkSize with a ChunkSizeCalculationPolicy set to Static will result in a default chunk size of 128Ki.
	// It can be between 64Ki and 1Gi due to the underlying limitations of lvm2.
	// +optional
	ChunkSize *resource.Quantity `json:"chunkSize,omitempty"`

	// MetadataSize specifies metadata size for thin pool. It used only when MetadataSizeCalculationPolicy
	// is set to Static. No MetadataSize with a MetadataSizeCalculationPolicy set to Static will result in
	// default metadata size of 1Gi. It can be between 2Mi and 16Gi due to the underlying limitations of lvm2.
	// +optional
	MetadataSize *resource.Quantity `json:"metadataSize,omitempty"`

	// MetadataSizeCalculationPolicy specifies the policy to calculate metadata size for the underlying volume.
	// When set to Host, the metadata size is calculated based on lvm2 default settings
	// When set to Static, the metadata size is calculated based on the static size attribute provided within MetadataSize
	// +kubebuilder:default=Host
	// +kubebuilder:validation:Enum=Host;Static
	// +optional
	MetadataSizeCalculationPolicy MetadataSizePolicy `json:"metadataSizeCalculationPolicy,omitempty"`
}

type VGStatus struct {
	// Name is the name of the volume group
	Name string `json:"name,omitempty"`
	// Status tells if the volume group was created on the node
	Status VGStatusType `json:"status,omitempty"`
	// Reason provides more detail on the volume group creation status
	Reason string `json:"reason,omitempty"`
	// Devices is the list of devices used by the volume group
	Devices []string `json:"devices,omitempty"`
	// Excluded contains the per node status of applied device exclusions that were picked up via selector,
	// but were not used for other reasons.
	Excluded []ExcludedDevice `json:"excluded,omitempty"`
	// DeviceDiscoveryPolicy is a field to indicate whether the devices are discovered
	// at runtime or preconfigured through a DeviceSelector
	// Setting this to DeviceDiscoveryPolicyPreconfigured indicates the devices are preconfigured through a DeviceSelector.
	// Setting this to DeviceDiscoveryPolicyRuntimeDynamic indicates the devices are added to the VG dynamically if they are present at runtime.
	// By default, the value is set to RuntimeDynamic.
	// +kubebuilder:validation:Enum=Preconfigured;RuntimeDynamic
	// +kubebuilder:default=RuntimeDynamic
	// +kubebuilder:validation:Required
	DeviceDiscoveryPolicy DeviceDiscoveryPolicy `json:"deviceDiscoveryPolicy,omitempty"`
}

type VGStatusType string