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

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

Author: ivankatliarchuk

docs/registry/txt.md

@@ -38,7 +38,7 @@ And when configured `--txt-suffix="-abc.%{record_type}"` for apex domain `exampl
 
 Occasionally, it may be necessary to remove outdated TXT records from your registry.
 
-The script could be found in [scripts/cleanup-legacy-txt-records.py](../../scripts/cleanup-legacy-txt-records.py) with instructions how to run it.
+An example script for AWS can be found in [scripts/cleanup-legacy-txt-records.py](../../scripts/cleanup-legacy-txt-records.py) with instructions on how to run it.
 The script performs targeted deletion of TXT records that include `ResourceRecords` matching the `heritage=external-dns,external-dns/owner=default` or similar pattern.
 In the event of unintended deletion of all TXT records managed by `external-dns`, `external-dns` will initiate a full DNS record regeneration, along with`TXT` and `non-TXT` records. Just be aware, this operation's duration is directly proportional to the DNS estate size."
 

pkg/apis/externaldns/types.go

@@ -615,7 +615,7 @@ func App(cfg *Config) *kingpin.Application {
 	app.Flag("txt-wildcard-replacement", "When using the TXT registry, a custom string that's used instead of an asterisk for TXT records corresponding to wildcard DNS records (optional)").Default(defaultConfig.TXTWildcardReplacement).StringVar(&cfg.TXTWildcardReplacement)
 	app.Flag("txt-encrypt-enabled", "When using the TXT registry, set if TXT records should be encrypted before stored (default: disabled)").BoolVar(&cfg.TXTEncryptEnabled)
 	app.Flag("txt-encrypt-aes-key", "When using the TXT registry, set TXT record decryption and encryption 32 byte aes key (required when --txt-encrypt=true)").Default(defaultConfig.TXTEncryptAESKey).StringVar(&cfg.TXTEncryptAESKey)
-	app.Flag("txt-new-format-only", "A key is reserved for TXT migraion. Enabling or disabling it will not take any effect. (deprecated)").BoolVar(&cfg.TXTNewFormatOnly)
+	app.Flag("txt-new-format-only", "Was used during TXT format migration. Enabling or disabling it will not take any effect. (deprecated)").BoolVar(&cfg.TXTNewFormatOnly)
 	app.Flag("dynamodb-region", "When using the DynamoDB registry, the AWS region of the DynamoDB table (optional)").Default(cfg.AWSDynamoDBRegion).StringVar(&cfg.AWSDynamoDBRegion)
 	app.Flag("dynamodb-table", "When using the DynamoDB registry, the name of the DynamoDB table (default: \"external-dns\")").Default(defaultConfig.AWSDynamoDBTable).StringVar(&cfg.AWSDynamoDBTable)
 

scripts/cleanup-legacy-txt-records.py

@@ -38,13 +38,13 @@
 #    - The script is executed with command-line arguments specifying the hosted zone ID, record pattern, total items to delete, batch size, and whether to perform a dry run or actual deletion.
 #    - Check 'To Run script' section for more details
 
+# WARNING: run this script at your own RISK. This will delete all the TXT rerods that do contain certain string.
 # To Run script
 # 1. Python, pip and pipenv installed https://pipenv.pypa.io/en/latest/
 # 2. AWS Access https://docs.aws.amazon.com/signin/latest/userguide/command-line-sign-in.html
 # 3. pipenv shell
 # 4. pip install boto3
 # 5. python scripts/cleanup-legacy-txt-records.py --help
-# WARNING: run this script at your own RISK. This will delete all the TXT rerods that do contain certain string.
 # 6. DRY RUN python scripts/cleanup-legacy-txt-records.py --zone-id ASDFQEQREWRQADF --record-match text
 # 6.1 Before execution consider to stop `external-dns`
 # 7. Execute Deletion. First few times with reduced number of items