diff options
Diffstat (limited to 'doc/user')
| -rw-r--r-- | doc/user/basic.rst | 2 | ||||
| -rw-r--r-- | doc/user/bgp.rst | 36 | ||||
| -rw-r--r-- | doc/user/flowspec.rst | 4 | ||||
| -rw-r--r-- | doc/user/installation.rst | 2 | ||||
| -rw-r--r-- | doc/user/ospfd.rst | 2 | ||||
| -rw-r--r-- | doc/user/pbr.rst | 2 | ||||
| -rw-r--r-- | doc/user/pim.rst | 4 | ||||
| -rw-r--r-- | doc/user/sharp.rst | 2 | ||||
| -rw-r--r-- | doc/user/zebra.rst | 4 |
9 files changed, 35 insertions, 23 deletions
diff --git a/doc/user/basic.rst b/doc/user/basic.rst index 8201fdf1b9..8fbea29ee7 100644 --- a/doc/user/basic.rst +++ b/doc/user/basic.rst @@ -390,7 +390,7 @@ Terminal Mode Commands .. index:: find COMMAND... .. clicmd:: find COMMAND... - This commmand performs a simple substring search across all defined commands + This command performs a simple substring search across all defined commands in all modes. As an example, suppose you're in enable mode and can't remember where the command to turn OSPF segment routing on is: diff --git a/doc/user/bgp.rst b/doc/user/bgp.rst index 5b453e75c3..be331ffb99 100644 --- a/doc/user/bgp.rst +++ b/doc/user/bgp.rst @@ -511,8 +511,8 @@ cause may lead to routing instability or oscillation across multiple speakers in iBGP topologies. This can occur with full-mesh iBGP, but is particularly problematic in non-full-mesh iBGP topologies that further reduce the routing information known to each speaker. This has primarily been documented with iBGP -route-reflection topologies. However, any route-hiding technologies potentially -could also exacerbate oscillation with MED. +:ref:`route-reflection <bgp-route-reflector>` topologies. However, any +route-hiding technologies potentially could also exacerbate oscillation with MED. This second issue occurs where speakers each have only a subset of routes, and there are cycles in the preferences between different combinations of routes - @@ -1145,7 +1145,7 @@ is 4 octet long. The following format is used to define the community value. ``graceful-shutdown`` represents well-known communities value ``GRACEFUL_SHUTDOWN`` ``0xFFFF0000`` ``65535:0``. :rfc:`8326` implements the purpose Graceful BGP Session Shutdown to reduce the amount of - lost traffic when taking BGP sessions down for maintainance. The use + lost traffic when taking BGP sessions down for maintenance. The use of the community needs to be supported from your peers side to actually have any effect. @@ -1176,20 +1176,20 @@ is 4 octet long. The following format is used to define the community value. ``llgr-stale`` ``llgr-stale`` represents well-known communities value ``LLGR_STALE`` ``0xFFFF0006`` ``65535:6``. - Assigned and intented only for use with routers supporting the + Assigned and intended only for use with routers supporting the Long-lived Graceful Restart Capability as described in [Draft-IETF-uttaro-idr-bgp-persistence]_. - Routers recieving routes with this community may (depending on + Routers receiving routes with this community may (depending on implementation) choose allow to reject or modify routes on the presence or absence of this community. ``no-llgr`` ``no-llgr`` represents well-known communities value ``NO_LLGR`` ``0xFFFF0007`` ``65535:7``. - Assigned and intented only for use with routers supporting the + Assigned and intended only for use with routers supporting the Long-lived Graceful Restart Capability as described in [Draft-IETF-uttaro-idr-bgp-persistence]_. - Routers recieving routes with this community may (depending on + Routers receiving routes with this community may (depending on implementation) choose allow to reject or modify routes on the presence or absence of this community. @@ -1251,7 +1251,7 @@ UPDATE messages. There are two types of community list: standard - This type accepts an explicit value for the atttribute. + This type accepts an explicit value for the attribute. expanded This type accepts a regular expression. Because the regex must be @@ -2240,10 +2240,15 @@ Displaying Routes by AS Path Route Reflector =============== -.. note:: This documentation is woefully incomplete. +BGP routers connected inside the same AS through BGP belong to an internal +BGP session, or IBGP. In order to prevent routing table loops, IBGP does not +advertise IBGP-learned routes to other routers in the same session. As such, +IBGP requires a full mesh of all peers. For large networks, this quickly becomes +unscalable. Introducing route reflectors removes the need for the full-mesh. -.. index:: bgp cluster-id A.B.C.D -.. clicmd:: bgp cluster-id A.B.C.D +When route reflectors are configured, these will reflect the routes announced +by the peers configured as clients. A route reflector client is configured +with: .. index:: neighbor PEER route-reflector-client .. clicmd:: neighbor PEER route-reflector-client @@ -2251,6 +2256,13 @@ Route Reflector .. index:: no neighbor PEER route-reflector-client .. clicmd:: no neighbor PEER route-reflector-client +To avoid single points of failure, multiple route reflectors can be configured. + +A cluster is a collection of route reflectors and their clients, and is used +by route reflectors to avoid looping. + +.. index:: bgp cluster-id A.B.C.D +.. clicmd:: bgp cluster-id A.B.C.D .. _routing-policy: @@ -2469,7 +2481,7 @@ certainly contains silly mistakes, if not serious flaws. route-map rm-no-export permit 20 ! route-map rm-blackhole permit 10 - description blackhole, up-pref and ensure it cant escape this AS + description blackhole, up-pref and ensure it cannot escape this AS set ip next-hop 127.0.0.1 set local-preference 10 set community additive no-export diff --git a/doc/user/flowspec.rst b/doc/user/flowspec.rst index f6af88cac8..b274afe8a2 100644 --- a/doc/user/flowspec.rst +++ b/doc/user/flowspec.rst @@ -167,7 +167,7 @@ set. That VRF will then be selected. The below full configuration example depicts how Route Targets are configured and how VRFs and cross VRF configuration is done. Note that the VRF are mapped on Linux Network Namespaces. For data traffic to cross VRF boundaries, virtual ethernet -interfaces are created with private IP adressing scheme. +interfaces are created with private IP addressing scheme. .. code-block:: frr @@ -322,7 +322,7 @@ There are some other known issues: - The validation procedure depicted in :rfc:`5575` is not available. This validation procedure has not been implemented, as this feature was not - used in the existing setups you shared wih us. + used in the existing setups you shared with us. - The filtering action shaper value, if positive, is not used to apply shaping. diff --git a/doc/user/installation.rst b/doc/user/installation.rst index e191ebd035..964297292f 100644 --- a/doc/user/installation.rst +++ b/doc/user/installation.rst @@ -272,7 +272,7 @@ options from the list below. .. option:: --enable-multipath=X Compile FRR with up to X way ECMP supported. This number can be from 0-999. - For backwards compatability with older configure options when setting X = 0, + For backwards compatibility with older configure options when setting X = 0, we will build FRR with 64 way ECMP. This is needed because there are hardcoded arrays that FRR builds towards, so we need to know how big to make these arrays at build time. Additionally if this parameter is diff --git a/doc/user/ospfd.rst b/doc/user/ospfd.rst index b6a7cd5de0..ad0a8639a3 100644 --- a/doc/user/ospfd.rst +++ b/doc/user/ospfd.rst @@ -218,7 +218,7 @@ To start OSPF process you have to specify the OSPF router. SPF-triggering event occurs within the hold-time of the previous SPF calculation. - This command supercedes the *timers spf* command in previous FRR + This command supersedes the *timers spf* command in previous FRR releases. .. index:: max-metric router-lsa [on-startup|on-shutdown] (5-86400) diff --git a/doc/user/pbr.rst b/doc/user/pbr.rst index 638767c557..6230bf777a 100644 --- a/doc/user/pbr.rst +++ b/doc/user/pbr.rst @@ -88,7 +88,7 @@ end destination. When a incoming packet matches the destination prefix specified, take the packet and forward according to the nexthops specified. This command accepts - both v4 and v6 prefixes. This command is used in conjuction of the + both v4 and v6 prefixes. This command is used in conjunction of the :clicmd:`match src-ip PREFIX` command for matching. .. clicmd:: set nexthop-group NAME diff --git a/doc/user/pim.rst b/doc/user/pim.rst index feb77db1e1..f4611c520b 100644 --- a/doc/user/pim.rst +++ b/doc/user/pim.rst @@ -210,8 +210,8 @@ is in a vrf, enter the interface command with the vrf keyword at the end. Set the IGMP version used on this interface. The default value is 3. -.. index:: ip multicat boundary oil WORD -.. clicmd:: ip multicat boundary oil WORD +.. index:: ip multicast boundary oil WORD +.. clicmd:: ip multicast boundary oil WORD Set a pim multicast boundary, based upon the WORD prefix-list. If a pim join or IGMP report is received on this interface and the Group is denied by the diff --git a/doc/user/sharp.rst b/doc/user/sharp.rst index ca8f1f512f..4568c2a901 100644 --- a/doc/user/sharp.rst +++ b/doc/user/sharp.rst @@ -29,7 +29,7 @@ documented elsewhere. Using SHARP =========== -All sharp commands are under the enable node and preceeded by the ``sharp`` +All sharp commands are under the enable node and preceded by the ``sharp`` keyword. At present, no sharp commands will be preserved in the config. .. index:: sharp install diff --git a/doc/user/zebra.rst b/doc/user/zebra.rst index 9dfe1ea39c..a7bf0c74da 100644 --- a/doc/user/zebra.rst +++ b/doc/user/zebra.rst @@ -380,7 +380,7 @@ At startup, FRR detects the presence of that file. It detects that the file statistics information matches the same file statistics information as `/proc/self/ns/net` ( through stat() function). As statistics information matches, then `vrf0` stands for the new default namespace name. -Consequently, the VRF naming `Default` will be overriden by the new discovered +Consequently, the VRF naming `Default` will be overridden by the new discovered namespace name `vrf0`. For those who don't use VRF backend with *Linux network namespace*, it is @@ -422,7 +422,7 @@ in routing entry, and can be configured like a route: .. index:: [no] ip route NETWORK MASK GATEWAY|INTERFACE label LABEL .. clicmd:: [no] ip route NETWORK MASK GATEWAY|INTERFACE label LABEL - NETWORK ans MASK stand for the IP prefix entry to be added as static + NETWORK and MASK stand for the IP prefix entry to be added as static route entry. GATEWAY is the gateway IP address to reach, in order to reach the prefix. INTERFACE is the interface behind which the prefix is located. |