mirror_frr/doc/user/index.rst
Trey Aspelund 433d9566bf doc: add FRR/Linux configuration examples for EVPN
The existing EVPN documentation in bgp.rst does not provide a holistic
configuration, just examples of individual features, and doesn't give
an operator any idea of what a compatible Linux netdev configuration
might look like. This introduces evpn.rst which includes a sample
frr.conf and corresponding Linux interface config (via iproute2) that
an operator can use to setup a basic EVPN topology and model their
interface manager's config from.

This initial version of evpn.rst shows Linux netdev config for
traditional bridges (vlan_filtering=0) and traditional vxlan devices
(single VNI). Later changes to this file will cover the use of
VLAN-aware bridges (vlan_filtering=1), single VXLAN devices
(multi VNI), and eventually bonds (for EVPN-MH).

Eventually the plan is to move the existing EVPN content from bgp.rst
into evpn.rst, but for now let's get some user-facing documentation in
place for interface configs.

Signed-off-by: Trey Aspelund <taspelund@nvidia.com>
2022-12-08 14:34:20 -05:00

102 lines
1.5 KiB
ReStructuredText

FRRouting User Guide
====================
############
Introduction
############
.. _introduction:
.. toctree::
:maxdepth: 2
overview
installation
setup
######
Basics
######
.. _basics:
.. toctree::
:maxdepth: 2
basic
extlog
vtysh
grpc
filter
routemap
ipv6
kernel
snmp
scripting
nexthop_groups
.. modules
#########
Protocols
#########
.. _protocols:
.. toctree::
:maxdepth: 2
zebra
bfd
bgp
babeld
fabricd
ldpd
eigrpd
evpn
isisd
nhrpd
ospfd
ospf6d
pathd
pim
pimv6
pbr
ripd
ripngd
sharp
static
vnc
vrrp
bmp
watchfrr
########
Appendix
########
.. _appendix:
.. toctree::
:maxdepth: 2
bugs
packet-dumps
glossary
frr-reload
################
Copyright notice
################
Copyright (c) 1996-2018 Kunihiro Ishiguro, et al.
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided that the
entire resulting derived work is distributed under the terms of a
permission notice identical to this one.
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation
approved by Kunihiro Ishiguro.