Unimgr M2 readout
[docs.git] / docs / release-process / milestone-readouts / m2 / genius.rst
1 ======
2 Genius
3 ======
4
5 Please provide updates on any previously-incomplete items from prior milestone
6 readouts.  NA
7
8 Functionality Freeze:
9 ---------------------
10
11 1. Final list of externally consumable APIs defined: Yes
12
13    Updates to mdsalutil-api module:
14
15    - Following utility classes are removed:
16
17      - ClusteringUtils
18      - EntityOwnerUtils
19
20    - Above utility classes are replaced by following new class:
21
22      - EntityOwnershipUtils
23
24    Updates to ITM api:
25
26    - Additional new RPCs will be added by ITM scale improvements:
27
28      - itm-rpc:get-egress-action
29      - itm-rpc:set-bfd-enable-on-tunnel
30
31    - Link to gerrit review for spec:
32
33      - https://git.opendaylight.org/gerrit/#/c/65809/
34
35 2. Are all your inter-project dependencies resolved (i.e., have the other
36    projects you were counting on given you what you needed)? Yes
37
38 3. Were there any project-specific deliverables planned for this milestone? No
39
40
41 Karaf Features Defined:
42 -----------------------
43
44 1. Are all your project's features that are intended for release added to the
45    features.xml and checked into integration git repository? Yes
46
47    - https://git.opendaylight.org/gerrit/gitweb?p=genius.git;a=blob_plain;f=features/genius-features/pom.xml
48    - https://git.opendaylight.org/gerrit/gitweb?p=integration/distribution.git;a=blob;f=features/repos/index/pom.xml;h=d9dbcafaed73ad39695a25a06e4e8f0ceb79b904;hb=HEAD
49
50
51 2. List all top-level, user-facing, and stable Karaf features for your project.
52
53    * **odl-genius** : This feature provides all functionalities provided by
54      genius modules, including interface manager, tunnel manager, resource manager
55      and ID manager and MDSAL Utils. It includes Genius APIs and implementation.
56
57    * **odl-genius-rest** : This feature includes RESTCONF with 'odl-genius'
58      feature.
59
60    * **odl-genius-api** : This feature includes API for all the functionalities
61      provided by Genius.
62
63    * **odl-genius-fcaps-application** : includes Genius FCAPS application.
64
65    * **odl-genius-fcaps-framework** : includes Genius FCAPS Framework.
66
67 Documentation:
68 --------------
69
70 1. List the kinds of documentation you will provide including at least:
71
72    - One user/operator guide section per user-facing feature.
73
74      - https://wiki.opendaylight.org/view/Genius_:_An_Overview
75      - https://wiki.opendaylight.org/view/Genius:_User_Guide
76    - One developer guide per top-level feature.
77
78      - http://docs.opendaylight.org/en/latest/submodules/genius/docs/index.html
79
80    - An installation guide for any top-level features that require more than
81      feature:install <feature-name> to install. --N/A
82
83    - Release notes (mandatory) [2]_.
84
85    - Optional tutorials and how-tos.
86
87 2. Have you checked in a reStructuredText outline to the docs repository? Yes
88
89    - Link to gerrit patch:
90
91      - https://git.opendaylight.org/gerrit/#/c/53072/
92
93 Integration and Test:
94 ---------------------
95
96 1. Have you started automated system testing for your top-level features? Yes
97
98    - https://jenkins.opendaylight.org/releng/view/genius/
99
100    - Link to test report:
101
102      - https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-upstream-all-oxygen/
103      - https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-3node-upstream-all-oxygen/
104
105 2. Have you filled out basic system test plan template for each top-level
106    feature (karaf and not karaf) and a comprehensive system test plan template
107    including functionality, cluster, scalability, performance,
108    longevity/stability for each stable feature? Yes
109
110    - Link to test plans:
111
112      - https://wiki.opendaylight.org/view/Genius:test_plan
113
114 Project Specific:
115 -----------------
116
117 1. Were there any project-specific deliverables planned for this milestone? No
118
119 2. Have you updated your project facts with the project type category? Yes
120
121 3. Do you acknowledge the changes to the RC Blocking Bug Policy [3]_? Yes
122
123 .. [1] Note that you can only reasonably hold a project to something if you
124        formally asked for it during the release planning process and the project
125        team members acknowledged that ask saying they would do it.
126 .. [2] Release notes must be updated prior to a major release. It is a good idea
127        to keep release notes as a living document when significant changes are
128        made.
129 .. [3] https://lists.opendaylight.org/pipermail/tsc/2016-December/006468.html
130