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