Merge "Late updates on integration deployment"
[oam.git] / docs / release-notes.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. SPDX-License-Identifier: CC-BY-4.0
3 .. Copyright (C) 2021 highstreet technologies GmbH
4
5
6 Operation and Maintenance Release Notes
7 =======================================
8
9 This document provides the release notes for O-RAN-SC D-Release of the Operation and Maintenance (OAM) project.
10
11 A collection of release notes for used projects is available in `O-RAN-SC OAM wiki release notes <https://wiki.o-ran-sc.org/display/OAM/E-Release+Notes>`__.
12
13 Version 5.0.0, 2021-11-29 
14 -------------------------
15
16 +---------------------------------------------------------+---------------------------------------------------------------------------------+
17 | Issue                                                   | Summary                                                                         |
18 +=========================================================+=================================================================================+
19 | `OAM-221  <https://jira.o-ran-sc.org/browse/OAM-221>`__ | Wrong value format in measurement ves example                                   |
20 +---------------------------------------------------------+---------------------------------------------------------------------------------+
21 | `OAM-222  <https://jira.o-ran-sc.org/browse/OAM-222>`__ | OAM Deployment enhancements                                                     |
22 +---------------------------------------------------------+---------------------------------------------------------------------------------+
23 | `OAM-223  <https://jira.o-ran-sc.org/browse/OAM-223>`__ | update from stating to released                                                 |
24 +---------------------------------------------------------+---------------------------------------------------------------------------------+
25 | `OAM-226  <https://jira.o-ran-sc.org/browse/OAM-226>`__ | Create yang model for CM according to the requirements by O-DU and the use case |
26 +---------------------------------------------------------+---------------------------------------------------------------------------------+
27 | `OAM-227  <https://jira.o-ran-sc.org/browse/OAM-227>`__ | Create VES stndDefined extension for PM-streaming                               |
28 +---------------------------------------------------------+---------------------------------------------------------------------------------+
29 | `OAM-228  <https://jira.o-ran-sc.org/browse/OAM-228>`__ | Update O-RAN-SC-Du Hello-world yang for CM                                      |
30 +---------------------------------------------------------+---------------------------------------------------------------------------------+
31 | `OAM-229  <https://jira.o-ran-sc.org/browse/OAM-229>`__ | Update header of o-ran-sc-du-hello-world                                        |
32 +---------------------------------------------------------+---------------------------------------------------------------------------------+
33 | `OAM-230  <https://jira.o-ran-sc.org/browse/OAM-230>`__ | Consider CM in o-ran-sc-du-hello-world.yang                                     |
34 +---------------------------------------------------------+---------------------------------------------------------------------------------+
35 | `OAM-231  <https://jira.o-ran-sc.org/browse/OAM-231>`__ | Add slice management to o-ran-sc-du-hello-world.yang                            |
36 +---------------------------------------------------------+---------------------------------------------------------------------------------+
37 | `OAM-232  <https://jira.o-ran-sc.org/browse/OAM-232>`__ | Add performance measurement job management to o-ran-sc-du-hello-world.yang      |
38 +---------------------------------------------------------+---------------------------------------------------------------------------------+
39 | `OAM-233  <https://jira.o-ran-sc.org/browse/OAM-233>`__ | Add subscription management to o-ran-sc-du-hello-world.yang                     |
40 +---------------------------------------------------------+---------------------------------------------------------------------------------+
41 | `OAM-234  <https://jira.o-ran-sc.org/browse/OAM-234>`__ | Create VES stndDefined PM streaming OpenAPI                                     |
42 +---------------------------------------------------------+---------------------------------------------------------------------------------+
43 | `OAM-235  <https://jira.o-ran-sc.org/browse/OAM-235>`__ | Create a Yang notification syntax                                               |
44 +---------------------------------------------------------+---------------------------------------------------------------------------------+
45 | `OAM-237  <https://jira.o-ran-sc.org/browse/OAM-237>`__ | Bug fixes in o-ran-sc-du-hello-world yang                                       |
46 +---------------------------------------------------------+---------------------------------------------------------------------------------+
47 | `OAM-238  <https://jira.o-ran-sc.org/browse/OAM-238>`__ | Update O-RAN-SC wiki release page                                               |
48 +---------------------------------------------------------+---------------------------------------------------------------------------------+
49
50
51 Version 4.0.4, 2021-05-22 
52 -------------------------
53
54 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
55 | Issue                                                              | Summary                                                                 |
56 +====================================================================+=========================================================================+
57 | `OAM-177     <https://jira.o-ran-sc.org/browse/OAM-177>`__         | Update Documentation for docker supporting IPv6                         |
58 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
59 | `OAM-188     <https://jira.o-ran-sc.org/browse/OAM-188>`__         | Provide OpenAPI                                                         |
60 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
61 | `OAM-191     <https://jira.o-ran-sc.org/browse/OAM-191>`__         | O-RU on-boarding                                                        |
62 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
63 | `OAM-192     <https://jira.o-ran-sc.org/browse/OAM-192>`__         | O-DU on-boarding                                                        |
64 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
65 | `OAM-193     <https://jira.o-ran-sc.org/browse/OAM-192>`__         | Test environment                                                        |
66 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
67 | `OAM-194     <https://jira.o-ran-sc.org/browse/OAM-194>`__         | O-RU closed loop recovery                                               |
68 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
69 | `OAM-195     <https://jira.o-ran-sc.org/browse/OAM-195>`__         | Documentation                                                           |
70 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
71 | `OAM-212     <https://jira.o-ran-sc.org/browse/OAM-212>`__         | Add section referencing O-RAN specifications                            |
72 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
73 | `OAM-213     <https://jira.o-ran-sc.org/browse/OAM-213>`__         | Update Deployment docs                                                  |
74 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
75
76 Version 4.0.3, 2021-04-23 
77 -------------------------
78
79 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
80 | Issue                                                              | Summary                                                                 |
81 +====================================================================+=========================================================================+
82 | `OAM-150     <https://jira.o-ran-sc.org/browse/OAM-150>`__         | Provide settings.xml                                                    |
83 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
84 | `OAM-171     <https://jira.o-ran-sc.org/browse/OAM-171>`__         | Update docs OAM architecture diagram                                    |
85 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
86 | `OAM-178     <https://jira.o-ran-sc.org/browse/OAM-178>`__         | Creation of use case docker-compose                                     |
87 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
88 | `OAM-179     <https://jira.o-ran-sc.org/browse/OAM-179>`__         | Remove unused folders                                                   |
89 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
90 | `OAM-181     <https://jira.o-ran-sc.org/browse/OAM-181>`__         | Update docker-compose to onap-sdnc:2.1.3                                |
91 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
92 | `OAM-182     <https://jira.o-ran-sc.org/browse/OAM-182>`__         | Create dev example for additional ves domains                           |
93 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
94 | `OAM-183     <https://jira.o-ran-sc.org/browse/OAM-183>`__         | Create VES client example for domain 'notification'                     |
95 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
96 | `OAM-184     <https://jira.o-ran-sc.org/browse/OAM-184>`__         | Create VES client example for domain 'stateChange'                      |
97 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
98 | `OAM-185     <https://jira.o-ran-sc.org/browse/OAM-185>`__         | Create VES client example for domain 'stndefined'                       |
99 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
100 | `OAM-187     <https://jira.o-ran-sc.org/browse/OAM-187>`__         | Update Jenkins Jobs                                                     |
101 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
102 | `OAM-189     <https://jira.o-ran-sc.org/browse/OAM-189>`__         | Remove builder jobs of project oam                                      |
103 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
104
105
106 Version 4.0.3, 2021-04-23 
107 -------------------------
108
109 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
110 | Issue                                                              | Summary                                                                 |
111 +====================================================================+=========================================================================+
112 | `OAM-150     <https://jira.o-ran-sc.org/browse/OAM-150>`__         | Provide settings.xml                                                    |
113 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
114 | `OAM-171     <https://jira.o-ran-sc.org/browse/OAM-171>`__         | Update docs OAM architecture diagram                                    |
115 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
116 | `OAM-178     <https://jira.o-ran-sc.org/browse/OAM-178>`__         | Creation of use case docker-compose                                     |
117 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
118 | `OAM-179     <https://jira.o-ran-sc.org/browse/OAM-179>`__         | Remove unused folders                                                   |
119 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
120 | `OAM-181     <https://jira.o-ran-sc.org/browse/OAM-181>`__         | Update docker-compose to onap-sdnc:2.1.3                                |
121 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
122 | `OAM-182     <https://jira.o-ran-sc.org/browse/OAM-182>`__         | Create dev example for additional ves domains                           |
123 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
124 | `OAM-183     <https://jira.o-ran-sc.org/browse/OAM-183>`__         | Create VES client example for domain 'notification'                     |
125 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
126 | `OAM-184     <https://jira.o-ran-sc.org/browse/OAM-184>`__         | Create VES client example for domain 'stateChange'                      |
127 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
128 | `OAM-185     <https://jira.o-ran-sc.org/browse/OAM-185>`__         | Create VES client example for domain 'stndefined'                       |
129 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
130 | `OAM-187     <https://jira.o-ran-sc.org/browse/OAM-187>`__         | Update Jenkins Jobs                                                     |
131 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
132 | `OAM-189     <https://jira.o-ran-sc.org/browse/OAM-189>`__         | Remove builder jobs of project oam                                      |
133 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
134
135
136 Version 4.0.3, 2021-04-23 
137 -------------------------
138
139 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
140 | Issue                                                              | Summary                                                                 |
141 +====================================================================+=========================================================================+
142 | `OAM-150     <https://jira.o-ran-sc.org/browse/OAM-150>`__         | Provide settings.xml                                                    |
143 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
144 | `OAM-171     <https://jira.o-ran-sc.org/browse/OAM-171>`__         | Update docs OAM architecture diagram                                    |
145 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
146 | `OAM-178     <https://jira.o-ran-sc.org/browse/OAM-178>`__         | Creation of use case docker-compose                                     |
147 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
148 | `OAM-179     <https://jira.o-ran-sc.org/browse/OAM-179>`__         | Remove unused folders                                                   |
149 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
150 | `OAM-181     <https://jira.o-ran-sc.org/browse/OAM-181>`__         | Update docker-compose to onap-sdnc:2.1.3                                |
151 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
152 | `OAM-182     <https://jira.o-ran-sc.org/browse/OAM-182>`__         | Create dev example for additional ves domains                           |
153 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
154 | `OAM-183     <https://jira.o-ran-sc.org/browse/OAM-183>`__         | Create VES client example for domain 'notification'                     |
155 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
156 | `OAM-184     <https://jira.o-ran-sc.org/browse/OAM-184>`__         | Create VES client example for domain 'stateChange'                      |
157 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
158 | `OAM-185     <https://jira.o-ran-sc.org/browse/OAM-185>`__         | Create VES client example for domain 'stndefined'                       |
159 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
160 | `OAM-187     <https://jira.o-ran-sc.org/browse/OAM-187>`__         | Update Jenkins Jobs                                                     |
161 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
162 | `OAM-189     <https://jira.o-ran-sc.org/browse/OAM-189>`__         | Remove builder jobs of project oam                                      |
163 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
164
165
166 Version 4.0.2, 2021-04-02
167 --------------------------
168
169 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
170 | Issue                                                              | Summary                                                                 |
171 +====================================================================+=========================================================================+
172 | `OAM-180     <https://jira.o-ran-sc.org/browse/OAM-180>`__         | Wrong time format in VES client scripts                                 |
173 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
174 | `OAM-176     <https://jira.o-ran-sc.org/browse/OAM-176>`__         | Support of IPv6 by docker-compose                                       |
175 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
176 | `OAM-175     <https://jira.o-ran-sc.org/browse/OAM-175>`__         | Update docker-compose and its configurations                            |
177 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
178 | `OAM-174     <https://jira.o-ran-sc.org/browse/OAM-174>`__         | Update VES Client scripts supporting VES 7.2                            |
179 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
180 | `OAM-173     <https://jira.o-ran-sc.org/browse/OAM-173>`__         | Update VES client scripts supporting https                              |
181 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
182 | `OAM-170     <https://jira.o-ran-sc.org/browse/OAM-170>`__         | Delete folder 'model' from OAM repo'                                    |
183 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
184 | `OAM-169     <https://jira.o-ran-sc.org/browse/OAM-169>`__         | Use case driven yang for O-DU                                           |
185 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
186 | `OAM-168     <https://jira.o-ran-sc.org/browse/OAM-168>`__         | Update namespace definitions in prototype yangs of O-RAN-SC             |
187 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
188 | `OAM-164     <https://jira.o-ran-sc.org/browse/OAM-164>`__         | Add WG4 november train yangs modules                                    |
189 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
190 | `SDNC-1480   <https://jira.onap.org/browse/SDNC-1480>`__           | O-RAN (FrontHaul) deviceManager: support of GuiCutThrough               |
191 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
192 | `CCSDK-3161  <https://jira.onap.org/browse/CCSDK-3161>`__          | O-RAN (FrontHaul) deviceManager: o-ran-fm.yang/alarm-notif to VES:fault |
193 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
194 | `CCSDK-3160  <https://jira.onap.org/browse/CCSDK-3160>`__          | CallHome to VES:pnfRegistration                                         |
195 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
196 | `NETCONF-766 <https://jira.opendaylight.org/browse/NETCONF-766>`__ | Logging al RESTCONF requests and responses [1]_                         |
197 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
198 | `NETCONF-744 <https://jira.opendaylight.org/browse/NETCONF-744>`__ | Read whole leaf-list using get/get-config RPC [1]_                      |
199 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
200 | `NETCONF-735 <https://jira.opendaylight.org/browse/NETCONF-735>`__ | Support NETCONF get/get-config with multiple selected subtrees [1]_     |
201 +--------------------------------------------------------------------+-------------------------------------------------------------------------+
202
203 .. [1] Patched via MAVEN repo into CCSDK as long as code is not merged into OpenDaylight master branch
204
205
206 Version 4.0.1, 2021-03-12
207 --------------------------
208
209 +--------------------------------------------------------+-------------------------------------------------------------+
210 | Issue                                                  | Summary                                                     |
211 +========================================================+=============================================================+
212 | `OAM-166 <https://jira.o-ran-sc.org/browse/OAM-166>`__ | Add WG4 July 2020 yang modules                              |
213 +--------------------------------------------------------+-------------------------------------------------------------+
214 | `OAM-163 <https://jira.o-ran-sc.org/browse/OAM-163>`__ | Rename yang filename to <module>@<revision> format          |
215 +--------------------------------------------------------+-------------------------------------------------------------+
216 | `OAM-160 <https://jira.o-ran-sc.org/browse/OAM-160>`__ | Modeling Repo: SIM directory not longer required            |
217 +--------------------------------------------------------+-------------------------------------------------------------+
218 | `OAM-159 <https://jira.o-ran-sc.org/browse/OAM-159>`__ | Remove yang models from Repo                                |
219 +--------------------------------------------------------+-------------------------------------------------------------+
220 | `OAM-154 <https://jira.o-ran-sc.org/browse/OAM-154>`__ | OAM tr069: Changing .gitignore for IntelliJ related files   |
221 +--------------------------------------------------------+-------------------------------------------------------------+
222 | `OAM-121 <https://jira.o-ran-sc.org/browse/OAM-121>`__ | Request to modify SMO deployment SOP                        |
223 +--------------------------------------------------------+-------------------------------------------------------------+
224 | `OAM-120 <https://jira.o-ran-sc.org/browse/OAM-120>`__ | Release dashboard image at version 2.0.3                    |
225 +--------------------------------------------------------+-------------------------------------------------------------+
226
227 Version 2.0.4, 2020-06-13
228 --------------------------
229
230 * Documentation updated
231 * Develop reusable OAM API such that the first consumer being a VTH can query, subscribe or publish on a DMaaP topic    Story
232 * Create helm deployment for SMO
233 * Feature split for starting devicemanagers
234 * Seed coder for an YANG linter
235 * Please see also Release Notes of `ONAP SDNC, DCAE, DMaaP, OOM <https://onap-doc.readthedocs.io/en/frankfurt/release/index.html>`_
236
237 Version 2.0.3, 2020-04-08
238 -------------------------
239
240 * What is an SMO?
241 * Provide xRAN datamodels
242 * Provide curl bash scripts for Software Management
243 * Add jenkins jobs for oam
244 * Add parents to model artifacts
245 * Add top level pom file to distribution
246 * Wrong image tag in nonrt-o1-controller distribution pom
247 * Use ONAP release parents directly
248 * Adjust artifact group name to ORAN naming rule
249 * Use ORAN parents
250 * Add push registry to distribution pom
251
252 Version 2.0.2, 2020-03-16
253 -------------------------
254
255 * Controller DeviceManager for O-RAN-SC
256 * Provide O1 yang modules
257
258 Version 2.0.1, 2020-02-26
259 -------------------------
260
261 * Develop VTH for A1 interface
262
263
264 Version 1.0.0, 2019-11-14
265 -------------------------
266
267 * Documentation added
268
269
270 Version 0.1.1, 2019-09-18
271 -------------------------
272
273 * Development environment added
274
275
276 Version 0.1.0, 2019-09-08
277 -------------------------
278 * Initial version