Removing a label on a bucket doesn't work

[rolandkool]

Hi there,

When a bucket contains a label that is not part of the terraform file or state, terraform tries to remove it. However this doesn't work so with every run it tries to remove the label.

Terraform Version

Terraform 0.11.5
Google Provider 1.9.0

Affected Resource(s)

• google_storage_bucket

Terraform Configuration Files

resource "google_storage_bucket" "testbucket" {
  name          = "myproject-testbucket"
  project       = "myproject"
  location      = "EUROPE-WEST1"
  storage_class = "REGIONAL"
  force_destroy = true

  labels = {
    opex = "teamxyz"
    application = "myapp"
  }
}

Debug Output

When adding a label to this bucket called 'remove' with value 'me', terraform shows this:

google_storage_bucket.testbucket:
Modifying... (ID: myproject-testbucket)
labels.%: "3" => "2"
labels.remove: "me" => ""

Expected Behavior

Label should be removed

Actual Behavior

Label remains on the bucket

[nat-henderson]

Interesting - you're right. The requests seem to be getting correctly formulated... I wonder what's going on there. I'll check on that.

[rolandkool]

Any news on this?

[rosbo]

The patch method update existing labels or add new ones when you pass a map of labels. You can also delete all labels by setting the labels field to NULL. You can set the value of a label explicitly to "null" in the JSON body. However, the golang client takes a map[string]string for the labels field. You can't pass a nil, only an empty string and empty string is a valid label value... Because of this, there is no way to delete a single label using the patch method.

There is an update method which replaces all the metadata which you can use to delete labels. You must pass all the metadata in the body of the request otherwise, you will erase the parts you omit.

I will explore the approach using the update method.

[rosbo]

After digging some more, you can pass a null value using the go client for a given label key by adding labels.my-key to the NullField on the resource.

[nat-henderson]

Thanks, @rosbo!

[rolandkool]

Verified that the labels are indeed removed now (with a build from the master branch).
Thanks!

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