Support labels for google cloud resources

[hashibot]

This issue was originally opened by @JorritSalverda as hashicorp/terraform#3546. It was migrated here as part of the provider split. The original body of the issue is below.

---

According to http://googlecloudplatform.blogspot.nl/2015/10/using-labels-to-organize-Google-Cloud-Platform-resources.html you can now use key/value pairs to label your resources.

It seem to be tags that have key=value format, but if I try that I get the following error, so apparently it's handled differently through the gcloud api.

Reason: invalid, Message: Invalid value for field 'tags.items[0]': 'environment=prod'.  Must be a match of regex '(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)'

Please add support for this as it will allow us to use this to label our resources for better cost reporting.

[hashibot]

This comment was originally opened by @JorritSalverda as hashicorp/terraform#3546 (comment). It was migrated here as part of the provider split. The original comment is below.

---

Judging from the info in the article it's a replacement for tags, but tags that previously existed are shown as value-less keys, which first led me to believe it used the tags system, but it's separately set with

curl --request POST --header "Authorization: Bearer your-oauth-token" --header 'Content-Type: application/json' --data '{"labels": {"env": "canary"}, "labelFingerprint": "abcdefghij="}' https://www.googleapis.com/compute/alpha/projects/your-project-id/zones/your-zone/instances/your-instance/setLabels

[hashibot]

This comment was originally opened by @lwander as hashicorp/terraform#3546 (comment). It was migrated here as part of the provider split. The original comment is below.

---

Unfortunately this seems to only be available in the beta API. I'll have to see what might break if we move from v1 to beta.

Have you considered using the metadata instance attribute? It supports key value pairs and is documented here

[hashibot]

This comment was originally opened by @JorritSalverda as hashicorp/terraform#3546 (comment). It was migrated here as part of the provider split. The original comment is below.

---

I've tested using metadata for it, but it's not what they use below the covers and doesn't unlock the new features. I can wait for the feature to go out of beta though.

[hashibot]

This comment was originally opened by @lwander as hashicorp/terraform#3546 (comment). It was migrated here as part of the provider split. The original comment is below.

---

I'm asking the SetLabel team internally to see if they have an estimate for when it will leave beta.

[hashibot]

This comment was originally opened by @devth as hashicorp/terraform#3546 (comment). It was migrated here as part of the provider split. The original comment is below.

---

1. Any update on when this will reach GA?
2. Will labels be available on all resource types?

[hashibot]

This comment was originally opened by @dvianello as hashicorp/terraform#3546 (comment). It was migrated here as part of the provider split. The original comment is below.

---

Hey!

Any update on this? It would be a brilliant way for us to track costs across different deployments...

[hashibot]

This comment was originally opened by @zbikmarc as hashicorp/terraform#3546 (comment). It was migrated here as part of the provider split. The original comment is below.

---

Regarding to official documentation of Google Cloud Platform labels are no more in beta
https://cloud.google.com/compute/docs/labeling-resources (see URL in example)

[hashibot]

This comment was originally opened by @tpoindessous as hashicorp/terraform#3546 (comment). It was migrated here as part of the provider split. The original comment is below.

---

Hi

@lwander , can you remove the upstream label please ?

Labels update on resource need to provide right fingerprint. It would be great to have common functions, that we could use in resource and datasource files.

Thanks !

[tpoindessous]

It's now available since #142

But it would be nice to have common functions.

Thanks

[danawillow]

Hey @tpoindessous, I'm not sure what you mean by common functions, but @selmanj is working on adding support for labels, generally.

[tpoindessous]

Hi

I was thinking about helpers functions, which everyone can use instead of rewriting code for using labels.

For example, I'm trying to add a new datasource for snapshot and I added support for searching by labels in my fork

	labels := d.Get("labels").(map[string]interface{})
	log.Printf("[DEBUG] Labels %s", labels)

	if len(labels) > 0 {
		filter := ""
		log.Printf("[DEBUG] Labels length : %d", len(labels))
		for k, v := range labels {
			log.Printf("[DEBUG] Label key : '%s', value : '%s'", k, v)
			filter = fmt.Sprintf("%s(labels.%s eq %s)", filter, k, v)
		}
		log.Printf("[DEBUG] Labels filter : %s", filter)
		snapshotList, err := config.clientCompute.Snapshots.List(project).Filter(filter).Do()
		if err != nil {
			return fmt.Errorf("Snapshot, error while Listing with filter '%s' ", filter)
		}
		log.Printf("[DEBUG] SnapshotList length : %d", len(snapshotList.Items))

		if len(snapshotList.Items) > 1 {
			return fmt.Errorf("Snapshot : too many snapshots found with these tags")
		} else if len(snapshotList.Items) == 0 {
			return fmt.Errorf("Snapshot : no snapshot found with these tags")
		} else {
			d.Set("name", snapshotList.Items[0].Name)
		}
	}

It would be useful to reduce code by using helpers functions.

Thanks for your work and your future work ;)

Thomas

[selmanj]

@tpoindessous I, too, don't like repeating myself. I'll use a helper function for sure here to reduce duplication. Thanks for the suggestion!

[zbikmarc]

It's awesome that there is labels support for compute_instances! But are there any plans of extending labels support to other resources in near future?

[tpoindessous]

There is a Work In Progress to add it for snapshot resource :) Le ven. 7 juil. 2017 à 10:53, Marcin Żbik <[email protected]> a écrit :

…

It's awesome that there is labels support for compute_instances! But are there any plans of extending labels support to other resources in near future? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#17 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AC6cEKZzzjhU0g42Eq3-xxrSHQNIMnIVks5sLfHpgaJpZM4N4fuk> .

[selmanj]

Added label support to google_compute_image in #339

[zbikmarc]

Any plans to add it to google_compute_instance_template in near future?
It looks like it is supported over API at least: https://googlecloudplatform.uservoice.com/forums/302595-compute-engine/suggestions/20145226-allow-settings-labels-in-instance-template

[selmanj]

@zbikmarc Yes, it's planned. I'll prioritize that resource when I get a chance.

[selmanj]

Opened #515

[selmanj]

Closing for now. Labels have been added to:

• compute_disk
• compute_gobal_forwarding_rule
• compute_image
• compute_instance
• compute_instance_template
• compute_snapshot

Feel free to file subsequent issues if you find any other resources that need labels.

[stefanthorpe]

Is it possible to add label support for

• sql_database_instance

[rosbo]

Hi,

I filed a separate issue (#1372) to track this. Thanks for reporting.

[ghost]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. If you feel I made an error 🤖 🙉 , please reach out to my human friends 👉 [email protected]. Thanks!