NEW PROVIDER: Netbird DNS Zone#4170
Conversation
|
Now that the org move is complete, I'm sending a friendly ping to PRs. Please rebase and I'd be glad to re-review. Thank you for your patience! |
|
Hi, thank you for your review, DNSContrl is very useful to me. |
|
ready for review :) |
|
Integration test result is the same as before, still failed on those MX/TXT cases. |
|
Hello! Looking good so far! Since MX/TXT records are supported, please add this to the tests that fail:
|
cafferata
left a comment
There was a problem hiding this comment.
Nice addition! The documentation is well-structured and covers configuration, metadata, usage, and activation clearly. A few smaller points from my review as inline comments.
Optionally: since #4208 landed before this PR, would you be open to implementing RegisterCredsMetadata()? That would make NetBird available in dnscontrol init. The PR has examples for simple providers like BIND and more complex ones like TransIP.
| **Note:** If metadata fields are not set, DNSControl will leave them unchanged in NetBird. | ||
|
|
||
| ## Usage | ||
|
|
There was a problem hiding this comment.
This note should use GitBook hint syntax per the style guide:
{% hint style="info" %}
**NOTE**: If metadata fields are not set, DNSControl will leave them unchanged in NetBird.
{% endhint %}
|
|
||
| **Note:** NetBird does not expose nameservers, so `{no_ns: "true"}` should be set on all domains to suppress the "Skipping registrar" warning. | ||
|
|
||
| To configure zone options, use metadata: |
There was a problem hiding this comment.
This note should use GitBook hint syntax per the style guide:
{% hint style="info" %}
**NOTE**: NetBird does not expose nameservers, so `{no_ns: "true"}` should be set on all domains to suppress the "Skipping registrar" warning.
{% endhint %}
| ```javascript | ||
| D("example.com", REG_DNSIMPLE, | ||
| { | ||
| no_ns: "true", |
There was a problem hiding this comment.
The indentation in this code block mixes tabs and spaces, resulting in misaligned lines. Suggested fix:
D("example.com", REG_NONE,
{
no_ns: "true",
netbird_enabled: "true",
netbird_enable_search_domain: "true",
},
DnsProvider(DSP_NETBIRD),
A("test", "1.2.3.4"),
);Also: the convention for DNS-only providers is REG_NONE (with var REG_NONE = NewRegistrar("none");), not REG_DNSIMPLE. This applies to the first usage example as well.
|
|
||
| ## Supported Record Types | ||
|
|
||
| NetBird API currently supports the following DNS record types: |
There was a problem hiding this comment.
Other provider docs typically document limitations like these in a Caveats section (see e.g. netlify.md). Consider renaming this to "Caveats".
https://docs.netbird.io/manage/dns/custom-zones
https://docs.netbird.io/api/resources/dns-zones
Integration Test Result:
Netbird does not currently support MX and TXT records, so three tests that rely on TXT/MX failed. Otherwise, all good.