docs: persistent-route guidance for clientless devices + align site-to-site on Networks#797
docs: persistent-route guidance for clientless devices + align site-to-site on Networks#797SunsetDrifter wants to merge 6 commits into
Conversation
…site-to-site on Networks Step 5 of both site-to-site guides (and the masquerade page) now walk a first-time admin through persisting a Linux static route end to end: detect Netplan vs systemd-networkd with `ls /etc/netplan/`, then a clear Option A / Option B that are framed as alternatives, with the exact editing mechanics (open in nano, save/exit keys, or a one-paste systemd-networkd drop-in). Standardize on the `<IFACE>` placeholder with an `ip -br addr` hint so a literal `eth0` can't silently misconfigure hosts using predictable interface names. Update the site-to-site use-case hub to recommend Networks for all non-exit-node scenarios, rename "Network Routes" to "Routes", and reconcile the comparison section with the Routes deprecation.
|
Warning Review limit reached
More reviews will be available in 2 minutes and 17 seconds. Learn how PR review limits work. Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file). ⌛ 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 (20)
✨ 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 |
…ning Move the 'use Networks instead' callout above the Architecture section and make it a Warning, matching the Routes deprecation. Keep the legacy no-Policy nuance and the Site-to-VPN pointer; rename Network Routes to Routes.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
src/pages/use-cases/site-to-site/index.mdx (1)
1-8:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winImport
Noteexplicitly where it is used.
<Note>is used at Line 7, but this file only importsTilesat Line 1. Please addNotefrom@/components/mdxto keep component usage explicit and aligned with page-level MDX conventions.Suggested fix
-import { Tiles } from '`@/components/Tiles`' +import { Note } from '`@/components/mdx`' +import { Tiles } from '`@/components/Tiles`'As per coding guidelines,
src/pages/**/*.{md,mdx}should “Import custom components from@/components/mdx(Note, Warning, Success),@/components/Tiles,@/components/YouTube,@/components/Button, or@/components/mdxas needed for alerts, layout, media, and UI”.🤖 Prompt for 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. In `@src/pages/use-cases/site-to-site/index.mdx` around lines 1 - 8, The file uses the `<Note>` component at line 7, but this component is not imported at the top of the file. Add an explicit import for the `Note` component from `@/components/mdx` alongside the existing `Tiles` import to ensure all custom components used in the file are properly declared and aligned with the project's MDX conventions.Source: Coding guidelines
🤖 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.
Outside diff comments:
In `@src/pages/use-cases/site-to-site/index.mdx`:
- Around line 1-8: The file uses the `<Note>` component at line 7, but this
component is not imported at the top of the file. Add an explicit import for the
`Note` component from `@/components/mdx` alongside the existing `Tiles` import
to ensure all custom components used in the file are properly declared and
aligned with the project's MDX conventions.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 8d97048e-1d35-44b7-bda6-2edf3e8f8607
📒 Files selected for processing (4)
src/pages/manage/network-routes/use-cases/site-to-site.mdxsrc/pages/manage/networks/masquerade.mdxsrc/pages/manage/networks/use-cases/site-to-site.mdxsrc/pages/use-cases/site-to-site/index.mdx
- advanced-configuration: Networks supports all scenarios (VPN-to-Site, Site-to-VPN, Site-to-Site), not VPN-to-Site only - how-routing-peers-work: Routes labeled deprecated, not 'still supported'
Addresses CodeRabbit: <Note> was used without an explicit import from @/components/mdx, relying on the global MDX provider.
Site-to-site moved to Networks; update the homelab and cloud use-case tiles/table and the access-home-devices and cloud-to-on-premise Next Steps links to /manage/networks/use-cases/site-to-site.
…onfig links Bucket A rename (display text only): rename the 'Network Routes' feature name to 'Routes' across prose, link labels, table cells, alt text, Tiles names, and code comments. Headings are deliberately left unchanged to avoid breaking anchors and inbound links; URL paths (/manage/network-routes) are unchanged. Generic routing-table mentions and the desktop system-tray UI label are left as-is. Also repoint the access-home-devices and cloud-to-on-premise 'Advanced configuration' Next Steps links from the Routes advanced-config page to /manage/networks/masquerade.
1 participant
Summary
Makes the site-to-site docs easy for a first-time IT admin to follow, and brings the site-to-site use-case hub in line with the recent Routes rename and deprecation.
Persistent routes for clientless devices
Step 5 of both site-to-site guides — and the matching Persistent configuration section on the masquerade page — now walk an admin through making a Linux static route survive a reboot, with no page-hopping:
ip route add, then detect the network manager withls /etc/netplan/.nano, the save/exit keystrokes, or a single copy-pastesystemd-networkddrop-in.<IFACE>placeholder plus anip -br addrhint, so a literaleth0can't silently misconfigure hosts that use predictable interface names (ens18, etc.).Site-to-site hub aligned on Networks
use-cases/site-to-site:Files
src/pages/manage/networks/use-cases/site-to-site.mdxsrc/pages/manage/network-routes/use-cases/site-to-site.mdxsrc/pages/manage/networks/masquerade.mdxsrc/pages/use-cases/site-to-site/index.mdxNotes for reviewers
/manage/networks/masquerade.Summary by CodeRabbit