update Neutron Northbound rel.notes
[docs.git] / docs / getting-started-guide / project-release-notes / bgp-ls-pcep.rst
1 ===========
2 BGP LS PCEP
3 ===========
4
5 Major Features
6 ==============
7
8 odl-bgpcep-bgp
9 --------------
10
11 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=bgpcep.git;a=blob;f=features/bgp/features-bgp/src/main/features/features.xml;hb=refs/heads/stable/carbon
12 * **Feature Description:**  OpenDaylight Border Gateway Protocol (BGP) plugin.
13 * **Top Level:** Yes
14 * **User Facing:** Yes
15 * **Experimental:** No
16 * **CSIT Test:** https://logs.opendaylight.org/releng/jenkins092/bgpcep-csit-1node-userfeatures-all-carbon
17
18 odl-bgpcep-bmp
19 --------------
20
21 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=bgpcep.git;a=blob;f=features/bmp/features-bmp/src/main/features/features.xml;hb=refs/heads/stable/carbon
22 * **Feature Description:**  OpenDaylight BGP Monitoring Protocol (BMP) plugin.
23 * **Top Level:** Yes
24 * **User Facing:** Yes
25 * **Experimental:** No
26 * **CSIT Test:** https://logs.opendaylight.org/releng/jenkins092/bgpcep-csit-1node-userfeatures-all-carbon
27
28 odl-bgpcep-pcep
29 ---------------
30
31 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=bgpcep.git;a=blob;f=features/pcep/features-pcep/src/main/features/features.xml;hb=refs/heads/stable/carbon
32 * **Feature Description:**  OpenDaylight Path Computation Element Configuration Protocol (PCEP) plugin.
33 * **Top Level:** Yes
34 * **User Facing:** Yes
35 * **Experimental:** No
36 * **CSIT Test:** https://logs.opendaylight.org/releng/jenkins092/bgpcep-csit-1node-userfeatures-all-carbon
37
38
39 Documentation
40 =============
41
42 * **User Guide(s):**
43
44   * :ref:`BGP User Guide <bgp-user-guide>`
45   * :ref:`BGP Monitoring Protocol User Guide <bgp-monitoring-protocol-user-guide>`
46   * :ref:`PCEP User Guide <pcep-user-guide>`
47
48 * **Developer Guide(s):**
49
50   * :ref:`BGP Developer Guide <bgp-developer-guide>`
51   * :ref:`BGP Monitoring Protocol Developer Guide <bgp-monitoring-protocol-developer-guide>`
52   * :ref:`PCEP Developer Guide <pcep-developer-guide>`
53
54 Security Considerations
55 =======================
56
57 None Known - all protocol implements the TCP Authentication Option (TCP MD5)
58
59 Quality Assurance
60 =================
61
62 * `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=10075>`_ (80,8%)
63 * `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/bgpcep/>`_
64
65 * `User features test <https://jenkins.opendaylight.org/releng/view/bgpcep/job/bgpcep-csit-1node-userfeatures-only-carbon/>`_
66 * `PCEP performance and scale tests <https://jenkins.opendaylight.org/releng/view/bgpcep/job/bgpcep-csit-1node-periodic-throughpcep-only-carbon/>`_
67 * `BGP Application peer performance and scale tests <https://jenkins.opendaylight.org/releng/view/bgpcep/job/bgpcep-csit-1node-periodic-bgp-ingest-only-carbon/>`_
68 * `BGP performance and scale test <https://jenkins.opendaylight.org/releng/view/bgpcep/job/bgpcep-csit-1node-periodic-bgp-ingest-mixed-only-carbon/>`_
69 * `BGP clustering <https://jenkins.opendaylight.org/releng/view/bgpcep/job/bgpcep-csit-3node-periodic-bgpclustering-only-carbon/>`_
70
71   The BGP extensions were tested manually with vendor's BGP router implementation or other software implementations (exaBGP, bagpipeBGP). Also, they are covered by the unit tests and automated system tests.
72
73 *  New BGP Openconfig statistics feature requires more testing.
74
75 Migration
76 ---------
77
78 BGP:
79 ^^^^
80
81 Protocol Configuration
82 ''''''''''''''''''''''
83
84 First we get old configuration
85
86 **URL:** ``/restconf/config/openconfig-network-instance:network-instances/network-instance/global-bgp/openconfig-network-instance:protocols``
87
88 **Method:** ``GET``
89
90 where *example-bmp-monitor* old bmp monitor id
91
92 Then we insert it
93
94 **URL:** ``/restconf/config/openconfig-network-instance:network-instances/network-instance/global-bgp/openconfig-network-instance:protocols``
95
96 **Method:** ``POST``
97
98 Topology Configuration
99 ''''''''''''''''''''''
100
101 First we get old configuration
102
103 **URL:** ``/restconf/config/network-topology:network-topology``
104
105 **Method:** ``GET``
106
107 Then we insert it
108
109 **URL:** ``/restconf/config/network-topology:network-topology``
110
111 **Method:** ``POST``
112
113 BMP:
114 ^^^^
115
116 First we get old configuration
117
118 **URL:** ``/restconf/config/network-topology:network-topology/topology/topology-netconf/node/controller-config/yang-ext:mount/config:modules/config:module/odl-bmp-impl-cfg:bmp-monitor-impl/example-bmp-monitor``
119
120 **Method:** ``GET``
121
122 **example-bmp-monitor** old bmp monitor id
123
124 Then we insert it
125
126 **URL:** ``/restconf/config/network-topology:network-topology/topology/topology-netconf/node/controller-config/yang-ext:mount/config:modules/config:module/odl-bmp-impl-cfg:bmp-monitor-impl/example-bmp-monitor``
127
128 **Method:** ``PUT``
129
130 PCEP:
131 ^^^^^
132
133 There are no additional steps needed for migration to this release.
134
135 Compatibility
136 -------------
137
138 * Is this release compatible with the previous release?
139   Yes
140 * Any API changes?
141 * Any configuration changes?
142   BGP OpenConfig configuration should be used instead of previous BGP CSS configuration.
143
144 Bugs Fixed
145 ----------
146
147 * `List of bugs fixed since the previous release <https://bugs.opendaylight.org/buglist.cgi?columnlist=product%2Ccomponent%2Cassigned_to%2Cbug_severity%2Ccf_issue_type%2Cshort_desc%2Cbug_status%2Cpriority%2Cdeadline%2Ccf_target_milestone&f1=cf_target_milestone&f2=cf_issue_type&known_name=Lithium%3A%20bgpcep&o1=substring&o2=equals&product=bgpcep&query_based_on=Lithium%3A%20bgpcep&query_format=advanced&resolution=FIXED&v1=Carbon&v2=Bug>`_
148
149 Known Issues
150 ------------
151
152 * `BUG-6562 <https://bugs.opendaylight.org/show_bug.cgi?id=6562>`_ Support add-path in base BGP NLRI
153
154 End-of-life
155 ===========
156
157 * None
158
159 Standards
160 =========
161
162 * `RFC4271 <https://tools.ietf.org/html/rfc4271>`_ - A Border Gateway Protocol 4 (BGP-4)
163 * `RFC4760 <https://tools.ietf.org/html/rfc4760>`_ - Multiprotocol Extensions for BGP-4
164 * `RFC1997 <https://tools.ietf.org/html/rfc1997>`_ - BGP Communities Attribute
165 * `RFC4360 <https://tools.ietf.org/html/rfc4360>`_ - BGP Extended Communities Attribute
166 * `RFC4486 <https://tools.ietf.org/html/rfc4486>`_ - Subcodes for BGP Cease Notification Message
167 * `RFC5004 <https://tools.ietf.org/html/rfc5004>`_ - Avoid BGP Best Path Transitions from One External to Another
168 * `RFC7752 <https://tools.ietf.org/html/rfc7752>`_ - North-Bound Distribution of Link-State and TE Information using BGP
169 * `RFC5440 <https://tools.ietf.org/html/rfc5440>`_ - Path Computation Element (PCE) Communication Protocol (PCEP)
170 * `RFC5541 <https://tools.ietf.org/html/rfc5541>`_ - Encoding of Objective Functions in the Path Computation Element Communication Protocol (PCEP)
171 * `RFC5455 <https://tools.ietf.org/html/rfc5455>`_ - Diffserv-Aware Class-Type Object for the Path Computation Element Communication Protocol
172 * `RFC5492 <https://tools.ietf.org/html/rfc5492>`_ - Capabilities Advertisement with BGP-4
173 * `RFC5521 <https://tools.ietf.org/html/rfc5521>`_ - Extensions to the Path Computation Element Communication Protocol (PCEP) for Route Exclusions
174 * `RFC5557 <https://tools.ietf.org/html/rfc5557>`_ - Path Computation Element Communication Protocol (PCEP) Requirements and Protocol Extensions in Support of Global Concurrent Optimization
175 * `RFC5575 <https://tools.ietf.org/html/rfc5575>`_ - Flow Specification
176 * `RFC5886 <https://tools.ietf.org/html/rfc5886>`_ - A Set of Monitoring Tools for Path Computation Element (PCE)-Based Architecture
177 * `RFC6286 <https://tools.ietf.org/html/rfc6286>`_ - Autonomous-System-Wide Unique BGP Identifier for BGP-4
178 * `RFC6793 <https://tools.ietf.org/html/rfc6793>`_ - BGP Support for Four-Octet Autonomous System (AS) Number Space
179 * `RFC7311 <https://tools.ietf.org/html/rfc7311>`_ - The Accumulated IGP Metric Attribute for BGP
180 * `RFC7674 <http://tools.ietf.org/html/rfc7674 >`_ - Clarification of the Flowspec Redirect Extended Community
181 * `RFC5668 <https://tools.ietf.org/html/rfc5668>`_ - 4-Octet AS Specific BGP Extended Community
182 * `RFC3107 <https://tools.ietf.org/html/rfc3107>`_ - Carrying Label Information in BGP-4
183 * `RFC4364 <https://tools.ietf.org/html/rfc4364>`_ - BGP/MPLS IP Virtual Private Networks (VPNs)
184 * `RFC7432 <https://tools.ietf.org/html/rfc7432>`_ - BGP MPLS-Based Ethernet VPN
185 * `RFC7911 <https://tools.ietf.org/html/rfc7911>`_ - Advertisement of Multiple Paths in BGP
186 * `RFC2918 <https://tools.ietf.org/html/rfc2918>`_ - Route Refresh Capability for BGP-4
187 * `draft-ietf-bess-evpn-overlay <https://tools.ietf.org/html/draft-ietf-bess-evpn-overlay-04>`_ - A Network Virtualization Overlay Solution using EVPN
188 * `draft-ietf-pce-pceps <https://tools.ietf.org/html/draft-ietf-pce-pceps-03>`_ - Secure Transport for PCEP
189 * `draft-gredler-idr-bgp-ls-segment-routing-ext-03 <https://tools.ietf.org/html/draft-gredler-idr-bgp-ls-segment-routing-ext-03>`_ - BGP Link-State extensions for Segment Routing
190 * `draft-ietf-idr-bgpls-segment-routing-epe-05 <https://tools.ietf.org/html/draft-ietf-idr-bgpls-segment-routing-epe-05>`_ - Segment Routing Egress Peer Engineering BGP-LS Extensions
191 * `draft-ietf-idr-flow-spec-v6-06 <https://tools.ietf.org/html/draft-ietf-idr-flow-spec-v6-06>`_ - Dissemination of Flow Specification Rules for IPv6 <br />
192 * `draft-ietf-idr-flowspec-redirect-ip-01 <https://tools.ietf.org/html/draft-ietf-idr-flowspec-redirect-ip-01>`_ - BGP Flow-Spec Redirect to IP Action
193
194 * Stateful extensions to the Path Computation Element Protocol, December 2013
195
196   * `draft-ietf-pce-stateful-pce-07 <https://tools.ietf.org/html/draft-ietf-pce-stateful-pce-07>`_ - PCEP Extensions for Stateful PCE
197   * `draft-ietf-pce-pce-initiated-lsp-00 <https://tools.ietf.org/html/draft-ietf-pce-pce-initiated-lsp-00>`_ - PCEP Extensions for PCE-initiated LSP Setup in a Stateful PCE Model
198
199 * Segment routing extension to the Path Computation Element Protocol, October 2014
200
201   * `draft-ietf-pce-segment-routing-01 <https://tools.ietf.org/html/draft-ietf-pce-segment-routing-01>`_ - PCEP Extension for segment routing
202   * `draft-ietf-pce-lsp-setup-type-01 <https://tools.ietf.org/html/draft-ietf-pce-lsp-setup-type-01>`_ - PCEP Extension for path setup type
203   * `draft-ietf-pce-stateful-sync-optimizations-03 <https://tools.ietf.org/html/draft-ietf-pce-stateful-sync-optimizations-03>`_ - Optimizations of Label Switched Path State Synchronization Procedures for a Stateful PCE
204   * `draft-sivabalan-pce-binding-label-sid-01 <https://tools.ietf.org/html/draft-sivabalan-pce-binding-label-sid-01>`_ - Carrying Binding Label/Segment-ID in PCE-based Networks
205   * `RFC7854 <https://tools.ietf.org/html/rfc7854>`_ - BGP Monitoring Protocol
206
207 Release Mechanics
208 =================
209
210 * `Link to release plan <https://wiki.opendaylight.org/view/BGP_LS_PCEP:Carbon_Release_Plan>`_
211
212 * Release plan not achieved
213
214   * `BUG-6966 <https://bugs.opendaylight.org/show_bug.cgi?id=6966>`_ Introduce infrastructure for inbound/outbound routing policies
215   * `BUG-6973 <https://bugs.opendaylight.org/show_bug.cgi?id=6973>`_ Migrate PCEP topology provider to use BP wiring
216   * `BUG-6976 <https://bugs.opendaylight.org/show_bug.cgi?id=6976>`_ Migrate BMP collector to use BP wiring
217   * `BUG-6978 <https://bugs.opendaylight.org/show_bug.cgi?id=6978>`_ Integrate BMP collector with Cluster Singleton Service