bae207065e9670764fffc5b0565f8b0f0bd256fc
[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.4% 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. Migration to this release involves migrating features to Karaf 4; see
49   `the wiki <https://wiki.opendaylight.org/view/Karaf_4_migration>`_ for details.
50
51 Compatibility
52 -------------
53
54 * Is this release compatible with the previous release?
55
56   No.
57
58 * Any API changes?
59
60   All Karaf 3 features have been removed in favour of (compatible) Karaf 4 features.
61
62 * Any configuration changes?
63
64   No. ODL Parent has no user-visible configuration.
65
66 Bugs Fixed
67 ----------
68
69 * `4219: Milestone: Upgrade karaf to 4.0.1 or later <https://bugs.opendaylight.org/show_bug.cgi?id=4219>`_
70 * `6278: karaf-parent belongs in odlparent <https://bugs.opendaylight.org/show_bug.cgi?id=6278>`_
71 * `6523: org.osgi.service.blueprint.container.ComponentDefinitionException Caused by: java.lang.RuntimeException at org.objectweb.asm.MethodVisitor.visitParameter <https://bugs.opendaylight.org/show_bug.cgi?id=6523>`_
72 * `6652: Migrate to karaf-maven-plugin features generation <https://bugs.opendaylight.org/show_bug.cgi?id=6652>`_
73 * `6709: Migrate dependent projects off opendaylight-karaf-empty <https://bugs.opendaylight.org/show_bug.cgi?id=6709>`_
74 * `6730: Upgrade shiro to current compatible release <https://bugs.opendaylight.org/show_bug.cgi?id=6730>`_
75 * `7446: Milestone: upgrade to guava-22 <https://bugs.opendaylight.org/show_bug.cgi?id=7446>`_
76 * `7813: karaf: do not package spring<https://bugs.opendaylight.org/show_bug.cgi?id=7813>`_
77
78 Known Issues
79 ------------
80
81 * `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>`_
82
83 End-of-life
84 ===========
85
86 * N/A.
87
88 Standards
89 =========
90
91 * N/A.
92
93 Release Mechanics
94 =================
95
96 * `Link to release plan <https://wiki.opendaylight.org/view/ODL_Parent:Nitrogen_Release_Plan>`_