docs(vlab): explain how to read test-connectivity output#302
Merged
Conversation
|
🚀 Deployed on https://preview-302--hedgehog-docs.netlify.app |
pau-hedgehog
force-pushed
the
pau/test-connectivity-gap
branch
7 times, most recently
from
7537dcf to
6070374
Compare
The Test Connectivity section in vlab/demo.md only showed the --help output. Newcomers to the tool repeatedly mis-read the per-pair logs: they see lines reporting "100% packet loss" or "connection refused", assume the fabric is broken, and miss that the test was deliberately checking that those pairs cannot reach each other. Add a short "How to read the output" subsection that: - frames the tool as comparing observed behaviour against the configured policy, not just running pings - gives the four expected/observed combinations as a table, with the surprising "should not be reachable + probe fails = pass" row called out so it doesn't trip up readers - points at the expected=true / expected=false fields in the per-pair log line so a single line can be interpreted on its own - nudges users toward the runner's summary instead of grepping through individual probe results Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Signed-off-by: Pau Capdevila <pau@githedgehog.com>
pau-hedgehog
force-pushed
the
pau/test-connectivity-gap
branch
from
6070374 to
49f8ff3
Compare
Frostman
approved these changes
Apr 30, 2026
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
2 participants
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.
The Test Connectivity section in vlab/demo.md only showed the --help output. Newcomers to the tool repeatedly mis-read the per-pair logs: they see lines reporting "100% packet loss" or "connection refused", assume the fabric is broken, and miss that the test was deliberately checking that those pairs cannot reach each other.
Add a short "How to read the output" subsection that: