Skip to content

Commit f319d43

Browse files
committed
Add note about possibly lower available capacity on MountVolume volumes
When a CreateVolume request is handled by an SP, the requested capacity does not include any potential overhead of filesystem metadata. This can cause confusion, as users may not be able to store data up to the amount of the requested size of the volume. The SP is expected to provision a volume following the capacity_range request, but the SP may not know how much storage for filesystem metadata will be required (depends on filesystem type and enabled features). In these cases, the usable capacity of the volume will be slightly smaller than the requested capacity.
1 parent e6fc13e commit f319d43

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

spec.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -790,6 +790,8 @@ Plugins MAY create 3 types of volumes:
790790
If CO requests a volume to be created from existing snapshot or volume and the requested size of the volume is larger than the original snapshotted (or cloned volume), the Plugin can either refuse such a call with `OUT_OF_RANGE` error or MUST provide a volume that, when presented to a workload by `NodePublish` call, has both the requested (larger) size and contains data from the snapshot (or original volume).
791791
Explicitly, it's the responsibility of the Plugin to resize the filesystem of the newly created volume at (or before) the `NodePublish` call, if the volume has `VolumeCapability` access type `MountVolume` and the filesystem resize is required in order to provision the requested capacity.
792792

793+
NOTE: The requested and reported sizes for a volume refer to the raw volume size that the SP allocated for the volume. Volumes with an `access_type` of `MountVolume` MAY have less available capacity due to the overhead of filesystem metadata (exact amount depends on filesystem). The underlying volume when used in `access_mode` with a value of `BlockVolume` MUST match the specified `capacity_range` request.
794+
793795
```protobuf
794796
message CreateVolumeRequest {
795797
// The suggested name for the storage space. This field is REQUIRED.

0 commit comments

Comments
 (0)