Gitiles
Code Review Sign In
gerrit.nordix.org / onap / cps / dba2b10e83c3c1761da474c8d323e069760886a2 / . / docs / release-notes.rst
blob: 602415a324ced5137007e5e20bd146e7af8c29f6 [file] [log] [blame]
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
JosephKeenane0643ab2022-02-15 18:23:05 +0000[diff] [blame]3.. Copyright (C) 2021-2022 Nordix Foundation
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]4
5.. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
6.. _release_notes:
7
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]8CPS Release Notes
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400[diff] [blame]9#################
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]10
11.. contents::
12 :depth: 2
13..
14
lukegleeson3be99242022-10-11 14:34:56 +0100[diff] [blame]15.. ======================
16.. * * * LONDON * * *
17.. ======================
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]18
lukegleeson3be99242022-10-11 14:34:56 +0100[diff] [blame]19Version: 3.2.0 (not yet released)
mpriyank4bd450e2022-10-05 09:50:59 +0100[diff] [blame]20=================================
21
22Release Data
23------------
24
25+--------------------------------------+--------------------------------------------------------+
26| **CPS Project** | |
27| | |
28+--------------------------------------+--------------------------------------------------------+
lukegleeson3be99242022-10-11 14:34:56 +0100[diff] [blame]29| **Docker images** | onap/cps-and-ncmp:3.2.0 |
mpriyank4bd450e2022-10-05 09:50:59 +0100[diff] [blame]30| | |
31+--------------------------------------+--------------------------------------------------------+
lukegleeson3be99242022-10-11 14:34:56 +0100[diff] [blame]32| **Release designation** | 3.2.0 London |
mpriyank4bd450e2022-10-05 09:50:59 +0100[diff] [blame]33| | |
34+--------------------------------------+--------------------------------------------------------+
35| **Release date** | (not yet released) |
36| | |
37+--------------------------------------+--------------------------------------------------------+
lukegleeson3be99242022-10-11 14:34:56 +0100[diff] [blame]38Features
39--------
40 - `CPS-1185 <https://jira.onap.org/browse/CPS-1185>`_ Get all dataspaces
41 - `CPS-1186 <https://jira.onap.org/browse/CPS-1186>`_ Get all schema sets for a dataspace
42 - `CPS-1187 <https://jira.onap.org/browse/CPS-1187>`_ Get single dataspace
43 - `CPS-1189 <https://jira.onap.org/browse/CPS-1189>`_ Various create endpoints should return 201 response with empty body
mpriyank4bd450e2022-10-05 09:50:59 +0100[diff] [blame]44
45Bug Fixes
46---------
lukegleeson984d1f22022-10-04 16:07:37 +0100[diff] [blame]47 - `CPS-1312 <https://jira.onap.org/browse/CPS-1312>`_ CPS(/NCMP) does not have version control
mpriyank4bd450e2022-10-05 09:50:59 +0100[diff] [blame]48
lukegleeson3be99242022-10-11 14:34:56 +0100[diff] [blame]49Known Limitations, Issues and Workarounds
50-----------------------------------------
51
52*System Limitations*
53
seanbeirne72c267e2022-10-18 12:39:22 +0100[diff] [blame]54For upgrading, CPS uses Liquibase for database upgrades. CPS/NCMP currently only supports upgrading from Liquibase changelog 11 to Liquibase changelog 16.
55This is from commit CPS-506: List all known modules and revision to CPS-1312: Default CMHandles to READY during upgrade or from ONAP release Honolulu to Kohn.
lukegleeson3be99242022-10-11 14:34:56 +0100[diff] [blame]56
seanbeirnedba2b102022-10-27 09:59:17 +0100[diff] [blame^]57.. ====================
58.. * * * KOHN * * *
59.. ====================
60
mpriyankfe775312022-09-30 14:16:51 +0100[diff] [blame]61Version: 3.1.4
62==============
63
64Release Data
65------------
66
67+--------------------------------------+--------------------------------------------------------+
68| **CPS Project** | |
69| | |
70+--------------------------------------+--------------------------------------------------------+
71| **Docker images** | onap/cps-and-ncmp:3.1.4 |
72| | |
73+--------------------------------------+--------------------------------------------------------+
74| **Release designation** | 3.1.4 Kohn |
75| | |
76+--------------------------------------+--------------------------------------------------------+
mpriyank4bd450e2022-10-05 09:50:59 +0100[diff] [blame]77| **Release date** | 2022 October 5 |
mpriyankfe775312022-09-30 14:16:51 +0100[diff] [blame]78| | |
79+--------------------------------------+--------------------------------------------------------+
80
81Bug Fixes
82---------
lukegleeson8c6b5622022-09-29 15:58:06 +0100[diff] [blame]83 - `CPS-1265 <https://jira.onap.org/browse/CPS-1265>`_ Revision field should not be required (NotNull) on cps-ri YangResourceEntity
mpriyankac0bffc2022-10-03 12:26:10 +0100[diff] [blame]84 - `CPS-1294 <https://jira.onap.org/browse/CPS-1294>`_ Kafka communication fault caused cmHandle registration error
mpriyankfe775312022-09-30 14:16:51 +0100[diff] [blame]85
mpriyank06736cb2022-09-29 14:29:40 +0100[diff] [blame]86Version: 3.1.3
87==============
88
89Release Data
90------------
91
92+--------------------------------------+--------------------------------------------------------+
93| **CPS Project** | |
94| | |
95+--------------------------------------+--------------------------------------------------------+
96| **Docker images** | onap/cps-and-ncmp:3.1.3 |
97| | |
98+--------------------------------------+--------------------------------------------------------+
99| **Release designation** | 3.1.3 Kohn |
100| | |
101+--------------------------------------+--------------------------------------------------------+
mpriyankfe775312022-09-30 14:16:51 +0100[diff] [blame]102| **Release date** | 2022 September 29 |
mpriyank06736cb2022-09-29 14:29:40 +0100[diff] [blame]103| | |
104+--------------------------------------+--------------------------------------------------------+
105
106Bug Fixes
107---------
108 - None
109
mpriyankef0ddfc2022-09-28 12:19:34 +0100[diff] [blame]110Version: 3.1.2
111==============
112
113Release Data
114------------
115
116+--------------------------------------+--------------------------------------------------------+
117| **CPS Project** | |
118| | |
119+--------------------------------------+--------------------------------------------------------+
120| **Docker images** | onap/cps-and-ncmp:3.1.2 |
121| | |
122+--------------------------------------+--------------------------------------------------------+
123| **Release designation** | 3.1.2 Kohn |
124| | |
125+--------------------------------------+--------------------------------------------------------+
mpriyank06736cb2022-09-29 14:29:40 +0100[diff] [blame]126| **Release date** | 2022 September 28 |
mpriyankef0ddfc2022-09-28 12:19:34 +0100[diff] [blame]127| | |
128+--------------------------------------+--------------------------------------------------------+
129
130Bug Fixes
131---------
132 - None
133
mpriyanka3f43502022-09-26 14:57:01 +0100[diff] [blame]134Version: 3.1.1
135==============
136
137Release Data
138------------
139
140+--------------------------------------+--------------------------------------------------------+
141| **CPS Project** | |
142| | |
143+--------------------------------------+--------------------------------------------------------+
144| **Docker images** | onap/cps-and-ncmp:3.1.1 |
145| | |
146+--------------------------------------+--------------------------------------------------------+
147| **Release designation** | 3.1.1 Kohn |
148| | |
149+--------------------------------------+--------------------------------------------------------+
mpriyankef0ddfc2022-09-28 12:19:34 +0100[diff] [blame]150| **Release date** | 2022 September 28 |
mpriyanka3f43502022-09-26 14:57:01 +0100[diff] [blame]151| | |
152+--------------------------------------+--------------------------------------------------------+
153
154Bug Fixes
155---------
156 - None
157
lukegleesonc9ec9152022-09-07 14:21:36 +0100[diff] [blame]158Security Notes
159--------------
160
161*Fixed Security Issues*
162
163 - `CPS-1226 <https://jira.onap.org/browse/CPS-1226>`_ Security bug in the logs
164
lukegleeson4a34fa52022-09-19 15:31:59 +0100[diff] [blame]165Version: 3.1.0
166==============
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400[diff] [blame]167
168Release Data
169------------
170
DylanB95ESTb130fd32022-04-04 13:09:22 +0100[diff] [blame]171+--------------------------------------+--------------------------------------------------------+
172| **CPS Project** | |
173| | |
174+--------------------------------------+--------------------------------------------------------+
175| **Docker images** | onap/cps-and-ncmp:3.1.0 |
176| | |
177+--------------------------------------+--------------------------------------------------------+
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400[diff] [blame]178| **Release designation** | 3.1.0 Kohn |
DylanB95ESTb130fd32022-04-04 13:09:22 +0100[diff] [blame]179| | |
180+--------------------------------------+--------------------------------------------------------+
lukegleeson4a34fa52022-09-19 15:31:59 +0100[diff] [blame]181| **Release date** | 2022 September 14 |
DylanB95ESTb130fd32022-04-04 13:09:22 +0100[diff] [blame]182| | |
183+--------------------------------------+--------------------------------------------------------+
184
185Features
186--------
lukegleeson4a34fa52022-09-19 15:31:59 +0100[diff] [blame]187 - `CPS-340 <https://jira.onap.org/browse/CPS-340>`_ Patch and update the root data node
188 - `CPS-575 <https://jira.onap.org/browse/CPS-575>`_ Write data for cmHandle using ncmp-datastores:passthrough-running (NCMP.)
189 - `CPS-731 <https://jira.onap.org/browse/CPS-731>`_ Query based on Public CM Properties
190 - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_ Async: NCMP Rest impl. including Request ID generation
191 - `CPS-829 <https://jira.onap.org/browse/CPS-829>`_ Async: Internal message topic incl. basic producer & Consumer
192 - `CPS-830 <https://jira.onap.org/browse/CPS-830>`_ DMI-NCMP Asynchronously Publish Response Event to Client Topic
193 - `CPS-869 <https://jira.onap.org/browse/CPS-869>`_ Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072
194 - `CPS-870 <https://jira.onap.org/browse/CPS-870>`_ Align CPS-Core output with SDN-C output (add module name)
195 - `CPS-875 <https://jira.onap.org/browse/CPS-875>`_ CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles
196 - `CPS-877 <https://jira.onap.org/browse/CPS-877>`_ CM Handle State: Exclude any CM-Handles from queries/operations that are not in state 'READY'
197 - `CPS-899 <https://jira.onap.org/browse/CPS-899>`_ Start and stop sessions on Java API
198 - `CPS-909 <https://jira.onap.org/browse/CPS-909>`_ Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state
199 - `CPS-917 <https://jira.onap.org/browse/CPS-917>`_ Structured Errors response for passthrough use-cases in NCMP
200 - `CPS-953 <https://jira.onap.org/browse/CPS-953>`_ Update maven deploy plugin version
201 - `CPS-977 <https://jira.onap.org/browse/CPS-977>`_ Query CM Handles using CpsPath
202 - `CPS-1000 <https://jira.onap.org/browse/CPS-1000>`_ Create Data Synchronization watchdog
203 - `CPS-1016 <https://jira.onap.org/browse/CPS-1016>`_ Merge 2 'query' end points in NCMP
204 - `CPS-1034 <https://jira.onap.org/browse/CPS-1034>`_ Publish lifecycle events for ADVISED , READY and LOCKED state transition"
205 - `CPS-1064 <https://jira.onap.org/browse/CPS-1064>`_ Support retrieval of YANG module sources for CM handle on the NCMP interface
206 - `CPS-1099 <https://jira.onap.org/browse/CPS-1099>`_ Expose simplified 'external' lock reason enum state over REST interface
207 - `CPS-1101 <https://jira.onap.org/browse/CPS-1101>`_ Introducing the DELETING and DELETED Cmhandle State
208 - `CPS-1102 <https://jira.onap.org/browse/CPS-1102>`_ Register the Cmhandle Sends Advised State notification.
209 - `CPS-1133 <https://jira.onap.org/browse/CPS-1133>`_ Enable/Disable Data Sync for Cm Handle
210 - `CPS-1136 <https://jira.onap.org/browse/CPS-1136>`_ DMI Audit Support (get all CM Handles for a registered DMI)
211
emacleeafb17362022-09-02 14:40:17 +0100[diff] [blame]212
213Bug Fixes
214---------
lukegleeson4a34fa52022-09-19 15:31:59 +0100[diff] [blame]215 - `CPS-896 <https://jira.onap.org/browse/CPS-896>`_ CM Handle Registration Process only partially completes when exception is thrown
216 - `CPS-957 <https://jira.onap.org/browse/CPS-957>`_ NCMP: fix getResourceDataForPassthroughOperational endpoint
217 - `CPS-1020 <https://jira.onap.org/browse/CPS-1020>`_ DuplicatedYangResourceException error at parallel cmHandle registration
218 - `CPS-1056 <https://jira.onap.org/browse/CPS-1056>`_ Wrong error response format in case of Dmi plugin error
219 - `CPS-1067 <https://jira.onap.org/browse/CPS-1067>`_ NCMP returns 500 error on searches endpoint when No DMi Handles registered
220 - `CPS-1085 <https://jira.onap.org/browse/CPS-1085>`_ Performance degradation on ncmp/v1/ch/searches endpoint
221 - `CPS-1088 <https://jira.onap.org/browse/CPS-1088>`_ Kafka consumer can not be turned off
222 - `CPS-1097 <https://jira.onap.org/browse/CPS-1097>`_ Unable to change state from LOCKED to ADVISED
223 - `CPS-1126 <https://jira.onap.org/browse/CPS-1126>`_ CmHandle creation performance degradation
224 - `CPS-1175 <https://jira.onap.org/browse/CPS-1175>`_ Incorrect response when empty body executed for cmhandle id-searches
225 - `CPS-1179 <https://jira.onap.org/browse/CPS-1179>`_ Node API - GET method returns invalid response when identifier contains '/'
226 - `CPS-1212 <https://jira.onap.org/browse/CPS-1212>`_ Additional Properties for CM Handles not included when send to DMI Plugin
227 - `CPS-1217 <https://jira.onap.org/browse/CPS-1217>`_ Searches endpoint gives back empty list however there are already available cmhandles
228 - `CPS-1218 <https://jira.onap.org/browse/CPS-1218>`_ NCMP logs are flooded with SyncUtils logs
puthuparambil.adityadd904322022-09-21 10:53:51 +0100[diff] [blame]229
230Known Limitations, Issues and Workarounds
231-----------------------------------------
232
233*System Limitations*
234
235Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition.
236Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces']
DylanB95ESTb130fd32022-04-04 13:09:22 +0100[diff] [blame]237
lukegleeson4a34fa52022-09-19 15:31:59 +0100[diff] [blame]238*Known Vulnerabilities*
239
240None
241
242*Workarounds*
243
244None
245
246Security Notes
247--------------
248
249*Fixed Security Issues*
250
251 - `CPS-963 <https://jira.onap.org/browse/CPS-963>`_ Liquibase has got serious vulnerability, upgrade required
252
253*Known Security Issues*
254
255None
256
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400[diff] [blame]257.. ========================
258.. * * * JAKARTA * * *
259.. ========================
260
261Version: 3.0.1
262==============
263
264Release Data
265------------
266
267+--------------------------------------+--------------------------------------------------------+
268| **CPS Project** | |
269| | |
270+--------------------------------------+--------------------------------------------------------+
271| **Docker images** | onap/cps-and-ncmp:3.0.1 |
272| | |
273+--------------------------------------+--------------------------------------------------------+
274| **Release designation** | 3.0.1 Jakarta |
275| | |
276+--------------------------------------+--------------------------------------------------------+
277| **Release date** | 2022 April 28 |
278| | |
279+--------------------------------------+--------------------------------------------------------+
280
281Bug Fixes
282---------
283 - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_ Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
284
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400[diff] [blame]285Version: 3.0.0
286==============
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]287
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400[diff] [blame]288Release Data
289------------
290
291+--------------------------------------+--------------------------------------------------------+
292| **CPS Project** | |
293| | |
294+--------------------------------------+--------------------------------------------------------+
295| **Docker images** | onap/cps-and-ncmp:3.0.0 |
296| | |
297+--------------------------------------+--------------------------------------------------------+
298| **Release designation** | 3.0.0 Jakarta |
299| | |
300+--------------------------------------+--------------------------------------------------------+
301| **Release date** | 2022 March 15 |
302| | |
303+--------------------------------------+--------------------------------------------------------+
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]304
305Features
306--------
puthuparambil.adityad0007332021-12-08 18:53:39 +0000[diff] [blame]307 - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_ Define response objects (schemas) in cps-ncmp
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]308 - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_ Update operation for datastore pass through running
309 - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_ Delete operation for datastore pass through running
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame]310 - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_ Support 'public' Cm Handle Properties
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]311 - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
JosephKeenan82ebf532021-12-08 18:16:44 +0000[diff] [blame]312 - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_ Ensure all DMI operations use POST method
puthuparambil.adityad0007332021-12-08 18:53:39 +0000[diff] [blame]313 - `CPS-780 <https://jira.onap.org/browse/CPS-780>`_ Add examples for parameters, request and response in openapi yaml for cps-core
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400[diff] [blame]314 - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
315 - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame]316 - `CPS-817 <https://jira.onap.org/browse/CPS-817>`_ Create Endpoint For Get Cm Handles (incl. public properties) By Name
mpriyank80dee972022-02-23 15:17:23 +0530[diff] [blame]317 - `CPS-837 <https://jira.onap.org/browse/CPS-837>`_ Add Remove and Update properties (DMI and Public) as part of CM Handle Registration update
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]318
319Bug Fixes
320---------
321
322 - `CPS-762 <https://jira.onap.org/browse/CPS-762>`_ Query cm handles for module names returns incorrect cm handle identifiers
ToineSiebelink3f142302021-12-07 11:30:10 +0000[diff] [blame]323 - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
niamhcore65bc4fd2021-12-08 14:19:02 +0000[diff] [blame]324 - `CPS-783 <https://jira.onap.org/browse/CPS-783>`_ Remove cm handle does not completely remove all cm handle information
puthuparambil.aditya71395fb2022-01-05 13:39:31 +0000[diff] [blame]325 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM
puthuparambil.aditya62ac0c32022-02-03 16:42:13 +0000[diff] [blame]326 - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
JosephKeenane0643ab2022-02-15 18:23:05 +0000[diff] [blame]327 - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame]328 - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
JosephKeenane0643ab2022-02-15 18:23:05 +0000[diff] [blame]329 - `CPS-887 <https://jira.onap.org/browse/CPS-887>`_ Increase performance of cmHandle registration for large number of schema sets in DB
mpriyank80dee972022-02-23 15:17:23 +0530[diff] [blame]330 - `CPS-892 <https://jira.onap.org/browse/CPS-892>`_ Fixed the response code during CM-Handle Registration from 201 CREATED to 204 NO_CONTENT
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame]331 - `CPS-893 <https://jira.onap.org/browse/CPS-893>`_ NCMP Java API depends on NCM-Rest-API (cyclic) through json properties on Java API
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]332
333Known Limitations, Issues and Workarounds
334-----------------------------------------
335
336*System Limitations*
337
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame]338Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
339`CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
340of cm handle registration.
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]341
Lathishb3550f12022-03-15 12:03:53 +0000[diff] [blame]342The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
343for more information.
344
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]345*Known Vulnerabilities*
346
347None
348
349*Workarounds*
350
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame]351Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
352pass an empty string as the value if you do not want to include names for these values.
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]353
354Security Notes
355--------------
356
357*Fixed Security Issues*
358
359None
360
361*Known Security Issues*
362
363None
364
365.. ========================
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]366.. * * * ISTANBUL * * *
367.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]368
Bruno Sakoto0eaf3342022-02-11 15:05:29 -0500[diff] [blame]369Version: 2.0.4
370==============
371
372Release Data
373------------
374
375+--------------------------------------+--------------------------------------------------------+
376| **CPS Project** | |
377| | |
378+--------------------------------------+--------------------------------------------------------+
379| **Docker images** | onap/cps-and-ncmp:2.0.4 |
380| | |
381+--------------------------------------+--------------------------------------------------------+
382| **Release designation** | 2.0.4 Istanbul |
383| | |
384+--------------------------------------+--------------------------------------------------------+
385| **Release date** | 2022 Feb 09 |
386| | |
387+--------------------------------------+--------------------------------------------------------+
388
389Bug Fixes
390---------
391
392 - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_ Fix docker compose for csit test.
393 - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_ Fix intermittent circular dependency error when the application starts.
394
395Version: 2.0.3
396==============
397
398Release Data
399------------
400
401+--------------------------------------+--------------------------------------------------------+
402| **CPS Project** | |
403| | |
404+--------------------------------------+--------------------------------------------------------+
405| **Docker images** | onap/cps-and-ncmp:2.0.3 |
406| | |
407+--------------------------------------+--------------------------------------------------------+
408| **Release designation** | 2.0.3 Istanbul |
409| | |
410+--------------------------------------+--------------------------------------------------------+
411| **Release date** | 2022-07-01 |
412| | |
413+--------------------------------------+--------------------------------------------------------+
414
415Bug Fixes
416---------
417
418 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
419
420Version: 2.0.2
421==============
422
423Release Data
424------------
425
426+--------------------------------------+--------------------------------------------------------+
427| **CPS Project** | |
428| | |
429+--------------------------------------+--------------------------------------------------------+
430| **Docker images** | onap/cps-and-ncmp:2.0.2 |
431| | |
432+--------------------------------------+--------------------------------------------------------+
433| **Release designation** | 2.0.2 Istanbul |
434| | |
435+--------------------------------------+--------------------------------------------------------+
436| **Release date** | 2021-16-12 |
437| | |
438+--------------------------------------+--------------------------------------------------------+
439
440Bug Fixes
441---------
442
443 - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_ Update log4j version due to security vulnerability
444
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]445Version: 2.0.1
446==============
447
448Release Data
449------------
450
451+--------------------------------------+--------------------------------------------------------+
452| **CPS Project** | |
453| | |
454+--------------------------------------+--------------------------------------------------------+
455| **Docker images** | onap/cps-and-ncmp:2.0.1 |
456| | |
457+--------------------------------------+--------------------------------------------------------+
458| **Release designation** | 2.0.1 Istanbul |
459| | |
460+--------------------------------------+--------------------------------------------------------+
461| **Release date** | 2021-14-10 |
462| | |
463+--------------------------------------+--------------------------------------------------------+
464
465Bug Fixes
466---------
467
468 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
469 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
470 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
471 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
472
473Known Limitations, Issues and Workarounds
474-----------------------------------------
475
476*System Limitations*
477
478Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
479
480*Known Vulnerabilities*
481
482 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
483
484*Workarounds*
485
486Add recursive method to save list node data to loop through all corresponding child nodes.
487
488Security Notes
489--------------
490
491*Fixed Security Issues*
492
493 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
494
495*Known Security Issues*
496
497None
498
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]499Version: 2.0.0
500==============
501
502Abstract
503--------
504
505This document provides the release notes for Istanbul release.
506
507Release Data
508------------
509
510+--------------------------------------+--------------------------------------------------------+
511| **CPS Project** | |
512| | |
513+--------------------------------------+--------------------------------------------------------+
514| **Docker images** | onap/cps-and-ncmp:2.0.0 |
515| | |
516+--------------------------------------+--------------------------------------------------------+
517| **Release designation** | 2.0.0 Istanbul |
518| | |
519+--------------------------------------+--------------------------------------------------------+
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]520| **Release date** | 2021-14-09 |
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]521| | |
522+--------------------------------------+--------------------------------------------------------+
523
524Features
525--------
DylanB95EST3fcf8692021-10-11 16:29:16 +0100[diff] [blame]526* Register DMI-Plugins with NCMP for CM Handle registrations.
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]527* Update, Create and Remove CM Handles.
528* Add support for retrieving and writing CM Handle data through NCMP datastores.
529* Automatic retrieval and caching of model information for CM Handles within NCMP.
530
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]531Deliverables
532------------
533
534Software Deliverables
535
536.. csv-table::
537 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
538 :widths: auto
539
540 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
541
542Bug Fixes
543---------
544
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]545 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]546 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
547 - `CPS-336 <https://jira.onap.org/browse/CPS-336>`_ Ends-with functionality in cpsPath does not conform with standard xPath behavior
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]548 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
549 - `CPS-357 <https://jira.onap.org/browse/CPS-357>`_ cps-review-verification-maven-master Jenkins job is failing when running csit test
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]550 - `CPS-367 <https://jira.onap.org/browse/CPS-367>`_ Get descendent does not support xpaths that end in list values
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]551 - `CPS-377 <https://jira.onap.org/browse/CPS-377>`_ Init ran model validation is failing error details are not provided
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]552 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
553 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]554 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
555 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
556 - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ Request to update node leaves (patch) responds with json parsing failure
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]557 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
558 - `CPS-479 <https://jira.onap.org/browse/CPS-479>`_ Get Nodes API does not always return the object from the root
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]559 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]560 - `CPS-501 <https://jira.onap.org/browse/CPS-501>`_ Put DataNode API has missing transaction and error handling for concurrency issues
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]561 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
562 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
563 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]564 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
565 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
566 - `CPS-591 <https://jira.onap.org/browse/CPS-591>`_ CPS-Core Leaf stored as integer is being returned from DB as float
Bruno Sakoto0eaf3342022-02-11 15:05:29 -0500[diff] [blame]567 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]568 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
569 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
570 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]571
572This document provides the release notes for Istanbul release.
573
574Summary
575-------
576
577Following CPS components are available with default ONAP/CPS installation.
578
579
580 * Platform components
581
582 - CPS (Helm charts)
583
584 * Service components
585
DylanB95EST3fcf8692021-10-11 16:29:16 +0100[diff] [blame]586 - CPS-NCMP
587 - CPS-Temporal
588 - DMI-Plugin
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]589
590 * Additional resources that CPS utilizes deployed using ONAP common charts
591
592 - Postgres Database
593
594
595Below service components (mS) are available to be deployed on-demand.
596 - CPS-TBDMT
597
598
599Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
600
601Known Limitations, Issues and Workarounds
602-----------------------------------------
603
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]604*System Limitations*
605
606Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
607
608*Known Vulnerabilities*
609
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]610 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
611 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
612 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]613
614*Workarounds*
615
616Add recursive method to save list node data to loop through all corresponding child nodes.
617
618Security Notes
619--------------
620
621*Fixed Security Issues*
622
623 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]624
625*Known Security Issues*
626
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]627 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
628
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]629Test Results
630------------
631 * `Integration tests`
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]632
ToineSiebelinkf0527c52021-07-06 13:03:03 +0100[diff] [blame]633.. ========================
634.. * * * HONOLULU * * *
635.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]636
ToineSiebelinkfd2134d2021-04-09 11:15:48 +0100[diff] [blame]637Version: 1.0.1
638==============
639
640Release Data
641------------
642
643+--------------------------------------+--------------------------------------------------------+
644| **CPS Project** | |
645| | |
646+--------------------------------------+--------------------------------------------------------+
647| **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
648| | |
649+--------------------------------------+--------------------------------------------------------+
650| **Release designation** | 1.0.1 Honolulu |
651| | |
652+--------------------------------------+--------------------------------------------------------+
653| **Release date** | 2021-04-09 |
654| | |
655+--------------------------------------+--------------------------------------------------------+
656
657Bug Fixes
658---------
659
puthuparambil.aditya8b584332021-10-12 16:49:03 +0100[diff] [blame]660 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
ToineSiebelinkfd2134d2021-04-09 11:15:48 +0100[diff] [blame]661 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
662 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
663 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
664 - `CPS-292 <https://jira.onap.org/browse/CPS-292>`_ Detailed information is missing to explain why data is not compliant with the specified YANG model
665 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
666 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
667 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
668
669Security Notes
670--------------
671
672*Fixed Security Issues*
673
674 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]675
ToineSiebelinka2d25b52021-04-13 15:10:47 +0100[diff] [blame]676*Known Security Issues*
677
678 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
679
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]680Version: 1.0.0
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]681==============
682
683
684Abstract
685--------
686
687This document provides the release notes for Honolulu release.
688
689Summary
690-------
691
692Following CPS components are available with default ONAP/CPS installation.
693
694
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]695 * Platform components
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]696
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]697 - CPS (Helm charts)
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]698
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]699 * Service components
700
701 - CPS Core
702
703 * Additional resources that CPS utilizes deployed using ONAP common charts
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]704
705 - Postgres Database
706
707
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]708Below service components (mS) are available to be deployed on-demand.
709 - CPS-TBDMT
710
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]711
712Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
713
714
715Release Data
716------------
717
718+--------------------------------------+--------------------------------------------------------+
719| **CPS Project** | |
720| | |
721+--------------------------------------+--------------------------------------------------------+
722| **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
723| | |
724+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]725| **Release designation** | 1.0.0 Honolulu |
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]726| | |
727+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]728| **Release date** | 2021-03-11 |
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]729| | |
730+--------------------------------------+--------------------------------------------------------+
731
732
733Features
734--------
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]735Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
736CPS has been driven by the needs of the E2E Networking Slicing use case.
737It currently supports basic (rw) persistence and simple queries.
738It also provides MVP support for network data access using simulated data.
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]739
740.. _honolulu_deliverable:
741
742Deliverables
743------------
744
745Software Deliverables
746
747.. csv-table::
748 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
749 :widths: auto
750
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]751 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]752
753
754Known Limitations, Issues and Workarounds
755-----------------------------------------
756
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]757 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
758 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
759 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
niamhcoredddf7312021-06-21 14:44:01 +0100[diff] [blame]760 - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ & `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Update data node leaves API does not support updating a list element with compound keys.
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]761
762*System Limitations*
763
764None
765
766*Known Vulnerabilities*
767
768None
769
770*Workarounds*
771
772Documented under corresponding jira if applicable.
773
774Security Notes
775--------------
776
777*Fixed Security Issues*
ToineSiebelink7c981df2021-03-01 09:53:56 +0000[diff] [blame]778
779* `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]780 - Upgrade org.onap.oparent to 3.2.0
ToineSiebelink7c981df2021-03-01 09:53:56 +0000[diff] [blame]781 - Upgrade spring.boot to 2.3.8.RELEASE
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]782 - Upgrade yangtools to 5.0.7
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]783
784*Known Security Issues*
785
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]786 * Weak Crytography using md5
787 * Risk seen in Zip file expansion
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]788
789*Known Vulnerabilities in Used Modules*
790
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]791 None
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]792
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]793CPS code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive.
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]794
795Test Results
796------------
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]797 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]798
799References
800----------
801
802For more information on the ONAP Honolulu release, please see:
803
804#. `ONAP Home Page`_
805#. `ONAP Documentation`_
806#. `ONAP Release Downloads`_
807#. `ONAP Wiki Page`_
808
809
810.. _`ONAP Home Page`: https://www.onap.org
811.. _`ONAP Wiki Page`: https://wiki.onap.org
812.. _`ONAP Documentation`: https://docs.onap.org
813.. _`ONAP Release Downloads`: https://git.onap.org
814
815Quick Links:
816
817 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
818 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_