Merge "Add MDSAL release notes"
[docs.git] / docs / getting-started-guide / project-release-notes / vbd.rst
1 ===============================
2 Honeycomb Virtual Bridge Domain
3 ===============================
4
5 Major Features
6 ==============
7
8 odl-vbd
9 ------------------
10
11 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=honeycomb/vbd.git;a=blob;f=features/vbd-features/src/main/features/features.xml;h=66f8ed281850afadcf769a2b9e0925aaedce983a;hb=refs/heads/stable/carbon
12 * **Feature Description:**  This feature provides models to configure Virtual Bridge Domains on VPP.
13 * **Top Level:** Yes
14 * **User Facing:** Yes
15 * **Experimental:** Yes
16 * **CSIT Test:** N/A
17
18 odl-vbd-ui
19 ------------------
20
21 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=honeycomb/vbd.git;a=blob;f=features/vbd-features/src/main/features/features.xml;h=66f8ed281850afadcf769a2b9e0925aaedce983a;hb=refs/heads/stable/carbon
22 * **Feature Description:**  This feature provides the GUI for VBD.
23 * **Top Level:** Yes
24 * **User Facing:** Yes
25 * **Experimental:** Yes
26 * **CSIT Test:** N/A
27
28
29 Documentation
30 =============
31
32 * `Wiki <https://wiki.opendaylight.org/view/Honeycomb/VBD>`_
33 * `VBD API https://wiki.opendaylight.org/view/Honeycomb/VBD/API>`_
34
35 Security Considerations
36 =======================
37
38 * N/A
39
40 Quality Assurance
41 =================
42
43 * `Sonar Report <https://sonar.opendaylight.org/overview?id=68028>`_ (0% - no coverage results available)
44 * VBD project is tested within `FastDataStacks (FDS) <https://wiki.opnfv.org/display/fds/FastDataStacks+Home>`_ testing suite, where severeal automated
45   tests are performed. More information about FDS testing can be found here:
46   `FDS testing <https://wiki.opnfv.org/display/fds/FDS+Testing>`_ and test
47   results are available here: `FDS test results <http://testresults.opnfv.org/reporting/functest/release/danube/index-status-apex.html>`_
48 * FDS automated tests perform series of functests where the whole stack is
49   beeing tested (Openstack/ODL (GBP,VBD)/HC/VPP).
50
51 Migration
52 ---------
53
54 * Please upgrade to VPP 17.04 stable.
55
56 Compatiblity
57 ------------
58
59 * Not compatible with previous VPP 17.01 or older stable versions.
60
61 Bugs Fixed
62 ----------
63
64 * `Bug 6077 <https://bugs.opendaylight.org/show_bug.cgi?id=6077>`_      RESOLVED        Bridge domain is not created when topology and node are created at the same time
65 * `Bug 6078 <https://bugs.opendaylight.org/show_bug.cgi?id=6078>`_      RESOLVED        BVI is set to true and should be false when creating VXLAN tunnel
66 * `Bug 6101 <https://bugs.opendaylight.org/show_bug.cgi?id=6101>`_      RESOLVED        Error when creating VLAN flood domain
67 * `Bug 6104 <https://bugs.opendaylight.org/show_bug.cgi?id=6104>`_      RESOLVED        Ip addresses nullPointerException
68 * `Bug 6105 <https://bugs.opendaylight.org/show_bug.cgi?id=6105>`_      RESOLVED        Error when removing nodes from bridge domain
69 * `Bug 6241 <https://bugs.opendaylight.org/show_bug.cgi?id=6241>`_      RESOLVED        Split horizon group is not set for VXLAN tunnel interfaces
70 * `Bug 6285 <https://bugs.opendaylight.org/show_bug.cgi?id=6285>`_      RESOLVED        HONEYCOMB/VBD Missing from Distribution Feature Index
71 * `Bug 6591 <https://bugs.opendaylight.org/show_bug.cgi?id=6591>`_      RESOLVED        VXLAN tunnels are not created correctly
72 * `Bug 7117 <https://bugs.opendaylight.org/show_bug.cgi?id=7117>`_      RESOLVED        Cannot add Virtual Bridge Domains in DLUX
73 * `Bug 7118 <https://bugs.opendaylight.org/show_bug.cgi?id=7118>`_      RESOLVED        Cannot remove VPP from inventory in DLUX
74 * `Bug 7148 <https://bugs.opendaylight.org/show_bug.cgi?id=7148>`_      RESOLVED        VBD Carbon Autorelease Build Failure
75 * `Bug 7655 <https://bugs.opendaylight.org/show_bug.cgi?id=7655>`_      RESOLVED        Karaf 4 migration: provide Karaf 4 honeycomb-vbd features
76 * `Bug 8009 <https://bugs.opendaylight.org/show_bug.cgi?id=8009>`_      RESOLVED        Mismatched VXLAN tunnel endpoint addresses
77 * `Bug 8167 <https://bugs.opendaylight.org/show_bug.cgi?id=8167>`_      RESOLVED        Default startup configuration file not created
78 * `Bug 8172 <https://bugs.opendaylight.org/show_bug.cgi?id=8172>`_      RESOLVED        VBD missing yangs for configuring LISP in VPP
79 * `Bug 8173 <https://bugs.opendaylight.org/show_bug.cgi?id=8173>`_      RESOLVED        Mismatch of v3po yangs between vbd and hc2vpp
80 * `Bug 8354 <https://bugs.opendaylight.org/show_bug.cgi?id=8354>`_      RESOLVED        Feature installs fails if installed in a particular order
81
82
83 Known Issues
84 ------------
85
86 * Due to yang updates for keeping VPP Rendering compatible with the latest
87   stable for VPP, 17.04, we are not going to be compatible with previous stable
88   VPPs. This, on the other hand, comes with a lot of augmentations of features.
89
90 End-of-life
91 ===========
92
93 * N/A
94
95 Standards
96 =========
97
98 * N/A
99
100 Release Mechanics
101 =================
102
103 * `Release plan <https://wiki.opendaylight.org/view/Honeycomb/VBD/Carbon/Release_Plan>`_
104 * no major shifts from official release plan