Skip to content

Commit 4faec98

Browse files
feat(txt-registry): deprecate legacy txt-format
Signed-off-by: ivan katliarchuk <[email protected]>
1 parent 84d8573 commit 4faec98

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

docs/registry/txt.md

+21
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,27 @@ The TXT registry supports single format for storing DNS record metadata:
1111

1212
- Creates a TXT record with record type information (e.g., 'a-' prefix for A records)
1313

14+
The TXT registry would try to guarantee a consistency in between providers and sources, if provider supports the behaviour
15+
16+
If you are dealing with APEX domains, example `example.com` and TXT records are failing to be created for managed record types specified by `--managed-record-types`, consider following options:
17+
18+
1. TXT record with prefix based on requirements. Example `--txt-prefix="%{record_type}-abc-"` or `--txt-prefix="%{record_type}.abc-"`
19+
2. TXT record with suffix based on requirements. Example `--txt-suffix="-abc-%{record_type}"` or `--txt-suffix="-abc.%{record_type}."`
20+
21+
Example when configured `--txt-prefix="%{record_type}-abc-"` for apex domain `example.com` the expected result is
22+
23+
| Name | TYPE |
24+
|:-----------------------------:|:--------:|
25+
| `a-abc-nginx-v2.ex.com.` | `TXT` |
26+
| `cname-abc-nginx-v3.ex.com.` | `CNAME` |
27+
28+
And when configured `--txt-suffix="-abc.%{record_type}"` for apex domain `example.com` the expected result is
29+
30+
| Name | TYPE |
31+
|:-----------------------------:|:-------:|
32+
| `nginx-v2-abc.a.ex.com.` | `TXT` |
33+
| `nginx-v3-abc.cname.ex.com..` | `CNAME` |
34+
1435
### Manually Cleanup Legacy TXT Records
1536

1637
> While deleting registry TXT records won't cause downtime, a well-thought-out migration and cleanup plan is crucial.

0 commit comments

Comments
 (0)