Use reference on release notes
[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 BGP RIB API
14 ^^^^^^^^^^^
15 This tree illustrates the BGP RIBs organization in datastore.
16
17 .. code-block:: console
18
19     bgp-rib
20       +--ro rib* [id]
21          +--ro id         rib-id
22          +--ro peer* [peer-id]
23          |  +--ro peer-id                  peer-id
24          |  +--ro peer-role                peer-role
25          |  +--ro simple-routing-policy?   simple-routing-policy
26          |  +--ro supported-tables* [afi safi]
27          |  |  +--ro afi             identityref
28          |  |  +--ro safi            identityref
29          |  |  +--ro send-receive?   send-receive
30          |  +--ro adj-rib-in
31          |  |  +--ro tables* [afi safi]
32          |  |     +--ro afi           identityref
33          |  |     +--ro safi          identityref
34          |  |     +--ro attributes
35          |  |     |  +--ro uptodate?   boolean
36          |  |     +--ro (routes)?
37          |  +--ro effective-rib-in
38          |  |  +--ro tables* [afi safi]
39          |  |     +--ro afi           identityref
40          |  |     +--ro safi          identityref
41          |  |     +--ro attributes
42          |  |     |  +--ro uptodate?   boolean
43          |  |     +--ro (routes)?
44          |  +--ro adj-rib-out
45          |     +--ro tables* [afi safi]
46          |        +--ro afi           identityref
47          |        +--ro safi          identityref
48          |        +--ro attributes
49          |        |  +--ro uptodate?   boolean
50          |        +--ro (routes)?
51          +--ro loc-rib
52             +--ro tables* [afi safi]
53                +--ro afi           identityref
54                +--ro safi          identityref
55                +--ro attributes
56                |  +--ro uptodate?   boolean
57                +--ro (routes)?
58
59 BGP pipeline
60 ^^^^^^^^^^^^
61 .. figure:: ./images/bgp-pipeline.png
62    :alt: BGP pipeline.
63
64    BGP pipeline - routes re-advertisement.
65
66 .. figure:: ./images/bgp-app-pipeline.png
67    :alt: BGP Application Peer pipeline.
68
69    BGP applcaition peer pipeline - routes injection.
70
71 Configuration
72 ^^^^^^^^^^^^^
73 .. toctree::
74    :maxdepth: 1
75
76    bgp-user-guide-protocol-configuration
77    bgp-user-guide-bgp-server
78    bgp-user-guide-bgp-peering
79    bgp-user-guide-bgp-application-peer
80    bgp-user-guide-protocol-configuration-loader
81
82 References
83 ^^^^^^^^^^
84 * `A Border Gateway Protocol 4 (BGP-4) <https://tools.ietf.org/html/rfc4271>`_
85 * `BGP Route Reflection <https://tools.ietf.org/html/rfc4456>`_
86 * `BGP Communities Attribute <https://tools.ietf.org/html/rfc1997>`_
87 * `BGP Support for Four-Octet Autonomous System (AS) Number Space <https://tools.ietf.org/html/rfc6793>`_
88 * `The Accumulated IGP Metric Attribute for BGP <https://tools.ietf.org/html/rfc7311>`_
89 * `4-Octet AS Specific BGP Extended Community <https://tools.ietf.org/html/rfc5668>`_
90 * `BGP Link Bandwidth Extended Community <https://tools.ietf.org/html/draft-ietf-idr-link-bandwidth-06>`_
91 * `Use of BGP for Routing in Large-Scale Data Centers <https://tools.ietf.org/html/rfc7938>`_