docs: document render-plan DNS resolution - #163
Open
sylvesterkaczmarek wants to merge 1 commit into
Open
Conversation
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.
Summary
Document that
fence render-plancan perform DNS lookups when the policy contains exact hostname allowlist entries.Problem
The CLI reference currently says
render-planvalidates JSON and prints firewall rules without applying them. That correctly describes host mutation, but it omits a separate observable side effect: the planner resolves exact hostname entries while building the frozen plan.A user can therefore run a preview expecting a purely local operation and still generate DNS traffic or receive a DNS-resolution failure.
Evidence / reproduction
src/cli.rs::render_plancallsbuild_plan(normalized, resolver), and the system CLI suppliesSystemResolver.dns_resolution_failed.render-planconfig containing an exact hostname and make system DNS unavailable. The command fails during planning even though it never applies nftables state.The distinction matters for offline or tightly controlled development environments:
render-planis non-mutating with respect to Fence enforcement, but hostname-based previews are not necessarily network-free.Change
Add one sentence to the CLI reference stating that exact hostname entries are resolved through the system resolver during planning and that DNS failure can fail the preview.
Documentation only; no planner, resolver, or firewall behavior changes.