Skip to content

Commit e58bb3d

Browse files
committed
Updated to CSI spec to reflect container-storage-interface/spec#551
1 parent 5558e47 commit e58bb3d

File tree

1 file changed

+14
-22
lines changed
  • keps/sig-storage/3314-csi-changed-block-tracking

1 file changed

+14
-22
lines changed

keps/sig-storage/3314-csi-changed-block-tracking/README.md

+14-22
Original file line numberDiff line numberDiff line change
@@ -557,10 +557,9 @@ message BlockMetadata {
557557
message GetAllocatedRequest {
558558
string security_token = 1;
559559
string namespace = 2;
560-
string volume_id = 3;
561-
string snapshot = 4;
562-
uint64 starting_offset = 5;
563-
uint32 max_results = 6;
560+
string snapshot_id = 3;
561+
uint64 starting_offset = 4;
562+
uint32 max_results = 5;
564563
}
565564
566565
@@ -573,11 +572,10 @@ message GetAllocatedResponse {
573572
message GetDeltaRequest {
574573
string security_token = 1;
575574
string namespace = 2;
576-
string volume = 3;
577-
string base_snapshot = 4;
578-
string target_snapshot = 5;
579-
uint64 starting_byte_offset = 6;
580-
uint32 max_results = 7;
575+
string base_snapshot_id = 3;
576+
string target_snapshot_id = 4;
577+
uint64 starting_byte_offset = 5;
578+
uint32 max_results = 6;
581579
}
582580
583581
message GetDeltaResponse {
@@ -628,10 +626,7 @@ The fields of the `GetAllocatedRequest` message are defined as follows:
628626
This is the object namespace in the CO system.
629627
The SP plugins implementation shall ignore this value.
630628

631-
- `volume_id`<br>
632-
The identifier of the volume in the nomenclature of the plugins.
633-
634-
- `snapshot`<br>
629+
- `snapshot_id`<br>
635630
The identifier of a snapshot of the specified volume, in the nomenclature of the plugins.
636631

637632
- `starting_offset`<br>
@@ -673,7 +668,7 @@ The following conditions are well defined:
673668
| Condition | gRPC Code | Description | Recovery Behavior |
674669
|-----------|-----------|-------------|-------------------|
675670
| Missing or otherwise invalid argument | 3 INVALID_ARGUMENT | Indicates that a required argument field was not specified or an argument value is invalid | The caller should correct the error and resubmit the call. |
676-
| Invalid `volume_id` or `snapshot` | 5 NOT_FOUND | Indicates that the volume or snapshot specified were not found. | The caller should re-check that these objects exist. |
671+
| Invalid `snapshot` | 5 NOT_FOUND | Indicates that the snapshot specified was not found. | The caller should re-check that this object exists. |
677672
| Invalid `starting_offset` | 11 OUT_OF_RANGE | The starting offset exceeds the volume size. | The caller should specify a `starting_offset` less than the volume's size. |
678673
| Invalid `security_token` | 16 UNAUTHENTICATED | The specified authentication token is invalid or has expired. | The caller should obtain a new security token. |
679674

@@ -696,16 +691,13 @@ The fields of the `GetDeltaRequest` message are defined as follows:
696691
This is the object namespace in the CO system.
697692
The SP plugins implementation shall ignore this value.
698693

699-
- `volume_id`<br>
700-
The identifier of the volume in the nomenclature of the plugins.
701-
702-
- `base_snapshot`<br>
694+
- `base_snapshot_id`<br>
703695
The identifier of a snapshot of the specified volume, in the nomenclature of the plugins.
704696

705-
- `target_snapshot`<br>
697+
- `target_snapshot_id`<br>
706698
The identifier of a second snapshot of the specified volume, in the nomenclature of the plugins.
707-
This snapshot should have been created after the `base_snapshot`, and the RPC will return the changes
708-
made since the `base_snapshot` was created.
699+
This snapshot should have been created after the base snapshot, and the RPC will return the changes
700+
made since the base snapshot was created.
709701

710702
- `starting_offset`<br>
711703
This specifies the 0 based starting byte position in the `target_snapshot` from which the result should be computed.
@@ -746,7 +738,7 @@ The following conditions are well defined:
746738
| Condition | gRPC Code | Description | Recovery Behavior |
747739
|-----------|-----------|-------------|-------------------|
748740
| Missing or otherwise invalid argument | 3 INVALID_ARGUMENT | Indicates that a required argument field was not specified or an argument value is invalid | The caller should correct the error and resubmit the call. |
749-
| Invalid `volume_id`, `base_snapshot` or `target_snapshot` | 5 NOT_FOUND | Indicates that the volume or snapshots specified were not found. | The caller should re-check that these objects exist. |
741+
| Invalid `base_snapshot` or `target_snapshot` | 5 NOT_FOUND | Indicates that the snapshots specified were not found. | The caller should re-check that these objects exist. |
750742
| Invalid `starting_offset` | 11 OUT_OF_RANGE | The starting offset exceeds the volume size. | The caller should specify a `starting_offset` less than the volume's size. |
751743
| Invalid `security_token` | 16 UNAUTHENTICATED | The specified authentication token is invalid or has expired. | The caller should obtain a new security token. |
752744

0 commit comments

Comments
 (0)