Skip to content

sidecar: Get credentials from annotation for snapshots #1297

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

Jump to bottom
Merged
merged 1 commit into from
May 19, 2025
Merged

sidecar: Get credentials from annotation for snapshots #1297

merged 1 commit into from
May 19, 2025

Conversation

black-dragon74
Copy link
Contributor

@black-dragon74 black-dragon74 commented Apr 30, 2025 •
edited
Loading

What type of PR is this?

/kind bug

What this PR does / why we need it:

When a snapshotcontent is created as a result of a volumegroupsnapshot the status for it is updated by calling the ListSnapshots RPC. Some COs require the credentials to be present in order to serve this RPC.

The current code tries to get credentials only from a volumesnapshotclass if present. This condition will never be met in case of VGS.

This patch adapts to code to fetch the credentials from the annotations AnnDeletionSecretRef* if volumesnapshotclassname is not present.

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

Get credentials from annotations for VolumeSnapshotContents that are a member of VolumeGroupSnapshot.

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/feature Categorizes issue or PR as related to a new feature. labels Apr 30, 2025
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Apr 30, 2025
@k8s-ci-robot
Copy link
Contributor

Welcome @black-dragon74!

It looks like this is your first PR to kubernetes-csi/external-snapshotter 🎉. 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/external-snapshotter 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 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 Apr 30, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @black-dragon74. 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-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Apr 30, 2025
@black-dragon74
Copy link
Contributor Author

/assign @xing-yang

Madhu-1
Madhu-1 reviewed May 13, 2025
View reviewed changes
pkg/sidecar-controller/snapshot_controller.go Outdated
@@ -290,6 +290,13 @@ func (ctrl *csiSnapshotSideCarController) checkandUpdateContentStatusOperation(c
}
}

if snapshotterListCredentials == nil && volumeGroupSnapshotMemberWithGroupSnapshotHandle {
Copy link
Contributor

Choose a reason for hiding this comment

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

i think we dont need snapshotterListCredentials == nil check here. it will always be nil becase tge className will not be set on the content.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Can you add a comment that content.Spec.VolumeSnapshotClassName is nil for individual snapshots that are part of a volume group snapshot?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done :)

The label was not updated for the bug (maybe it requires a manual update)

@xing-yang
Copy link
Collaborator

Can you mark this as a bug fix?
Also add release notes.

@xing-yang
Copy link
Collaborator

/ok-to-test

@k8s-ci-robot 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 14, 2025
@black-dragon74
sidecar: Get credentials from annotation for snapshots
78bbdbf 
When a snapshotcontent is created as a result of a volumegroupsnapshot
the status for it is updated by calling the ListSnapshots RPC. Some COs
require the credentials to be present in order to serve this RPC.

The current code tries to get credentials only from a volumesnapshotclass
if present. This condition will never be met in case of VGS.

This patch adapts to code to fetch the credentials from the annotations
`AnnDeletionSecretRef*` if volumesnapshotclassname is not present.

Signed-off-by: Niraj Yadav <[email protected]>
@black-dragon74 black-dragon74 force-pushed the get-creds-from-annon branch from 6a54e58 to 78bbdbf Compare May 14, 2025 14:55
@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. and removed release-note-none Denotes a PR that doesn't merit a release note. labels May 14, 2025
@Madhu-1
Copy link
Contributor

Madhu-1 commented May 15, 2025

/kind bug

@k8s-ci-robot k8s-ci-robot added the kind/bug Categorizes issue or PR as related to a bug. label May 15, 2025
@Madhu-1
Copy link
Contributor

Madhu-1 commented May 15, 2025

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 15, 2025
@xing-yang
Copy link
Collaborator

/lgtm
/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: black-dragon74, 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:

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 19, 2025
@k8s-ci-robot k8s-ci-robot merged commit 4cedb3f into kubernetes-csi:master May 19, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@chrishenzie chrishenzie Awaiting requested review from chrishenzie

@mauriciopoppe mauriciopoppe Awaiting requested review from mauriciopoppe

@Madhu-1 Madhu-1 Awaiting requested review from Madhu-1

@xing-yang xing-yang Awaiting requested review from xing-yang

Assignees

@xing-yang xing-yang

@Madhu-1 Madhu-1

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/bug Categorizes issue or PR as related to a bug. kind/feature Categorizes issue or PR as related to a new feature. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@black-dragon74 @k8s-ci-robot @xing-yang @Madhu-1