diff --git a/csi.proto b/csi.proto index d46b4909..cf221041 100644 --- a/csi.proto +++ b/csi.proto @@ -991,7 +991,8 @@ message ControllerServiceCapability { // ListVolumesResponse.entry.published_nodes field LIST_VOLUMES_PUBLISHED_NODES = 10; - // Indicates the SP supports controller level volume condition. + // Indicates that the Controller service can report volume + // conditions. // An SP MAY implement `VolumeCondition` in only the Controller // Plugin, only the Node Plugin, or both. // If `VolumeCondition` is implemented in both the Controller and @@ -1364,7 +1365,7 @@ message VolumeUsage { Unit unit = 4; } -// VolumeCondition represents the current condition of a volume +// VolumeCondition represents the current condition of a volume. message VolumeCondition { option (alpha_message) = true; @@ -1399,7 +1400,7 @@ message NodeServiceCapability { GET_VOLUME_STATS = 2; // See VolumeExpansion for details. EXPAND_VOLUME = 3; - // Indicates the SP supports node level volume condition. + // Indicates that the Node service can report volume conditions. // An SP MAY implement `VolumeCondition` in only the Node // Plugin, only the Controller Plugin, or both. // If `VolumeCondition` is implemented in both the Node and diff --git a/lib/go/csi/csi.pb.go b/lib/go/csi/csi.pb.go index 67f72d26..35f59755 100644 --- a/lib/go/csi/csi.pb.go +++ b/lib/go/csi/csi.pb.go @@ -205,7 +205,8 @@ const ( // Indicates the SP supports the // ListVolumesResponse.entry.published_nodes field ControllerServiceCapability_RPC_LIST_VOLUMES_PUBLISHED_NODES ControllerServiceCapability_RPC_Type = 10 - // Indicates the SP supports controller level volume condition. + // Indicates that the Controller service can report volume + // conditions. // An SP MAY implement `VolumeCondition` in only the Controller // Plugin, only the Node Plugin, or both. // If `VolumeCondition` is implemented in both the Controller and @@ -301,7 +302,7 @@ const ( NodeServiceCapability_RPC_GET_VOLUME_STATS NodeServiceCapability_RPC_Type = 2 // See VolumeExpansion for details. NodeServiceCapability_RPC_EXPAND_VOLUME NodeServiceCapability_RPC_Type = 3 - // Indicates the SP supports node level volume condition. + // Indicates that the Node service can report volume conditions. // An SP MAY implement `VolumeCondition` in only the Node // Plugin, only the Controller Plugin, or both. // If `VolumeCondition` is implemented in both the Node and @@ -4233,7 +4234,7 @@ func (m *VolumeUsage) GetUnit() VolumeUsage_Unit { return VolumeUsage_UNKNOWN } -// VolumeCondition represents the current condition of a volume +// VolumeCondition represents the current condition of a volume. type VolumeCondition struct { // Normal volumes are available for use and operating optimally. // An abnormal volume does not meet these criteria. diff --git a/spec.md b/spec.md index 97595f62..10c7dacb 100644 --- a/spec.md +++ b/spec.md @@ -1548,7 +1548,9 @@ message ControllerGetVolumeResponse { ##### ControllerGetVolume Errors -If the plugin is unable to complete the ControllerGetVolume call successfully, it MUST return a non-ok gRPC code in the gRPC status. If the conditions defined below are encountered, the plugin MUST return the specified gRPC error code. The CO MUST implement the specified error recovery behavior when it encounters the gRPC error code. +If the plugin is unable to complete the ControllerGetVolume call successfully, it MUST return a non-ok gRPC code in the gRPC status. +If the conditions defined below are encountered, the plugin MUST return the specified gRPC error code. +The CO MUST implement the specified error recovery behavior when it encounters the gRPC error code. | Condition | gRPC Code | Description | Recovery Behavior | |-----------|-----------|-------------|-------------------| @@ -1646,7 +1648,8 @@ message ControllerServiceCapability { // ListVolumesResponse.entry.published_nodes field LIST_VOLUMES_PUBLISHED_NODES = 10; - // Indicates the SP supports controller level volume condition. + // Indicates that the Controller service can report volume + // conditions. // An SP MAY implement `VolumeCondition` in only the Controller // Plugin, only the Node Plugin, or both. // If `VolumeCondition` is implemented in both the Controller and @@ -2365,7 +2368,7 @@ message VolumeUsage { Unit unit = 4; } -// VolumeCondition represents the current condition of a volume +// VolumeCondition represents the current condition of a volume. message VolumeCondition { option (alpha_message) = true; @@ -2419,7 +2422,7 @@ message NodeServiceCapability { GET_VOLUME_STATS = 2; // See VolumeExpansion for details. EXPAND_VOLUME = 3; - // Indicates the SP supports node level volume condition. + // Indicates that the Node service can report volume conditions. // An SP MAY implement `VolumeCondition` in only the Node // Plugin, only the Controller Plugin, or both. // If `VolumeCondition` is implemented in both the Node and