Skip to content

Latest commit

 

History

History
45 lines (35 loc) · 2.56 KB

crd-logical-volume.md

File metadata and controls

45 lines (35 loc) · 2.56 KB

LogicalVolume

LogicalVolume is a custom resource definition (CRD) that represents a TopoLVM volume and helps communication between CSI controller and node services.

Field Type Description
apiVersion string APIVersion.
kind string Kind.
metadata ObjectMeta Standard object's metadata.
spec LogicalVolumeSpec Specification of desired behavior of the logical volume.
status LogicalVolumeStatus Most recently observed status of the logical volume.

LogicalVolumeSpec

Field Type Description
name string Suggested name of the logical volume.
nodeName string Name of the node where the logical volume should be created.
size Quantity Amount of local storage required for the logical volume.

LogicalVolumeStatus

Field Type Description
volumeID string Name of the logical volume. Also used as the unique volume ID in the CSI context.
code uint32 gRPC error code. If there is no error, 0 is assigned.
message string Error message.

Lifecycle

Initially, status.volumeID is empty. It is set by topolvm-node on target nodes after it creates an LVM logical volume.

LogicalVolume is created with a finalizer. When a LogicalVolume is being deleted, topolvm-node on the target node deletes the corresponding LVM logical volume and clears the finalizer.