FaaS: Add M2 and M3 status
[docs.git] / docs / release-process / milestone-readouts / m2 / ovsdb.rst
1 =====
2 OVSDB
3 =====
4
5 Please provide updates on any previously-incomplete items from prior milestone
6 readouts.
7 None
8
9 Functionality Freeze:
10 ---------------------
11
12 1. Final list of externally consumable APIs defined: Yes
13
14    - If you had Tentative APIs, have they been moved to Provisional or dropped? No
15
16    - If any of your Tentative APIs were dropped, have you notified all projects
17      that were expecting them? No API dropped.
18    - Also please list all dropped APIs. - None
19
20 2. Are all your inter-project dependencies resolved (i.e., have the other
21    projects you were counting on given you what you needed)? Yes
22
23 3. Were there any project-specific deliverables planned for this milestone? Yes (Mainly Bug Fixes)
24
25    - If so, were they delivered? Yes
26
27 Karaf Features Defined:
28 -----------------------
29
30 1. Are all your project's features that are intended for release added to the
31    features.xml and checked into integration git repository? Yes
32
33    - `Existing Features <https://git.opendaylight.org/gerrit/gitweb?p=ovsdb.git;a=tree;f=southbound/southbound-features;h=99e3dbd349e18886312a82db325f54ae2fb70ac6;hb=HEAD>`_
34
35 2. List all top-level, user-facing, and stable Karaf features for your project.
36
37    - **OVSDB Southbound Plugin**:
38
39      * **odl-ovsdb-southbound-api**: User should install this feature if they want to load the yang models expose by the plugin and want to write their own plugin implementation.
40      * **odl-ovsdb-southbound-impl** : User should install this feature if they want to consume plugin using the java bindings.
41      * **odl-ovsdb-southbound-impl-rest**: User should install this feature if they want to write application that consume plugin using java binding as well as rest interface.
42      * **odl-ovsdb-southbound-impl-ui**: User should install this feature if they want to use bindings provided by odl-ovsdb-southbound-impl-rest and also want to load the Dlux GUI.
43
44    - **OVSDB Hardware vTEP Plugin**:
45
46      * **odl-ovsdb-hwvtepsouthbound-api**: User should install this feature if they want to load the yang models expose by the plugin and want to write their own plugin implementation.
47      * **odl-ovsdb-hwvtepsouthbound** : User should install this feature if they want to consume plugin using the java bindings.
48      * **odl-ovsdb-hwvtepsouthbound-rest**: User should install this feature if they want to write application that consume plugin using java binding as well as rest interface.
49      * **odl-ovsdb-hwvtepsouthbound-ui**: User should install this feature if they want to use bindings provided by odl-ovsdb-hwvtepsouthbound-rest and also want to load the dlux GUI.
50
51 Documentation:
52 --------------
53
54 1. List the kinds of documentation you will provide including at least:
55
56    * **User Guide(s):**
57
58      * :doc:`OVSDB User Guide <../../../user-guide/ovsdb-user-guide>`
59
60    * **Developer Guide(s):**
61
62      * :doc:`OVSDB Developer Guide <../../../developer-guide/ovsdb-developer-guide>`
63
64    * Release notes
65
66 2. Have you checked in a reStructuredText outline to the docs repository? Yes
67
68    - `Docs module <https://git.opendaylight.org/gerrit/gitweb?p=ovsdb.git;a=tree;f=docs;h=5369a85700cc02e8a9945fa7b1b0926c0f6e295f;hb=HEAD>`_
69
70 Integration and Test:
71 ---------------------
72
73 1. Have you started automated system testing for your top-level features? Yes
74
75    - ` CSIT Tests <https://jenkins.opendaylight.org/releng/view/ovsdb/>`_
76
77 2. Have you filled out basic system test plan template for each top-level
78    feature (karaf and not karaf) and a comprehensive system test plan template
79    including functionality, cluster, scalability, performance,
80    longevity/stability for each stable feature? No
81
82    - Not done yet, will be available by M3
83
84 3. Have you integrated odlparent 3 / yangtools 2? No
85
86 Project Specific:
87 -----------------
88
89 1. Were there any project-specific deliverables planned for this milestone? Yes (Mostly bug fixing)
90
91 2. Have you updated your project facts with the project type category? Yes
92
93 3. Do you acknowledge the changes to the RC Blocking Bug Policy [3]_? Yes
94
95 .. [1] Note that you can only reasonably hold a project to something if you
96        formally asked for it during the release planning process and the project
97        team members acknowledged that ask saying they would do it.
98 .. [2] Release notes must be updated prior to a major release. It is a good idea
99        to keep release notes as a living document when significant changes are
100        made.
101 .. [3] https://lists.opendaylight.org/pipermail/tsc/2016-December/006468.html