Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The VolumeGroup specification contains a few minor mistakes #71

Merged
merged 3 commits into from
Aug 5, 2024
Merged

The VolumeGroup specification contains a few minor mistakes #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4827b97
volumegroup: description should mention MODIFY_VOLUME_GROUP
nixpanic Jul 25, 2024
29950bf
volumegroup: correct comment for the ControllerGetVolumeGroup RPC call
nixpanic Jul 25, 2024
1aedc8a
build: update generated files
nixpanic Jul 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions lib/go/volumegroup/volumegroup_grpc.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions volumegroup/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ service Controller {
// ListVolumeGroups RPC call to list volume groups.
rpc ListVolumeGroups(ListVolumeGroupsRequest)
returns (ListVolumeGroupsResponse) {}
// CreateVolumeGroup RPC call to get a volume group.
// ControllerGetVolumeGroup RPC call to get a volume group.
rpc ControllerGetVolumeGroup(ControllerGetVolumeGroupRequest)
returns (ControllerGetVolumeGroupResponse) {}
}
Expand Down Expand Up @@ -181,7 +181,7 @@ It is out of the scope of the CSI spec to determine whether a group is consisten
provider to clarify that in the vendor specific documentation. This is true either when creating a new volume with a
group id or adding an existing volume to a group.

CSI drivers supporting MODIFY_VOLUME_GROUP_MEMBERSHIP MUST implement ModifyVolumeGroupMembership RPC.
CSI drivers supporting MODIFY_VOLUME_GROUP MUST implement ModifyVolumeGroupMembership RPC.

```protobuf
// ModifyVolumeGroupMembershipRequest holds the required
Expand Down Expand Up @@ -228,7 +228,7 @@ code. The CO MUST implement the specified error recovery behavior when it encoun

| Condition | gRPC Code | Description | Recovery Behavior |
| ---------------------------------------------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| Volumes incompatible or not supported | 3 INVALID_ARGUMENT | Besides the general cases, this code MUST also be used to indicate when plugin supporting MODIFY_VOLUME_GROUP_MEMBERSHIP cannot modify a volume group because a volume to be added is incompatible with other volumes in the group. More human-readable information SHOULD be provided in the gRPC `status.message` field. | On volumes incompatibility related issues, caller MUST use different volume ids as the input parameter. |
| Volumes incompatible or not supported | 3 INVALID_ARGUMENT | Besides the general cases, this code MUST also be used to indicate when plugin supporting MODIFY_VOLUME_GROUP cannot modify a volume group because a volume to be added is incompatible with other volumes in the group. More human-readable information SHOULD be provided in the gRPC `status.message` field. | On volumes incompatibility related issues, caller MUST use different volume ids as the input parameter. |
| Volume id or volume group does not exist | 5 NOT_FOUND | Indicates that one of the specified volume ids or the volume group itself does not exist. | Caller MUST verify that the `volume_ids` is correct and the volume group exists, and has not been deleted before retrying with exponential back off. |
| Unable to add volumes because the maximum is reached | 8 RESOURCE_EXHAUSTED | Indicates that group can not add more volumes because the maximum limit is reached. More human-readable information MAY be provided in the gRPC `status.message` field. | Caller MUST ensure that whatever is preventing volume group from being modified is addressed before retrying with exponential backoff. |

Expand Down
2 changes: 1 addition & 1 deletion volumegroup/volumegroup.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ service Controller {
// ListVolumeGroups RPC call to list volume groups.
rpc ListVolumeGroups(ListVolumeGroupsRequest)
returns (ListVolumeGroupsResponse) {}
// CreateVolumeGroup RPC call to get a volume group.
// ControllerGetVolumeGroup RPC call to get a volume group.
rpc ControllerGetVolumeGroup(ControllerGetVolumeGroupRequest)
returns (ControllerGetVolumeGroupResponse) {}
}
Expand Down