Skip to content

Commit fe4eedb

Browse files
committed
Document iBGP in README.md
1 parent 1b303e4 commit fe4eedb

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -241,6 +241,27 @@ session with your route collector over IPv6, using multiprotocol BGP to export
241241
routes for both IPv4 and IPv6 in a single session, using `add paths` to also
242242
all routes instead of the best routes available.
243243

244+
### iBGP
245+
246+
There is no true convention regarding iBGP usage since it's strictly internal
247+
to an AS, so this filter library will not attempt to make any assumption about
248+
how you might use iBGP. This means that by default, any route received from
249+
iBGP will not be exported by functions like `export_cone` or
250+
`export_to_downstream`. This avoids potential accidents like internal traffic
251+
engineering hijacks from being exported to the Internet and causing a major
252+
incident.
253+
254+
To export an iBGP route to downstreams, set `export_downstream = 1;` in the
255+
import filter when importing the iBGP route.
256+
257+
To export an iBGP route to upstreams, create a new `export_*` function that
258+
returns `true` for the subset of routes you wish to export, such as
259+
`export_ibgp`. Then, you can write your export clause as follows:
260+
261+
```
262+
export where export_cone([PEER_ASN]) || export_ibgp();
263+
```
264+
244265
## BGP communities
245266

246267
The following large informational communities are implemented by default:

0 commit comments

Comments
 (0)