Skip to content

Commit cbb86a4

Browse files
committed
Clarify VolumeCapability in CreateVolumeRequest
Clarify why VolumeCapability in CreateVolumeRequest is a repeated list.
1 parent b08a16d commit cbb86a4

File tree

3 files changed

+113
-95
lines changed

3 files changed

+113
-95
lines changed

csi.proto

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -200,14 +200,20 @@ message CreateVolumeRequest {
200200

201201
CapacityRange capacity_range = 2;
202202

203-
// The capabilities that the provisioned volume MUST have: the Plugin
204-
// MUST provision a volume that could satisfy ALL of the
205-
// capabilities specified in this list. The Plugin MUST assume that
206-
// the CO MAY use the provisioned volume later with ANY of the
207-
// capabilities specified in this list. This also enables the CO to do
208-
// early validation: if ANY of the specified volume capabilities are
209-
// not supported by the Plugin, the call SHALL fail. This field is
210-
// REQUIRED.
203+
// The capabilities that the provisioned volume MUST have. SP MUST
204+
// provision a volume that will satisfy ALL of the capabilities
205+
// specified in this list. Otherwise SP MUST return the appropriate
206+
// gRPC error code.
207+
// The Plugin MUST assume that the CO MAY use the provisioned volume
208+
// with ANY of the capabilities specified in this list.
209+
// For example, a CO MAY specify two volume capabilities: one with
210+
// access mode SINGLE_NODE_WRITER and another with access mode
211+
// MULTI_NODE_READER_ONLY. In this case, the SP MUST verify that the
212+
// provisioned volume can be used in either mode.
213+
// This also enables the CO to do early validation: If ANY of the
214+
// specified volume capabilities are not supported by the SP, the call
215+
// MUST return the appropriate gRPC error code.
216+
// This field is REQUIRED.
211217
repeated VolumeCapability volume_capabilities = 3;
212218

213219
// Plugin specific parameters passed in as opaque key-value pairs.

0 commit comments

Comments
 (0)