Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

V5 upgrade docs updated for Default Provider Values and Data Source 404 erroring #8903

Merged
merged 3 commits into from
Sep 11, 2023

Conversation

NickElliot
Copy link
Contributor

Release Note Template for Downstream PRs (will be copied)


@NickElliot NickElliot marked this pull request as ready for review September 8, 2023 22:31
@NickElliot NickElliot requested a review from c2thorn September 8, 2023 22:31
@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.

Terraform GA: Diff ( 1 file changed, 8 insertions(+))
Terraform Beta: Diff ( 1 file changed, 8 insertions(+))

@@ -118,8 +118,16 @@ The new annotations model is similar to the new labels model and will be applied

There are now two annotation-related fields with the new model, the `annotations` and the output-only `effective_annotations` fields.

### Provider default values shown at plan-time

`project`, `region`, and `zone` fields will now display their values during plan-time instead of defaulting to the unknown `(known after apply)` value normally displayed for `computed` fields. These values will be taken from either the Terraform resource config file, provider config, or local environment variables, depending on which variables are supplied by the user, matching the existing per-resource functionality for what default values are used in execution of a Terraform plan.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
`project`, `region`, and `zone` fields will now display their values during plan-time instead of defaulting to the unknown `(known after apply)` value normally displayed for `computed` fields. These values will be taken from either the Terraform resource config file, provider config, or local environment variables, depending on which variables are supplied by the user, matching the existing per-resource functionality for what default values are used in execution of a Terraform plan.
`project`, `region`, and `zone` fields will now display their values during plan-time instead of defaulting to the unknown `(known after apply)` value normally displayed for [Computed](https://developer.hashicorp.com/terraform/plugin/sdkv2/schemas/schema-behaviors#computed) fields. These values will be taken from either the Terraform resource config file, provider config, or local environment variables, depending on which variables are supplied by the user, matching the existing per-resource functionality for what default values are used in execution of a Terraform plan.

Not sure if adding a link to the docs for what "Computed" means will be more or less confusing for users. I'll defer to your opinion.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not sure the level of expected technical specification in here -- if erring on the side of basic terminology, I'll rewrite it to describe it along the lines of "fields without fixed default values"

Copy link
Member

Choose a reason for hiding this comment

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

That sounds even better. Thanks!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The new wording is in, sounds good?

Copy link
Member

Choose a reason for hiding this comment

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

added another suggestion on second thought

@@ -118,8 +118,16 @@ The new annotations model is similar to the new labels model and will be applied

There are now two annotation-related fields with the new model, the `annotations` and the output-only `effective_annotations` fields.

### Provider default values shown at plan-time

`project`, `region`, and `zone` fields will now display their values during plan-time instead of the placeholder `(known after apply)` value normally displayed for fields without fixed default values. These values will be taken from either the Terraform resource config file, provider config, or local environment variables, depending on which variables are supplied by the user, matching the existing per-resource functionality for what default values are used in execution of a Terraform plan.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
`project`, `region`, and `zone` fields will now display their values during plan-time instead of the placeholder `(known after apply)` value normally displayed for fields without fixed default values. These values will be taken from either the Terraform resource config file, provider config, or local environment variables, depending on which variables are supplied by the user, matching the existing per-resource functionality for what default values are used in execution of a Terraform plan.
`project`, `region`, and `zone` fields will now display their values during plan-time instead of the placeholder `(known after apply)` value normally displayed for fields without provider default values. These values will be taken from either the Terraform resource config file, provider config, or local environment variables, depending on which variables are supplied by the user, matching the existing per-resource functionality for what default values are used in execution of a Terraform plan.

I understand fixed != API value here, but might as well be specific?

Copy link
Contributor Author

@NickElliot NickElliot Sep 11, 2023

Choose a reason for hiding this comment

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

I think the problem is it conflicts with the other usage of provider as a term -- since it does use the "provder default" value, as in what is configured in the user's provider config. I thought about saying "universal default", "hard-coded default", or similar to mean "regardless of local configuration", but wasn't sure if that became more or less clear than "fixed" on its own

Copy link
Member

@c2thorn c2thorn Sep 11, 2023

Choose a reason for hiding this comment

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

That makes sense. How about "fixed Terraform default values" ? If not, I'm fine with just "fixed". Users that care will probably already understand from the (known after apply) part.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That sounds good to me!

@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.

Terraform GA: Diff ( 1 file changed, 8 insertions(+))
Terraform Beta: Diff ( 1 file changed, 8 insertions(+))

@NickElliot NickElliot merged commit 75597f4 into GoogleCloudPlatform:main Sep 11, 2023
7 checks passed
@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.

Terraform GA: Diff ( 1 file changed, 8 insertions(+))
Terraform Beta: Diff ( 1 file changed, 8 insertions(+))

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants