Skip to content

Conversation

BBBmau
Copy link
Collaborator

@BBBmau BBBmau commented Oct 14, 2025

The current documentation for this write-only field is not intuitive at all. It caused some confusion of it not existing in the resource itself in this issue:

This PR resolves that and aligns more with the other cloud provider docs

Release Note Template for Downstream PRs (will be copied)

See Write release notes for guidance.


@BBBmau
Copy link
Collaborator Author

BBBmau commented Oct 14, 2025

This answers your question you brought up here:

we'll want to make sure other write-only arguments follow the same change

@ramonvermeulen

@ramonvermeulen
Copy link
Contributor

ramonvermeulen commented Oct 14, 2025

This answers your question you brought up here:

we'll want to make sure other write-only arguments follow the same change

@ramonvermeulen

Thanks for picking this up! I will take a look at this tomorrow, and see if I can change it for all the other write only documentation references (e.g. also the newly generated docs around write-only).

[Read more about sensitive data in state](https://www.terraform.io/language/state/sensitive-data). Passwords will not be retrieved when running
"terraform import".

-> **Note:** Write-Only argument `password_wo` is available to use in place of `password`. Write-Only argumentss are supported in HashiCorp Terraform 1.11.0 and later. [Learn more](https://developer.hashicorp.com/terraform/language/resources/ephemeral#write-only-arguments).
Copy link
Contributor

@ramonvermeulen ramonvermeulen Oct 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NIT, for the rest LGTM!

Suggested change
-> **Note:** Write-Only argument `password_wo` is available to use in place of `password`. Write-Only argumentss are supported in HashiCorp Terraform 1.11.0 and later. [Learn more](https://developer.hashicorp.com/terraform/language/resources/ephemeral#write-only-arguments).
-> **Note:** Write-Only argument `password_wo` is available to use in place of `password`. Write-Only arguments are supported in HashiCorp Terraform 1.11.0 and later. [Learn more](https://developer.hashicorp.com/terraform/language/resources/ephemeral#write-only-arguments).

@modular-magician
Copy link
Collaborator

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

google provider: Diff ( 1 file changed, 8 insertions(+), 10 deletions(-))
google-beta provider: Diff ( 1 file changed, 8 insertions(+), 10 deletions(-))


* ~> **Note:** One of `value` or `value_wo` can only be set.

* `password_wo_version` - (Optional) An integer value used to trigger an update for `password_wo`. This property should be incremented when updating `password_wo`. For more info see [updating write-only attributes](/docs/providers/google/guides/using_write_only_attributes.html#updating-write-only-attributes).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe this should also be a doc on: updating write only arguments?

@BBBmau
Copy link
Collaborator Author

BBBmau commented Oct 14, 2025

Thanks for picking this up! I will take a look at this tomorrow, and see if I can change it for all the other write only documentation references (e.g. also the newly generated docs around write-only).

I'm actually looking at the generation currently. feel free to work on:

that adds root_password_wo for sql_database_instance resource


* ~> **Note:** One of `value` or `value_wo` can only be set.

* `password_wo_version` - (Optional) An integer value used to trigger an update for `password_wo`. This property should be incremented when updating `password_wo`. For more info see [updating write-only attributes](/docs/providers/google/guides/using_write_only_attributes.html#updating-write-only-attributes).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* `password_wo_version` - (Optional) An integer value used to trigger an update for `password_wo`. This property should be incremented when updating `password_wo`. For more info see [updating write-only attributes](/docs/providers/google/guides/using_write_only_attributes.html#updating-write-only-attributes).
* `password_wo_version` - (Optional) An integer value used to trigger an update for `password_wo`. This property should be incremented when updating `password_wo`. For more info see [updating write-only arguments](/docs/providers/google/guides/using_write_only_attributes.html#updating-write-only-attributes).

Copy link
Contributor

@ramonvermeulen ramonvermeulen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we would want to update using_write_only_attributes.html#updating-write-only-attributes as well to state arguments. For the rest LGTM!

@ramonvermeulen
Copy link
Contributor

I'm actually looking at the generation currently. feel free to work on:

Oh nice, Thanks! I think it would indeed be nice to tackle it all in one PR.
I am logging off now, but will take a look at the sql_database_instance tomorrow if time permits.

Linking hashicorp/terraform-provider-google#24702 because it will be closed with this PR as well.

@modular-magician
Copy link
Collaborator

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

google provider: Diff ( 1 file changed, 11 insertions(+), 12 deletions(-))
google-beta provider: Diff ( 1 file changed, 11 insertions(+), 12 deletions(-))

@modular-magician
Copy link
Collaborator

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

google provider: Diff ( 1 file changed, 11 insertions(+), 12 deletions(-))
google-beta provider: Diff ( 1 file changed, 11 insertions(+), 12 deletions(-))

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants