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.

Sign up for GitHub

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

Jump to bottom

Document eventual consistency handling in Contributing Guide #12844

Closed
breathingdust opened this issue Apr 16, 2020 · 3 comments · Fixed by #17508
Closed

Document eventual consistency handling in Contributing Guide #12844

breathingdust opened this issue Apr 16, 2020 · 3 comments · Fixed by #17508
Assignees
@bflad
Labels
documentation Introduces or discusses updates to documentation. enhancement Requests to existing resources that expand the functionality or scope. provider Pertains to the provider itself, rather than any interaction with AWS.
Milestone
v3.28.0

Comments

@breathingdust
Copy link
Member

breathingdust commented Apr 16, 2020 •
edited by bflad
Loading

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 other comments that do not add relevant new information or questions, 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

Description

Improve contributing guide by including guidance for best practice for handling eventual consistency.

Best practice

  • Wrap problematic code with resource.Retry() with 1-2 minute timeout
  • Ensure there's a isResourceTimeoutError(err) conditional afterwards

To be avoided

  • resource.RetryableError should be very specific to the eventual consistency problem (no generic handling of all errors or all "invalid parameter" errors)
  • Customizable timeouts are generally not the solution 🙂
@breathingdust breathingdust added enhancement Requests to existing resources that expand the functionality or scope. documentation Introduces or discusses updates to documentation. labels Apr 16, 2020
@github-actions github-actions bot added the needs-triage Waiting for first response or review from a maintainer. label Apr 16, 2020
@breathingdust breathingdust added provider Pertains to the provider itself, rather than any interaction with AWS. and removed needs-triage Waiting for first response or review from a maintainer. labels Apr 16, 2020
@bflad bflad self-assigned this Feb 8, 2021
bflad added a commit that referenced this issue Feb 8, 2021
@bflad
docs/contributing: Initial Retries and Waiters documentation
a560575 
Reference: #12844
Reference: #15792
Reference: #16796

This page is meant to serve as a reference for all the related retry and waiting logic present in the provider. Further enhancements could discuss resource timeouts in general, however there is some future uncertainty with that functionality so it is currently omitted.
@bflad bflad mentioned this issue Feb 8, 2021
Merged
bflad added a commit that referenced this issue Feb 10, 2021
@bflad
docs/contributing: Initial Retries and Waiters documentation (#17508)
51c7793 
Reference: #12844
Reference: #15792
Reference: #16796

This page is meant to serve as a reference for all the related retry and waiting logic present in the provider. Further enhancements could discuss resource timeouts in general, however there is some future uncertainty with that functionality so it is currently omitted.
@github-actions github-actions bot added this to the v3.28.0 milestone Feb 10, 2021
@bflad
Copy link
Contributor

bflad commented Feb 10, 2021

💥 https://github.com/hashicorp/terraform-provider-aws/blob/main/docs/contributing/retries-and-waiters.md

@ghost
Copy link

ghost commented Feb 12, 2021

This has been released in version 3.28.0 of the Terraform AWS provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template for triage. Thanks!

@ghost
Copy link

ghost commented Mar 12, 2021

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. Thanks!

@ghost ghost locked as resolved and limited conversation to collaborators Mar 12, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@bflad bflad

Labels
documentation Introduces or discusses updates to documentation. enhancement Requests to existing resources that expand the functionality or scope. provider Pertains to the provider itself, rather than any interaction with AWS.
Projects
None yet
Milestone
v3.28.0
Development

Successfully merging a pull request may close this issue.

docs/contributing: Initial Retries and Waiters documentation hashicorp/terraform-provider-aws
2 participants
@bflad @breathingdust