Improve error messages for ControllerExpandVolume / CreateSnapshot of multi-zone PV. #1718

hungnguyen243 · 2024-05-21T20:53:13Z

What type of PR is this?

/kind cleanup

What this PR does / why we need it:

Improve error messages for ControllerExpandVolume / CreateSnapshot of multi-zone PV.

Before:
CreateSnapshot: "Failed to create snapshot: failed to take snapshot of the volume projects/psch-gke-dev/zones/multi-zone/disks/hdml-llama2-70b-hf: "rpc error: code = Unknown desc = CreateSnapshot, failed
to getDisk: googleapi: Error 400: Invalid value for field 'zone': 'multi-zone'. Unknown zone., invalid"
ControllerExpandVolume: "resize volume "my-disk-pv" by resizer "pd.csi.storage.gke.io" failed: rpc error: code = Unknown desc = ControllerExpandVolume failed to resize disk: failed to get disk: googleapi: Error 400: In
valid value for field 'zone': 'multi-zone'. Unknown zone., invalid"

After:
CreateSnapshot: "Snapshots are not supported with the multi-zone PV volumeHandle feature"
ControllerExpandVolume: "Resize operation is not supported with the multi-zone PVC volumeHandle feature. Please re-create the disk from source if you want a larger size."

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?

Update logging on multi-zone feature support for volume snapshot and resize

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

…shot

k8s-ci-robot · 2024-05-21T20:53:23Z

Hi @hungnguyen243. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Sneha-at · 2024-05-21T22:15:46Z

/ok-to-test

Sneha-at · 2024-05-21T23:57:16Z

/retest-required

hungnguyen243 · 2024-05-22T01:18:39Z

/retest-required

amacaskill · 2024-05-22T19:32:36Z

I checked the e2e snapshot failure, the snapshot operation hadn't returned success before we tried to delete the disk, so that's why we got the operation error: https://screenshot.googleplex.com/7aHcpQdMhw4sBr5

…eSnapshot

hungnguyen243 · 2024-05-23T15:59:47Z

/retest-required

hungnguyen243 · 2024-05-23T16:38:16Z

/retest

Sneha-at · 2024-05-23T22:09:26Z

/lgtm

pwschuurman · 2024-05-24T20:38:54Z

pkg/gce-pd-csi-driver/controller.go

@@ -1158,6 +1158,11 @@ func (gceCS *GCEControllerServer) CreateSnapshot(ctx context.Context, req *csi.C
 		return nil, status.Errorf(codes.InvalidArgument, "CreateSnapshot Volume ID is invalid: %v", err.Error())
 	}

