Document UDP DNS tunnels - #36
Merged
Merged
Conversation
Explain how the TCP tunnel mode can publish UDP-only data-plane ports for DNS services such as Pi-hole, CoreDNS, and dnsmasq. Describe framing, flow limits, compatibility checks, test coverage, and the safeguards needed when exposing a recursive resolver. Signed-off-by: Alex Ellis (OpenFaaS Ltd) <alexellis2@gmail.com>
AI Pull Request OverviewDisclaimer: This review was generated by automated AI and may contain errors. Do not trust its outputs without human verification. Summary
Approval rating (1-10)9/10. The change is clear, scoped, and publishable; I found no blocking content, rendering, or workflow issues. Summary per fileSummary per file
Overall AssessmentThis documentation update is well scoped to the FAQ and directly addresses the ambiguity around UDP support in Detailed ReviewDetailed ReviewContent reviewNo blocking findings.
AI agent details. |
alexellis
marked this pull request as ready for review
July 29, 2026 13:18
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Document UDP support in the FAQ and explain that UDP data-plane ports are
published through the existing
inlets-pro tcp serverandinlets-pro tcp clientmode.The update includes:
--udp-port 53--portor--portsvalue is requiredbounded flow state, and server capability checks
recursive resolver
Nearby FAQ descriptions now include UDP alongside HTTP and TCP.
Motivation and context
UDP forwarding shipped in inlets Pro 0.11.13, but the FAQ still described the
product and its data plane primarily in terms of HTTP and TCP. This left the
DNS use case and the intentionally named
tcptunnel mode unclear.The documentation now shows that a UDP-only tunnel can reverse proxy DNS from
an exit node to a resolver on the client's private network.
User impact
Users can configure UDP DNS forwarding without inferring that a TCP data-plane
port is required. They also get the operational caveats needed for recursive
DNS exposure and TCP-specific DNS behaviour.
Testing
python3 -m mkdocs build --strictthe framing, flow-table, capability, and end-to-end tests in inlets Pro