Skip to content

docs: add network test flow diagrams#8

Closed
rnetser wants to merge 1 commit into
mainfrom
docs/network-flow-diagrams
Closed

docs: add network test flow diagrams#8
rnetser wants to merge 1 commit into
mainfrom
docs/network-flow-diagrams

Conversation

@rnetser

@rnetser rnetser commented Jun 18, 2026

Copy link
Copy Markdown
Owner
What this PR does / why we need it:

Adds 11 Mermaid-diagrammed documentation files under docs/flows/ covering the most common network test flow patterns used in this repository.

These docs explain resource creation chains and data flows — not pytest mechanics. Each doc uses Mermaid flowcharts that render natively on GitHub.

Files added:

File Content
README.md Index of all flow docs
VM_CREATION.md Modern factory vs legacy VM creation patterns
LINUX_BRIDGE.md NNCP → bridge → NAD → VM secondary interface flow
LOCALNET.md OVN bridge mapping → CUDN → namespace → VM flow
SRIOV.md SriovNodePolicy → VFs → SriovNetwork/NAD → VM
UDN.md Namespace label → Layer2UserDefinedNetwork → VM
CONNECTIVITY_TESTING.md Ping, TCP/iperf3, ContinuousPing patterns
MIGRATION.md Migration with stuntime measurement
HOT_PLUG.md NIC hot-plug/unplug + MAC pool integration
CLOUD_INIT_NETWORKING.md Static IP, dual-stack, MAC-matched, runcmd patterns
GOLDEN_IMAGE.md Download-once clone-many pattern

Inspired by PR RedHatQE#4902 but focused on actual flows rather than pytest tutorials.

Which issue(s) this PR fixes:

Related to RedHatQE#4902

Special notes for reviewer:

All diagrams use Mermaid flowcharts. Patterns were derived from actual code analysis of tests/network/ (45+ subdirectories, 31 conftest files).

jira-ticket:

Generated-by: Claude noreply@anthropic.com

Add 11 Mermaid-diagrammed docs under docs/flows/ covering:
- VM creation (factory vs legacy patterns)
- Linux bridge, localnet, SR-IOV, UDN network flows
- Connectivity testing (ping, TCP, ContinuousPing)
- Migration with stuntime measurement
- NIC hot-plug/unplug
- Cloud-init network configuration
- Golden image pattern

Each doc shows the actual resource creation chain and data
flow — no pytest tutorials, just flows.

Generated-by: Claude <noreply@anthropic.com>
Signed-off-by: rnetser <rnetser@redhat.com>
@rnetser rnetser closed this Jun 18, 2026
@rnetser rnetser deleted the docs/network-flow-diagrams branch June 18, 2026 16:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant