feat(txt-registry): deprecate legacy txt-format #5172

ivankatliarchuk · 2025-03-13T09:42:07Z

Description

follow-up for feat(txt-registry): add option to use only new format #4946
relates feat(TXT Registry): metadata format #4624
relates Multiple design failures in new-format TXT registry ownership records #3757

TODO:

✅ fix tests
✅ test on real cluster and account
✅ review docs
✅ added TXT legacy record cleanup script

Checklist

Unit tests updated
End user documentation updated

Executed on real cluster with arguments

go run main.go \
    --provider=aws \
    --registry=txt \
    --source=fake \
    --aws-zone-type=private \
    --zone-id-filter=/hostedzone/XXXXXX \
    --log-level=debug \
    --policy=sync \
    --interval=60s \
    --fqdn-template=a1.ex.com

Without change, records current and old format created

aws route53 list-resource-record-sets --hosted-zone-id ${ZONE_UNDER_TEST} --query "ResourceRecordSets[?Type=='TXT'].{Name:Name, Value:ResourceRecords[0].Value}" --output table
-----------------------------------------------------------------------------
|                          ListResourceRecordSets                           |
+--------------------+------------------------------------------------------+
|        Name        |                        Value                         |
+--------------------+------------------------------------------------------+
|  a-fhbr.a1.ex.com. |  "heritage=external-dns,external-dns/owner=default"  |
|  a-gwbl.a1.ex.com. |  "heritage=external-dns,external-dns/owner=default"  |
|  a-hgmc.a1.ex.com. |  "heritage=external-dns,external-dns/owner=default"  |
|  a-hmqw.a1.ex.com. |  "heritage=external-dns,external-dns/owner=default"  |
|  a-hoxg.a1.ex.com. |  "heritage=external-dns,external-dns/owner=default"  |
|  a-ipfd.a1.ex.com. |  "heritage=external-dns,external-dns/owner=default"  |
|  a-melr.a1.ex.com. |  "heritage=external-dns,external-dns/owner=default"  |
|  a-mkde.a1.ex.com. |  "heritage=external-dns,external-dns/owner=default"  |
|  a-uknh.a1.ex.com. |  "heritage=external-dns,external-dns/owner=default"  |
|  a-xiqj.a1.ex.com. |  "heritage=external-dns,external-dns/owner=default"  |
|  fhbr.a1.ex.com.   |  "heritage=external-dns,external-dns/owner=default"  |
|  gwbl.a1.ex.com.   |  "heritage=external-dns,external-dns/owner=default"  |
|  hgmc.a1.ex.com.   |  "heritage=external-dns,external-dns/owner=default"  |
|  hmqw.a1.ex.com.   |  "heritage=external-dns,external-dns/owner=default"  |
|  hoxg.a1.ex.com.   |  "heritage=external-dns,external-dns/owner=default"  |
|  ipfd.a1.ex.com.   |  "heritage=external-dns,external-dns/owner=default"  |
|  melr.a1.ex.com.   |  "heritage=external-dns,external-dns/owner=default"  |
|  mkde.a1.ex.com.   |  "heritage=external-dns,external-dns/owner=default"  |
|  uknh.a1.ex.com.   |  "heritage=external-dns,external-dns/owner=default"  |
|  xiqj.a1.ex.com.   |  "heritage=external-dns,external-dns/owner=default"  |
+--------------------+------------------------------------------------------+

With the change. New format records created, letagcy TXT records left untouched

❯❯ aws route53 list-resource-record-sets --hosted-zone-id ${ZONE_UNDER_TEST} --query "ResourceRecordSets[?Type=='TXT'].{Name:Name, Value:ResourceRecords[0].Value}" --output table
-----------------------------------------------------------------------------
|                          ListResourceRecordSets                           |
+--------------------+------------------------------------------------------+
|        Name        |                        Value                         |
+--------------------+------------------------------------------------------+
|  a-dkmw.a1.ex.com. |  "heritage=external-dns,external-dns/owner=default"  |
|  a-ihkf.a1.ex.com. |  "heritage=external-dns,external-dns/owner=default"  |
|  a-iztb.a1.ex.com. |  "heritage=external-dns,external-dns/owner=default"  |
|  a-jlmh.a1.ex.com. |  "heritage=external-dns,external-dns/owner=default"  |
|  a-kmam.a1.ex.com. |  "heritage=external-dns,external-dns/owner=default"  |
|  a-lqpv.a1.ex.com. |  "heritage=external-dns,external-dns/owner=default"  |
|  a-rizx.a1.ex.com. |  "heritage=external-dns,external-dns/owner=default"  |
|  a-sjfa.a1.ex.com. |  "heritage=external-dns,external-dns/owner=default"  |
|  a-uvlq.a1.ex.com. |  "heritage=external-dns,external-dns/owner=default"  |
|  a-vgpc.a1.ex.com. |  "heritage=external-dns,external-dns/owner=default"  |
|  bwwo.a1.ex.com.   |  "heritage=external-dns,external-dns/owner=default"  |
|  ecvx.a1.ex.com.   |  "heritage=external-dns,external-dns/owner=default"  |
|  ilan.a1.ex.com.   |  "heritage=external-dns,external-dns/owner=default"  |
|  iyda.a1.ex.com.   |  "heritage=external-dns,external-dns/owner=default"  |
|  nhhy.a1.ex.com.   |  "heritage=external-dns,external-dns/owner=default"  |
|  pazy.a1.ex.com.   |  "heritage=external-dns,external-dns/owner=default"  |
|  sdeo.a1.ex.com.   |  "heritage=external-dns,external-dns/owner=default"  |
|  tosb.a1.ex.com.   |  "heritage=external-dns,external-dns/owner=default"  |
|  wrej.a1.ex.com.   |  "heritage=external-dns,external-dns/owner=default"  |
|  yymt.a1.ex.com.   |  "heritage=external-dns,external-dns/owner=default"  |
+--------------------+------------------------------------------------------+
``

Signed-off-by: ivan katliarchuk <[email protected]>

ivankatliarchuk · 2025-03-13T10:06:26Z

/label tide/merge-method-squash

ivankatliarchuk · 2025-03-13T10:06:58Z

/kind cleanup

Signed-off-by: ivan katliarchuk <[email protected]>

docs/registry/txt.md

mloiseleur · 2025-06-22T09:42:11Z

/lgtm
I left some minor suggestion.
I let @szuecs proceed with the final review.

Co-authored-by: Michel Loiseleur <[email protected]>

docs/registry/txt.md

Signed-off-by: ivan katliarchuk <[email protected]>

szuecs · 2025-06-24T09:35:19Z

/approve

k8s-ci-robot · 2025-06-24T09:35:28Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: szuecs

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [szuecs]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

scripts/aws-cleanup-legacy-txt-records.py

Signed-off-by: ivan katliarchuk <[email protected]>

mloiseleur · 2025-06-25T07:15:14Z

/lgtm

ivankatliarchuk · 2025-06-25T09:39:23Z

A while back External-DNS changed the format of the TXT records. To ensure compatibility both formats where used. As an intermediary step a switch was added in [2] to only create the new format. With [3] the old format was completely removed, thus halfing the number of TXT records. [1] https://github.com/kubernetes-sigs/external-dns/releases/tag/v0.18.0 [2] kubernetes-sigs/external-dns#4946 [3] kubernetes-sigs/external-dns#5172

maartenschalekamp · 2025-07-17T07:54:19Z

This is a breaking change as its causing the error

flag parsing error: unknown long flag '--txt-new-format-only'

Just mentioning it as its not listed as a breaking change on the release notes. Only as a feature.

frittentheke · 2025-07-17T08:29:52Z

This is a breaking change as its causing the error
flag parsing error: unknown long flag '--txt-new-format-only'
Just mentioning it as its not listed as a breaking change on the release notes. Only as a feature.

Would also be nice to point people (again) at the required steps to clean up their otherwise now orphaned records in the old format.

