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

Provider GoDaddy fix domain update #3427

Merged
merged 5 commits into from
Jun 16, 2023
Merged

Provider GoDaddy fix domain update #3427

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bbce4a8
chore: godaddy s/Discard/Ignore/g - its confusing
nefelim4ag Feb 21, 2023
f569247
fix: godaddy add ratelimit backoff
nefelim4ag Feb 21, 2023
7a45201
fix: godaddy #2467 update 2nd level records
nefelim4ag Feb 21, 2023
36409bb
fix: godaddy - use right methods to add/delete/update
nefelim4ag Mar 3, 2023
3abaaee
fix: godaddy - handle correctly when no postfix/prefix used for TXT
nefelim4ag Mar 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions provider/godaddy/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,13 @@ import (
"errors"
"fmt"
"io"
"math/rand"
"net/http"
"strconv"
"time"

"golang.org/x/time/rate"

"sigs.k8s.io/external-dns/pkg/apis/externaldns"
)

Expand Down Expand Up @@ -71,6 +75,9 @@ type Client struct {
// Client is the underlying HTTP client used to run the requests. It may be overloaded but a default one is instanciated in ``NewClient`` by default.
Client *http.Client

// GoDaddy limits to 60 requests per minute
Ratelimiter *rate.Limiter

// Logger is used to log HTTP requests and responses.
Logger Logger

Expand Down Expand Up @@ -115,6 +122,7 @@ func NewClient(useOTE bool, apiKey, apiSecret string) (*Client, error) {
APISecret: apiSecret,
APIEndPoint: endpoint,
Client: &http.Client{},
Ratelimiter: rate.NewLimiter(rate.Every(60*time.Second), 60),
Timeout: DefaultTimeout,
}

Expand Down Expand Up @@ -216,7 +224,22 @@ func (c *Client) Do(req *http.Request) (*http.Response, error) {
if c.Logger != nil {
c.Logger.LogRequest(req)
}

c.Ratelimiter.Wait(req.Context())
resp, err := c.Client.Do(req)
// In case of several clients behind NAT we still can hit rate limit
for i := 1; i < 3 && err == nil && resp.StatusCode == 429; i++ {
retryAfter, _ := strconv.ParseInt(resp.Header.Get("Retry-After"), 10, 0)

jitter := rand.Int63n(retryAfter)
retryAfterSec := retryAfter + jitter/2

sleepTime := time.Duration(retryAfterSec) * time.Second
time.Sleep(sleepTime)

c.Ratelimiter.Wait(req.Context())
resp, err = c.Client.Do(req)
}
if err != nil {
return nil, err
}
Expand Down
233 changes: 148 additions & 85 deletions provider/godaddy/godaddy.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
Expand Down Expand Up @@ -34,13 +34,13 @@ import (
const (
gdMinimalTTL = 600
gdCreate = 0
gdUpdate = 1
gdReplace = 1
gdDelete = 2
)

var actionNames = []string{
"create",
"update",
"replace",
"delete",
}

Expand Down Expand Up @@ -82,9 +82,8 @@ type gdRecordField struct {
Service *string `json:"service,omitempty"`
}

type gdUpdateRecordField struct {
type gdReplaceRecordField struct {
Data string `json:"data"`
Name string `json:"name"`
TTL int64 `json:"ttl"`
Port *int `json:"port,omitempty"`
Priority *int `json:"priority,omitempty"`
Expand Down Expand Up @@ -247,7 +246,7 @@ func (p *GDProvider) records(ctx *context.Context, zone string, all bool) (*gdRe

results.records = append(results.records, rec)
} else {
log.Infof("GoDaddy: Discard record %s for %s is %+v", rec.Name, zone, rec)
log.Infof("GoDaddy: Ignore record %s for %s is %+v", rec.Name, zone, rec)
}
}

Expand Down Expand Up @@ -347,28 +346,20 @@ func (p *GDProvider) changeAllRecords(endpoints []gdEndpoint, zoneRecords []*gdR
log.Debugf("Skipping record %s because no hosted zone matching record DNS Name was detected", dnsName)
} else {
dnsName = strings.TrimSuffix(dnsName, "."+zone)
if dnsName == zone {
dnsName = ""
}

if e.endpoint.RecordType == endpoint.RecordTypeA && (len(dnsName) == 0) {
dnsName = "@"
}

for _, target := range e.endpoint.Targets {
change := gdRecordField{
Type: e.endpoint.RecordType,
Name: dnsName,
TTL: p.ttl,
Data: target,
}

if e.endpoint.RecordTTL.IsConfigured() {
change.TTL = maxOf(gdMinimalTTL, int64(e.endpoint.RecordTTL))
}
e.endpoint.RecordTTL = endpoint.TTL(maxOf(gdMinimalTTL, int64(e.endpoint.RecordTTL)))

if err := zoneRecord.applyChange(e.action, p.client, change, p.DryRun); err != nil {
log.Errorf("Unable to apply change %s on record %s, %v", actionNames[e.action], change, err)
if err := zoneRecord.applyEndpoint(e.action, p.client, *e.endpoint, dnsName, p.DryRun); err != nil {
log.Errorf("Unable to apply change %s on record %s type %s, %v", actionNames[e.action], dnsName, e.endpoint.RecordType, err)

return err
}
return err
}
}
}
Expand All @@ -393,11 +384,49 @@ func (p *GDProvider) ApplyChanges(ctx context.Context, changes *plan.Changes) er
changedZoneRecords[i] = &records[i]
}

allChanges := make([]gdEndpoint, 0, countTargets(changes))
var allChanges []gdEndpoint

allChanges = p.appendChange(gdDelete, changes.Delete, allChanges)
allChanges = p.appendChange(gdDelete, changes.UpdateOld, allChanges)
allChanges = p.appendChange(gdCreate, changes.UpdateNew, allChanges)

iOldSkip := make(map[int]bool)
iNewSkip := make(map[int]bool)

for iOld, recOld := range changes.UpdateOld {
for iNew, recNew := range changes.UpdateNew {
if recOld.DNSName == recNew.DNSName && recOld.RecordType == recNew.RecordType {
ReplaceEndpoints := []*endpoint.Endpoint{recNew}
allChanges = p.appendChange(gdReplace, ReplaceEndpoints, allChanges)
iOldSkip[iOld] = true
iNewSkip[iNew] = true
break
}
}
}

for iOld, recOld := range changes.UpdateOld {
_, found := iOldSkip[iOld]
if found {
continue
}
for iNew, recNew := range changes.UpdateNew {
_, found := iNewSkip[iNew]
if found {
continue
}

if recOld.DNSName != recNew.DNSName {
continue
}

DeleteEndpoints := []*endpoint.Endpoint{recOld}
CreateEndpoints := []*endpoint.Endpoint{recNew}
allChanges = p.appendChange(gdDelete, DeleteEndpoints, allChanges)
allChanges = p.appendChange(gdCreate, CreateEndpoints, allChanges)

break
}
}

allChanges = p.appendChange(gdCreate, changes.Create, allChanges)

log.Infof("GoDaddy: %d changes will be done", len(allChanges))
Expand All @@ -409,102 +438,136 @@ func (p *GDProvider) ApplyChanges(ctx context.Context, changes *plan.Changes) er
return nil
}

func (p *gdRecords) addRecord(client gdClient, change gdRecordField, dryRun bool) error {
func (p *gdRecords) addRecord(client gdClient, endpoint endpoint.Endpoint, dnsName string, dryRun bool) error {
var response GDErrorResponse
for _, target := range endpoint.Targets {
change := gdRecordField{
Type: endpoint.RecordType,
Name: dnsName,
TTL: int64(endpoint.RecordTTL),
Data: target,
}

log.Debugf("GoDaddy: Add an entry %s to zone %s", change.String(), p.zone)

p.records = append(p.records, change)
p.changed = true
p.records = append(p.records, change)
p.changed = true

if dryRun {
log.Infof("[DryRun] - Add record %s.%s of type %s %s", change.Name, p.zone, change.Type, toString(change))
} else if err := client.Patch(fmt.Sprintf("/v1/domains/%s/records", p.zone), []gdRecordField{change}, &response); err != nil {
log.Errorf("Add record %s.%s of type %s failed: %s", change.Name, p.zone, change.Type, response)
log.Debugf("GoDaddy: Add an entry %s to zone %s", change.String(), p.zone)
if dryRun {
log.Infof("[DryRun] - Add record %s.%s of type %s %s", change.Name, p.zone, change.Type, toString(change))
} else if err := client.Patch(fmt.Sprintf("/v1/domains/%s/records", p.zone), []gdRecordField{change}, &response); err != nil {
log.Errorf("Add record %s.%s of type %s failed: %s", change.Name, p.zone, change.Type, response)

return err
return err
}
}

return nil
}

func (p *gdRecords) updateRecord(client gdClient, change gdRecordField, dryRun bool) error {
log.Debugf("GoDaddy: Update an entry %s to zone %s", change.String(), p.zone)

for index, record := range p.records {
if record.Type == change.Type && record.Name == change.Name {
var response GDErrorResponse

p.records[index] = change
p.changed = true
func (p *gdRecords) replaceRecord(client gdClient, endpoint endpoint.Endpoint, dnsName string, dryRun bool) error {
changed := []gdReplaceRecordField{}
records := []string{}

changed := []gdUpdateRecordField{{
Data: change.Data,
Name: change.Name,
TTL: change.TTL,
Port: change.Port,
Priority: change.Priority,
Weight: change.Weight,
Protocol: change.Protocol,
Service: change.Service,
}}

if dryRun {
log.Infof("[DryRun] - Update record %s.%s of type %s %s", change.Name, p.zone, change.Type, toString(changed))
} else if err := client.Patch(fmt.Sprintf("/v1/domains/%s/records/%s", p.zone, change.Type), changed, &response); err != nil {
log.Errorf("Update record %s.%s of type %s failed: %v", change.Name, p.zone, change.Type, response)
for _, target := range endpoint.Targets {
change := gdRecordField{
Type: endpoint.RecordType,
Name: dnsName,
TTL: int64(endpoint.RecordTTL),
Data: target,
}

return err
for index, record := range p.records {
if record.Type == change.Type && record.Name == change.Name {
p.records[index] = change
p.changed = true
}
}
records = append(records, target)
changed = append(changed, gdReplaceRecordField{
Data: change.Data,
TTL: change.TTL,
Port: change.Port,
Priority: change.Priority,
Weight: change.Weight,
Protocol: change.Protocol,
Service: change.Service,
})
}

var response GDErrorResponse

if dryRun {
log.Infof("[DryRun] - Replace record %s.%s of type %s %s", dnsName, p.zone, endpoint.RecordType, records)

return nil
}

log.Debugf("Replace record %s.%s of type %s %s", dnsName, p.zone, endpoint.RecordType, records)
if err := client.Put(fmt.Sprintf("/v1/domains/%s/records/%s/%s", p.zone, endpoint.RecordType, dnsName), changed, &response); err != nil {
log.Errorf("Replace record %s.%s of type %s failed: %v", dnsName, p.zone, endpoint.RecordType, response)

return err
}

return nil
}

// Remove one record from the record list
func (p *gdRecords) deleteRecord(client gdClient, change gdRecordField, dryRun bool) error {
log.Debugf("GoDaddy: Delete an entry %s to zone %s", change.String(), p.zone)
func (p *gdRecords) deleteRecord(client gdClient, endpoint endpoint.Endpoint, dnsName string, dryRun bool) error {
records := []string{}

for _, target := range endpoint.Targets {
change := gdRecordField{
Type: endpoint.RecordType,
Name: dnsName,
TTL: int64(endpoint.RecordTTL),
Data: target,
}
records = append(records, target)

deleteIndex := -1
log.Debugf("GoDaddy: Delete an entry %s from zone %s", change.String(), p.zone)

for index, record := range p.records {
if record.Type == change.Type && record.Name == change.Name && record.Data == change.Data {
deleteIndex = index
break
deleteIndex := -1

for index, record := range p.records {
if record.Type == change.Type && record.Name == change.Name && record.Data == change.Data {
deleteIndex = index
break
}
}
}

if deleteIndex >= 0 {
var response GDErrorResponse
if deleteIndex >= 0 {
p.records[deleteIndex] = p.records[len(p.records)-1]

p.records[deleteIndex] = p.records[len(p.records)-1]
p.records = p.records[:len(p.records)-1]
p.changed = true
}
}

p.records = p.records[:len(p.records)-1]
p.changed = true
if dryRun {
log.Infof("[DryRun] - Delete record %s.%s of type %s %s", dnsName, p.zone, endpoint.RecordType, records)

if dryRun {
log.Infof("[DryRun] - Delete record %s.%s of type %s %s", change.Name, p.zone, change.Type, toString(change))
} else if err := client.Delete(fmt.Sprintf("/v1/domains/%s/records/%s/%s", p.zone, change.Type, change.Name), &response); err != nil {
log.Errorf("Delete record %s.%s of type %s failed: %v", change.Name, p.zone, change.Type, response)
return nil
}

return err
}
} else {
log.Warnf("GoDaddy: record in zone %s not found %s to delete", p.zone, change.String())
var response GDErrorResponse
if err := client.Delete(fmt.Sprintf("/v1/domains/%s/records/%s/%s", p.zone, endpoint.RecordType, dnsName), &response); err != nil {
log.Errorf("Delete record %s.%s of type %s failed: %v", dnsName, p.zone, endpoint.RecordType, response)

return err
}

return nil
}

func (p *gdRecords) applyChange(action int, client gdClient, change gdRecordField, dryRun bool) error {
func (p *gdRecords) applyEndpoint(action int, client gdClient, endpoint endpoint.Endpoint, dnsName string, dryRun bool) error {
switch action {
case gdCreate:
return p.addRecord(client, change, dryRun)
case gdUpdate:
return p.updateRecord(client, change, dryRun)
return p.addRecord(client, endpoint, dnsName, dryRun)
case gdReplace:
return p.replaceRecord(client, endpoint, dnsName, dryRun)
case gdDelete:
return p.deleteRecord(client, change, dryRun)
return p.deleteRecord(client, endpoint, dnsName, dryRun)
}

return nil
Expand Down