-
Notifications
You must be signed in to change notification settings - Fork 2.6k
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
Multi target plan ( Page Not Found ) #404
Changes from 1 commit
baaf72a
bc81730
41a3119
1ff3d43
b247a75
d1979ce
ada43e4
c4e6188
d51b1b0
a4fb4bc
88ef640
36ce919
6e93afe
b543159
dbafc58
93f40c6
aaf5c9c
a0c3911
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and | |
limitations under the License. | ||
*/ | ||
|
||
package registry | ||
package endpoint | ||
|
||
import ( | ||
"errors" | ||
|
@@ -24,37 +24,30 @@ import ( | |
) | ||
|
||
var ( | ||
errInvalidHeritage = errors.New("heritage is unknown or not found") | ||
ErrInvalidHeritage = errors.New("heritage is unknown or not found") | ||
) | ||
|
||
// known keys | ||
const ( | ||
heritage = "external-dns" | ||
// OwnerLabelKey is the name of the label that defines the owner of an Endpoint. | ||
OwnerLabelKey = "owner" | ||
// ResourceLabelKey is the name of the label that identifies k8s resource which wants to acquire the DNS name | ||
ResourceLabelKey = "resource" | ||
) | ||
|
||
// serializeLabel transforms endpoints labels into a external-dns format string | ||
func serializeLabel(labels map[string]string, surroundQuotes bool) string { | ||
var tokens []string | ||
tokens = append(tokens, fmt.Sprintf("heritage=%s", heritage)) | ||
var keys []string | ||
for key := range labels { | ||
keys = append(keys, key) | ||
} | ||
sort.Strings(keys) // sort for consistency | ||
// Labels store metadata related to the endpoint | ||
// it is then stored in a persistent storage via serialization | ||
type Labels map[string]string | ||
|
||
for _, key := range keys { | ||
tokens = append(tokens, fmt.Sprintf("%s/%s=%s", heritage, key, labels[key])) | ||
} | ||
if surroundQuotes { | ||
return fmt.Sprintf("\"%s\"", strings.Join(tokens, ",")) | ||
} | ||
return strings.Join(tokens, ",") | ||
// NewLabels returns empty Labels | ||
func NewLabels() Labels { | ||
return map[string]string{} | ||
} | ||
|
||
// deserializeLabel constructs endpoints labels from a provided format string | ||
// NewLabelsFromString constructs endpoints labels from a provided format string | ||
// if heritage set to another value is found then error is returned | ||
// no heritage automatically assumes is not owned by external-dns | ||
func deserializeLabel(labelText string) (map[string]string, error) { | ||
// no heritage automatically assumes is not owned by external-dns and returns invalidHeritage error | ||
func NewLabelsFromString(labelText string) (Labels, error) { | ||
endpointLabels := map[string]string{} | ||
labelText = strings.Trim(labelText, "\"") // drop quotes | ||
tokens := strings.Split(labelText, ",") | ||
|
@@ -66,7 +59,7 @@ func deserializeLabel(labelText string) (map[string]string, error) { | |
key := strings.Split(token, "=")[0] | ||
val := strings.Split(token, "=")[1] | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can we use Kubernetes' label parsing functions? Seems easier to use: https://github.com/linki/chaoskube/blob/v0.6.1/main.go#L59 and we don't have to maintain this. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I will try it out :) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. done :) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. undone, because labels could not be parsed if "/" are present :( |
||
if key == "heritage" && val != heritage { | ||
return nil, errInvalidHeritage | ||
return nil, ErrInvalidHeritage | ||
} | ||
if key == "heritage" { | ||
foundExternalDNSHeritage = true | ||
|
@@ -78,8 +71,28 @@ func deserializeLabel(labelText string) (map[string]string, error) { | |
} | ||
|
||
if !foundExternalDNSHeritage { | ||
return nil, errInvalidHeritage | ||
return nil, ErrInvalidHeritage | ||
} | ||
|
||
return endpointLabels, nil | ||
} | ||
|
||
// Serialize transforms endpoints labels into a external-dns recognizable format string | ||
// withQuotes adds additional quotes | ||
func (l Labels) Serialize(withQuotes bool) string { | ||
var tokens []string | ||
tokens = append(tokens, fmt.Sprintf("heritage=%s", heritage)) | ||
var keys []string | ||
for key := range l { | ||
keys = append(keys, key) | ||
} | ||
sort.Strings(keys) // sort for consistency | ||
|
||
for _, key := range keys { | ||
tokens = append(tokens, fmt.Sprintf("%s/%s=%s", heritage, key, l[key])) | ||
} | ||
if withQuotes { | ||
return fmt.Sprintf("\"%s\"", strings.Join(tokens, ",")) | ||
} | ||
return strings.Join(tokens, ",") | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -57,17 +57,17 @@ func (im *TXTRegistry) Records() ([]*endpoint.Endpoint, error) { | |
return nil, err | ||
} | ||
|
||
endpoints := make([]*endpoint.Endpoint, 0) | ||
endpoints := []*endpoint.Endpoint{} | ||
|
||
labelMap := map[string]map[string]string{} | ||
labelMap := map[string]endpoint.Labels{} | ||
|
||
for _, record := range records { | ||
if record.RecordType != endpoint.RecordTypeTXT { | ||
endpoints = append(endpoints, record) | ||
continue | ||
} | ||
labels, err := deserializeLabel(record.Target) | ||
if err == errInvalidHeritage { | ||
labels, err := endpoint.NewLabelsFromString(record.Target) | ||
if err == endpoint.ErrInvalidHeritage { | ||
//if no heritage is found or it is invalid | ||
//case when value of txt record cannot be identified | ||
//record will not be removed as it will have empty owner | ||
|
@@ -85,11 +85,8 @@ func (im *TXTRegistry) Records() ([]*endpoint.Endpoint, error) { | |
if labels, ok := labelMap[ep.DNSName]; ok { | ||
ep.Labels = labels | ||
} else { | ||
//this indicates that owner could not be identified, set empty string | ||
// so that record will not be modified by external-dns | ||
ep.Labels = map[string]string{ | ||
endpoint.OwnerLabelKey: "", | ||
} | ||
//this indicates that owner could not be identified, as there is no corresponding TXT record | ||
ep.Labels = endpoint.NewLabels() | ||
} | ||
} | ||
|
||
|
@@ -106,12 +103,13 @@ func (im *TXTRegistry) ApplyChanges(changes *plan.Changes) error { | |
Delete: filterOwnedRecords(im.ownerID, changes.Delete), | ||
} | ||
for _, r := range filteredChanges.Create { | ||
txt := endpoint.NewEndpoint(im.mapper.toTXTName(r.DNSName), im.createTXTLabel(r), endpoint.RecordTypeTXT) | ||
r.Labels[endpoint.OwnerLabelKey] = im.ownerID | ||
txt := endpoint.NewEndpoint(im.mapper.toTXTName(r.DNSName), r.Labels.Serialize(true), endpoint.RecordTypeTXT) | ||
filteredChanges.Create = append(filteredChanges.Create, txt) | ||
} | ||
|
||
for _, r := range filteredChanges.Delete { | ||
txt := endpoint.NewEndpoint(im.mapper.toTXTName(r.DNSName), im.createTXTLabel(r), endpoint.RecordTypeTXT) | ||
txt := endpoint.NewEndpoint(im.mapper.toTXTName(r.DNSName), r.Labels.Serialize(true), endpoint.RecordTypeTXT) | ||
|
||
// when we delete TXT records for which value has changed (due to new label) this would still work because | ||
// !!! TXT record value is uniquely generated from the Labels of the endpoint. Hence old TXT record can be uniquely reconstructed | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. the comment is here and in line 128. I am not sure if this makes sense to me. I think this is more a property of the ApplyChanges function of how it does this change or do I miss something? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I added the comment here because what is going on here is a bit of magic. With this PR change we cannot predict what is the value stored in the TXT record, and for the TXT record to be correctly deleted/updated we should make sure its value matches what is stored on DNS provider side. And this is done via regenerating txt record value from labels There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ok |
||
|
@@ -120,12 +118,12 @@ func (im *TXTRegistry) ApplyChanges(changes *plan.Changes) error { | |
|
||
// make sure TXT records are consistently updated as well | ||
for _, r := range filteredChanges.UpdateNew { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. All 3 for loops are basically the same, can you refactor them with "extract method" and call them 3 times, for example:
|
||
txt := endpoint.NewEndpoint(im.mapper.toTXTName(r.DNSName), im.createTXTLabel(r), endpoint.RecordTypeTXT) | ||
txt := endpoint.NewEndpoint(im.mapper.toTXTName(r.DNSName), r.Labels.Serialize(true), endpoint.RecordTypeTXT) | ||
filteredChanges.UpdateNew = append(filteredChanges.UpdateNew, txt) | ||
} | ||
// make sure TXT records are consistently updated as well | ||
for _, r := range filteredChanges.UpdateOld { | ||
txt := endpoint.NewEndpoint(im.mapper.toTXTName(r.DNSName), im.createTXTLabel(r), endpoint.RecordTypeTXT) | ||
txt := endpoint.NewEndpoint(im.mapper.toTXTName(r.DNSName), r.Labels.Serialize(true), endpoint.RecordTypeTXT) | ||
// when we updateOld TXT records for which value has changed (due to new label) this would still work because | ||
// !!! TXT record value is uniquely generated from the Labels of the endpoint. Hence old TXT record can be uniquely reconstructed | ||
filteredChanges.UpdateOld = append(filteredChanges.UpdateOld, txt) | ||
|
@@ -138,15 +136,6 @@ func (im *TXTRegistry) ApplyChanges(changes *plan.Changes) error { | |
TXT registry specific private methods | ||
*/ | ||
|
||
func (im *TXTRegistry) createTXTLabel(e *endpoint.Endpoint) string { | ||
labels := map[string]string{} | ||
for k, v := range e.Labels { | ||
labels[k] = v | ||
} | ||
labels[endpoint.OwnerLabelKey] = im.ownerID | ||
return serializeLabel(labels, true) | ||
} | ||
|
||
/** | ||
nameMapper defines interface which maps the dns name defined for the source | ||
to the dns name which TXT record will be created with | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Owner
was supposed to identify the owner of a resource. For us it was to say it's "the cluster" (or rather the - usually one - instance of external-dns). However now the owner is a particular resource in a particular namespace in a particular cluster. I wonder if it's confusing to separate them this way.I would rather clarify it with either a combined owner resource (
owner=extdns1/default/my-service
, is that even easier to code?) or two owner related labels (ownerInstance=extdns1, ownerResource=default/my-service
, just a rename then).Although there's the concern of backwards compatibility...
@ideahitme let me know what you think.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah I agree, the naming is probably not the most descriptive.
I would still prefer them to be separated:
I also can see scenarios where "resource" label can be ignored altogether, so in my mind it is just a metadata, which allows to implement a "method" for determining resource-ownership, but it could be used for something else, or a different method could be implemented. That's why I thought it is better to keep the label name independent of how we use it.
With the previous statement though it is possibly better to rename "owner" label to something else, like "external-dns-instance", but since it would break compatibility, I would not do this change in this PR. However this change would be possible with some code change which would allow us to gradually migrate txt record values.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed!