Allow retries on DNS records if the record already exists #773
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I couldn't come up with a unit test for this one as it relies on creating records, waiting, deleting a record and then asserting that state. I've manually completed it but can't find a sensible way of automating that. |
jacobbednarz
commented
Aug 17, 2020
| @@ -270,6 +271,10 @@ func resourceCloudflareRecord() *schema.Resource { | |||
| Computed: true, | |||
| }, | |||
| }, | |||
| Timeouts: &schema.ResourceTimeout{ | |||
| Create: schema.DefaultTimeout(30 * time.Second), | |||
There was a problem hiding this comment.
Realistically, 10-15s is probably stil more than enough 🤷♂️
Despite best efforts, occasionally Terraform's API calls will be faster than the remote API's consistency. The scenario is easiest to find when you are constantly updating similar records back and forth or changing between A/CNAME and there is a `Delete` operation involved. This results in a scenario where an end user will get failures from `terraform apply` runs that indicate the record alredy exists but moments later, is available for use. To handle this scenario a bit nicer for the user, we can attempt to automatically retry the operation for a short period of time. I've opted for 30s as that is high enough that the remote API state will be in sync but also low enough that you won't be waiting too long to find out there is an issue there if the state is as intended and you're introducing an unintended duplicate. Fixes cloudflare#750
jacobbednarz
force-pushed
the
retry-a-and-cnames-on-duplicates
branch
from
86b84ff to
7f04599
Compare
jacobbednarz
commented
Aug 17, 2020
| return resource.Retry(d.Timeout(schema.TimeoutCreate), func() *resource.RetryError { | ||
| r, err := client.CreateDNSRecord(newRecord.ZoneID, newRecord) | ||
| if err != nil { | ||
| if strings.Contains(err.Error(), "already exist") { |
There was a problem hiding this comment.
Pretty naive matching but it covers the A/CNAME cases nicely.
patryk
approved these changes
Aug 18, 2020
boekkooi-lengoo
pushed a commit
to boekkooi-lengoo/terraform-provider-cloudflare
that referenced
this pull request
Feb 28, 2022
Replace hard coded per_page parameter on DNS API with default
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Despite best efforts, occasionally Terraform's API calls will be faster
than the remote API's consistency. The scenario is easiest to find when
you are constantly updating similar records back and forth or changing
between A/CNAME and there is a
Deleteoperation involved.This results in a scenario where an end user will get failures from
terraform applyruns that indicate the record alredy exists butmoments later, is available for use.
To handle this scenario a bit nicer for the user, we can attempt to
automatically retry the operation for a short period of time. I've opted
for 30s as that is high enough that the remote API state will be in sync
but also low enough that you won't be waiting too long to find out there
is an issue there if the state is as intended and you're introducing an
unintended duplicate.
Fixes #750