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

Contributing Documentation: Add section on error handling #15792

Closed
gdavison opened this issue Oct 22, 2020 · 4 comments · Fixed by #17508
Closed

Contributing Documentation: Add section on error handling #15792

gdavison opened this issue Oct 22, 2020 · 4 comments · Fixed by #17508
Assignees
Labels
documentation Introduces or discusses updates to documentation. provider Pertains to the provider itself, rather than any interaction with AWS. technical-debt Addresses areas of the codebase that need refactoring or redesign.
Milestone

Comments

@gdavison
Copy link
Contributor

Add a section to documentation providing guidance on API error handling.

Among others, things to document:

  • The Delete operation should not return an error when the resource is not found, but simply short circuit.
  • Repeat the instructions to remove resource from state using d.SetId("") when not found during the Read operation
  • Document use of resource.Retry(iamwaiter.PropagationTimeout, ...) for IAM eventual consistency
@gdavison gdavison added enhancement Requests to existing resources that expand the functionality or scope. documentation Introduces or discusses updates to documentation. technical-debt Addresses areas of the codebase that need refactoring or redesign. and removed enhancement Requests to existing resources that expand the functionality or scope. labels Oct 22, 2020
@bflad bflad self-assigned this Dec 14, 2020
@bflad
Copy link
Contributor

bflad commented Dec 14, 2020

Since this is similar to other in progress provider documentation I'm already working on, picking this up as well. Most likely this will make sense as its own page, since there could be a lot of content that does not fit well with the existing information architecture of the contributing guide.

@bflad bflad added the provider Pertains to the provider itself, rather than any interaction with AWS. label Dec 14, 2020
bflad added a commit that referenced this issue Feb 8, 2021
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 added a commit that referenced this issue Feb 10, 2021
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

@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.
Labels
documentation Introduces or discusses updates to documentation. provider Pertains to the provider itself, rather than any interaction with AWS. technical-debt Addresses areas of the codebase that need refactoring or redesign.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants