Merge "Route reflector cluster id doc"
[docs.git] / docs / user-guide / bgpcep-guide / bgp / bgp-user-guide-config-concepts.rst
1 .. _bgp-user-guide-config-concepts:
2
3 Basic Configuration & Concepts
4 ==============================
5 The following section shows how to configure BGP basics, how to verify functionality and presents essential components of the plugin.
6 Next samples demonstrate the plugin's runtime configuration capability.
7 It shows the way to configure the plugin via REST, using standardized OpenConfig BGP APIs.
8
9 .. contents:: Contents
10    :depth: 2
11    :local:
12
13 Configuration
14 ^^^^^^^^^^^^^
15 .. toctree::
16    :maxdepth: 2
17
18    bgp-user-guide-protocol-configuration
19    bgp-user-guide-rib-config-policies
20    bgp-user-guide-bgp-server
21    bgp-user-guide-bgp-peering
22    bgp-user-guide-bgp-application-peer
23    bgp-user-guide-protocol-configuration-loader
24
25 BGP RIB API
26 ^^^^^^^^^^^
27 This tree illustrates the BGP RIBs organization in datastore.
28
29 .. code-block:: console
30
31     bgp-rib
32       +--ro rib* [id]
33          +--ro id         rib-id
34          +--ro peer* [peer-id]
35          |  +--ro peer-id                  peer-id
36          |  +--ro peer-role                peer-role
37          |  +--ro simple-routing-policy?   simple-routing-policy
38          |  +--ro supported-tables* [afi safi]
39          |  |  +--ro afi             identityref
40          |  |  +--ro safi            identityref
41          |  |  +--ro send-receive?   send-receive
42          |  +--ro adj-rib-in
43          |  |  +--ro tables* [afi safi]
44          |  |     +--ro afi           identityref
45          |  |     +--ro safi          identityref
46          |  |     +--ro attributes
47          |  |     |  +--ro uptodate?   boolean
48          |  |     +--ro (routes)?
49          |  +--ro effective-rib-in
50          |  |  +--ro tables* [afi safi]
51          |  |     +--ro afi           identityref
52          |  |     +--ro safi          identityref
53          |  |     +--ro attributes
54          |  |     |  +--ro uptodate?   boolean
55          |  |     +--ro (routes)?
56          |  +--ro adj-rib-out
57          |     +--ro tables* [afi safi]
58          |        +--ro afi           identityref
59          |        +--ro safi          identityref
60          |        +--ro attributes
61          |        |  +--ro uptodate?   boolean
62          |        +--ro (routes)?
63          +--ro loc-rib
64             +--ro tables* [afi safi]
65                +--ro afi           identityref
66                +--ro safi          identityref
67                +--ro attributes
68                |  +--ro uptodate?   boolean
69                +--ro (routes)?
70
71 BGP pipeline
72 ^^^^^^^^^^^^
73 .. figure:: ./images/bgp-pipeline.png
74    :alt: BGP pipeline.
75
76    BGP pipeline - routes re-advertisement.
77
78 .. figure:: ./images/bgp-app-pipeline.png
79    :alt: BGP Application Peer pipeline.
80
81    BGP applcaition peer pipeline - routes injection.
82
83 References
84 ^^^^^^^^^^
85 * `A Border Gateway Protocol 4 (BGP-4) <https://tools.ietf.org/html/rfc4271>`_
86 * `BGP Route Reflection <https://tools.ietf.org/html/rfc4456>`_
87 * `BGP Communities Attribute <https://tools.ietf.org/html/rfc1997>`_
88 * `BGP Support for Four-Octet Autonomous System (AS) Number Space <https://tools.ietf.org/html/rfc6793>`_
89 * `The Accumulated IGP Metric Attribute for BGP <https://tools.ietf.org/html/rfc7311>`_
90 * `4-Octet AS Specific BGP Extended Community <https://tools.ietf.org/html/rfc5668>`_
91 * `BGP Link Bandwidth Extended Community <https://tools.ietf.org/html/draft-ietf-idr-link-bandwidth-06>`_
92 * `Use of BGP for Routing in Large-Scale Data Centers <https://tools.ietf.org/html/rfc7938>`_