Updated git submodules
[docs.git] / docs / getting-started-guide / project-release-notes / bier.rst
1 =======================================
2 Bit Indexed Explicit Replication (BIER)
3 =======================================
4
5 odl-bier-all
6 ------------
7
8 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=bier.git;a=blob;f=features/features-bier/pom.xml;hb=refs/heads/stable/nitrogen
9 * **Feature Description:**  This is a summary feature containing the default functionalities provided by BIER project.
10 * **Top Level:** Yes
11 * **User Facing:** Yes
12 * **Experimental:** Yes
13 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/bier/job/bier-csit-1node-basic-all-nitrogen/
14
15 Documentation
16 =============
17
18 * **User Guide(s):**
19
20   *  :ref:`bier-user-guide`
21
22 * **Developer Guide(s):**
23
24   *  :ref:`bier-dev-guide`
25
26 Security Considerations
27 =======================
28
29 * Do you have any external interfaces other than RESTCONF?
30
31   * BIER project needs to get topology information via BGP-LS and BIER configuration via NETCONF.
32
33 * Other security issues?
34
35   * The required security issues are provided in the RESTCONF, NETCONF and BGP-LS projects.
36
37 Quality Assurance
38 =================
39
40 * `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=72693>`_ 76.7%
41 * `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/bier/job/bier-csit-1node-basic-all-nitrogen/>`_
42 * Testing methodology. How extensive was it? What should be expected to work?
43   What has not been tested as much?
44 * There are unit tests and integration test available under folder "test" and system test in CSIT but the NETCONF
45   interface is not tested and will be completed in next release.
46
47 Migration
48 ---------
49
50 <<<<<<< HEAD
51 * Is it possible to migrate from the previous release? If so, how?
52 =======
53 * Is it possible migrate from the previous release? If so, how?
54 >>>>>>> Update bier release-notes for nitrogen
55
56 * Migration with data from Carbon to Nitrogen is not supported.
57
58 Compatibility
59 -------------
60
61 * Is this release compatible with the previous release? Yes.
62 * Any API changes? Yes. Some BIER-TE APIs have been added and listed as following.
63 bier/bierman/api/src/main/yang/bier-te-config-api.yang
64 configure-te-node
65 configure-te-label
66 delete-te-babel
67 delete-te-bsl
68 delete-te-si
69 delete-te-bp
70 * Any configuration changes? Yes. BGP-LS should be used instead of OpenFlow to get topology information.
71
72 Bugs Fixed
73 ----------
74
75 * None.
76
77 Known Issues
78 ------------
79
80 * None.
81
82 End-of-life
83 ===========
84
85 * None.
86
87 Standards
88 =========
89
90 * `Multicast using Bit Index Explicit Replication <https://datatracker.ietf.org/doc/draft-ietf-bier-architecture>`_
91 * `YANG Data Model for BIER Protocol <https://datatracker.ietf.org/doc/draft-ietf-bier-bier-yang>`_
92
93 Release Mechanics
94 =================
95
96 * `Link to release plan <https://wiki.opendaylight.org/view/BIER:Nitrogen:Release_Plan>`_
97 * No major changes.