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

Support to add ResoureManagerTags to GCP Compute Disk, Image, Snapshot #1377

Merged

Conversation

arkadeepsen
Copy link
Contributor

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:

This PR allows users to bind a list of tags to resources created by the driver, namely GCP Compute Disk, Image, Snapshot. The original issue #1319 provides more details on the usefulness of GCP tags.

Which issue(s) this PR fixes:

Fixes #1319

Special notes for your reviewer:

This PR adds the functionality to bind GCP resource manager tags to compute pd resources created by the driver. The tag keys and values will be created by the user and only the tag bindings to the pd resources will be created by the driver. The driver now accepts a new argument, --extra-tags, and a list of tags can be provided to the driver using this argument. The tag list is then validated to check if they are in the expected format or not. The list is also validated to check that a tag parent_id and key combination is not used more that once. The tags are attached to the Compute Disk, Image, Snapshot when the corresponding resources are created.

Does this PR introduce a user-facing change?:
Yes

Users can now attach existing tags to GCP Compute Disk, Image, Snapshot resources created by the driver. The driver now accepts a new argument, `--extra-tags`, and a list of tags can be provided to the driver using this argument. The argument is optional, and if the tags are not provided, then there is no change in the existing behavior.

@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 Sep 22, 2023
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Sep 22, 2023

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: arkadeepsen / name: Arkadeep Sen (e703794)

@k8s-ci-robot
Copy link
Contributor

Welcome @arkadeepsen!

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 needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Sep 22, 2023
@k8s-ci-robot
Copy link
Contributor

Hi @arkadeepsen. 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/XXL Denotes a PR that changes 1000+ 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 Sep 22, 2023
@arkadeepsen arkadeepsen changed the title Support to add ResoureManagerTags to GCP Compute Disk, Image, Snapsho… Support to add ResoureManagerTags to GCP Compute Disk, Image, Snapshot Oct 4, 2023
@arkadeepsen arkadeepsen force-pushed the resource-manager-tags branch from c272900 to 5fe0523 Compare October 4, 2023 13:03
@arkadeepsen arkadeepsen force-pushed the resource-manager-tags branch 2 times, most recently from 1f7ccfb to 6400a6d Compare October 19, 2023 16:39
@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 20, 2023
@arkadeepsen arkadeepsen force-pushed the resource-manager-tags branch 3 times, most recently from 4726b09 to 3b7aeaf Compare October 24, 2023 04:32
@k8s-ci-robot k8s-ci-robot added needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Oct 28, 2023
@arkadeepsen arkadeepsen force-pushed the resource-manager-tags branch from 3b7aeaf to d4a2788 Compare November 15, 2023 13:49
@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Nov 15, 2023
@arkadeepsen arkadeepsen force-pushed the resource-manager-tags branch from d4a2788 to 7847650 Compare November 15, 2023 15:00
@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Nov 22, 2023
@arkadeepsen arkadeepsen force-pushed the resource-manager-tags branch from 7847650 to 9a385e4 Compare November 22, 2023 17:52
@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Nov 22, 2023
@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Dec 6, 2023
@arkadeepsen arkadeepsen force-pushed the resource-manager-tags branch from 9a385e4 to e93b90c Compare December 7, 2023 06:39
@arkadeepsen arkadeepsen force-pushed the resource-manager-tags branch 3 times, most recently from c781133 to 17dd55b Compare April 19, 2024 12:11
@arkadeepsen
Copy link
Contributor Author

/retest-required

@k8s-ci-robot k8s-ci-robot added needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Apr 19, 2024
@arkadeepsen arkadeepsen force-pushed the resource-manager-tags branch from 17dd55b to fe6154e Compare April 22, 2024 04:24
@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Apr 22, 2024
@arkadeepsen
Copy link
Contributor Author

/retest-required

pkg/common/parameters.go Outdated Show resolved Hide resolved
case ParameterKeyResourceTags:
paramResourceTags, err := ConvertTagsStringToMap(v)
if err != nil {
return p, fmt.Errorf("parameters contain invalid tags parameter: %w", err)
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm looking for the actual key that the user would be familiar with (eg: ParameterKeyResourceTags) to be present in the output error message. This will allow the user to know what parameter to correct in their gRPC call. The end user will likely be a Kubernetes user, and this parameter should map to a parameter key they are familiar with, so they can update the corresponding parameter on their StorageClass. Without that context, they'll just be left with the value, and it won't be as clear about what parameter to change to fix the error they're seeing.

@arkadeepsen arkadeepsen force-pushed the resource-manager-tags branch from fe6154e to 00ed53a Compare April 23, 2024 03:29
@arkadeepsen
Copy link
Contributor Author

/retest-required

1 similar comment
@arkadeepsen
Copy link
Contributor Author

/retest-required

pkg/common/utils_test.go Outdated Show resolved Hide resolved
pkg/gce-cloud-provider/compute/gce-compute.go Outdated Show resolved Hide resolved
@arkadeepsen arkadeepsen force-pushed the resource-manager-tags branch from 00ed53a to 95bee6e Compare April 24, 2024 16:57
@arkadeepsen arkadeepsen force-pushed the resource-manager-tags branch from 95bee6e to e703794 Compare April 24, 2024 17:01
@arkadeepsen
Copy link
Contributor Author

/retest-required

1 similar comment
@arkadeepsen
Copy link
Contributor Author

/retest-required

@pwschuurman
Copy link
Contributor

/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 25, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: arkadeepsen, pwschuurman

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 25, 2024
@k8s-ci-robot k8s-ci-robot merged commit 78ef53b into kubernetes-sigs:master Apr 25, 2024
7 checks passed
@bharath-b-rh
Copy link

/cherry-pick release-1.6

@k8s-infra-cherrypick-robot

@bharath-b-rh: only kubernetes-sigs org members may request cherry picks. If you are already part of the org, make sure to change your membership to public. Otherwise you can still do the cherry-pick manually.

In response to this:

/cherry-pick release-1.6

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.

@bharath-b-rh
Copy link

@pwschuurman Could you please help me with cherry picking this change to release-1.6. Thank you!

@mattcary
Copy link
Contributor

/cherry-pick release-1.14

@k8s-infra-cherrypick-robot

@mattcary: Failed to get PR patch from GitHub. This PR will need to be manually cherrypicked.

Error messagestatus code 406 not one of [200], body: {"message":"Sorry, the diff exceeded the maximum number of lines (20000)","errors":[{"resource":"PullRequest","field":"diff","code":"too_large"}],"documentation_url":"https://docs.github.com/rest/pulls/pulls#get-a-pull-request","status":"406"}

In response to this:

/cherry-pick release-1.14

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.

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/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support to add ResoureManagerTags to GCP Compute Disk, Image, Snapshot resources
7 participants