* feat(txt-registry): only support single format Signed-off-by: ivan katliarchuk <[email protected]> * feat(txt-registry): only support single format Signed-off-by: ivan katliarchuk <[email protected]> * feat(txt-registry): only support single format Signed-off-by: ivan katliarchuk <[email protected]> * feat(txt-registry): only support single format Signed-off-by: ivan katliarchuk <[email protected]> * feat(txt-registry): only support single format Signed-off-by: ivan katliarchuk <[email protected]> * feat(txt-registry): deprecate legacy txt-format Signed-off-by: ivan katliarchuk <[email protected]> * feat(txt-registry): deprecate legacy txt-format Signed-off-by: ivan katliarchuk <[email protected]> * feat(txt-registry): deprecate legacy txt-format Signed-off-by: ivan katliarchuk <[email protected]> * feat(txt-registry): deprecate legacy txt-format Signed-off-by: ivan katliarchuk <[email protected]> * feat(txt-registry): deprecate legacy txt-format Signed-off-by: ivan katliarchuk <[email protected]> * feat(txt-registry): deprecate legacy txt-format Signed-off-by: ivan katliarchuk <[email protected]> * feat(txt-registry): deprecate legacy txt-format Signed-off-by: ivan katliarchuk <[email protected]> * feat(txt-registry): deprecate legacy txt-format Signed-off-by: ivan katliarchuk <[email protected]> * feat(txt-registry): deprecate legacy txt-format Signed-off-by: ivan katliarchuk <[email protected]> * feat(txt-registry): deprecate legacy txt-format Signed-off-by: ivan katliarchuk <[email protected]> * feat(txt-registry): deprecate legacy txt-format Signed-off-by: ivan katliarchuk <[email protected]> * feat(txt-registry): deprecate legacy txt-format Signed-off-by: ivan katliarchuk <[email protected]> * feat(txt-registry): deprecate legacy txt-format Signed-off-by: ivan katliarchuk <[email protected]> * feat(txt-registry): deprecate legacy txt-format Co-authored-by: Michel Loiseleur <[email protected]> * feat(txt-registry): deprecate legacy txt-format Co-authored-by: Michel Loiseleur <[email protected]> * feat(txt-registry): deprecate legacy txt-format Signed-off-by: ivan katliarchuk <[email protected]> * feat(txt-registry): deprecate legacy txt-format Signed-off-by: ivan katliarchuk <[email protected]> * feat(txt-registry): deprecate legacy txt-format Signed-off-by: ivan katliarchuk <[email protected]> * feat(txt-registry): address review comments Signed-off-by: ivan katliarchuk <[email protected]> * feat(txt-registry): deprecate legacy txt-format Signed-off-by: ivan katliarchuk <[email protected]> * feat(txt-registry): deprecate legacy txt-format * feat(txt-registry): deprecate legacy txt-format Co-authored-by: Michel Loiseleur <[email protected]> * feat(txt-registry): deprecate legacy txt-format Signed-off-by: ivan katliarchuk <[email protected]> * feat(txt-registry): deprecate legacy txt-format Signed-off-by: ivan katliarchuk <[email protected]> --------- Signed-off-by: ivan katliarchuk <[email protected]> Co-authored-by: Michel Loiseleur <[email protected]> # Conflicts: # controller/execute.go # registry/txt.go # registry/txt_encryption_test.go # registry/txt_test.go

Phil1602 · 2025-09-25T16:09:40Z

This is a breaking change as its causing the error
flag parsing error: unknown long flag '--txt-new-format-only'
Just mentioning it as its not listed as a breaking change on the release notes. Only as a feature.
Would also be nice to point people (again) at the required steps to clean up their otherwise now orphaned records in the old format.

Yep. Just opened #5868 therefore.

ivankatliarchuk and others added 5 commits March 6, 2025 09:03

Merge branch 'kubernetes-sigs:master' into master

141e87b

Merge branch 'kubernetes-sigs:master' into master

a3395cc

Merge branch 'kubernetes-sigs:master' into master

fc24c55

Merge branch 'kubernetes-sigs:master' into master

6e691be

feat(txt-registry): only support single format

bc329b3

Signed-off-by: ivan katliarchuk <[email protected]>

ivankatliarchuk marked this pull request as draft March 13, 2025 09:42

k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 13, 2025

k8s-ci-robot requested review from mloiseleur and szuecs March 13, 2025 09:42

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Mar 13, 2025

ivankatliarchuk mentioned this pull request Mar 13, 2025

feat(TXT Registry): metadata format #4624

Closed

2 tasks

feat(txt-registry): only support single format

9fb8141

Signed-off-by: ivan katliarchuk <[email protected]>

k8s-ci-robot added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Mar 13, 2025

k8s-ci-robot added the kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. label Mar 13, 2025

ivankatliarchuk added 6 commits March 13, 2025 11:28

feat(txt-registry): only support single format

5d82582

Signed-off-by: ivan katliarchuk <[email protected]>

feat(txt-registry): only support single format

d595404

Signed-off-by: ivan katliarchuk <[email protected]>

feat(txt-registry): only support single format

b50c7d9

Signed-off-by: ivan katliarchuk <[email protected]>

feat(txt-registry): deprecate legacy txt-format

566bb39

Signed-off-by: ivan katliarchuk <[email protected]>

feat(txt-registry): deprecate legacy txt-format

2ee1723

Signed-off-by: ivan katliarchuk <[email protected]>

feat(txt-registry): deprecate legacy txt-format

f8882f6

Signed-off-by: ivan katliarchuk <[email protected]>

ivankatliarchuk changed the title ~~WIP: feat(txt-registry): deprecate legacy txt-format~~ feat(txt-registry): deprecate legacy txt-format Mar 14, 2025

