Fix “Is is” typo
[docs.git] / docs / getting-started-guide / project-release-notes / odlparent.rst
1 ==========
2 ODL Parent
3 ==========
4
5 Major Features
6 ==============
7
8 There are no user-visible features.
9
10 Documentation
11 =============
12
13 * **Developer Guide(s):**
14
15   * :ref:`odl-parent-developer-guide`
16
17 Security Considerations
18 =======================
19
20 * Do you have any external interfaces other than RESTCONF?
21
22   No
23
24 * Other security issues?
25
26   No
27
28 Quality Assurance
29 =================
30
31 * `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=23179>`_ (6.9% coverage)
32 * There are no CSIT jobs, ODL Parent has a system test waiver
33 * ODL Parent is tested by all builds, and manually tested by running the basic
34   Karaf container and verifying the scripts we modify (``client`` in
35   particular).
36 * We verify the following:
37
38   * ``start`` starts the Karaf container.
39     (in a working state, capable of installing features)
40   * ``client`` can connect to a running Karaf container.
41   * ``stop`` stops a running Karaf container.
42
43 Migration
44 ---------
45
46 * Is it possible to migrate from the previous release? If so, how?
47
48   Yes. There are no specific migration aspects related to ODL Parent.
49
50 Compatibility
51 -------------
52
53 * Is this release compatible with the previous release?
54
55   Yes.
56
57 * Any API changes?
58
59   Yes, but they are backwards-compatible.
60
61 * Any configuration changes?
62
63   No. ODL Parent has no user-visible configuration.
64
65 Bugs Fixed
66 ----------
67
68 * `6236: Code generation performance optimization required in YangTemplate <https://bugs.opendaylight.org/show_bug.cgi?id=6236>`_
69 * `6523: RuntimeException at MethodVisitor.visitParameter <https://bugs.opendaylight.org/show_bug.cgi?id=6523>`_
70 * `6790: Karaf ssh EOFError <https://bugs.opendaylight.org/show_bug.cgi?id=6790>`_
71 * `7537: Add git.properties <https://bugs.opendaylight.org/show_bug.cgi?id=7537>`_
72 * `7745: Port already in use: 1099 <https://bugs.opendaylight.org/show_bug.cgi?id=7745>`_
73 * `7813: Karaf: do not package Spring <https://bugs.opendaylight.org/show_bug.cgi?id=7813>`_
74
75 Known Issues
76 ------------
77
78 * The Karaf 4 distribution doesn’t work; the workaround is to use Karaf 3 for Carbon.
79 * `Link to Open Bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=UNCONFIRMED&bug_status=CONFIRMED&bug_status=IN_PROGRESS&bug_status=WAITING_FOR_REVIEW&product=odlparent>`_
80
81 End-of-life
82 ===========
83
84 * All the Karaf 3 features are deprecated and will be removed in Nitrogen.
85
86 Standards
87 =========
88
89 * N/A.
90
91 Release Mechanics
92 =================
93
94 * `Link to release plan <https://wiki.opendaylight.org/view/ODL_Parent:Carbon_Release_Plan>`_
95 * We failed to implement the switch to Karaf 4; this has been postponed to Nitrogen.