docs(cni): Add ADD/DEL and GC sequence diagrams - #395
Open
privateip wants to merge 2 commits into
Open
Conversation
CNI ADD/DEL behavior and garbage collection had no sequence diagrams, so understanding the attach chain or the orphan-cleanup sweeps meant reading source across five binaries. Add a unified ADD diagram, a unified DEL diagram, and a new GC diagram covering both the CRD/VRF sweep and the eBPF table sweep, each with prose notes explaining the non-obvious behavior. Move the CNI diagram doc next to the CNI configuration reference so the two live together. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Two recent fixes changed CNI DEL and BGP publish behavior: DEL now deletes the host veth/tap interface directly instead of deferring it to GC, and galactic-bgp now prunes dead sibling annotations and dedupes advertised prefixes on every ADD. Update the ADD/DEL and GC sequence diagrams and their notes to match, including a correction that GC's kernel sweep never covered the host interface in the first place. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
privateip
force-pushed
the
docs/cni-gc-sequence-diagrams
branch
from
August 14, 2026 16:56
9362dde to
fcf2691
Compare
privateip
marked this pull request as ready for review
August 14, 2026 16:58
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
CNI ADD/DEL behavior and garbage collection had no sequence diagrams, so understanding the attach chain or the orphan-cleanup sweeps meant reading source across five binaries. This adds a unified ADD diagram, a unified DEL diagram, and a new GC diagram covering both the CRD/VRF sweep and the eBPF table sweep, each with prose notes explaining the non-obvious behavior. The CNI diagram doc also moves next to the CNI configuration reference so the two live together.
Test plan