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

r/aws_opensearch_domain_policy: handle domain update propagation delays #36592

Merged
merged 3 commits into from
Mar 26, 2024

Conversation

jar-b
Copy link
Member

@jar-b jar-b commented Mar 26, 2024

Description

This change adds logic to retry ValidationExceptions which indicate a domain change is in-progress. When a domain policy change immediately follows domain creation or modification, delays in propagation of the ACTIVE status can cause intermittent ValidationExceptions. These errors are now retried for a short interval (2 minutes), which should allow configurations pairing domain and domain policy resources to complete successfully on the first apply.

Relations

Closes #35811

References

Output from Acceptance Testing

% make testacc PKG=elasticsearch TESTS=TestAccElasticsearchDomainPolicy_
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go1.21.8 test ./internal/service/elasticsearch/... -v -count 1 -parallel 20 -run='TestAccElasticsearchDomainPolicy_'  -timeout 360m

--- PASS: TestAccElasticsearchDomainPolicy_basic (1956.43s)
PASS
ok      github.com/hashicorp/terraform-provider-aws/internal/service/elasticsearch      1962.012s
% make testacc PKG=opensearch TESTS=TestAccOpenSearchDomainPolicy_
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go1.21.8 test ./internal/service/opensearch/... -v -count 1 -parallel 20 -run='TestAccOpenSearchDomainPolicy_'  -timeout 360m

--- PASS: TestAccOpenSearchDomainPolicy_basic (2148.30s)
PASS
ok      github.com/hashicorp/terraform-provider-aws/internal/service/opensearch 2153.767

jar-b added 2 commits March 26, 2024 13:30
…elays

This change adds logic to retry ValidationExceptions which indicate a domain change is in-progress. When a domain policy change immediately follows domain creation or modification, delays in propagation of the ACTIVE status can cause intermittent ValidationExceptions. These errors are now retried for a short interval (2 minutes), which should allow configurations pairing domain and domain policy resources to complete successfully on the first apply.

```console
% make testacc PKG=elasticsearch TESTS=TestAccElasticsearchDomainPolicy_
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go1.21.8 test ./internal/service/elasticsearch/... -v -count 1 -parallel 20 -run='TestAccElasticsearchDomainPolicy_'  -timeout 360m

--- PASS: TestAccElasticsearchDomainPolicy_basic (1956.43s)
PASS
ok      github.com/hashicorp/terraform-provider-aws/internal/service/elasticsearch      1962.012s
```
This change adds logic to retry ValidationExceptions which indicate a domain change is in-progress. When a domain policy change immediately follows domain creation or modification, delays in propagation of the ACTIVE status can cause intermittent ValidationExceptions. These errors are now retried for a short interval (2 minutes), which should allow configurations pairing domain and domain policy resources to complete successfully on the first apply.

```console
% make testacc PKG=opensearch TESTS=TestAccOpenSearchDomainPolicy_
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go1.21.8 test ./internal/service/opensearch/... -v -count 1 -parallel 20 -run='TestAccOpenSearchDomainPolicy_'  -timeout 360m

--- PASS: TestAccOpenSearchDomainPolicy_basic (2148.30s)
PASS
ok      github.com/hashicorp/terraform-provider-aws/internal/service/opensearch 2153.767
```
Copy link

Community Note

Voting for Prioritization

  • Please vote on this pull request by adding a 👍 reaction to the original post to help the community and maintainers prioritize this pull request.
  • Please see our prioritization guide for information on how we prioritize.
  • 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.

For Submitters

  • Review the contribution guide relating to the type of change you are making to ensure all of the necessary steps have been taken.
  • For new resources and data sources, use skaff to generate scaffolding with comments detailing common expectations.
  • Whether or not the branch has been rebased will not impact prioritization, but doing so is always a welcome surprise.

@github-actions github-actions bot added service/elasticsearch Issues and PRs that pertain to the elasticsearch service. service/opensearch Issues and PRs that pertain to the opensearch service. size/XS Managed by automation to categorize the size of a PR. and removed service/elasticsearch Issues and PRs that pertain to the elasticsearch service. service/opensearch Issues and PRs that pertain to the opensearch service. labels Mar 26, 2024
@terraform-aws-provider terraform-aws-provider bot added the prioritized Part of the maintainer teams immediate focus. To be addressed within the current quarter. label Mar 26, 2024
Copy link
Contributor

@ewbankkit ewbankkit left a comment

Choose a reason for hiding this comment

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

LGTM 🚀.

@jar-b jar-b merged commit 78c1710 into main Mar 26, 2024
34 checks passed
@jar-b jar-b deleted the b-elasticsearch_domain_policy-retry branch March 26, 2024 19:29
@github-actions github-actions bot added this to the v5.43.0 milestone Mar 26, 2024
github-actions bot pushed a commit that referenced this pull request Mar 26, 2024
Copy link

This functionality has been released in v5.43.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. Thank you!

@github-actions github-actions bot removed the prioritized Part of the maintainer teams immediate focus. To be addressed within the current quarter. label Mar 28, 2024
Copy link

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 29, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
size/XS Managed by automation to categorize the size of a PR.
Projects
None yet
2 participants