Add GroupControllerServer interface for VolumeGroupSnapshot API

[nixpanic]

What type of PR is this?

Uncomment only one /kind <> line, hit enter to put that in a new line, and remove leading whitespaces from that line:

/kind api-change
/kind bug
/kind cleanup
/kind design
/kind documentation
/kind failing-test

/kind feature

/kind flake

What this PR does / why we need it:

VolumeGroupSnapshots have been added to the CSI Spec with version 1.8.0. This PR implements the new API.

Which issue(s) this PR fixes:

Fixes #417
Closes #426 a copy of this PR with kubernetes-csi/csi-test#467 to run CSI Sanity validation

Special notes for your reviewer:

The Kubernetes CSI external-snapshotter does not have the full functionality at this time. The implementation of the VolumeGroupSnapshot functions is largely untested at the moment.

Does this PR introduce a user-facing change?:

Together with the Kubernetes CSI external-snapshotter, the csi-driver-host-path provides ALPHA support for the VolumeGroupSnapshot functionality.

[k8s-ci-robot]

Welcome @nixpanic!

It looks like this is your first PR to kubernetes-csi/csi-driver-host-path 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-csi/csi-driver-host-path has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

[k8s-ci-robot]

Hi @nixpanic. Thanks for your PR.

I'm waiting for a kubernetes-csi 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/test-infra repository.

[xing-yang]

/ok-to-test

[xing-yang]

/assign

[nixpanic]

Addressed all typos in pkg/state/state.go.

I do not see an issue with the use of the hostPath.mutex in the newly added CSI RPC functions.

[nixpanic]

In case someone wants to test this PR, a container image is available at quay.io/nixpanic/csi-driver-host-path:GroupControllerServer.

[xing-yang]

This missed adding a Type: csi.PluginCapability_Service_GROUP_CONTROLLER_SERVICE here:
https://github.com/kubernetes-csi/csi-driver-host-path/blob/v1.11.0/pkg/hostpath/identityserver.go#L54

[RaunakShah]

Also, GetPluginCapabilities in hostpath/identityserver.go needs to return the group controller capability

[nixpanic]

Thanks for the reviews @xing-yang and @RaunakShah! Your comments should have been addressed now.

The PR has been rebased so that conflicts with go.mod from the master branch are resolved too.

[nixpanic]

A container-image with the current PR is at quay.io/nixpanic/csi-driver-host-path:GroupControllerServer_v2

[nixpanic]

FYI, tests will fail until kubernetes-csi/csi-test#450 is merged and used by the CI.

[ggriffiths]

Looks like the builds are failing here, feel free to re-request review when this is ready.

[leonardoce]

Hi. I'm testing this PR (thanks, @xing-yang, for pointing me at this).
I realized that Group Snapshots are failing with failed to take group snapshot of the volumes [...]: “rpc error: code = AlreadyExists desc = group snapshot with the same name: ... but with different SourceVolumeIds already exist).

In the code, it looks like we're comparing PV handle IDs against snapshot handle IDs (see the MatchesSourceVolumeIDs function and the CreateVolumeGroupSnapshot function).

Doing this, the first CreateVolumeGroupSnapshot call will work correctly since the internal state is empty, and the subsequent calls will fail. I had positive results adding this commit that makes the GroupSnapshot struct keep track of both snapshot IDs and source volumes IDs.

Happy to help. Thank you!

[leonardoce]

I'd also consider this commit, setting the GroupSnapshotId field in the ListSnapshots GRPC response

[nixpanic]

I'd also consider this commit, setting the GroupSnapshotId field in the ListSnapshots GRPC response

Thanks! Will include that in the next update for this PR.

[nixpanic]

Thanks @leonardoce, your commits have been added in test-only PR #426 now.

[k8s-ci-robot]

@nixpanic: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
pull-kubernetes-csi-csi-driver-host-path-1-24-on-kubernetes-1-24	f784917	link	true	/test pull-kubernetes-csi-csi-driver-host-path-1-24-on-kubernetes-1-24
pull-kubernetes-csi-csi-driver-host-path-1-24-test-on-kubernetes-1-24	f784917	link	false	/test pull-kubernetes-csi-csi-driver-host-path-1-24-test-on-kubernetes-1-24
pull-kubernetes-csi-csi-driver-host-path-1-25-test-on-kubernetes-1-25	f784917	link	false	/test pull-kubernetes-csi-csi-driver-host-path-1-25-test-on-kubernetes-1-25
pull-kubernetes-csi-csi-driver-host-path-1-25-on-kubernetes-1-25	f784917	link	true	/test pull-kubernetes-csi-csi-driver-host-path-1-25-on-kubernetes-1-25

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

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/test-infra repository. I understand the commands that are listed here.

[nixpanic]

Ah! tests fail as release-tools/prow.sh still uses CSI_PROW_SANITY_VERSION v5.0.0. That needs to be v5.1.0 or newer.

This driver reports the new capability, bit the v5.0.0 version of the tests do not know about it.

kubernetes-csi/csi-release-tools#240 has already been merged, but it needs to be sync'd into this repository.

[xing-yang]

Submitted this PR to update release-tools: #474

[xing-yang]

/retest

[nixpanic]

/retest

Everything has passed, but there it still a comment from the k8s-ci-bot about earlier failed tests, maybe this updates it?

[xing-yang]

/lgtm
/approve

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: nixpanic, xing-yang

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 [xing-yang]

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