docs: add Networks site-to-site use-case guide#773
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.
|
Warning Review limit reached
More reviews will be available in 13 minutes and 34 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis PR introduces a new Site-to-Site Networks documentation page with end-to-end setup guidance, integrates it into the docs navigation system, and updates the legacy Network Routes page to clarify that the new Networks-based approach is the recommended solution for most site-to-site deployments. ChangesSite-to-Site Documentation and Navigation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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)
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/components/NavigationDocs.jsx`:
- Around line 218-221: Run the mandated ESLint check (npm run lint -- src/) and
fix any reported next/core-web-vitals violations in the NavigationDocs
component: address issues around the menu item object with title 'Site-to-Site'
(ensure trailing commas, consistent quoting, and proper JSX/prop usage) and any
lint errors in the render/return JSX of the NavigationDocs component (e.g.,
unused vars, missing keys, or accessibility/Next.js rules) so the linter passes
for changes made in this file.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 75337b5d-7cdd-46b4-a6c3-f1bcd6b02932
📒 Files selected for processing (3)
src/components/NavigationDocs.jsxsrc/pages/manage/network-routes/use-cases/site-to-site.mdxsrc/pages/manage/networks/use-cases/site-to-site.mdx
2 participants
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.Summary by CodeRabbit