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.

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

describe ABORTED as error message for CreateVolumeGroupSnapshot #563

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

nixpanic
Copy link

What type of PR is this?

Documentation enhancement for a common CreateVolumeGroupSnapshot error.

What this PR does / why we need it:

The ABORTED error code is currently not documented for CreateVolumeGroupSnapshot but is explained for CreateSnapshot.

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Does this PR introduce an API-breaking change?:

none

Copy link
Member

@saad-ali saad-ali left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Per @bswartz --

  • "Not clear what expected behavior if GroupSnapshot for volume A, B, C pending and another one for group B, C, D is triggered"
  • "Probably ok if there are 2 overlapping group snapshots and SP decided to return ABORTED for 2nd snapshot and let you retry." So it's probably ok not to explicitly mention this case.

Per @xing-yang: "Specified group snapshot, could mean all parameters have to be the same".

Next step:

  • Let's clarify what "specified group snapshot" means.

@saad-ali
Copy link
Member

Also, @nixpanic, please make sure you've signed the CLA.

@nixpanic
Copy link
Author

Per @bswartz --

* "Not clear what expected behavior if GroupSnapshot for volume A, B, C pending and another one for group B, C, D is triggered"

* "Probably ok if there are 2 overlapping group snapshots and SP decided to return ABORTED for 2nd snapshot and let you retry." So it's probably ok not to explicitly mention this case.

If there is a conflict with the volumes that are part of the group snapshot that should be created, the FAILED_PRECONDITION error is more suitable to return. I do not think ABORTED needs to cover a case like this (too).

Per @xing-yang: "Specified group snapshot, could mean all parameters have to be the same".

Yes, that is more suitable. This ABORTED error is for the CreateVolumeGroupSnapshot call, and is intended to match the similar error that CreateVolume can return.

Next step:

* Let's clarify what "specified group snapshot" means.

I've rephrased specified group snapshot to group snapshot with the exact same parameters and similar.

Also, @nixpanic, please make sure you've signed the CLA.

This was completed with a group approval for IBM employees, sent by Brad Topol in the beginning of the month 🥳

Just like ABORTED is an error for the CreateSnapshot procedure, it
should be documented for CreateVolumeGroupSnapshot.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants