diff --git a/public/docs-static/img/how-to-guides/select-network-routes.png b/public/docs-static/img/how-to-guides/select-network-routes.png new file mode 100644 index 00000000..7c182b08 Binary files /dev/null and b/public/docs-static/img/how-to-guides/select-network-routes.png differ diff --git a/src/components/NavigationDocs.jsx b/src/components/NavigationDocs.jsx index 03693095..4fdb38ea 100644 --- a/src/components/NavigationDocs.jsx +++ b/src/components/NavigationDocs.jsx @@ -64,6 +64,7 @@ export const docsNavigation = [ links: [ { title: 'Routing traffic to private networks', href: '/how-to/routing-traffic-to-private-networks' }, { title: 'Configuring default routes for Internet traffic', href: '/how-to/configuring-default-routes-for-internet-traffic' }, + { title: 'Resolve overlapping routes', href: '/how-to/resolve-overlapping-routes' }, ] }, { diff --git a/src/pages/how-to/resolve-overlapping-routes.mdx b/src/pages/how-to/resolve-overlapping-routes.mdx new file mode 100644 index 00000000..c7c9272c --- /dev/null +++ b/src/pages/how-to/resolve-overlapping-routes.mdx @@ -0,0 +1,82 @@ + +# Resolve overlapping routes with the route selection feature + +NetBird [Network Routes](/how-to/routing-traffic-to-private-networks) feature enables peers to access external networks such as VPCs, LANs, +or office networks seamlessly. + +In most scenarios, network administrators connect their NetBird peers to these external networks by defining a network route, +which includes specifying a network range, such as `172.17.0.0/16`, and assigning a routing peer. + +However, challenges arise when multiple networks have overlapping network ranges. To solve this, NetBird introduces +a route selection feature. This feature allows users to explicitly choose which routes to apply on the client side, ensuring +that peers connect to the correct network without conflicts. + + + The route selection feature is available in the NetBird client in the version `v0.27.4` and later. + + +## How to use the route selection feature + +There are two ways to use the route selection feature: +- Command line interface (CLI) via the `netbird routes` command. +- GUI via the NetBird system tray application. + + +### Select routes using the CLI + +To list available routes using the CLI, you can use the `netbird routes list` command: + +```bash +demo@netbird:~$ netbird routes list +Available Routes: + + - ID: aws-vpc-ireland + Network: 172.17.0.0/16 + Status: Selected + + - ID: aws-vpc-ohio + Network: 172.17.0.0/16 + Status: Selected +``` + +In the example above, we have two routes with overlapping network ranges. Both of them are selected, which means that they are active on the client side and conflicting. +To select a specific route, you can use the `netbird routes select` command. You can provide a list of routes + +```bash +demo@netbird:~$ netbird routes select aws-vpc-ireland +Routes selected successfully. +``` + + + When running the `netbird routes select` command, the NetBird client will automatically deselect all other routes by default. + + +Below are some examples of how to use the `netbird routes select` command: +```bash + # select all routes + netbird routes select all + # select multiple routes + netbird routes select route1 route2 + # append a route to the selected routes without deselecting the others + netbird routes select -a route3 +``` + +### Select routes using the GUI + +To select routes using the GUI, you can open the NetBird system tray application and navigate to the `Network Routes` menu. +You can select or deselect routes by clicking on the checkbox next to the route name. + +

+ select-network-routes +

+ + +## Get started +

+ +

+ +- Make sure to [star us on GitHub](https://github.com/netbirdio/netbird) +- Follow us [on Twitter](https://twitter.com/netbird) +- Join our [Slack Channel](https://join.slack.com/t/netbirdio/shared_invite/zt-vrahf41g-ik1v7fV8du6t0RwxSrJ96A) +- NetBird [latest release](https://github.com/netbirdio/netbird/releases) on GitHub