feat: support adding ResourceManagerTags to GCP resources #1008

salasberryfin · 2023-08-24T15:49:28Z

What type of PR is this?

kind/feature

What this PR does / why we need it

This PR allows users to bind tags to GCP resources, including Compute Instances, GKE clusters and attached disks. As described in the original issue #992, Tags are used for defining IAM policy conditions, Organization conditionals policies and integrating with Cloud billing for cost management, which are not supported by labels.

Which issue(s) this PR fixes

Fixes #992

Special notes for your reviewer

With this solution, users are able to bind resource-manager tags to infrastructure resources. The Tag Key/Tag Value must already exist in GCP and CAPG converts the provided list of key/value ( resourceManagerTags) into the unique IDs generated by GCP. For any tags that cannot be retrieved (whether it is a permission issue or the tags don't exist), an empty value will be returned, effectively ignoring the key/value pair. Any other valid tags will be added.

This is an example of how a simple tag could be added to the yaml definition:

resourceManagerTags:
  - {parentID: "parent-project", key: "foo", value: "bar"}

TODOs:

squashed commits
includes documentation
adds unit tests

Release note:

Users can now pass existing `resourceManagerTags` to bind them to cloud resources. If this is not provided, the behavior stays the same and no tags are added to the resource.

k8s-ci-robot · 2023-08-24T15:49:36Z

Welcome @salasberryfin!

It looks like this is your first PR to kubernetes-sigs/cluster-api-provider-gcp 🎉. 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/cluster-api-provider-gcp 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-08-24T15:49:37Z

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

richardcase · 2023-08-29T04:59:39Z

/ok-to-test

richardcase · 2023-08-29T11:30:44Z

/test pull-cluster-api-provider-gcp-verify

richardcase

A quick review, mostly just nits.

I'll take a proper look and look at the verification failure later today/tomorrow

api/v1beta1/gcpcluster_types.go

api/v1beta1/gcpmachine_types.go

api/v1beta1/tags.go

salasberryfin · 2023-08-29T15:45:10Z

I addressed some of the comments but my changes broke something. I'll be fixing it and updating the code as soon as possible.

salasberryfin · 2023-08-30T08:54:11Z

Hopefully I addressed all comments and CI issues with the last commit 🙂

richardcase

Great work on this @salasberryfin .

Lets find some time to chat about this

api/v1beta1/gcpcluster_types.go

cloud/scope/machine.go

richardcase · 2023-08-31T04:29:01Z

cloud/scope/machine.go

@@ -338,6 +338,9 @@ func (m *MachineScope) InstanceSpec(log logr.Logger) *compute.Instance {
 				m.ClusterGetter.Name(),
 			),
 		},
