Ambiguous instantiation of health checks resource objects

[woodham1]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request.
• Please do not leave +1 or me too comments, they generate extra noise for issue followers and do not help prioritize the request.
• If you are interested in working on this issue or have submitted a pull request, please leave a comment.
• If an issue is assigned to a user, that user is claiming responsibility for the issue.
• Customers working with a Google Technical Account Manager or Customer Engineer can ask them to reach out internally to expedite investigation and resolution of this issue.

Description

I understand that health checks may be defined as an array future implementations of the terraform resource, where hypothetically at a future date we may support multiple health checks in one backend_service resource, but the description of the variable is inherently contradictory. (aside from the the fact that the variable itself is plural.)

This sentence The set of URLs to HealthCheck resources for health checking this RegionBackendService. Currently at most one health check can be specified. Should most likely be updated to read The URL to HealthCheck resources for health checking this RegionBackendService. Currently at most one health check can be specified. Written as is, specifying URLs, then clarifying the sentence afterwards is asking to "gotcha" the end user. If there needs to be a disclaimer to specify that it is a set it can be appended on the end.

I know it's not ideal, but using a plural, then specifying that plural to be incorrect in the next sentence is IMO, not very user-friendly.

New or Affected Resource(s)

compute_region_backend_service

Potential Terraform Configuration

References

No response

b/328077461

[macwas]

We are not going to change it and here are the reasons:

• actually health checks are already defined as an array, see definition at https://cloud.google.com/compute/docs/reference/rest/v1/backendServices, so the first sentence refers to the type of the parameter.
• The second sentence, that the most one health check can be specified, is just a description of conditions that this parameter has to meet.

We didn't find a better description of the current state, namely that the field is an array that accepts only one element.