sendnrw/netbird-docs
2
0
Fork 0
mirror of https://github.com/netbirdio/docs.git synced 2026-04-16 07:26:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add network routes documentation

Browse Source
This commit is contained in:
Maycon Santos
2022-09-05 16:23:38 +02:00
parent c90f9447bb
commit ea677ae2b6
4 changed files with 6 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/how-to-guides/routes.md
View File

@@ -17,22 +17,22 @@ In these cases, you can configure network routes assigning routing peers to conn
## Concepts
### Network routes
A network route describes the network you want to connect with your NetBird peers. It has an identifier, a network CIDR, a routing peer, and some parameters available for managing priority and masquerading.
A network route describes the network you want to connect with your NetBird peers. It has an identifier, a network range, a routing peer, and some parameters available for managing priority and masquerading.
:::info
Network routes is available for NetBird v0.9.0 or later.
:::
### Network identifiers and CIDRs
Network identifiers are names for each network you want to route traffic from your peers, and network CIDR are IP ranges in CIDR notation which refers to an external network. The combination of identifiers and these ranges makes a single network.
### Network identifiers and ranges
Network identifiers are names for each network you want to route traffic from your peers, and ranges are IP ranges declared in CIDR notation which refers to an external network. The combination of identifiers and these ranges makes a single network.
### Routing peer
A routing peer is a node that will route packets between your routed network and the other NetBird peers.
:::info
Only Linux OS nodes can be assigned as routing peers.
:::
### High availability routes
A highly available route is a combination of multiple routes with the same network identifier and CIDR. They have different routing peers offering high-available paths for communication between your peers and external networks.
A highly available route is a combination of multiple routes with the same network identifier and ranges. They have different routing peers offering high-available paths for communication between your peers and external networks.
Nodes connected to routing peers will choose one of them to route packets to external networks based on connection type and defined metrics.
### Masquerade
Masquerade hides other NetBird network IPs behind the routing peer local address when accessing the target Network CIDR. This option allows access to your private networks without configuring routes on your local routers or other devices.
Masquerade hides other NetBird network IPs behind the routing peer local address when accessing the target Network range. This option allows access to your private networks without configuring routes on your local routers or other devices.
If you don't enable this option, you must configure a route to your NetBird network in your external network infrastructure.
### Metric and priority
@@ -56,7 +56,4 @@ Once you are done filling the route information, you can click on the `create` b
<p align="center">
<img src="/docs/img/how-to-guides/netbird-network-routes-saved-new.png" alt="high-level-dia" width="600" style={{boxShadow: '0 4px 8px 0 rgba(0, 0, 0, 0.2), 0 6px 20px 0 rgba(0, 0, 0, 0.19)'}} />
</p>
Done! Now every peer connected to your routing peer will be able to send traffic to your external network.
### Masquerading your NetBird traffic
Configuring a route is enough to route packets from your NetBird peers to your external networks, but in order to make the communication
Done! Now every peer connected to your routing peer will be able to send traffic to your external network.