v1

type DeviceLinkPolicy string

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

	Spec   LocalVolumeSpec   `json:"spec,omitempty"`
	Status LocalVolumeStatus `json:"status,omitempty"`
}

type LocalVolumeDeviceLink struct {
	metav1.TypeMeta `json:",inline"`

	// metadata is the standard object's metadata and has
	// ownerRef set to the LocalVolume or LocalVolumeSet object.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	metav1.ObjectMeta `json:"metadata,omitempty"`
	// spec holds user settable values for the device link
	// +required
	Spec LocalVolumeDeviceLinkSpec `json:"spec"`
	// status holds observed values for the device link.
	// if not set, this means local-storage-operator has not synced
	// this particular volume yet on the node.
	// +optional
	Status LocalVolumeDeviceLinkStatus `json:"status,omitzero"`
}

type LocalVolumeDeviceLinkList struct {
	metav1.TypeMeta `json:",inline"`

	// metadata is the standard list's metadata.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	metav1.ListMeta `json:"metadata"`

	Items []LocalVolumeDeviceLink `json:"items"`
}

type LocalVolumeDeviceLinkSpec struct {
	// persistentVolumeName is the name of the persistent volume linked to the device
	// +required
	// +kubebuilder:validation:MinLength=1
	// +kubebuilder:validation:MaxLength=253
	PersistentVolumeName string `json:"persistentVolumeName"`

	// nodeName is the name of the OpenShift node on which this
	// LocalVolumeDeviceLink object exists
	// +required
	// +kubebuilder:validation:MinLength=1
	// +kubebuilder:validation:MaxLength=253
	NodeName string `json:"nodeName,omitempty"`

	// policy expresses how to manage symlinks for the device.
	// "None" means no policy has been chosen, and will generate an alert if
	// there is a mismatch between .status.currentLinkTarget and
	// .status.preferredLinkTarget.
	// "CurrentLinkTarget" silences the alert and keeps the existing symlink
	// pointing to .status.currentLinkTarget.
	// "PreferredLinkTarget" silences the alert and changes the symlink to point
	// to .status.preferredLinkTarget.
	// The default value is determined by local-storage-operator and is subject
	// to change. In this version of operator, default is `None`.
	// +optional
	Policy DeviceLinkPolicy `json:"policy,omitempty"`
}

type LocalVolumeDeviceLinkStatus struct {
	// currentLinkTarget is the current devicePath being used by local storage operator
	// This could be /dev/disk/by-id symlink if available but since LocalVolume objects
	// allow users to specify different path, it may be user's specified value in
	// LocalVolume object.
	// +required
	// +kubebuilder:validation:MinLength=1
	// +kubebuilder:validation:MaxLength=4096
	CurrentLinkTarget string `json:"currentLinkTarget,omitempty"`
	// preferredLinkTarget is the /dev/disk/by-id symlink for the device that the local storage
	// operator evaluated as the most stable and the least error prone. The local storage operator
	// recommends using this symlink, after a careful review by the cluster admin.
	// +optional
	// +kubebuilder:validation:MaxLength=4096
	PreferredLinkTarget string `json:"preferredLinkTarget,omitempty"`
	// validLinkTargets is the list of /dev/disk/by-id symlinks for the device that the local
	// storage operator considers as valid. The list may contain at most 256 entries.
	// +optional
	// +listType=set
	// +kubebuilder:validation:MaxItems=256
	ValidLinkTargets []string `json:"validLinkTargets,omitempty"`
	// persistentVolumeSymlinkPath is the symlink in /mnt/local-storage directory that points to
	// the actual local device.
	// This path is used by corresponding PersistentVolume (PV) object for all operations (e.g. mount).
	// LSO creates and updates this symlink for the whole lifetime of the PV.
	// This field is immutable once set, because the path in the corresponding
	// PV object is immutable too.
	// +optional
	// +kubebuilder:validation:MaxLength=4096
	// +kubebuilder:validation:XValidation:rule="self == oldSelf || oldSelf == ”",message="persistentVolumeSymlinkPath is immutable once set"
	PersistentVolumeSymlinkPath string `json:"persistentVolumeSymlinkPath,omitempty"`
	// filesystemUUID is the UUID of the filesystem found on the device (when available)
	// +optional
	// +kubebuilder:validation:MinLength=1
	// +kubebuilder:validation:MaxLength=4096
	FilesystemUUID string `json:"filesystemUUID,omitempty"`
	// conditions is a list of operator conditions.
	// +optional
	// +listType=map
	// +listMapKey=type
	Conditions []operatorv1.OperatorCondition `json:"conditions,omitempty"`
}

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

type LocalVolumeSpec struct {
	// managementState indicates whether and how the operator should manage the component
	// +optional
	ManagementState operatorv1.ManagementState `json:"managementState,omitempty"`
	// logLevel is an intent based logging for an overall component.  It does not give fine grained control, but it is a
	// simple way to manage coarse grained logging choices that operators have to interpret for their operands.
	// +optional
	LogLevel operatorv1.LogLevel `json:"logLevel,omitempty"`
	// Nodes on which the provisoner must run
	// +optional
	NodeSelector *corev1.NodeSelector `json:"nodeSelector,omitempty"`
	// List of storage class and devices they can match
	StorageClassDevices []StorageClassDevice `json:"storageClassDevices,omitempty"`
	// If specified, a list of tolerations to pass to the diskmaker and provisioner DaemonSets.
	// +optional
	Tolerations []corev1.Toleration `json:"tolerations,omitempty"`
}

type LocalVolumeStatus struct {
	// ObservedGeneration is the last generation of this object that
	// the operator has acted on.
	ObservedGeneration *int64 `json:"observedGeneration,omitempty"`

	// state indicates what the operator has observed to be its current operational status.
	State operatorv1.ManagementState `json:"managementState,omitempty"`

	// Conditions is a list of conditions and their status.
	Conditions []operatorv1.OperatorCondition `json:"conditions,omitempty"`

	// readyReplicas indicates how many replicas are ready and at the desired state
	ReadyReplicas int32 `json:"readyReplicas"`

	// generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.
	// +optional
	Generations []operatorv1.GenerationStatus `json:"generations,omitempty"`
}

type PersistentVolumeMode string

type StorageClassDevice struct {
	// StorageClass name to use for set of matched devices
	StorageClassName string `json:"storageClassName"`
	// Volume mode. Raw or with file system
	// + optional
	VolumeMode PersistentVolumeMode `json:"volumeMode,omitempty"`
	// File system type
	// +optional
	FSType string `json:"fsType,omitempty"`
	// A list of device paths which would be chosen for local storage.
	// For example - ["/dev/sda", "/dev/sdb", "/dev/disk/by-id/ata-crucial"]
	DevicePaths []string `json:"devicePaths,omitempty"`
	// This option will destroy all leftover data on the devices before they're used as PersistentVolumes. Use with care.
	// +optional
	ForceWipeDevicesAndDestroyAllData bool `json:"forceWipeDevicesAndDestroyAllData,omitempty"`
}