+		Params: &compute.InstanceParams{
+			ResourceManagerTags: infrav1.AddResourceManagerTags(context.TODO(), m.GCPMachine.Spec.ResourceManagerTags),


We should probably capture the additional permissions required in the docs somewhere:

roles/resourcemanager.tagAdmin

roles/resourcemanager.tagUser

I think, TagUser role should be enough since listing tags and creating tag bindings are the operations implementation is dependent on.

api/v1beta1/gcpmachine_types.go

cloud/scope/machine.go

salasberryfin · 2023-10-17T16:23:53Z

Last change moves tag related functions to cloud/services (under shared services). I still have to fix the creation of the resource manager client.

salasberryfin · 2023-10-18T11:08:45Z

NewTagBindingsClient is now created in cloud/scope/clients.go aligned with other client creation. In this case, due to the regional nature of some resource manager tagging operations, the endpoint (including location) needs to be appended to the default client options.

cloud/services/shared/tags.go

exp/api/v1beta1/gcpmanagedcluster_types.go

richardcase · 2023-10-26T14:32:42Z

This is only adding optional API fields so:

/override pull-cluster-api-provider-gcp-apidiff

k8s-ci-robot · 2023-10-26T14:32:44Z

@richardcase: Overrode contexts on behalf of richardcase: pull-cluster-api-provider-gcp-apidiff

In response to this:

This is only adding optional API fields so:

/override pull-cluster-api-provider-gcp-apidiff

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.

richardcase · 2023-10-26T14:39:23Z

Thanks for the hard work on this @salasberryfin. I have created #1053 as a follow-up to add E2E test coverage for this feature.

From my side:

/lgtm

For final approval:

/assign cpanato

salasberryfin · 2023-10-27T09:49:38Z

Thanks @richardcase. I'll be happy to work on #1053 as well.

Signed-off-by: Carlos Salas <[email protected]>

richardcase · 2023-10-31T10:43:53Z

Like before:

/override pull-cluster-api-provider-gcp-apidiff

k8s-ci-robot · 2023-10-31T10:43:56Z

@richardcase: Overrode contexts on behalf of richardcase: pull-cluster-api-provider-gcp-apidiff

In response to this:

Like before:

/override pull-cluster-api-provider-gcp-apidiff

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.

richardcase · 2023-10-31T10:44:14Z

Thanks @salasberryfin

/lgtm
/approve

k8s-ci-robot · 2023-10-31T10:44:23Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: richardcase, salasberryfin

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~~ [richardcase]

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 do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. release-note Denotes a PR that will be considered when it comes time to generate release notes. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Aug 24, 2023

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 Aug 24, 2023

k8s-ci-robot requested review from cpanato and richardcase August 24, 2023 15:49

k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Aug 24, 2023

salasberryfin changed the title ~~WIP: feat: support adding ResourceManagerTags to compute instances~~ feat: support adding ResourceManagerTags to compute instances Aug 28, 2023

salasberryfin marked this pull request as ready for review August 28, 2023 09:39

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 28, 2023

k8s-ci-robot requested a review from dims August 28, 2023 09:39

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 Aug 29, 2023

salasberryfin force-pushed the support-adding-resourcemanagertags branch from ce232ab to 11d3567 Compare August 29, 2023 09:14

richardcase reviewed Aug 29, 2023

View reviewed changes

salasberryfin force-pushed the support-adding-resourcemanagertags branch from 11d3567 to 71e33e5 Compare August 29, 2023 15:36

k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Aug 29, 2023

salasberryfin force-pushed the support-adding-resourcemanagertags branch 2 times, most recently from 0a90467 to c0eb2c2 Compare August 30, 2023 08:42

salasberryfin mentioned this pull request Aug 30, 2023

[CAPG] Add support for ResourceManagerTags rancher/highlander#32

Closed

richardcase reviewed Aug 31, 2023

View reviewed changes

bharath-b-rh reviewed Sep 5, 2023

View reviewed changes

api/v1beta1/gcpmachine_types.go Show resolved Hide resolved

bharath-b-rh reviewed Sep 5, 2023

View reviewed changes

cloud/scope/machine.go Outdated Show resolved Hide resolved

salasberryfin force-pushed the support-adding-resourcemanagertags branch 2 times, most recently from fae628a to 430be9f Compare October 17, 2023 16:23

salasberryfin force-pushed the support-adding-resourcemanagertags branch from 430be9f to 48f508f Compare October 18, 2023 11:06

salasberryfin requested a review from richardcase October 18, 2023 14:24

richardcase reviewed Oct 26, 2023

View reviewed changes

cloud/services/shared/tags.go Show resolved Hide resolved

exp/api/v1beta1/gcpmanagedcluster_types.go Outdated Show resolved Hide resolved

salasberryfin force-pushed the support-adding-resourcemanagertags branch from 48f508f to c58badf Compare October 26, 2023 12:14

salasberryfin requested a review from richardcase October 26, 2023 12:19

salasberryfin force-pushed the support-adding-resourcemanagertags branch from c58badf to 6292a28 Compare October 26, 2023 12:51

richardcase mentioned this pull request Oct 26, 2023

[E2E] Add test to cover ResourceManagerTags #1053

Open

k8s-ci-robot assigned cpanato and richardcase Oct 26, 2023

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 26, 2023

feat: support adding resource manager tags to gcp resources

2b58598

Signed-off-by: Carlos Salas <[email protected]>

salasberryfin force-pushed the support-adding-resourcemanagertags branch from 6292a28 to 2b58598 Compare October 31, 2023 10:35

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 31, 2023

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 31, 2023

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 31, 2023

k8s-ci-robot merged commit 173d8a2 into kubernetes-sigs:main Oct 31, 2023
5 checks passed

k8s-ci-robot added this to the v1.1.0 milestone Oct 31, 2023

salasberryfin mentioned this pull request Apr 11, 2024

REQUEST: New membership for salasberryfin kubernetes/org#4877

Closed

11 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: support adding ResourceManagerTags to GCP resources #1008

feat: support adding ResourceManagerTags to GCP resources #1008

salasberryfin commented Aug 24, 2023 •

edited

Loading

k8s-ci-robot commented Aug 24, 2023

k8s-ci-robot commented Aug 24, 2023

richardcase commented Aug 29, 2023

richardcase commented Aug 29, 2023

richardcase left a comment

salasberryfin commented Aug 29, 2023

salasberryfin commented Aug 30, 2023 •

edited

Loading

richardcase left a comment

richardcase Aug 31, 2023

bharath-b-rh Sep 5, 2023

salasberryfin commented Oct 17, 2023

salasberryfin commented Oct 18, 2023

richardcase commented Oct 26, 2023

k8s-ci-robot commented Oct 26, 2023

richardcase commented Oct 26, 2023

salasberryfin commented Oct 27, 2023

richardcase commented Oct 31, 2023

k8s-ci-robot commented Oct 31, 2023

richardcase commented Oct 31, 2023

k8s-ci-robot commented Oct 31, 2023

feat: support adding ResourceManagerTags to GCP resources #1008

feat: support adding ResourceManagerTags to GCP resources #1008

Conversation

salasberryfin commented Aug 24, 2023 • edited Loading

k8s-ci-robot commented Aug 24, 2023

k8s-ci-robot commented Aug 24, 2023

richardcase commented Aug 29, 2023

richardcase commented Aug 29, 2023

richardcase left a comment

Choose a reason for hiding this comment

salasberryfin commented Aug 29, 2023

salasberryfin commented Aug 30, 2023 • edited Loading

richardcase left a comment

Choose a reason for hiding this comment

richardcase Aug 31, 2023

Choose a reason for hiding this comment

bharath-b-rh Sep 5, 2023

Choose a reason for hiding this comment

salasberryfin commented Oct 17, 2023

salasberryfin commented Oct 18, 2023

richardcase commented Oct 26, 2023

k8s-ci-robot commented Oct 26, 2023

richardcase commented Oct 26, 2023

salasberryfin commented Oct 27, 2023

richardcase commented Oct 31, 2023

k8s-ci-robot commented Oct 31, 2023

richardcase commented Oct 31, 2023

k8s-ci-robot commented Oct 31, 2023

salasberryfin commented Aug 24, 2023 •

edited

Loading

salasberryfin commented Aug 30, 2023 •

edited

Loading