UserVolumeConfig

UserVolumeConfig is a user volume configuration document. User volume is automatically allocated as a partition on the specified disk and mounted under /var/mnt/<name>. The partition label is automatically generated as u-<name>.

apiVersion: v1alpha1
kind: UserVolumeConfig
name: ceph-data # Name of the volume.
# The provisioning describes how the volume is provisioned.
provisioning:
    # The disk selector expression.
    diskSelector:
        match: disk.transport == "nvme" # The Common Expression Language (CEL) expression to match the disk.
    maxSize: 50GiB # The maximum size of the volume, if not specified the volume can grow to the size of the

    # # The minimum size of the volume.
    # minSize: 2.5GiB
# The filesystem describes how the volume is formatted.
filesystem:
    type: xfs # Filesystem type. Default is `xfs`.

Field	Type	Description
`name`	string	Name of the volume. Name might be between 1 and 34 characters long and can only contain: lowercase and uppercase ASCII letters, digits, and hyphens.
`provisioning`	ProvisioningSpec	The provisioning describes how the volume is provisioned.
`filesystem`	FilesystemSpec	The filesystem describes how the volume is formatted.

provisioning

ProvisioningSpec describes how the volume is provisioned.

Field	Type	Description
`diskSelector`	DiskSelector	The disk selector expression.
`grow`	bool	Should the volume grow to the size of the disk (if possible).
`minSize`	ByteSize	The minimum size of the volume. Size is specified in bytes, but can be expressed in human readable format, e.g. 100MB. Show example(s) `minSize: 2.5GiB`
`maxSize`	ByteSize	The maximum size of the volume, if not specified the volume can grow to the size of the disk. Size is specified in bytes, but can be expressed in human readable format, e.g. 100MB. Show example(s) `maxSize: 50GiB`

diskSelector

DiskSelector selects a disk for the volume.

Field	Type	Description	Value(s)
`match`	Expression	The Common Expression Language (CEL) expression to match the disk. Show example(s) `match: disk.size > 120u * GB && disk.size < 1u * TB` `match: disk.transport == "sata" && !disk.rotational && !system_disk`

filesystem

FilesystemSpec configures the filesystem for the volume.

Field	Type	Description	Value(s)
`type`	FilesystemType	Filesystem type. Default is `xfs`.	`ext4` `xfs`

Last modified April 3, 2025: feat: implement user volumes (664fa3697)