Add routing peer sizing guide#815
Draft
SunsetDrifter wants to merge 7 commits into
Draft
Conversation
Add a Sizing Routing Peers page under Networks covering the four-step sizing method, a per-peer capacity table, the tuning levers that matter, and how to scale out by sharding load across identical Networks. Cross-link it from How Routing Peers Work (HA note + related tile) and the Networks overview, and add it to the docs navigation.
Generalize the Acme example to remote users, correct the encrypt/decrypt framing and reach the local network rather than the datacenter, use 'routing peer' instead of 'gateway', and rename the recap to Summary.
Correct the high-availability description: a single Network does not balance load across its peers — different metrics give failover (one peer carries all), equal metrics give latency-based nearest-peer selection, which splits traffic by geography but never evenly. Shard into more Networks to split load deterministically. Also collapse redundant restatements, drop the secondary worked example (the capacity table covers it), and slim the commodity-hardware guidance.
Extend the capacity table down to 1 and 2 vCPUs, drop the 'or more' from the interface column, and adjust the methodology note so the interface column reads uniformly as the minimum NIC to pair with each size.
Add a userspace-mode capacity table showing wireguard-go does not scale across cores (download plateaus ~6.8 Gbps, only ~4-5 cores used), and the cases where a routing peer runs userspace: missing/broken/conflicting kernel module, no TUN device (netstack, incl. rootless Docker), non-Linux peers, and forcing userspace to capture policy IDs and blocked traffic events. Name the exact benchmark CPU (Xeon Platinum 8375C).
Rename the Scaling out heading and reword the body, description, and recap to talk about splitting load across more Networks instead of sharding. Update the in-page anchor link to match the new heading.
Lead each direction bullet with Download:/Upload: and say the routing peer encrypts/decrypts, tying the pulling/pushing distinction to the capacity table's column names.
Contributor
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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
1 participant
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
Adds a new Sizing Routing Peers page under Manage → Networks (
/manage/networks/sizing-routing-peers), giving admins a method to choose the size and number of routing peers from measured throughput.What the page covers
wireguard-godoes not scale across cores, plus the cases where a routing peer ends up on userspace: missing/broken/conflicting kernel module, no TUN device (netstack, including rootless Docker), non-Linux peers, and forcing userspace to capture policy IDs and blocked traffic events.Wiring