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

feat: support PVC annotation template for provisioner secret #1196

Merged

Conversation

hoyho
Copy link
Contributor

@hoyho hoyho commented Apr 17, 2024

Provisioner can resolve templated per volume secret in storage class such as following example: csi.storage.k8s.io/provisioner-secret-name: ${pvc.annotations['example.com/foo_secret']}
The secret will be stored as metadata in annotations of PV, so it can find the secret OnDelete even the PVC was deleted

What type of PR is this?
/kind feature

What this PR does / why we need it:
Inconsistent usage of per volume secrets in storage class with parameter like csi.storage.k8s.io/provisioner-secret-name
We can support syntax like other API does
csi.storage.k8s.io/node-publish-secret-name: ${pvc.annotations['team.example.com/key']}

Which issue(s) this PR fixes:
Fixes #1148

Special notes for your reviewer:
We can use original PVC object to resolve secret during provision and store it to PV's metadata.
Parameters on existing SC are immutable so the provisioner should compatible with previous version.

Does this PR introduce a user-facing change?:

Added support for PVC annotations in `csi.storage.k8s.io/provisioner-secret-name` StorageClass parameters. For example: `csi.storage.k8s.io/provisioner-secret-name: ${pvc.annotations['xyz']}`.

Provisioner can resolve templated per volume secret in storage class such as following example:
`csi.storage.k8s.io/provisioner-secret-name: ${pvc.annotations['example.com/foo_secret']}`
The secret will be stored as metadata in annotations of PV, so it can find the
secret OnDelete even the PVC was deleted

Signed-off-by: hoyho <[email protected]>
@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. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Apr 17, 2024
@k8s-ci-robot
Copy link
Contributor

Hi @hoyho. 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.

@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Apr 17, 2024
@hoyho
Copy link
Contributor Author

hoyho commented Apr 17, 2024

/assign @jsafrane @pohly
PTAL.

@jsafrane
Copy link
Contributor

/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 Apr 23, 2024
@jsafrane
Copy link
Contributor

The PR looks good, however, it introduces a new feature (or a bugfix). Please file release note in the PR description to advertise it to our users / CSI driver vendors.

@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 Apr 24, 2024
@jsafrane
Copy link
Contributor

I updated the release note by myself.
/lgtm
/approve

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

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: hoyho, jsafrane

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 Apr 24, 2024
@k8s-ci-robot k8s-ci-robot merged commit 6918c44 into kubernetes-csi:master Apr 24, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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/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/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

per volume secret tokens not recognized
4 participants