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

Add deprecation message for generated beta fields. #2142

Merged
merged 1 commit into from
Oct 4, 2018

Conversation

modular-magician
Copy link
Collaborator

@danawillow
Copy link
Contributor

For #2143.

Marking as a WIP because I don't want to submit this until we're definitely sure this is what we're doing, but at least for now I wouldn't mind some feedback on wording.

@danawillow danawillow requested a review from paddycarver October 2, 2018 00:10
@danawillow
Copy link
Contributor

Actually, a better reason for this being a WIP is that some of these fields/resources have reached GA now, and should be marked as such.

Copy link
Contributor

@paddycarver paddycarver left a comment

Choose a reason for hiding this comment

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

I'd ideally like to get a guide page up on the website explaining the multi-provider situation, so we can link to it from the deprecation message. I think we should also use the Resource.DeprecationMessage property when entire resources are getting deprecated, instead of setting it on each field.

I think

Use terraform-provider-google-beta to continue using it.

Makes sense to us, but to a user it may be confusing. Something like

Use the $RESOURCE resource in the terraform-provider-google-beta provider to continue using it. See https://terraform.io/docs/provider/google/guides/provider-versions.html for more details on beta {field/resource}s.

may give some more context? The parts I think are important in that:

  • calling out that terraform-provider-google-beta is a different provider
  • directing them to the resource to use--yes, they should have the same name, but I think it helps underscore that the providers aren't all-in, you can do them on a resource-by-resource basis
  • there's a link to some documentation explaining how to use the other provider, because the provider = "google-beta" hack won't be intuitive at first.

@paddycarver paddycarver added this to the 1.19.0 milestone Oct 2, 2018
@ghost ghost added size/m and removed size/xl labels Oct 3, 2018
@modular-magician modular-magician force-pushed the codegen-pr-518 branch 2 times, most recently from a762792 to de78b19 Compare October 4, 2018 01:14
@ghost ghost added size/l and removed size/m labels Oct 4, 2018
@danawillow danawillow changed the title WIP: Add deprecation message for generated beta fields. Add deprecation message for generated beta fields. Oct 4, 2018
@paddycarver paddycarver merged commit fab1363 into hashicorp:master Oct 4, 2018
@bluemalkin
Copy link

It would be good if the CHANGELOG documentation would instruct people how to update their existing states... coming from a previous version of the provider.

e.g. Warning: google_container_node_pool.api: "region": [DEPRECATED] This field is in beta and will be removed from this provider. Use it in the the google-beta provider instead. See https://terraform.io/docs/providers/google/provider_versions.html for more details.

So I go and remove region attribute and now terraform wants force resource re-creation !

@paddycarver
Copy link
Contributor

Did you try using it with the google-beta provider?

@bluemalkin
Copy link

@paddycarver I did but I do not want to switch to the beta provider that is my point

chrisst pushed a commit to chrisst/terraform-provider-google that referenced this pull request Nov 9, 2018
Add deprecation message for generated beta fields.
@ghost
Copy link

ghost commented Nov 16, 2018

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 feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. If you feel I made an error 🤖 🙉 , please reach out to my human friends 👉 hashibot-feedback@hashicorp.com. Thanks!

@ghost ghost locked and limited conversation to collaborators Nov 16, 2018
@modular-magician modular-magician deleted the codegen-pr-518 branch November 16, 2024 23:21
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants