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

arkadeepsen · 2023-09-22T12:07:34Z

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.

linux-foundation-easycla · 2023-09-22T12:07:40Z

The committers listed above are authorized under a signed CLA.

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

k8s-ci-robot · 2023-09-22T12:07:42Z

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 · 2023-09-22T12:07:43Z

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.

arkadeepsen · 2024-03-25T05:44:24Z

/retest-required

pkg/common/parameters.go

pwschuurman · 2024-03-27T18:34:45Z

pkg/common/parameters.go

+		case ParameterKeyResourceTags:
+			paramResourceTags, err := ConvertTagsStringToMap(v)
+			if err != nil {
+				return p, fmt.Errorf("parameters contain invalid tags parameter: %w", err)


Can you specify the exact name of the parameter key in this error? This will make it easier for the user to address the error (by knowing exactly which parameter key to modify).

@pwschuurman I have added the full string containing the parent ID, tag key and value in the error message returned by ConvertTagsStringToMap().

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.

Got it. Added the name of the parameter key in the error message.

pwschuurman · 2024-03-27T18:35:04Z

pkg/common/utils.go

+	const maxNumberOfTags = 50
+	if len(tagsMap) > maxNumberOfTags {
+		return nil, fmt.Errorf("more than %d tags is not allowed, given: %d", maxNumberOfTags, len(tagsMap))
+	}


pkg/common/utils_test.go

pkg/gce-cloud-provider/compute/gce-compute.go

pwschuurman · 2024-03-27T18:49:44Z

cmd/gce-pd-csi-driver/main.go

@@ -79,6 +79,8 @@ var (
 	computeEndpoint           *url.URL
 	allowedComputeEnvironment = []gce.Environment{gce.EnvironmentStaging, gce.EnvironmentProduction}

+	extraTagsStr = flag.String("extra-tags", "", "Extra tags to attach to each Compute Disk, Image, Snapshot created. It is a comma separated list of parent id, key and value like '<parent_id1>/<tag_key1>/<tag_value1>,...,<parent_idN>/<tag_keyN>/<tag_valueN>'. parent_id is the Organization or the Project ID where the tag key and the tag value resources exist. A maximum of 50 tags bindings is allowed for a resource. See https://cloud.google.com/resource-manager/docs/tags/tags-overview, https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing for details")


Great, thanks.

README.md

pkg/common/utils.go

pwschuurman · 2024-03-29T23:16:14Z

pkg/gce-cloud-provider/compute/gce-compute.go

+	// GCP has a rate limit of 600 requests per minute, restricting
+	// here to 8 requests per second.
+	limiter := common.NewLimiter(gcpTagsRequestRateLimit, gcpTagsRequestTokenBucketSize, true)


I think one optimization would be to use a shared rate limiter, scoped to a CloudProvider client. This would allow each PDCSI controller instance to rate limit calls across CreateSnapshot/CreateVolume.

The 90 second initial delay seems a bit long. I think in the worst case you'd only need to wait for a maximum of 60 seconds until the per-minute quota is refilled (per the documentation: https://cloud.google.com/compute/api-quota#api-rate-limits).

Also, I don't think having an exponential backoff is that useful here (especially at a rate of 2.0), since the per-minute quota is a fixed window rate limit. You'll either be competing with another client, and exhaust quota before the next minute, or quota will refill and the bucket will be replenished. The only thing you may want to adjust is a negotiation scheme for the per-second bucket rate, but without direct knowledge of the request rate of any other client, this seems complicated to determine.

arkadeepsen · 2024-04-19T13:29:36Z

/retest-required

arkadeepsen · 2024-04-22T05:16:04Z

/retest-required

pkg/common/parameters.go

pwschuurman · 2024-04-22T18:47:23Z

pkg/common/parameters.go

+		case ParameterKeyResourceTags:
+			paramResourceTags, err := ConvertTagsStringToMap(v)
+			if err != nil {
+				return p, fmt.Errorf("parameters contain invalid tags parameter: %w", err)


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 · 2024-04-23T04:28:56Z

/retest-required

arkadeepsen · 2024-04-23T05:01:56Z

/retest-required

pkg/common/utils_test.go

pkg/gce-cloud-provider/compute/gce-compute.go

…mage, Snapshot resources

arkadeepsen · 2024-04-24T18:22:27Z

/retest-required

arkadeepsen · 2024-04-25T02:53:17Z

/retest-required

pwschuurman · 2024-04-25T04:07:21Z

/lgtm
/approve

k8s-ci-robot · 2024-04-25T04:07:36Z

[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:

~~OWNERS~~ [pwschuurman]

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 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

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 requested review from pwschuurman and saikat-royc September 22, 2023 12:07

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 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 force-pushed the resource-manager-tags branch from c272900 to 5fe0523 Compare October 4, 2023 13:03

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 added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 20, 2023

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 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 force-pushed the resource-manager-tags branch from 3b7aeaf to d4a2788 Compare November 15, 2023 13:49

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 force-pushed the resource-manager-tags branch from d4a2788 to 7847650 Compare November 15, 2023 15:00

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 force-pushed the resource-manager-tags branch from 7847650 to 9a385e4 Compare November 22, 2023 17:52

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 added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Dec 6, 2023

arkadeepsen force-pushed the resource-manager-tags branch from 9a385e4 to e93b90c Compare December 7, 2023 06:39

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 25, 2024

pwschuurman reviewed Mar 27, 2024

View reviewed changes

pwschuurman reviewed Mar 29, 2024

View reviewed changes

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Apr 4, 2024

arkadeepsen force-pushed the resource-manager-tags branch 3 times, most recently from c781133 to 17dd55b Compare April 19, 2024 12:11

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 force-pushed the resource-manager-tags branch from 17dd55b to fe6154e Compare April 22, 2024 04:24

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Apr 22, 2024

pwschuurman reviewed Apr 22, 2024

View reviewed changes

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

pwschuurman reviewed Apr 23, 2024

View reviewed changes

pkg/common/utils_test.go Outdated Show resolved Hide resolved

pkg/gce-cloud-provider/compute/gce-compute.go Outdated Show resolved Hide resolved

arkadeepsen force-pushed the resource-manager-tags branch from 00ed53a to 95bee6e Compare April 24, 2024 16:57

Add support for addition of ResoureManagerTags to GCP Compute Disk, I…

e703794

…mage, Snapshot resources

arkadeepsen force-pushed the resource-manager-tags branch from 95bee6e to e703794 Compare April 24, 2024 17:01

k8s-ci-robot assigned pwschuurman Apr 25, 2024

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 added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 25, 2024

k8s-ci-robot merged commit 78ef53b into kubernetes-sigs:master Apr 25, 2024
7 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

arkadeepsen commented Sep 22, 2023

linux-foundation-easycla bot commented Sep 22, 2023 •

edited

k8s-ci-robot commented Sep 22, 2023

k8s-ci-robot commented Sep 22, 2023

arkadeepsen commented Mar 25, 2024

pwschuurman Mar 27, 2024

arkadeepsen Apr 19, 2024

pwschuurman Apr 22, 2024

arkadeepsen Apr 23, 2024

pwschuurman Mar 27, 2024

pwschuurman Mar 27, 2024

pwschuurman Mar 29, 2024

arkadeepsen commented Apr 19, 2024

arkadeepsen commented Apr 22, 2024

pwschuurman Apr 22, 2024

arkadeepsen commented Apr 23, 2024

arkadeepsen commented Apr 23, 2024

arkadeepsen commented Apr 24, 2024

arkadeepsen commented Apr 25, 2024

pwschuurman commented Apr 25, 2024

k8s-ci-robot commented Apr 25, 2024

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

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

Conversation

arkadeepsen commented Sep 22, 2023

linux-foundation-easycla bot commented Sep 22, 2023 • edited

k8s-ci-robot commented Sep 22, 2023

k8s-ci-robot commented Sep 22, 2023

arkadeepsen commented Mar 25, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

arkadeepsen commented Apr 19, 2024

arkadeepsen commented Apr 22, 2024

Choose a reason for hiding this comment

arkadeepsen commented Apr 23, 2024

arkadeepsen commented Apr 23, 2024

arkadeepsen commented Apr 24, 2024

arkadeepsen commented Apr 25, 2024

pwschuurman commented Apr 25, 2024

k8s-ci-robot commented Apr 25, 2024

linux-foundation-easycla bot commented Sep 22, 2023 •

edited