hashicorp / terraform-provider-google

Terraform Provider for Google Cloud Platform
https://registry.terraform.io/providers/hashicorp/google/latest/docs
Mozilla Public License 2.0
2.29k stars 1.72k forks source link

Address confusion about `allUsers` and `allAuthenticatedUsers` in IAM resource documentation #13787

Open SarahFrench opened 1 year ago

SarahFrench commented 1 year ago

Community Note

Description

Making this issue after seeing this bug report: https://github.com/hashicorp/terraform-provider-google/issues/13592

Not all services support this list of members in the docs, which is hardcoded as part of the IAM docs template (mmv1/templates/terraform/resource_iam.html.markdown.erb).

It might be useful to allow service-specific information to those generated pages, perhaps as an explicit Exceptions for [PRODUCT NAME] section . I'm not sure if there are enough exceptions to warrant this though.

See comments for recommendations about how to address this with smaller changes.

New or Affected Resource(s)

Potential Terraform Configuration

N/A

References

SarahFrench commented 1 year ago

I submitted this as a typical Enhancement as it changes user-facing documentation, but it requires changes to how IAM docs are generated widely in the provider and impacts other developers working on the provider

rileykarson commented 1 year ago

Addtl notes:

SarahFrench commented 1 year ago

Also: can add example showing how to include workload identity federation in member(s) argument