Merge "update project of-config release notes"
[docs.git] / docs / release-notes / projects / 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/pom.xml;h=f5acb8c44359fb258ef3b22c00269e48a091b7ee;hb=refs/heads/stable/oxygen
12 * **Feature Description:**  OpenDaylight Border Gateway Protocol (BGP) plugin.
13 * **Top Level:** Yes
14 * **User Facing:** Yes
15 * **Experimental:** No
16 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/bgpcep/job/bgpcep-csit-1node-userfeatures-all-oxygen
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/pom.xml;h=6b195866c508ea053ecec4445973467b31aa7bfe;hb=refs/heads/stable/oxygen
22 * **Feature Description:**  OpenDaylight BGP Monitoring Protocol (BMP) plugin.
23 * **Top Level:** Yes
24 * **User Facing:** Yes
25 * **Experimental:** No
26 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/bgpcep/job/bgpcep-csit-1node-userfeatures-all-oxygen
27
28 odl-bgpcep-pcep
29 ---------------
30
31 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=bgpcep.git;a=tree;f=features/pcep/features-pcep;h=252a957bf6b8549ad53cedb45bbd76dca9ba7cb5;hb=refs/heads/stable/oxygen
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://jenkins.opendaylight.org/releng/view/bgpcep/job/bgpcep-csit-1node-userfeatures-all-oxygen
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/dashboard?id=org.opendaylight.bgpcep%3Abgpcep-aggregator>`_ (72.4%)
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-gate-userfeatures-all-oxygen/>`_
66 * `PCEP performance and scale tests <https://jenkins.opendaylight.org/releng/view/bgpcep/job/bgpcep-csit-1node-periodic-throughpcep-only-oxygen/>`_
67 * `BGP Application peer performance and scale tests <https://jenkins.opendaylight.org/releng/view/bgpcep/job/bgpcep-csit-1node-periodic-throughpcep-all-oxygen/>`_
68 * `BGP performance and scale test <https://jenkins.opendaylight.org/releng/view/bgpcep/job/bgpcep-csit-1node-periodic-bgp-ingest-mixed-all-oxygen/>`_
69 * `BGP clustering <https://jenkins.opendaylight.org/releng/view/bgpcep/job/bgpcep-csit-3node-periodic-bgpclustering-ha-only-oxygen/>`_
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 Migration
74 ---------
75
76 * No additional migration steps needed.
77
78 Compatibility
79 -------------
80
81 * Is this release compatible with the previous release?
82   Yes
83 * Any API changes?
84 * Any configuration changes?
85   BGP CSS configuration is not longer supported.
86   BMP CSS configuration is not longer supported.
87   PCEP CSS configuration is not longer supported.
88
89 Bugs Fixed
90 ----------
91
92 * `List of bugs fixed since the previous release <https://jira.opendaylight.org/browse/BGPCEP-763?jql=project%20%3D%20BGPCEP%20AND%20status%20in%20(Resolved%2C%20Verified)%20AND%20created%20%3E%3D%202017-10-07%20AND%20created%20%3C%3D%202018-03-08>`_
93
94 Known Issues
95 ------------
96
97 * `List key known issues with workarounds <https://jira.opendaylight.org/browse/BGPCEP-762?jql=project%20%3D%20BGPCEP%20AND%20status%20in%20(Open%2C%20%22In%20Progress%22)%20AND%20created%20%3E%3D%202017-10-07%20AND%20created%20%3C%3D%202018-03-08>`_
98
99 End-of-life
100 ===========
101
102 * BGP CSS Configuration.
103 * PCEP CSS Configuration.
104 * BMP CSS Configuration.
105
106 Standards
107 =========
108
109 * :ref:`BGP Supported Capabilities <bgp-user-guide-supported-capabilities>`
110 * :ref:`PCEP Supported Capabilities <pcep-user-guide-supported-capabilities>`
111 * :ref:`BGP Monitoring Protocol Supported Capabilities <bgp-monitoring-protocol-user-guide-supported-capabilities>`
112
113 Release Mechanics
114 =================
115
116 * `Link to release plan <https://wiki.opendaylight.org/view/BGP_LS_PCEP:Oxygen_Release_Plan>`_