Add documentation to deploy and test SnapshotMetadata support #575

PrasadG193 · 2024-12-17T12:54:05Z

What this PR does / why we need it:

This PR related to the SnapshotMetadata service support added with - #569

This PR:

Updates deploy.sh script to deploy csi-hostpathplugin with external-snapshot-metadata support.
Add documentation for steps to deploy and test SnapshotMetadata support.

Steps to deploy csi hostpath driver with snapshot-metadata service using deploy.sh script:

Install SnapshotMetadataService CRD using the following command

$ VERSION=main
$ kubectl apply -f https://raw.githubusercontent.com/kubernetes-csi/external-snapshotmetadata/${VERSION}/client/config/crd/cbt.storage.k8s.io_snapshotmetadataservices.yaml

Deploy csi hostpath driver with snapshot-metadata service using the following command:

$ SNAPSHOT_METADATA_TESTS=true deploy/kubernetes-latest/deploy.sh

NONE

k8s-triage-robot · 2024-12-17T15:32:51Z

Unknown CLA label state. Rechecking for CLA labels.

Send feedback to sig-contributor-experience at kubernetes/community.

/check-cla
/easycla

PrasadG193 · 2024-12-17T16:22:14Z

/check-cla

Signed-off-by: Prasad Ghangal <[email protected]>

Rakshith-R

almost LGTM, just few nits
@PrasadG193

tested with complete setup here https://github.com/Rakshith-R/external-snapshot-metadata/actions/runs/12480399908/job/34831167597?pr=8

deploy/kubernetes-1.27/hostpath/csi-hostpath-plugin.yaml

deploy/util/deploy-hostpath.sh

deploy/kubernetes-1.27/hostpath/csi-snapshot-metadata-sidecar.patch

Signed-off-by: Prasad Ghangal <[email protected]>

PrasadG193 · 2025-01-08T06:28:26Z

deploy/kubernetes-1.27/hostpath/csi-hostpath-plugin.yaml

+          # TODO: Set release tag after new release is made with SnapshotMetadata support
+          image: gcr.io/k8s-staging-sig-storage/hostpathplugin:canary


@Rakshith-R @xing-yang We cannot use released tag here until new release is made having support for SnapshotMetada service. I don't think we can use canary image tag here.

@Rakshith-R @xing-yang We cannot use released tag here until new release is made having support for SnapshotMetada service. I don't think we can use canary image tag here.

I think we can override it to canary while testing it at ext-snapshot-metadata repo + SnapshotMetadata service is guarded by a flag too in deploy script.

Let's leave it at a released tag here ?

That is one option. Its just until the release is made, if someone want to try the feature (using steps documented at docs/example-snapshot-metadata.md), they won't be able to setup things.
@xing-yang any thoughts?

In the DPWG meeting, we decided to move ahead with canary image tag for now. This will be overridden at release time.

On a second thought, we can't merge a canary image as that will affect CI for all the sidecars. We need to hold off this PR until we cut a release for K8s 1.32. We are still waiting for a few other sidecars to be released before doing that.

@Rakshith-R @xing-yang We cannot use released tag here until new release is made having support for SnapshotMetada service. I don't think we can use canary image tag here.

I think we can override it to canary while testing it at ext-snapshot-metadata repo + SnapshotMetadata service is guarded by a flag too in deploy script.

Let's leave it at a released tag here ?

I don't think we need to hold the entire pr.

Let's go with this approach of leaving driver image at a released tag and overriding the image to canary and turn on snap-metadata flag to test the feature.

@PrasadG193 @xing-yang ^

Rakshith-R

Everything else other than csi-hosthpath-driver image looks good to me.

Signed-off-by: Prasad Ghangal <[email protected]>

xing-yang · 2025-01-09T16:53:51Z

/hold

carlbraganza · 2025-01-09T19:16:03Z

I followed the instructions successfully - worked as described.

Signed-off-by: Prasad Ghangal <[email protected]>

PrasadG193 · 2025-01-13T10:36:05Z

docs/example-snapshot-metadata.md

