docs: add Networks site-to-site use-case guide#773
Draft
SunsetDrifter wants to merge 2 commits into
Draft
Conversation
Add a canonical site-to-site guide built on Networks/Resources/Policies, which is the recommended and actively developed approach. Reposition the legacy Network Routes site-to-site Note to point at the new page and scope Network Routes to the wide-open, no-policy case only. Add the new page to the docs sidebar under Networks > Use Cases.
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 |
…rks site-to-site - Remove non-existent 'Type: Subnet' field; describe Resource Groups under Additional Options to match the actual UI - Rename Step 4 to 'Create access control policies' - Trim prerequisites (drop account line and device examples)
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 canonical Site-to-Site use-case guide built on the Networks / Resources / Policies system, and repositions the legacy Network Routes guide as a narrow fallback.
NetBird's docs previously implied Networks couldn't do site-to-site (the legacy doc even stated "Network Routes is required when you need Site-to-Site"). That's incorrect — Networks fully supports two-routing-peer site-to-site, verified end-to-end in a lab. This guide documents the recommended pattern so customers migrating off legacy routes don't have to rediscover it.
Changes
src/pages/manage/networks/use-cases/site-to-site.mdx— full guide: architecture, prerequisites, example topology, setup keys, install, one Network per site (Resource + Routing Peer with Masquerade), policies, static routes (with persistence + bidirectional/return-route notes), verify, cloud routing peers, next steps.src/pages/manage/network-routes/use-cases/site-to-site.mdx— replaced the top<Note>to make Networks the default recommendation; Network Routes is now scoped to the wide-open, no-policy case only (empty Access Control Groups). Source-IP/Masquerade is no longer cited as a differentiator since Masquerade toggles per Routing Peer in both systems.src/components/NavigationDocs.jsx— added the new page to the sidebar under Networks → Use Cases.Notes
NavigationAPI.jsxneeds no change (page isn't underipa/); nonext.config.mjsredirect needed.