Skip to content

Commit

Permalink
Change required capability for published_node_ids in GetVolume
Browse files Browse the repository at this point in the history
Instead of PUBLISH_UNPUBLISH_VOLUME, use the LIST_VOLUMES_PUBLISHED_NODES
capability to control the published_node_ids field in ControllerGetVolume.
This change is to be more consistent with the existing behavior. It is
a backwards-incompatible change, but the API is alpha.

Also clarify the LIST_VOLUMES_PUBLISHED_NODES docs.
  • Loading branch information
bswartz committed Jul 23, 2021
1 parent 486e6bd commit d64255d
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
6 changes: 4 additions & 2 deletions csi.proto
Original file line number Diff line number Diff line change
Expand Up @@ -922,7 +922,7 @@ message ControllerGetVolumeResponse {
// A list of all the `node_id` of nodes that this volume is
// controller published on.
// This field is OPTIONAL.
// This field MUST be specified if the PUBLISH_UNPUBLISH_VOLUME
// This field MUST be specified if the LIST_VOLUMES_PUBLISHED_NODES
// controller capability is supported.
// published_node_ids MAY include nodes not published to or
// reported by the SP. The CO MUST be resilient to that.
Expand Down Expand Up @@ -1049,7 +1049,9 @@ message ControllerServiceCapability {
EXPAND_VOLUME = 9;

// Indicates the SP supports the
// ListVolumesResponse.entry.published_nodes field
// ListVolumesResponse.entry.published_node_ids field and the
// ControllerGetVolumeResponse.published_node_ids field.
// The SP MUST also support PUBLISH_UNPUBLISH_VOLUME.
LIST_VOLUMES_PUBLISHED_NODES = 10;

// Indicates that the Controller service can report volume
Expand Down
6 changes: 4 additions & 2 deletions spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -1553,7 +1553,7 @@ message ControllerGetVolumeResponse {
// A list of all the `node_id` of nodes that this volume is
// controller published on.
// This field is OPTIONAL.
// This field MUST be specified if the PUBLISH_UNPUBLISH_VOLUME
// This field MUST be specified if the LIST_VOLUMES_PUBLISHED_NODES
// controller capability is supported.
// published_node_ids MAY include nodes not published to or
// reported by the SP. The CO MUST be resilient to that.
Expand Down Expand Up @@ -1709,7 +1709,9 @@ message ControllerServiceCapability {
EXPAND_VOLUME = 9;
// Indicates the SP supports the
// ListVolumesResponse.entry.published_nodes field
// ListVolumesResponse.entry.published_node_ids field and the
// ControllerGetVolumeResponse.published_node_ids field.
// The SP MUST also support PUBLISH_UNPUBLISH_VOLUME.
LIST_VOLUMES_PUBLISHED_NODES = 10;
// Indicates that the Controller service can report volume
Expand Down

0 comments on commit d64255d

Please sign in to comment.