Skip to content

Commit 25a8dcf

Browse files
committed
Clarify VolumeCapability and readonly on publish and stage
1 parent 8fd698e commit 25a8dcf

File tree

3 files changed

+107
-89
lines changed

3 files changed

+107
-89
lines changed

csi.proto

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -592,11 +592,13 @@ message ControllerPublishVolumeRequest {
592592
// field to match the node ID returned by `NodeGetInfo`.
593593
string node_id = 2;
594594

595-
// The capability of the volume the CO expects the volume to have.
595+
// Volume capability describing how the CO intends to use this volume.
596+
// SP MUST ensure the CO can use the published volume as described.
597+
// Otherwise SP MUST return the appropriate gRPC error code.
596598
// This is a REQUIRED field.
597599
VolumeCapability volume_capability = 3;
598600

599-
// Whether to publish the volume in readonly mode.
601+
// Indicates SP MUST publish the volume in readonly mode.
600602
// CO MUST set this field to false if SP does not have the
601603
// PUBLISH_READONLY controller capability.
602604
// This is a REQUIRED field.
@@ -954,7 +956,9 @@ message NodeStageVolumeRequest {
954956
// This is a REQUIRED field.
955957
string staging_target_path = 3;
956958

957-
// The capability of the volume the CO expects the volume to have.
959+
// Volume capability describing how the CO intends to use this volume.
960+
// SP MUST ensure the CO can use the staged volume as described.
961+
// Otherwise SP MUST return the appropriate gRPC error code.
958962
// This is a REQUIRED field.
959963
VolumeCapability volume_capability = 4;
960964

@@ -1013,12 +1017,14 @@ message NodePublishVolumeRequest {
10131017
// This is a REQUIRED field.
10141018
string target_path = 4;
10151019

1016-
// The capability of the volume the CO expects the volume to have.
1020+
// Volume capability describing how the CO intends to use this volume.
1021+
// SP MUST ensure the CO can use the published volume as described.
1022+
// Otherwise SP MUST return the appropriate gRPC error code.
10171023
// This is a REQUIRED field.
10181024
VolumeCapability volume_capability = 5;
10191025

1020-
// Whether to publish the volume in readonly mode. This field is
1021-
// REQUIRED.
1026+
// Indicates SP MUST publish the volume in readonly mode.
1027+
// This field is REQUIRED.
10221028
bool readonly = 6;
10231029

10241030
// Secrets required by plugin to complete node publish volume request.

0 commit comments

Comments
 (0)