+	volumeIsMultiZone := isMultiZoneVolKey(volKey)
+	if gceCS.multiZoneVolumeHandleConfig.Enable && volumeIsMultiZone {
+		return nil, fmt.Errorf("Snapshots are not supported with the `multi-zone` PV volumeHandle feature.")


These should return a proper status.Error (eg: InvalidArgument)

I would also omit the backticks. This will be printed to the terminal, so it won't be markdown formatted

pwschuurman · 2024-05-24T20:40:21Z

pkg/gce-pd-csi-driver/controller.go

+
+	volumeIsMultiZone := isMultiZoneVolKey(volKey)
+	if gceCS.multiZoneVolumeHandleConfig.Enable && volumeIsMultiZone {
+		return nil, fmt.Errorf("Resize operation is not supported with the `multi-zone` PVC volumeHandle feature. Please re-create the disk from source if you want a larger size.")


I think naming this "ControllerExpandVolume" instead of "Resize operation" is actually better. It describes the RPC, as "Resize" is more of a Container Orchestrator term.

pwschuurman · 2024-05-24T20:42:18Z

pkg/gce-pd-csi-driver/controller.go

+
+	volumeIsMultiZone := isMultiZoneVolKey(volKey)
+	if gceCS.multiZoneVolumeHandleConfig.Enable && volumeIsMultiZone {
+		return nil, fmt.Errorf("Resize operation is not supported with the `multi-zone` PVC volumeHandle feature. Please re-create the disk from source if you want a larger size.")


Use "volume" instead of "disk". Also, print out the volumeID in the error message

pwschuurman

Please add some tests that validate passing in a "multi-zone" volumeID returns the appropriate error (eg: InvalidArgument) for these two RPCs.

pwschuurman · 2024-05-24T22:27:22Z

pkg/gce-pd-csi-driver/controller.go

@@ -1158,6 +1158,11 @@ func (gceCS *GCEControllerServer) CreateSnapshot(ctx context.Context, req *csi.C
 		return nil, status.Errorf(codes.InvalidArgument, "CreateSnapshot Volume ID is invalid: %v", err.Error())
 	}

+	volumeIsMultiZone := isMultiZoneVolKey(volKey)
+	if gceCS.multiZoneVolumeHandleConfig.Enable && volumeIsMultiZone {
+		return nil, status.Errorf(codes.InvalidArgument, "Snapshots are not supported with the multi-zone PV volumeHandle feature")


Can you also emit the volumeID here?

pwschuurman · 2024-05-24T22:28:00Z

pkg/gce-pd-csi-driver/controller_test.go

@@ -255,6 +255,77 @@ func TestCreateSnapshotArguments(t *testing.T) {
 	}
 }

+func TestUnsupporteddMultiZoneCreateSnapshot(t *testing.T) {


s/TestUnsupporteddMultiZoneCreateSnapshot/TestUnsupportedMultiZoneCreateSnapshot

pwschuurman · 2024-05-24T22:30:50Z

/lgtm

pwschuurman · 2024-05-24T22:53:13Z

/lgtm
/approve

k8s-ci-robot · 2024-05-24T22:53:18Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: hungnguyen243, pwschuurman

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [pwschuurman]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

hungnguyen243 · 2024-05-28T20:26:30Z

/retest

improve error messages for multi-PV ControllerExpandVolume/CreateSnap…

3137bf0

…shot

k8s-ci-robot added do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels May 21, 2024

k8s-ci-robot requested review from leiyiz and mattcary May 21, 2024 20:53

k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label May 21, 2024

k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label May 21, 2024

k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels May 21, 2024

move error logging for multi-zone PV from createPdSnapshot into Creat…

015dede

…eSnapshot

k8s-ci-robot assigned Sneha-at May 23, 2024

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 23, 2024

pwschuurman reviewed May 24, 2024

View reviewed changes

update error status code and add test cases

a72836c

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed lgtm "Looks good to me", indicates that a PR is ready to be merged. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 24, 2024

pwschuurman reviewed May 24, 2024

View reviewed changes

k8s-ci-robot assigned pwschuurman May 24, 2024

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 24, 2024

add volume ID to CreateSnapshot error message

eb3e6eb

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 24, 2024

correct typo in test case func

6a7146b

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 24, 2024

k8s-ci-robot merged commit 82c6deb into kubernetes-sigs:master May 28, 2024
7 checks passed

hungnguyen243 mentioned this pull request Feb 27, 2025

REQUEST: New membership for hungnguyen243 kubernetes/org#5431

Closed

11 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve error messages for ControllerExpandVolume / CreateSnapshot of multi-zone PV. #1718

Improve error messages for ControllerExpandVolume / CreateSnapshot of multi-zone PV. #1718

hungnguyen243 commented May 21, 2024 •

edited

Loading

k8s-ci-robot commented May 21, 2024

Sneha-at commented May 21, 2024

Sneha-at commented May 21, 2024

hungnguyen243 commented May 22, 2024

amacaskill commented May 22, 2024

hungnguyen243 commented May 23, 2024 •

edited

Loading

hungnguyen243 commented May 23, 2024

Sneha-at commented May 23, 2024

pwschuurman May 24, 2024

pwschuurman May 24, 2024

pwschuurman May 24, 2024

pwschuurman May 24, 2024

pwschuurman left a comment

pwschuurman May 24, 2024

pwschuurman May 24, 2024

pwschuurman commented May 24, 2024

pwschuurman commented May 24, 2024

k8s-ci-robot commented May 24, 2024

hungnguyen243 commented May 28, 2024

Improve error messages for ControllerExpandVolume / CreateSnapshot of multi-zone PV. #1718

Improve error messages for ControllerExpandVolume / CreateSnapshot of multi-zone PV. #1718

Conversation

hungnguyen243 commented May 21, 2024 • edited Loading

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Special notes for your reviewer:

Does this PR introduce a user-facing change?

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

k8s-ci-robot commented May 21, 2024

Sneha-at commented May 21, 2024

Sneha-at commented May 21, 2024

hungnguyen243 commented May 22, 2024

amacaskill commented May 22, 2024

hungnguyen243 commented May 23, 2024 • edited Loading

hungnguyen243 commented May 23, 2024

Sneha-at commented May 23, 2024

pwschuurman May 24, 2024

Choose a reason for hiding this comment

pwschuurman May 24, 2024

Choose a reason for hiding this comment

pwschuurman May 24, 2024

Choose a reason for hiding this comment

pwschuurman May 24, 2024

Choose a reason for hiding this comment

pwschuurman left a comment

Choose a reason for hiding this comment

pwschuurman May 24, 2024

Choose a reason for hiding this comment

pwschuurman May 24, 2024

Choose a reason for hiding this comment

pwschuurman commented May 24, 2024

pwschuurman commented May 24, 2024

k8s-ci-robot commented May 24, 2024

hungnguyen243 commented May 28, 2024

hungnguyen243 commented May 21, 2024 •

edited

Loading

hungnguyen243 commented May 23, 2024 •

edited

Loading