@@ -112,7 +112,7 @@ message CreateVolumeRequest {
112
112
113
113
// The suggested name for the storage space. This field is REQUIRED.
114
114
// It serves two purposes:
115
- // 1) Idempotency - This name is generated by the CO to achieve
115
+ // 1) Idempotency - This name is generated by the CO to achieve
116
116
// idempotency. If `CreateVolume` fails, the volume may or may not
117
117
// be provisioned. In this case, the CO may call `CreateVolume`
118
118
// again, with the same name, to ensure the volume exists. The
@@ -141,7 +141,7 @@ message CreateVolumeRequest {
141
141
// not supported by the Plugin, the call SHALL fail. This field is
142
142
// REQUIRED.
143
143
repeated VolumeCapability volume_capabilities = 4 ;
144
-
144
+
145
145
// Plugin specific parameters passed in as opaque key-value pairs.
146
146
// This field is OPTIONAL. The Plugin is responsible for parsing and
147
147
// validating these parameters. COs will treat these as opaque.
@@ -229,7 +229,7 @@ message VolumeCapability {
229
229
// `required_bytes` and `limit_bytes` can be set to the same value. At
230
230
// least one of the these fields MUST be specified.
231
231
message CapacityRange {
232
- // Volume must be at least this big.
232
+ // Volume must be at least this big.
233
233
uint64 required_bytes = 1 ;
234
234
235
235
// Volume must not be bigger than this.
@@ -260,7 +260,7 @@ message VolumeInfo {
260
260
// The total bytes of a serialized VolumeHandle must be less than 1 MiB.
261
261
message VolumeHandle {
262
262
// ID is the identity of the provisioned volume specified by the
263
- // Plugin. This field is REQUIRED.
263
+ // Plugin. This field is REQUIRED.
264
264
// This information SHALL NOT be considered sensitive such that, for
265
265
// example, the CO MAY generate log messages that include this data.
266
266
string id = 1 ;
@@ -320,7 +320,7 @@ message ControllerPublishVolumeRequest {
320
320
// The handle of the volume to be used on a node.
321
321
// This field is REQUIRED.
322
322
VolumeHandle volume_handle = 2 ;
323
-
323
+
324
324
// The ID of the node. This field is OPTIONAL. The CO SHALL set (or
325
325
// clear) this field to match the `NodeID` returned by `GetNodeID`.
326
326
// `GetNodeID` is allowed to omit `NodeID` from a successful `Result`;
@@ -414,7 +414,7 @@ message ValidateVolumeCapabilitiesRequest {
414
414
Version version = 1 ;
415
415
416
416
// The information about the volume to check. This is a REQUIRED
417
- // field.
417
+ // field.
418
418
VolumeInfo volume_info = 2 ;
419
419
420
420
// The capabilities that the CO wants to check for the volume. This
@@ -455,10 +455,10 @@ message ListVolumesRequest {
455
455
// returned.
456
456
uint32 max_entries = 2 ;
457
457
458
- // A token to specify where to start paginating. Set this field to
458
+ // A token to specify where to start paginating. Set this field to
459
459
// `next_token` returned by a previous `ListVolumes` call to get the
460
460
// next page of entries. This field is OPTIONAL.
461
- string starting_token = 3 ;
461
+ string starting_token = 3 ;
462
462
}
463
463
464
464
message ListVolumesResponse {
@@ -469,7 +469,7 @@ message ListVolumesResponse {
469
469
470
470
repeated Entry entries = 1 ;
471
471
472
- // This token allows you to get the next page of entries for
472
+ // This token allows you to get the next page of entries for
473
473
// `ListVolumes` request. If the number of entries is larger than
474
474
// `max_entries`, use the `next_token` as a value for the
475
475
// `starting_token` field in the next `ListVolumes` request. This
@@ -548,12 +548,12 @@ message ControllerServiceCapability {
548
548
CREATE_DELETE_VOLUME = 1 ;
549
549
PUBLISH_UNPUBLISH_VOLUME = 2 ;
550
550
LIST_VOLUMES = 3 ;
551
- GET_CAPACITY = 4 ;
551
+ GET_CAPACITY = 4 ;
552
552
}
553
553
554
554
Type type = 1 ;
555
555
}
556
-
556
+
557
557
oneof type {
558
558
// RPC that the controller supports.
559
559
RPC rpc = 1 ;
@@ -568,7 +568,7 @@ message NodePublishVolumeRequest {
568
568
// The handle of the volume to publish. This field is REQUIRED.
569
569
VolumeHandle volume_handle = 2 ;
570
570
571
- // The CO SHALL set this field to the value returned by
571
+ // The CO SHALL set this field to the value returned by
572
572
// `ControllerPublishVolume` if the corresponding Controller Plugin
573
573
// has `PUBLISH_UNPUBLISH_VOLUME` controller capability, and SHALL be
574
574
// left unset if the corresponding Controller Plugin does not have
@@ -612,7 +612,7 @@ message NodeUnpublishVolumeRequest {
612
612
// The handle of the volume. This field is REQUIRED.
613
613
VolumeHandle volume_handle = 2 ;
614
614
615
- // The path at which the volume was published. It MUST be an absolute
615
+ // The path at which the volume was published. It MUST be an absolute
616
616
// path in the root filesystem of the process serving this request.
617
617
// This is a REQUIRED field.
618
618
string target_path = 3 ;
@@ -640,10 +640,10 @@ message GetNodeIDRequest {
640
640
641
641
message GetNodeIDResponse {
642
642
message Result {
643
- // The ID of the node which SHALL be used by CO in
643
+ // The ID of the node which SHALL be used by CO in
644
644
// `ControllerPublishVolume`. This is an OPTIONAL field. If unset,
645
645
// the CO SHALL leave the `node_id` field unset in
646
- // `ControllerPublishVolume`.
646
+ // `ControllerPublishVolume`.
647
647
NodeID node_id = 1 ;
648
648
}
649
649
@@ -699,7 +699,7 @@ message NodeServiceCapability {
699
699
700
700
Type type = 1 ;
701
701
}
702
-
702
+
703
703
oneof type {
704
704
// RPC that the controller supports.
705
705
RPC rpc = 1 ;
@@ -841,7 +841,7 @@ message Error {
841
841
// retrying.
842
842
INVALID_PARAMETER_VALUE = 7 ;
843
843
}
844
-
844
+
845
845
// Machine parsable error code.
846
846
CreateVolumeErrorCode error_code = 1 ;
847
847
@@ -900,7 +900,7 @@ message Error {
900
900
// succeeded.
901
901
VOLUME_DOES_NOT_EXIST = 4 ;
902
902
}
903
-
903
+
904
904
// Machine parsable error code.
905
905
DeleteVolumeErrorCode error_code = 1 ;
906
906
@@ -1007,7 +1007,7 @@ message Error {
1007
1007
// retrying.
1008
1008
INVALID_NODE_ID = 8 ;
1009
1009
}
1010
-
1010
+
1011
1011
// Machine parsable error code.
1012
1012
ControllerPublishVolumeErrorCode error_code = 1 ;
1013
1013
@@ -1098,7 +1098,7 @@ message Error {
1098
1098
// retrying.
1099
1099
NODE_ID_REQUIRED = 8 ;
1100
1100
}
1101
-
1101
+
1102
1102
ControllerUnpublishVolumeErrorCode error_code = 1 ;
1103
1103
string error_description = 2 ;
1104
1104
}
@@ -1136,7 +1136,7 @@ message Error {
1136
1136
// retrying.
1137
1137
INVALID_VOLUME_INFO = 5 ;
1138
1138
}
1139
-
1139
+
1140
1140
ValidateVolumeCapabilitiesErrorCode error_code = 1 ;
1141
1141
string error_description = 2 ;
1142
1142
}
@@ -1190,7 +1190,7 @@ message Error {
1190
1190
// retrying.
1191
1191
INVALID_VOLUME_HANDLE = 7 ;
1192
1192
}
1193
-
1193
+
1194
1194
NodePublishVolumeErrorCode error_code = 1 ;
1195
1195
string error_description = 2 ;
1196
1196
}
@@ -1241,7 +1241,7 @@ message Error {
1241
1241
// retrying.
1242
1242
INVALID_VOLUME_HANDLE = 4 ;
1243
1243
}
1244
-
1244
+
1245
1245
NodeUnpublishVolumeErrorCode error_code = 1 ;
1246
1246
string error_description = 2 ;
1247
1247
}
@@ -1262,7 +1262,7 @@ message Error {
1262
1262
BAD_PLUGIN_CONFIG = 1 ;
1263
1263
MISSING_REQUIRED_HOST_DEPENDENCY = 2 ;
1264
1264
}
1265
-
1265
+
1266
1266
ProbeNodeErrorCode error_code = 1 ;
1267
1267
string error_description = 2 ;
1268
1268
}
@@ -1282,7 +1282,7 @@ message Error {
1282
1282
BAD_PLUGIN_CONFIG = 1 ;
1283
1283
MISSING_REQUIRED_HOST_DEPENDENCY = 2 ;
1284
1284
}
1285
-
1285
+
1286
1286
GetNodeIDErrorCode error_code = 1 ;
1287
1287
string error_description = 2 ;
1288
1288
}
0 commit comments