+  b. Execute deploy script to setup hostpath plugin driver with external-snapshot-metadata change
+
+  ```
+  $ SNAPSHOT_METADATA_TESTS=true HOSTPATHPLUGIN_REGISTRY=gcr.io/k8s-staging-sig-storage HOSTPATHPLUGIN_TAG=canary ./deploy/kubernetes-1.27/deploy.sh


@xing-yang @Rakshith-R turned out the deploy.sh script already has a support to override container images. So we can use these flags to deploy the hostpathplugin with canary image

Rakshith-R

Thanks,
Looks good to me!

deploy/kubernetes-1.27/hostpath/csi-hostpath-plugin.yaml

PrasadG193 · 2025-01-23T04:50:05Z

/assign @xing-yang

xing-yang · 2025-01-24T20:03:01Z

/lgtm
/approve

k8s-ci-robot · 2025-01-24T20:03:10Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: PrasadG193, Rakshith-R, 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

xing-yang · 2025-01-24T20:03:15Z

/hold cancel

k8s-ci-robot added the release-note-none Denotes a PR that doesn't merit a release note. label Dec 17, 2024

k8s-ci-robot requested review from humblec and jingxu97 December 17, 2024 12:54

k8s-ci-robot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Dec 17, 2024

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Dec 17, 2024

PrasadG193 added 4 commits December 19, 2024 16:13

Update deploy script to deploy snapshot-metadata service

ebb9d84

Signed-off-by: Prasad Ghangal <[email protected]>

Update deploy/util/deploy-hostpath.sh

dd826ba

Update manifest links

6886d26

Signed-off-by: Prasad Ghangal <[email protected]>

Add documentation for testing SnapshotMetadata service

0c52080

Signed-off-by: Prasad Ghangal <[email protected]>

PrasadG193 force-pushed the update-deploy-script branch from 319ce44 to 0c52080 Compare December 19, 2024 10:44

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Dec 19, 2024

PrasadG193 added 3 commits December 19, 2024 18:31

Refer snapshot metadata client pod manifest from repo

295e9cd

Signed-off-by: Prasad Ghangal <[email protected]>

Correct pod manifest file name

80c7ebe

Signed-off-by: Prasad Ghangal <[email protected]>

Do not create snapshot metadata rbac by default

eafaa37

Signed-off-by: Prasad Ghangal <[email protected]>

Rakshith-R reviewed Dec 24, 2024

View reviewed changes

deploy/kubernetes-1.27/hostpath/csi-hostpath-plugin.yaml Outdated Show resolved Hide resolved

deploy/util/deploy-hostpath.sh Show resolved Hide resolved

deploy/kubernetes-1.27/hostpath/csi-snapshot-metadata-sidecar.patch Outdated Show resolved Hide resolved

Set hostpathplugin image tag to canary

dde7e9b

Signed-off-by: Prasad Ghangal <[email protected]>

PrasadG193 commented Jan 8, 2025

View reviewed changes

Rakshith-R reviewed Jan 8, 2025

View reviewed changes

Correct snapshot name in kubectl get cmd

99a5d45

Signed-off-by: Prasad Ghangal <[email protected]>

PrasadG193 requested a review from xing-yang January 9, 2025 13:16

Consistent sample snapshotcontent name

bb2cf22

Signed-off-by: Prasad Ghangal <[email protected]>

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 9, 2025

Use released image tag for hostpath deployment

8110ea0

Signed-off-by: Prasad Ghangal <[email protected]>

PrasadG193 commented Jan 13, 2025

View reviewed changes

Rakshith-R approved these changes Jan 14, 2025

View reviewed changes

carlbraganza reviewed Jan 15, 2025

View reviewed changes

deploy/kubernetes-1.27/hostpath/csi-hostpath-plugin.yaml Show resolved Hide resolved

carlbraganza reviewed Jan 15, 2025

View reviewed changes

deploy/kubernetes-1.27/hostpath/csi-hostpath-plugin.yaml Show resolved Hide resolved

k8s-ci-robot assigned xing-yang Jan 23, 2025

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

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 24, 2025

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 24, 2025

k8s-ci-robot merged commit c6e6e9a into kubernetes-csi:master Jan 24, 2025
10 checks passed

Rakshith-R mentioned this pull request Mar 4, 2025

CSI Differential Snapshot for Block Volumes kubernetes/enhancements#3314

Open

4 tasks

		# TODO: Set release tag after new release is made with SnapshotMetadata support
		image: gcr.io/k8s-staging-sig-storage/hostpathplugin:canary

Add documentation to deploy and test SnapshotMetadata support #575

Add documentation to deploy and test SnapshotMetadata support #575

Conversation

PrasadG193 commented Dec 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

k8s-triage-robot commented Dec 17, 2024

Uh oh!

PrasadG193 commented Dec 17, 2024

Uh oh!

Rakshith-R left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

PrasadG193 Jan 8, 2025

Choose a reason for hiding this comment

Uh oh!

Rakshith-R Jan 8, 2025

Choose a reason for hiding this comment

Uh oh!

PrasadG193 Jan 8, 2025

Choose a reason for hiding this comment

Uh oh!

PrasadG193 Jan 9, 2025

Choose a reason for hiding this comment

Uh oh!

xing-yang Jan 9, 2025

Choose a reason for hiding this comment

Uh oh!

Rakshith-R Jan 10, 2025

Choose a reason for hiding this comment

Uh oh!

Rakshith-R left a comment

Choose a reason for hiding this comment

Uh oh!

xing-yang commented Jan 9, 2025

Uh oh!

carlbraganza commented Jan 9, 2025

Uh oh!

PrasadG193 Jan 13, 2025

Choose a reason for hiding this comment

Uh oh!

Rakshith-R left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

PrasadG193 commented Jan 23, 2025

Uh oh!

xing-yang commented Jan 24, 2025

Uh oh!

k8s-ci-robot commented Jan 24, 2025

Uh oh!

xing-yang commented Jan 24, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

PrasadG193 commented Dec 17, 2024 •

edited

Loading