Skip to content

Commit fd9091a

Browse files
committed
refine documentation on how to use the flag
1 parent 7c22a03 commit fd9091a

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

docs/flags.md

+1
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,7 @@
150150
| `--txt-prefix=""` | When using the TXT registry, a custom string that's prefixed to each ownership DNS record (optional). Could contain record type template like '%{record_type}-prefix-'. Mutual exclusive with txt-suffix! |
151151
| `--txt-suffix=""` | When using the TXT registry, a custom string that's suffixed to the host portion of each ownership DNS record (optional). Could contain record type template like '-%{record_type}-suffix'. Mutual exclusive with txt-prefix! |
152152
| `--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) |
153+
| `--txt-new-format-only` | When using the TXT registry, only create new format records with record type information (default: disabled) |
153154
| `--[no-]txt-encrypt-enabled` | When using the TXT registry, set if TXT records should be encrypted before stored (default: disabled) |
154155
| `--txt-encrypt-aes-key=""` | When using the TXT registry, set TXT record decryption and encryption 32 byte aes key (required when --txt-encrypt=true) |
155156
| `--dynamodb-region=""` | When using the DynamoDB registry, the AWS region of the DynamoDB table (optional) |

docs/registry/txt.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,19 @@ The TXT registry supports two formats for storing DNS record metadata:
1010

1111
By default, the TXT registry creates records in both formats for backwards compatibility. You can configure it to use only the new format by using the `--txt-new-format-only` flag. This reduces the number of TXT records created, which can be helpful when working with provider-specific record limits.
1212

13-
Note: AAAA records always use only the new format regardless of this setting.
13+
Note: The following record types always use only the new format regardless of this setting:
14+
- AAAA records
15+
- Encrypted TXT records (when using `--txt-encrypt-enabled`)
1416

1517
Example:
1618
```sh
1719
# Default behavior - creates both formats
18-
external-dns
20+
external-dns --provider=aws --source=ingress --managed-record-types=A,TXT
1921

20-
# Only create new format records
21-
external-dns --txt-new-format-only
22+
# Only create new format records (alongside other required flags)
23+
external-dns --provider=aws --source=ingress --managed-record-types=A,TXT --txt-new-format-only
2224
```
25+
The `--txt-new-format-only` flag should be used in addition to your existing external-dns configuration flags. It does not implicitly configure TXT record handling - you still need to specify `--managed-record-types=TXT` if you want external-dns to manage TXT records.
2326

2427
## Prefixes and Suffixes
2528

0 commit comments

Comments
 (0)