ivankatliarchuk marked this pull request as ready for review March 14, 2025 11:28

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 14, 2025

ivankatliarchuk added 4 commits March 14, 2025 11:30

feat(txt-registry): deprecate legacy txt-format

8301811

Signed-off-by: ivan katliarchuk <[email protected]>

feat(txt-registry): deprecate legacy txt-format

213003a

Signed-off-by: ivan katliarchuk <[email protected]>

feat(txt-registry): deprecate legacy txt-format

06bdd64

Signed-off-by: ivan katliarchuk <[email protected]>

feat(txt-registry): deprecate legacy txt-format

33c5960

Signed-off-by: ivan katliarchuk <[email protected]>

ivankatliarchuk commented Jun 21, 2025

View reviewed changes

docs/registry/txt.md Outdated Show resolved Hide resolved

docs/registry/txt.md Outdated Show resolved Hide resolved

feat(txt-registry): deprecate legacy txt-format

368c4a0

ivankatliarchuk requested a review from szuecs June 21, 2025 09:32

mloiseleur reviewed Jun 22, 2025

View reviewed changes

docs/registry/txt.md Outdated Show resolved Hide resolved

mloiseleur reviewed Jun 22, 2025

View reviewed changes

docs/registry/txt.md Outdated Show resolved Hide resolved

mloiseleur reviewed Jun 22, 2025

View reviewed changes

docs/registry/txt.md Outdated Show resolved Hide resolved

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 22, 2025

feat(txt-registry): deprecate legacy txt-format

d4aad29

Co-authored-by: Michel Loiseleur <[email protected]>

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 22, 2025

ivankatliarchuk mentioned this pull request Jun 23, 2025

feat: add new flags to allow migration of OwnerID #4823

Merged

2 tasks

szuecs reviewed Jun 24, 2025

View reviewed changes

docs/registry/txt.md Outdated Show resolved Hide resolved

feat(txt-registry): deprecate legacy txt-format

d2e3274

Signed-off-by: ivan katliarchuk <[email protected]>

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 24, 2025

nikParasyr reviewed Jun 25, 2025

View reviewed changes

scripts/aws-cleanup-legacy-txt-records.py Outdated Show resolved Hide resolved

feat(txt-registry): deprecate legacy txt-format

83ac680

Signed-off-by: ivan katliarchuk <[email protected]>

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 25, 2025

k8s-ci-robot merged commit 9f16d83 into kubernetes-sigs:master Jun 25, 2025
13 checks passed

ivankatliarchuk deleted the feat-txt-registry branch June 25, 2025 07:20

ivankatliarchuk mentioned this pull request Jul 1, 2025

Regex including and excluding same records #5591

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(txt-registry): deprecate legacy txt-format #5172

feat(txt-registry): deprecate legacy txt-format #5172

ivankatliarchuk commented Mar 13, 2025 •

edited

Loading

Uh oh!

ivankatliarchuk commented Mar 13, 2025

Uh oh!

ivankatliarchuk commented Mar 13, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mloiseleur commented Jun 22, 2025

Uh oh!

Uh oh!

szuecs commented Jun 24, 2025

Uh oh!

k8s-ci-robot commented Jun 24, 2025

Uh oh!

Uh oh!

mloiseleur commented Jun 25, 2025

Uh oh!

Uh oh!

ivankatliarchuk commented Jun 25, 2025

Uh oh!

maartenschalekamp commented Jul 17, 2025 •

edited

Loading

Uh oh!

frittentheke commented Jul 17, 2025 •

edited

Loading

Uh oh!

Phil1602 commented Sep 25, 2025

Uh oh!

Uh oh!

feat(txt-registry): deprecate legacy txt-format #5172

feat(txt-registry): deprecate legacy txt-format #5172

Conversation

ivankatliarchuk commented Mar 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ivankatliarchuk commented Mar 13, 2025

Uh oh!

ivankatliarchuk commented Mar 13, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mloiseleur commented Jun 22, 2025

Uh oh!

Uh oh!

szuecs commented Jun 24, 2025

Uh oh!

k8s-ci-robot commented Jun 24, 2025

Uh oh!

Uh oh!

mloiseleur commented Jun 25, 2025

Uh oh!

Uh oh!

ivankatliarchuk commented Jun 25, 2025

Uh oh!

maartenschalekamp commented Jul 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

frittentheke commented Jul 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Phil1602 commented Sep 25, 2025

Uh oh!

Uh oh!

ivankatliarchuk commented Mar 13, 2025 •

edited

Loading

maartenschalekamp commented Jul 17, 2025 •

edited

Loading

frittentheke commented Jul 17, 2025 •

edited

Loading