[Dataflow] Improve documentation on the use of the parameters argument.

[damondouglas]

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.

Terraform Version

This issue is not related to a specific terraform version.

Affected Resource(s)

dataflow_flex_template_job

Terraform Configuration

No response

Debug Output

No response

Expected Behavior

The documentation on parameters could probably state: "string / string Key/Value pairs to be passed to the Dataflow job that are specific to the template.", replacing the phrase "Additional pipeline options such as serviceAccount, workerMachineType, etc can be specified here." with "Parameters common to all Dataflow jobs such as serviceAccount, etc should be assigned using this resource block's designated parameter."

Actual Behavior

No response

Steps to reproduce

No response

Important Factoids

No response

References

No response

b/331217711

[damondouglas]

Is there a way to assign this to myself?

[roaks3]

@damondouglas I can assign you. Normally we would forward this as a new ticket, but I see that this is an action item from the previous issue #17570. Would you like to close the other issue? And do you need us to forward this one as well?

[damondouglas]

@roaks3 Thank you. I'm not able to close #17570.

[melinath]

Note from triage: In case it's relevant, we did change the behavior of the parameters field slightly in 5.0: https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/version_5_upgrade#resource-google_dataflow_flex_template_job

[damondouglas]

@melinath Thank you for this helpful information. The noted behavior change does not change the fix strategy for #17612. I will cc you on the PR in case you do not get alerts anyway.

[github-actions]

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 have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.