-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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
Refresh Google provider configuration reference page #1559
Refresh Google provider configuration reference page #1559
Conversation
Hi! I'm the modular magician, I work on Magic Modules. Pull request statusesNo diff detected in terraform-google-conversion. New Pull RequestsI built this PR into one or more new PRs on other repositories, and when those are closed, this PR will also be merged and closed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good refresh! Couple small comments.
third_party/terraform/website/docs/provider_reference.html.markdown
Outdated
Show resolved
Hide resolved
The `google` and `google-beta` provider blocks are used to configure default values for | ||
your GCP project and location (`zone` and `region`), and add your credentials. | ||
|
||
-> You can avoid using a provider block by using environment variables. Every |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should be explicit about the inheritance path of specifying these values in environment vs provider vs resource. Even in the Full Reference section the language doesn't show which value will 'win' if duplicated. I think specifying the inheritance in one place (preferably up high) is valuable. Or maybe in the other Configuration Reference section.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Breaking down one of the examples;
The default project to manage resources in. If another
project is specified on a resource, it will take precedence. Alternatively, this
can be specified using the specified using theGOOGLE_PROJECT
environment
variable, or any of the following ordered by precedence.
The default project to manage resources in. If another project is specified on a resource, it will take precedence.
clearly specifies the relationship between provider <-> resource
Alternatively, this can be specified using the specified using the
GOOGLE_PROJECT
environment variable, or any of the following ordered by precedence.
I think that the Alternatively, this can be specified...
implies the relationship there- that explicit values take precendence -strongly enough, especially because it should be the default assumption of users. Do you think it's insufficient?
third_party/terraform/website/docs/provider_reference.html.markdown
Outdated
Show resolved
Hide resolved
third_party/terraform/website/docs/provider_reference.html.markdown
Outdated
Show resolved
Hide resolved
Hi! I'm the modular magician, I work on Magic Modules. Pull request statusesterraform-provider-google-beta already has an open PR. New Pull RequestsI didn't open any new pull requests because of this PR. |
Tracked submodules are build/terraform-beta build/terraform-mapper build/terraform build/ansible build/inspec.
81867f6
to
73b55c1
Compare
I had some spare time while GKE runs were going to test omitted blocks, and I saw that our configuration reference was a bit of a mess compared to Azure; we spend a lot of time documenting every single env var you could use and it's a little intimidating; instead, add a quick reference for "what are the fields on the provider block" and a full reference to dig into the specifics of each field and what vars can be used etc.
If I misspoke about anything related to authentication, please correct me! I'm around 70% confident I got it all right.
/cc @chrisst @paddycarver if either of you have feelings
[all]
[terraform]
[terraform-beta]
[ansible]
[inspec]