Skip to content

Add support for extra-create-metadata when creating snapshots #935

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

Conversation

francoispqt
Copy link
Contributor

What type of PR is this?
/kind feature

What this PR does / why we need it:
This PR adds metadata in the description field for Snapshots and Images created from the CreateSnapshot CSI method when the external-snapshotter is run with the --extra-create-metadata flag.

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

Does this PR introduce a user-facing change?:

Description field for Images and Snapshots will be filled with JSON encoded metadata containing the name and namespace of the VolumeSnapshot and the name of the VolumeSnapshot content.

@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/feature Categorizes issue or PR as related to a new feature. labels Mar 22, 2022
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Mar 22, 2022

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: francoispqt / name: Francois Parquet (460cd2a)

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Mar 22, 2022
@k8s-ci-robot
Copy link
Contributor

Welcome @francoispqt!

It looks like this is your first PR to kubernetes-sigs/gcp-compute-persistent-disk-csi-driver 🎉. 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-sigs/gcp-compute-persistent-disk-csi-driver 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 Mar 22, 2022
@k8s-ci-robot
Copy link
Contributor

Hi @francoispqt. 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/test-infra repository.

@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Mar 22, 2022
@francoispqt francoispqt force-pushed the add-support-extra-create-metadata-create-snapshot branch 2 times, most recently from 27d195e to efdfc39 Compare March 22, 2022 15:14
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 22, 2022
@mattcary
Copy link
Contributor

/ok-to-test

Thanks for working on this! Basically looks okay to me, I'll wait for it to run through tests.

Remember to squash your commits before checking in.

@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 Mar 25, 2022
@francoispqt
Copy link
Contributor Author

francoispqt commented Mar 30, 2022

Thanks for reviewing!

Sure I will squash my commits before merging.

// encodeDiskTags encodes requested volume tags into JSON string, as GCE does
// not support tags on GCE PDs and we use Description field as fallback.
func encodeDiskTags(tags map[string]string) (string, error) {
// encodeTags encodes requested volume or snapshot tags into JSON string, as GCE does
Copy link
Contributor

@mattcary mattcary Mar 31, 2022

Choose a reason for hiding this comment

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

This comment is a little out of date, as PD does support labels now. To reduce confusion, could you reword this something like the following?

enocodeTags encodes requested volume or snapshot tags into a JSON string, suitable for putting into 
the PD Description field.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You're right. I have updated the comment.

I think using labels would be more convenient than using the description field (for cost monitoring for example) but even though Snapshot and PD now support labels, the constraint on label values (max length 63 char) make it unsuitable.

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks. Let's wait for the tests to pass, squash your commits, and I'll lgtm.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have just squashed commits

@francoispqt francoispqt force-pushed the add-support-extra-create-metadata-create-snapshot branch from cdd1673 to 8c2be6e Compare April 1, 2022 08:27
@mattcary
Copy link
Contributor

mattcary commented Apr 1, 2022

/lgtm
/approve

Thanks!

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

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: francoispqt, mattcary

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 1, 2022
@k8s-ci-robot k8s-ci-robot merged commit e008326 into kubernetes-sigs:master Apr 1, 2022
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/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Implement extra-create-metadata in CreateSnapshot
3 participants