blob: 26a7a552e05ed370edd9defb88b4682ec6c31dee [file] [log] [blame]
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
lukegleesone0154a62023-01-25 15:06:52 +00003.. Copyright (C) 2021-2023 Nordix Foundation
ToineSiebelinkb87f3232021-02-26 12:05:30 +00004
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 +00008CPS Release Notes
Bruno Sakotoa1129b62022-03-15 08:09:07 -04009#################
ToineSiebelinkb87f3232021-02-26 12:05:30 +000010
11.. contents::
12 :depth: 2
13..
14
lukegleesond7764c42023-04-20 14:11:20 +010015.. ========================
16.. * * * MONTREAL * * *
17.. ========================
niamhcoref7b414e2021-11-17 11:02:07 +000018
danielhanrahan56384d12023-09-20 17:10:40 +010019Version: 3.3.8
20==============
21
22Release Data
23------------
24
25+--------------------------------------+--------------------------------------------------------+
26| **CPS Project** | |
27| | |
28+--------------------------------------+--------------------------------------------------------+
29| **Docker images** | onap/cps-and-ncmp:3.3.8 |
30| | |
31+--------------------------------------+--------------------------------------------------------+
32| **Release designation** | 3.3.8 Montreal |
33| | |
34+--------------------------------------+--------------------------------------------------------+
35| **Release date** | Not yet released |
36| | |
37+--------------------------------------+--------------------------------------------------------+
38
39Bug Fixes
40---------
413.3.8
42
43Features
44--------
45
leventecsanyid35ad5c2023-08-23 15:55:30 +020046Version: 3.3.7
47==============
48
49Release Data
50------------
51
52+--------------------------------------+--------------------------------------------------------+
53| **CPS Project** | |
54| | |
55+--------------------------------------+--------------------------------------------------------+
56| **Docker images** | onap/cps-and-ncmp:3.3.7 |
57| | |
58+--------------------------------------+--------------------------------------------------------+
59| **Release designation** | 3.3.7 Montreal |
60| | |
61+--------------------------------------+--------------------------------------------------------+
danielhanrahan56384d12023-09-20 17:10:40 +010062| **Release date** | 2023 September 20 |
leventecsanyid35ad5c2023-08-23 15:55:30 +020063| | |
64+--------------------------------------+--------------------------------------------------------+
65
66Bug Fixes
67---------
683.3.7
danielhanrahanefc55772023-09-15 12:02:35 +010069 - `CPS-1866 <https://jira.onap.org/browse/CPS-1866>`_ Fix ClassDefNotFoundError in opendaylight Yang parser
leventecsanyid35ad5c2023-08-23 15:55:30 +020070
71Features
72--------
egernug60a780c2023-09-19 15:26:42 +010073- `CPS-1789 <https://jira.onap.org/browse/CPS-1789>`_ CPS Upgrade to Springboot 3.0.
74
75Note
76----
77Migrating to Spring Boot 3.0 requires the product be built with Java 17 and at least MVN version 3.8.7.
leventecsanyid35ad5c2023-08-23 15:55:30 +020078
egernugbdac4402023-07-21 13:27:24 +010079Version: 3.3.6
80==============
81
82Release Data
83------------
84
85+--------------------------------------+--------------------------------------------------------+
86| **CPS Project** | |
87| | |
88+--------------------------------------+--------------------------------------------------------+
89| **Docker images** | onap/cps-and-ncmp:3.3.6 |
90| | |
91+--------------------------------------+--------------------------------------------------------+
92| **Release designation** | 3.3.6 Montreal |
93| | |
94+--------------------------------------+--------------------------------------------------------+
leventecsanyid35ad5c2023-08-23 15:55:30 +020095| **Release date** | 2023 August 23 |
egernugbdac4402023-07-21 13:27:24 +010096| | |
97+--------------------------------------+--------------------------------------------------------+
98
99Bug Fixes
100---------
1013.3.6
danielhanrahan996d0c22023-08-17 15:43:34 +0100102 - `CPS-1841 <https://jira.onap.org/browse/CPS-1841>`_ Update of top-level data node fails with exception
mpriyank41c7d002023-08-22 13:17:46 +0100103 - `CPS-1842 <https://jira.onap.org/browse/CPS-1842>`_ Replace event-id with correlation-id for data read operation cloud event
egernugbdac4402023-07-21 13:27:24 +0100104
105Features
106--------
danielhanrahan92705462023-05-18 10:18:10 +0100107 - `CPS-1696 <https://jira.onap.org/browse/CPS-1696>`_ Get Data Node to return entire List data node.
mpriyank612fb572023-08-01 15:36:27 +0100108 - `CPS-1819 <https://jira.onap.org/browse/CPS-1819>`_ Ability to disable sending authorization header.
egernugbdac4402023-07-21 13:27:24 +0100109
110
egernug6c9621a2023-07-19 11:05:00 +0100111Version: 3.3.5
112==============
113
114Release Data
115------------
116
117+--------------------------------------+--------------------------------------------------------+
118| **CPS Project** | |
119| | |
120+--------------------------------------+--------------------------------------------------------+
121| **Docker images** | onap/cps-and-ncmp:3.3.5 |
122| | |
123+--------------------------------------+--------------------------------------------------------+
124| **Release designation** | 3.3.5 Montreal |
125| | |
126+--------------------------------------+--------------------------------------------------------+
egernugbdac4402023-07-21 13:27:24 +0100127| **Release date** | 2023 July 21 |
egernug6c9621a2023-07-19 11:05:00 +0100128| | |
129+--------------------------------------+--------------------------------------------------------+
130
131Bug Fixes
132---------
1333.3.5
134
135Features
136--------
danielhanrahan74a47152023-06-28 12:55:20 +0100137 - `CPS-1760 <https://jira.onap.org/browse/CPS-1760>`_ Improve handling of special characters in Cps Paths
egernug6c9621a2023-07-19 11:05:00 +0100138
mpriyank8caa3422023-06-30 11:14:10 +0100139Version: 3.3.4
140==============
141
142Release Data
143------------
144
145+--------------------------------------+--------------------------------------------------------+
146| **CPS Project** | |
147| | |
148+--------------------------------------+--------------------------------------------------------+
149| **Docker images** | onap/cps-and-ncmp:3.3.4 |
150| | |
151+--------------------------------------+--------------------------------------------------------+
152| **Release designation** | 3.3.4 Montreal |
153| | |
154+--------------------------------------+--------------------------------------------------------+
egernug6c9621a2023-07-19 11:05:00 +0100155| **Release date** | 2023 July 19 |
mpriyank8caa3422023-06-30 11:14:10 +0100156| | |
157+--------------------------------------+--------------------------------------------------------+
158
159Bug Fixes
160---------
1613.3.4
162
163Features
164--------
egernugdb62ffb2023-07-18 10:57:42 +0100165 - `CPS-1767 <https://jira.onap.org/browse/CPS-1767>`_ Upgrade CPS to java 17
mpriyank8caa3422023-06-30 11:14:10 +0100166
danielhanrahan19f963b2023-06-15 13:52:34 +0100167Version: 3.3.3
168==============
169
170Release Data
171------------
172
173+--------------------------------------+--------------------------------------------------------+
174| **CPS Project** | |
175| | |
176+--------------------------------------+--------------------------------------------------------+
177| **Docker images** | onap/cps-and-ncmp:3.3.3 |
178| | |
179+--------------------------------------+--------------------------------------------------------+
180| **Release designation** | 3.3.3 Montreal |
181| | |
182+--------------------------------------+--------------------------------------------------------+
mpriyank8caa3422023-06-30 11:14:10 +0100183| **Release date** | 2023 June 30 |
danielhanrahan19f963b2023-06-15 13:52:34 +0100184| | |
185+--------------------------------------+--------------------------------------------------------+
186
187Bug Fixes
188---------
1893.3.3
190
191Features
192--------
mpriyank6da95412023-06-29 16:56:11 +0100193 - `CPS-1515 <https://jira.onap.org/browse/CPS-1515>`_ Support Multiple CM-Handles for NCMP Get Operation
194 - `CPS-1675 <https://jira.onap.org/browse/CPS-1675>`_ Persistence write performance improvement(s)
195 - `CPS-1745 <https://jira.onap.org/browse/CPS-1745>`_ Upgrade to Openapi 3.0.3
danielhanrahan19f963b2023-06-15 13:52:34 +0100196
mpriyank436b75b2023-05-03 11:10:08 +0100197Version: 3.3.2
198==============
199
200Release Data
201------------
202
203+--------------------------------------+--------------------------------------------------------+
204| **CPS Project** | |
205| | |
206+--------------------------------------+--------------------------------------------------------+
207| **Docker images** | onap/cps-and-ncmp:3.3.2 |
208| | |
209+--------------------------------------+--------------------------------------------------------+
210| **Release designation** | 3.3.2 Montreal |
211| | |
212+--------------------------------------+--------------------------------------------------------+
danielhanrahan19f963b2023-06-15 13:52:34 +0100213| **Release date** | 2023 June 15 |
mpriyank436b75b2023-05-03 11:10:08 +0100214| | |
215+--------------------------------------+--------------------------------------------------------+
216
217Bug Fixes
218---------
2193.3.2
danielhanrahan5cec5322023-06-15 11:08:54 +0100220 - `CPS-1716 <https://jira.onap.org/browse/CPS-1716>`_ NCMP: Java Heap OutOfMemory errors and slow registration in case of 20k cmhandles
mpriyank436b75b2023-05-03 11:10:08 +0100221
222Features
223--------
--globalc7e5a802023-04-05 17:08:08 +0530224 - `CPS-1006 <https://jira.onap.org/browse/CPS-1006>`_ Extend CPS PATCH API to allow update of leaves for multiple data nodes
danielhanrahan5cec5322023-06-15 11:08:54 +0100225 - `CPS-1273 <https://jira.onap.org/browse/CPS-1273>`_ Add <,> operators support to cps-path
226 - `CPS-1664 <https://jira.onap.org/browse/CPS-1664>`_ Use recursive SQL to fetch descendants in CpsPath queries to improve query performance
227 - `CPS-1676 <https://jira.onap.org/browse/CPS-1676>`_ Entity ID types do not match types in database definition
228 - `CPS-1677 <https://jira.onap.org/browse/CPS-1677>`_ Remove dataspace_id column from Fragment table
mpriyank436b75b2023-05-03 11:10:08 +0100229
lukegleesond7764c42023-04-20 14:11:20 +0100230Version: 3.3.1
halil.cakal0b8d85d2023-03-23 12:44:27 +0000231==============
232
233Release Data
234------------
235
236+--------------------------------------+--------------------------------------------------------+
237| **CPS Project** | |
238| | |
239+--------------------------------------+--------------------------------------------------------+
lukegleesond7764c42023-04-20 14:11:20 +0100240| **Docker images** | onap/cps-and-ncmp:3.3.1 |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000241| | |
242+--------------------------------------+--------------------------------------------------------+
lukegleesond7764c42023-04-20 14:11:20 +0100243| **Release designation** | 3.3.1 Montreal |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000244| | |
245+--------------------------------------+--------------------------------------------------------+
mpriyank436b75b2023-05-03 11:10:08 +0100246| **Release date** | 2023 May 03 |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000247| | |
248+--------------------------------------+--------------------------------------------------------+
249
250Bug Fixes
251---------
lukegleesond7764c42023-04-20 14:11:20 +01002523.3.1
halil.cakal0b8d85d2023-03-23 12:44:27 +0000253 - None
254
255Features
256--------
mpriyank52c5e542023-05-02 15:58:55 +0100257 - `CPS-1272 <https://jira.onap.org/browse/CPS-1272>`_ Add Contains operation to CPS Path
258 - `CPS-1573 <https://jira.onap.org/browse/CPS-1573>`_ Remove 32K limit for DB operations
259 - `CPS-1627 <https://jira.onap.org/browse/CPS-1627>`_ Dependency versions uplift because of vulnerability issues
260 - `CPS-1629 <https://jira.onap.org/browse/CPS-1629>`_ Ordering of leaf elements to support combination of AND/OR in cps-path
261 - `CPS-1637 <https://jira.onap.org/browse/CPS-1637>`_ Extend hazelcast to work on kubernetes
halil.cakal0b8d85d2023-03-23 12:44:27 +0000262
lukegleesond7764c42023-04-20 14:11:20 +0100263Version: 3.3.0
264==============
265
266Release Data
267------------
268
269+--------------------------------------+--------------------------------------------------------+
270| **CPS Project** | |
271| | |
272+--------------------------------------+--------------------------------------------------------+
273| **Docker images** | onap/cps-and-ncmp:3.3.0 |
274| | |
275+--------------------------------------+--------------------------------------------------------+
276| **Release designation** | 3.3.0 Montreal |
277| | |
278+--------------------------------------+--------------------------------------------------------+
279| **Release date** | 2023 April 20 |
280| | |
281+--------------------------------------+--------------------------------------------------------+
282
283Bug Fixes
284---------
2853.3.0
286 - None
287
288Features
289--------
290 - `CPS-1215 <https://jira.onap.org/browse/CPS-1215>`_ Add OR operation for CPS Path
291 - `CPS-1617 <https://jira.onap.org/browse/CPS-1617>`_ Use cascade delete in fragments table
292
293.. ======================
294.. * * * LONDON * * *
295.. ======================
296
mpriyank0fd4d192023-03-10 13:48:20 +0000297Version: 3.2.6
298==============
299
300Release Data
301------------
302
303+--------------------------------------+--------------------------------------------------------+
304| **CPS Project** | |
305| | |
306+--------------------------------------+--------------------------------------------------------+
307| **Docker images** | onap/cps-and-ncmp:3.2.6 |
308| | |
309+--------------------------------------+--------------------------------------------------------+
310| **Release designation** | 3.2.6 London |
311| | |
312+--------------------------------------+--------------------------------------------------------+
seanbeirnef5a3a212023-03-06 09:12:49 +0000313| **Release date** | 2023 March 22 |
mpriyank0fd4d192023-03-10 13:48:20 +0000314| | |
315+--------------------------------------+--------------------------------------------------------+
316
317Bug Fixes
318---------
3193.2.6
arpitsingh2b4c4882023-03-03 21:38:57 +0530320 - `CPS-1526 <https://jira.onap.org/browse/CPS-1526>`_ Fix response message for PATCH operation
seanbeirnef5a3a212023-03-06 09:12:49 +0000321 - `CPS-1563 <https://jira.onap.org/browse/CPS-1563>`_ Fix 500 response error on id-searches with empty parameters
mpriyank0fd4d192023-03-10 13:48:20 +0000322
323Features
324--------
seanbeirnef5a3a212023-03-06 09:12:49 +0000325 - `CPS-1396 <https://jira.onap.org/browse/CPS-1396>`_ Query data nodes across all anchors under one dataspace
mpriyank0fd4d192023-03-10 13:48:20 +0000326
mpriyankade5a6e2023-03-09 17:58:31 +0000327Version: 3.2.5
328==============
329
330Release Data
331------------
332
333+--------------------------------------+--------------------------------------------------------+
334| **CPS Project** | |
335| | |
336+--------------------------------------+--------------------------------------------------------+
337| **Docker images** | onap/cps-and-ncmp:3.2.5 |
338| | |
339+--------------------------------------+--------------------------------------------------------+
340| **Release designation** | 3.2.5 London |
341| | |
342+--------------------------------------+--------------------------------------------------------+
mpriyank06bfe4e2023-03-10 11:48:23 +0000343| **Release date** | 2023 March 10 |
mpriyankade5a6e2023-03-09 17:58:31 +0000344| | |
345+--------------------------------------+--------------------------------------------------------+
346
347Bug Fixes
348---------
3493.2.5
mpriyank06bfe4e2023-03-10 11:48:23 +0000350 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ Introduce control switch for model loader functionality.
mpriyankade5a6e2023-03-09 17:58:31 +0000351
352Features
353--------
354 - None
355
seanbeirnef0f4fd82023-03-07 13:42:04 +0000356Version: 3.2.4
357==============
358
359Release Data
360------------
361
362+--------------------------------------+--------------------------------------------------------+
363| **CPS Project** | |
364| | |
365+--------------------------------------+--------------------------------------------------------+
366| **Docker images** | onap/cps-and-ncmp:3.2.4 |
367| | |
368+--------------------------------------+--------------------------------------------------------+
369| **Release designation** | 3.2.4 London |
370| | |
371+--------------------------------------+--------------------------------------------------------+
mpriyankbd5ba8d2023-03-09 16:33:02 +0000372| **Release date** | 2023 March 09 |
seanbeirnef0f4fd82023-03-07 13:42:04 +0000373| | |
374+--------------------------------------+--------------------------------------------------------+
375
376Bug Fixes
377---------
3783.2.4
mpriyankbd5ba8d2023-03-09 16:33:02 +0000379 - `CPS-1533 <https://jira.onap.org/browse/CPS-1533>`_ Fix for Temp tables cause Out of shared memory errors in Postgres
380 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ NCMP failed to start due to issue in SubscriptionModelLoader
381
382Features
383--------
384 - None
seanbeirnef0f4fd82023-03-07 13:42:04 +0000385
mpriyankfd43dbe2023-02-08 11:21:08 +0000386Version: 3.2.3
387==============
388
389Release Data
390------------
391
392+--------------------------------------+--------------------------------------------------------+
393| **CPS Project** | |
394| | |
395+--------------------------------------+--------------------------------------------------------+
396| **Docker images** | onap/cps-and-ncmp:3.2.3 |
397| | |
398+--------------------------------------+--------------------------------------------------------+
399| **Release designation** | 3.2.3 London |
400| | |
401+--------------------------------------+--------------------------------------------------------+
seanbeirnef9af5f82023-03-07 10:36:18 +0000402| **Release date** | 2023 March 07 |
mpriyankfd43dbe2023-02-08 11:21:08 +0000403| | |
404+--------------------------------------+--------------------------------------------------------+
405
406Bug Fixes
407---------
4083.2.3
seanbeirnef9af5f82023-03-07 10:36:18 +0000409 - `CPS-1494 <https://jira.onap.org/browse/CPS-1494>`_ NCMP Inventory Performance Improvements
mpriyankfd43dbe2023-02-08 11:21:08 +0000410
411Features
412--------
seanbeirnef9af5f82023-03-07 10:36:18 +0000413 - `CPS-1401 <https://jira.onap.org/browse/CPS-1401>`_ Added V2 of Get Data Node API,support to retrieve all data nodes under an anchor
414 - `CPS-1502 <https://jira.onap.org/browse/CPS-1502>`_ Delete Performance Improvements
mpriyankfd43dbe2023-02-08 11:21:08 +0000415
seanbeirnef8e980a2023-01-27 18:09:33 +0000416Version: 3.2.2
417==============
418
419Release Data
420------------
421
422+--------------------------------------+--------------------------------------------------------+
423| **CPS Project** | |
424| | |
425+--------------------------------------+--------------------------------------------------------+
426| **Docker images** | onap/cps-and-ncmp:3.2.2 |
427| | |
428+--------------------------------------+--------------------------------------------------------+
429| **Release designation** | 3.2.2 London |
430| | |
431+--------------------------------------+--------------------------------------------------------+
mpriyankfd43dbe2023-02-08 11:21:08 +0000432| **Release date** | 2023 February 08 |
seanbeirnef8e980a2023-01-27 18:09:33 +0000433| | |
434+--------------------------------------+--------------------------------------------------------+
435
436Bug Fixes
437---------
mpriyank0b5950d2023-02-07 17:55:10 +00004383.2.2
mpriyankfd43dbe2023-02-08 11:21:08 +0000439 - `CPS-1173 <https://jira.onap.org/browse/CPS-1173>`_ Delete Performance Improvements.
mpriyank0b5950d2023-02-07 17:55:10 +0000440
441Features
442--------
443 - None
seanbeirnef8e980a2023-01-27 18:09:33 +0000444
leventecsanyi37d72852022-10-26 10:44:08 +0200445Version: 3.2.1
446==============
mpriyank4bd450e2022-10-05 09:50:59 +0100447
448Release Data
449------------
450
451+--------------------------------------+--------------------------------------------------------+
452| **CPS Project** | |
453| | |
454+--------------------------------------+--------------------------------------------------------+
lukegleesone0154a62023-01-25 15:06:52 +0000455| **Docker images** | onap/cps-and-ncmp:3.2.1 |
mpriyank4bd450e2022-10-05 09:50:59 +0100456| | |
457+--------------------------------------+--------------------------------------------------------+
leventecsanyi37d72852022-10-26 10:44:08 +0200458| **Release designation** | 3.2.1 London |
mpriyank4bd450e2022-10-05 09:50:59 +0100459| | |
460+--------------------------------------+--------------------------------------------------------+
lukegleesone0154a62023-01-25 15:06:52 +0000461| **Release date** | 2023 January 27 |
mpriyank4bd450e2022-10-05 09:50:59 +0100462| | |
463+--------------------------------------+--------------------------------------------------------+
Cédric Ollivier490b20d2023-03-15 21:40:48 +0100464
lukegleeson3be99242022-10-11 14:34:56 +0100465Features
466--------
leventecsanyi37d72852022-10-26 10:44:08 +02004673.2.1
lukegleesone0154a62023-01-25 15:06:52 +0000468 - `CPS-341 <https://jira.onap.org/browse/CPS-341>`_ Added support for multiple data tree instances under 1 anchor.
469 - `CPS-1002 <https://jira.onap.org/browse/CPS-1002>`_ Add CPS-E-05 endpoint for 'Query data, NCMP-Operational Datastore' using cpsPaths
470 - `CPS-1182 <https://jira.onap.org/browse/CPS-1182>`_ Upgrade Opendaylight
ToineSiebelink294bcb52022-12-23 11:07:42 +0000471 - `CPS-1185 <https://jira.onap.org/browse/CPS-1185>`_ Get all dataspaces.
472 - `CPS-1186 <https://jira.onap.org/browse/CPS-1186>`_ Get single dataspace.
lukegleesonf20b4992022-12-09 15:48:55 +0000473 - `CPS-1187 <https://jira.onap.org/browse/CPS-1187>`_ Added API to get all schema sets for a given dataspace.
lukegleesone0154a62023-01-25 15:06:52 +0000474 - `CPS-1236 <https://jira.onap.org/browse/CPS-1236>`_ DMI audit support for NCMP: Filter on any properties of CM Handles
ToineSiebelink294bcb52022-12-23 11:07:42 +0000475 - `CPS-1257 <https://jira.onap.org/browse/CPS-1257>`_ Added support for application/xml Content-Type (write only).
lukegleesone0154a62023-01-25 15:06:52 +0000476 - `CPS-1381 <https://jira.onap.org/browse/CPS-1381>`_ Query large outputs using limit/depth/pagination
ToineSiebelink294bcb52022-12-23 11:07:42 +0000477 - `CPS-1421 <https://jira.onap.org/browse/CPS-1421>`_ Optimized query for large number of hits with descendants.
lukegleesone0154a62023-01-25 15:06:52 +0000478 - `CPS-1422 <https://jira.onap.org/browse/CPS-1422>`_ Fetch CM handles by collection of xpaths (CPS Core)
479 - `CPS-1424 <https://jira.onap.org/browse/CPS-1424>`_ Updating CmHandleStates using batch operation
480 - `CPS-1439 <https://jira.onap.org/browse/CPS-1439>`_ Use native query to delete data nodes
mpriyank4bd450e2022-10-05 09:50:59 +0100481
482Bug Fixes
483---------
ToineSiebelink294bcb52022-12-23 11:07:42 +00004843.2.1
lukegleesone0154a62023-01-25 15:06:52 +0000485 - `CPS-1171 <https://jira.onap.org/browse/CPS-1171>`_ Optimized retrieval of data nodes with many descendants.
486 - `CPS-1288 <https://jira.onap.org/browse/CPS-1288>`_ Hazelcast TTL for IMap is not working
487 - `CPS-1289 <https://jira.onap.org/browse/CPS-1289>`_ Getting wrong error code for create node api
488 - `CPS-1326 <https://jira.onap.org/browse/CPS-1326>`_ Creation of DataNodeBuilder with module name prefix is very slow
489 - `CPS-1344 <https://jira.onap.org/browse/CPS-1344>`_ Top level container (prefix) is not always the first module
ToineSiebelink294bcb52022-12-23 11:07:42 +0000490 - `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_ Add Basic Auth to CPS/NCMP OpenAPI Definitions.
lukegleesone0154a62023-01-25 15:06:52 +0000491 - `CPS-1352 <https://jira.onap.org/browse/CPS-1352>`_ Handle YangChoiceNode in right format.
ToineSiebelink294bcb52022-12-23 11:07:42 +0000492 - `CPS-1409 <https://jira.onap.org/browse/CPS-1409>`_ Fix Delete uses case with '/' in path.
lukegleesone0154a62023-01-25 15:06:52 +0000493 - `CPS-1433 <https://jira.onap.org/browse/CPS-1433>`_ Fix to allow posting data with '/' key fields.
494 - `CPS-1442 <https://jira.onap.org/browse/CPS-1442>`_ CPS PATCH operation does not merge existing data
495 - `CPS-1446 <https://jira.onap.org/browse/CPS-1446>`_ Locked cmhandles and ready to locked state transitions causing long cmHandle discovery
496 - `CPS-1457 <https://jira.onap.org/browse/CPS-1457>`_ CpsDataPersistenceService#getDataNodes uses non-normalized xpaths
497 - `CPS-1458 <https://jira.onap.org/browse/CPS-1458>`_ CpsDataPersistenceService#getDataNodes does not handle root xpath
498 - `CPS-1460 <https://jira.onap.org/browse/CPS-1460>`_ CPS Path Processing Performance Test duration is too low
ToineSiebelink294bcb52022-12-23 11:07:42 +0000499
leventecsanyi37d72852022-10-26 10:44:08 +02005003.2.0
ToineSiebelink294bcb52022-12-23 11:07:42 +0000501 - `CPS-1312 <https://jira.onap.org/browse/CPS-1312>`_ CPS(/NCMP) does not have version control.
mpriyank4bd450e2022-10-05 09:50:59 +0100502
lukegleeson3be99242022-10-11 14:34:56 +0100503Known Limitations, Issues and Workarounds
504-----------------------------------------
505
506*System Limitations*
507
seanbeirne72c267e2022-10-18 12:39:22 +0100508For upgrading, CPS uses Liquibase for database upgrades. CPS/NCMP currently only supports upgrading from Liquibase changelog 11 to Liquibase changelog 16.
509This 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 +0100510
arpitsingh2b4c4882023-03-03 21:38:57 +0530511CPS core Patch operation currently supports updating data of one top level data node. When performing Patch on multiple top level data nodes at once
512a 400 Bad Request is sent as response. This is part of commit CPS-1526.
513
seanbeirnedba2b102022-10-27 09:59:17 +0100514.. ====================
515.. * * * KOHN * * *
516.. ====================
517
mpriyankfe775312022-09-30 14:16:51 +0100518Version: 3.1.4
519==============
520
521Release Data
522------------
523
524+--------------------------------------+--------------------------------------------------------+
525| **CPS Project** | |
526| | |
527+--------------------------------------+--------------------------------------------------------+
528| **Docker images** | onap/cps-and-ncmp:3.1.4 |
529| | |
530+--------------------------------------+--------------------------------------------------------+
531| **Release designation** | 3.1.4 Kohn |
532| | |
533+--------------------------------------+--------------------------------------------------------+
mpriyank4bd450e2022-10-05 09:50:59 +0100534| **Release date** | 2022 October 5 |
mpriyankfe775312022-09-30 14:16:51 +0100535| | |
536+--------------------------------------+--------------------------------------------------------+
537
538Bug Fixes
539---------
lukegleeson8c6b5622022-09-29 15:58:06 +0100540 - `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 +0100541 - `CPS-1294 <https://jira.onap.org/browse/CPS-1294>`_ Kafka communication fault caused cmHandle registration error
mpriyankfe775312022-09-30 14:16:51 +0100542
mpriyank06736cb2022-09-29 14:29:40 +0100543Version: 3.1.3
544==============
545
546Release Data
547------------
548
549+--------------------------------------+--------------------------------------------------------+
550| **CPS Project** | |
551| | |
552+--------------------------------------+--------------------------------------------------------+
553| **Docker images** | onap/cps-and-ncmp:3.1.3 |
554| | |
555+--------------------------------------+--------------------------------------------------------+
556| **Release designation** | 3.1.3 Kohn |
557| | |
558+--------------------------------------+--------------------------------------------------------+
mpriyankfe775312022-09-30 14:16:51 +0100559| **Release date** | 2022 September 29 |
mpriyank06736cb2022-09-29 14:29:40 +0100560| | |
561+--------------------------------------+--------------------------------------------------------+
562
563Bug Fixes
564---------
565 - None
566
mpriyankef0ddfc2022-09-28 12:19:34 +0100567Version: 3.1.2
568==============
569
570Release Data
571------------
572
573+--------------------------------------+--------------------------------------------------------+
574| **CPS Project** | |
575| | |
576+--------------------------------------+--------------------------------------------------------+
577| **Docker images** | onap/cps-and-ncmp:3.1.2 |
578| | |
579+--------------------------------------+--------------------------------------------------------+
580| **Release designation** | 3.1.2 Kohn |
581| | |
582+--------------------------------------+--------------------------------------------------------+
mpriyank06736cb2022-09-29 14:29:40 +0100583| **Release date** | 2022 September 28 |
mpriyankef0ddfc2022-09-28 12:19:34 +0100584| | |
585+--------------------------------------+--------------------------------------------------------+
586
587Bug Fixes
588---------
589 - None
590
mpriyanka3f43502022-09-26 14:57:01 +0100591Version: 3.1.1
592==============
593
594Release Data
595------------
596
597+--------------------------------------+--------------------------------------------------------+
598| **CPS Project** | |
599| | |
600+--------------------------------------+--------------------------------------------------------+
601| **Docker images** | onap/cps-and-ncmp:3.1.1 |
602| | |
603+--------------------------------------+--------------------------------------------------------+
604| **Release designation** | 3.1.1 Kohn |
605| | |
606+--------------------------------------+--------------------------------------------------------+
mpriyankef0ddfc2022-09-28 12:19:34 +0100607| **Release date** | 2022 September 28 |
mpriyanka3f43502022-09-26 14:57:01 +0100608| | |
609+--------------------------------------+--------------------------------------------------------+
610
611Bug Fixes
612---------
613 - None
614
lukegleesonc9ec9152022-09-07 14:21:36 +0100615Security Notes
616--------------
617
618*Fixed Security Issues*
619
620 - `CPS-1226 <https://jira.onap.org/browse/CPS-1226>`_ Security bug in the logs
621
lukegleeson4a34fa52022-09-19 15:31:59 +0100622Version: 3.1.0
623==============
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400624
625Release Data
626------------
627
DylanB95ESTb130fd32022-04-04 13:09:22 +0100628+--------------------------------------+--------------------------------------------------------+
629| **CPS Project** | |
630| | |
631+--------------------------------------+--------------------------------------------------------+
632| **Docker images** | onap/cps-and-ncmp:3.1.0 |
633| | |
634+--------------------------------------+--------------------------------------------------------+
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400635| **Release designation** | 3.1.0 Kohn |
DylanB95ESTb130fd32022-04-04 13:09:22 +0100636| | |
637+--------------------------------------+--------------------------------------------------------+
lukegleeson4a34fa52022-09-19 15:31:59 +0100638| **Release date** | 2022 September 14 |
DylanB95ESTb130fd32022-04-04 13:09:22 +0100639| | |
640+--------------------------------------+--------------------------------------------------------+
641
642Features
643--------
lukegleeson4a34fa52022-09-19 15:31:59 +0100644 - `CPS-340 <https://jira.onap.org/browse/CPS-340>`_ Patch and update the root data node
645 - `CPS-575 <https://jira.onap.org/browse/CPS-575>`_ Write data for cmHandle using ncmp-datastores:passthrough-running (NCMP.)
646 - `CPS-731 <https://jira.onap.org/browse/CPS-731>`_ Query based on Public CM Properties
647 - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_ Async: NCMP Rest impl. including Request ID generation
648 - `CPS-829 <https://jira.onap.org/browse/CPS-829>`_ Async: Internal message topic incl. basic producer & Consumer
649 - `CPS-830 <https://jira.onap.org/browse/CPS-830>`_ DMI-NCMP Asynchronously Publish Response Event to Client Topic
650 - `CPS-869 <https://jira.onap.org/browse/CPS-869>`_ Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072
651 - `CPS-870 <https://jira.onap.org/browse/CPS-870>`_ Align CPS-Core output with SDN-C output (add module name)
652 - `CPS-875 <https://jira.onap.org/browse/CPS-875>`_ CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles
653 - `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'
654 - `CPS-899 <https://jira.onap.org/browse/CPS-899>`_ Start and stop sessions on Java API
655 - `CPS-909 <https://jira.onap.org/browse/CPS-909>`_ Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state
656 - `CPS-917 <https://jira.onap.org/browse/CPS-917>`_ Structured Errors response for passthrough use-cases in NCMP
657 - `CPS-953 <https://jira.onap.org/browse/CPS-953>`_ Update maven deploy plugin version
658 - `CPS-977 <https://jira.onap.org/browse/CPS-977>`_ Query CM Handles using CpsPath
659 - `CPS-1000 <https://jira.onap.org/browse/CPS-1000>`_ Create Data Synchronization watchdog
660 - `CPS-1016 <https://jira.onap.org/browse/CPS-1016>`_ Merge 2 'query' end points in NCMP
661 - `CPS-1034 <https://jira.onap.org/browse/CPS-1034>`_ Publish lifecycle events for ADVISED , READY and LOCKED state transition"
662 - `CPS-1064 <https://jira.onap.org/browse/CPS-1064>`_ Support retrieval of YANG module sources for CM handle on the NCMP interface
663 - `CPS-1099 <https://jira.onap.org/browse/CPS-1099>`_ Expose simplified 'external' lock reason enum state over REST interface
664 - `CPS-1101 <https://jira.onap.org/browse/CPS-1101>`_ Introducing the DELETING and DELETED Cmhandle State
665 - `CPS-1102 <https://jira.onap.org/browse/CPS-1102>`_ Register the Cmhandle Sends Advised State notification.
666 - `CPS-1133 <https://jira.onap.org/browse/CPS-1133>`_ Enable/Disable Data Sync for Cm Handle
667 - `CPS-1136 <https://jira.onap.org/browse/CPS-1136>`_ DMI Audit Support (get all CM Handles for a registered DMI)
668
emacleeafb17362022-09-02 14:40:17 +0100669
670Bug Fixes
671---------
lukegleeson4a34fa52022-09-19 15:31:59 +0100672 - `CPS-896 <https://jira.onap.org/browse/CPS-896>`_ CM Handle Registration Process only partially completes when exception is thrown
673 - `CPS-957 <https://jira.onap.org/browse/CPS-957>`_ NCMP: fix getResourceDataForPassthroughOperational endpoint
674 - `CPS-1020 <https://jira.onap.org/browse/CPS-1020>`_ DuplicatedYangResourceException error at parallel cmHandle registration
675 - `CPS-1056 <https://jira.onap.org/browse/CPS-1056>`_ Wrong error response format in case of Dmi plugin error
676 - `CPS-1067 <https://jira.onap.org/browse/CPS-1067>`_ NCMP returns 500 error on searches endpoint when No DMi Handles registered
677 - `CPS-1085 <https://jira.onap.org/browse/CPS-1085>`_ Performance degradation on ncmp/v1/ch/searches endpoint
678 - `CPS-1088 <https://jira.onap.org/browse/CPS-1088>`_ Kafka consumer can not be turned off
679 - `CPS-1097 <https://jira.onap.org/browse/CPS-1097>`_ Unable to change state from LOCKED to ADVISED
680 - `CPS-1126 <https://jira.onap.org/browse/CPS-1126>`_ CmHandle creation performance degradation
681 - `CPS-1175 <https://jira.onap.org/browse/CPS-1175>`_ Incorrect response when empty body executed for cmhandle id-searches
682 - `CPS-1179 <https://jira.onap.org/browse/CPS-1179>`_ Node API - GET method returns invalid response when identifier contains '/'
683 - `CPS-1212 <https://jira.onap.org/browse/CPS-1212>`_ Additional Properties for CM Handles not included when send to DMI Plugin
684 - `CPS-1217 <https://jira.onap.org/browse/CPS-1217>`_ Searches endpoint gives back empty list however there are already available cmhandles
685 - `CPS-1218 <https://jira.onap.org/browse/CPS-1218>`_ NCMP logs are flooded with SyncUtils logs
puthuparambil.adityadd904322022-09-21 10:53:51 +0100686
687Known Limitations, Issues and Workarounds
688-----------------------------------------
689
690*System Limitations*
691
692Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition.
693Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces']
DylanB95ESTb130fd32022-04-04 13:09:22 +0100694
lukegleeson4a34fa52022-09-19 15:31:59 +0100695*Known Vulnerabilities*
696
697None
698
699*Workarounds*
700
701None
702
703Security Notes
704--------------
705
706*Fixed Security Issues*
707
708 - `CPS-963 <https://jira.onap.org/browse/CPS-963>`_ Liquibase has got serious vulnerability, upgrade required
709
710*Known Security Issues*
711
712None
713
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400714.. ========================
715.. * * * JAKARTA * * *
716.. ========================
717
718Version: 3.0.1
719==============
720
721Release Data
722------------
723
724+--------------------------------------+--------------------------------------------------------+
725| **CPS Project** | |
726| | |
727+--------------------------------------+--------------------------------------------------------+
728| **Docker images** | onap/cps-and-ncmp:3.0.1 |
729| | |
730+--------------------------------------+--------------------------------------------------------+
731| **Release designation** | 3.0.1 Jakarta |
732| | |
733+--------------------------------------+--------------------------------------------------------+
734| **Release date** | 2022 April 28 |
735| | |
736+--------------------------------------+--------------------------------------------------------+
737
738Bug Fixes
739---------
740 - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_ Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
741
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400742Version: 3.0.0
743==============
niamhcoref7b414e2021-11-17 11:02:07 +0000744
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400745Release Data
746------------
747
748+--------------------------------------+--------------------------------------------------------+
749| **CPS Project** | |
750| | |
751+--------------------------------------+--------------------------------------------------------+
752| **Docker images** | onap/cps-and-ncmp:3.0.0 |
753| | |
754+--------------------------------------+--------------------------------------------------------+
755| **Release designation** | 3.0.0 Jakarta |
756| | |
757+--------------------------------------+--------------------------------------------------------+
758| **Release date** | 2022 March 15 |
759| | |
760+--------------------------------------+--------------------------------------------------------+
niamhcoref7b414e2021-11-17 11:02:07 +0000761
762Features
763--------
puthuparambil.adityad0007332021-12-08 18:53:39 +0000764 - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_ Define response objects (schemas) in cps-ncmp
niamhcoref7b414e2021-11-17 11:02:07 +0000765 - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_ Update operation for datastore pass through running
766 - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_ Delete operation for datastore pass through running
DylanB95ESTe5573382022-01-27 17:12:52 +0000767 - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_ Support 'public' Cm Handle Properties
niamhcoref7b414e2021-11-17 11:02:07 +0000768 - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
JosephKeenan82ebf532021-12-08 18:16:44 +0000769 - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_ Ensure all DMI operations use POST method
puthuparambil.adityad0007332021-12-08 18:53:39 +0000770 - `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 -0400771 - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
772 - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
DylanB95ESTe5573382022-01-27 17:12:52 +0000773 - `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 +0530774 - `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 +0000775
776Bug Fixes
777---------
778
779 - `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 +0000780 - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
niamhcore65bc4fd2021-12-08 14:19:02 +0000781 - `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 +0000782 - `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 +0000783 - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
JosephKeenane0643ab2022-02-15 18:23:05 +0000784 - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
DylanB95ESTe5573382022-01-27 17:12:52 +0000785 - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
JosephKeenane0643ab2022-02-15 18:23:05 +0000786 - `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 +0530787 - `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 +0000788 - `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 +0000789
790Known Limitations, Issues and Workarounds
791-----------------------------------------
792
793*System Limitations*
794
DylanB95ESTe5573382022-01-27 17:12:52 +0000795Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
796`CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
797of cm handle registration.
niamhcoref7b414e2021-11-17 11:02:07 +0000798
Lathishb3550f12022-03-15 12:03:53 +0000799The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
800for more information.
801
niamhcoref7b414e2021-11-17 11:02:07 +0000802*Known Vulnerabilities*
803
804None
805
806*Workarounds*
807
DylanB95ESTe5573382022-01-27 17:12:52 +0000808Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
809pass an empty string as the value if you do not want to include names for these values.
niamhcoref7b414e2021-11-17 11:02:07 +0000810
811Security Notes
812--------------
813
814*Fixed Security Issues*
815
816None
817
818*Known Security Issues*
819
820None
821
822.. ========================
shivasubedi44beaa32021-09-13 15:16:30 +0100823.. * * * ISTANBUL * * *
824.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000825
Bruno Sakoto0eaf3342022-02-11 15:05:29 -0500826Version: 2.0.4
827==============
828
829Release Data
830------------
831
832+--------------------------------------+--------------------------------------------------------+
833| **CPS Project** | |
834| | |
835+--------------------------------------+--------------------------------------------------------+
836| **Docker images** | onap/cps-and-ncmp:2.0.4 |
837| | |
838+--------------------------------------+--------------------------------------------------------+
839| **Release designation** | 2.0.4 Istanbul |
840| | |
841+--------------------------------------+--------------------------------------------------------+
842| **Release date** | 2022 Feb 09 |
843| | |
844+--------------------------------------+--------------------------------------------------------+
845
846Bug Fixes
847---------
848
849 - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_ Fix docker compose for csit test.
850 - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_ Fix intermittent circular dependency error when the application starts.
851
852Version: 2.0.3
853==============
854
855Release Data
856------------
857
858+--------------------------------------+--------------------------------------------------------+
859| **CPS Project** | |
860| | |
861+--------------------------------------+--------------------------------------------------------+
862| **Docker images** | onap/cps-and-ncmp:2.0.3 |
863| | |
864+--------------------------------------+--------------------------------------------------------+
865| **Release designation** | 2.0.3 Istanbul |
866| | |
867+--------------------------------------+--------------------------------------------------------+
868| **Release date** | 2022-07-01 |
869| | |
870+--------------------------------------+--------------------------------------------------------+
871
872Bug Fixes
873---------
874
875 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
876
877Version: 2.0.2
878==============
879
880Release Data
881------------
882
883+--------------------------------------+--------------------------------------------------------+
884| **CPS Project** | |
885| | |
886+--------------------------------------+--------------------------------------------------------+
887| **Docker images** | onap/cps-and-ncmp:2.0.2 |
888| | |
889+--------------------------------------+--------------------------------------------------------+
890| **Release designation** | 2.0.2 Istanbul |
891| | |
892+--------------------------------------+--------------------------------------------------------+
893| **Release date** | 2021-16-12 |
894| | |
895+--------------------------------------+--------------------------------------------------------+
896
897Bug Fixes
898---------
899
900 - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_ Update log4j version due to security vulnerability
901
lukegleeson9c583712021-09-30 17:21:11 +0100902Version: 2.0.1
903==============
904
905Release Data
906------------
907
908+--------------------------------------+--------------------------------------------------------+
909| **CPS Project** | |
910| | |
911+--------------------------------------+--------------------------------------------------------+
912| **Docker images** | onap/cps-and-ncmp:2.0.1 |
913| | |
914+--------------------------------------+--------------------------------------------------------+
915| **Release designation** | 2.0.1 Istanbul |
916| | |
917+--------------------------------------+--------------------------------------------------------+
918| **Release date** | 2021-14-10 |
919| | |
920+--------------------------------------+--------------------------------------------------------+
921
922Bug Fixes
923---------
924
925 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
926 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
927 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
928 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
929
930Known Limitations, Issues and Workarounds
931-----------------------------------------
932
933*System Limitations*
934
935Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
936
937*Known Vulnerabilities*
938
939 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
940
941*Workarounds*
942
943Add recursive method to save list node data to loop through all corresponding child nodes.
944
945Security Notes
946--------------
947
948*Fixed Security Issues*
949
950 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
951
952*Known Security Issues*
953
954None
955
shivasubedi44beaa32021-09-13 15:16:30 +0100956Version: 2.0.0
957==============
958
959Abstract
960--------
961
962This document provides the release notes for Istanbul release.
963
964Release Data
965------------
966
967+--------------------------------------+--------------------------------------------------------+
968| **CPS Project** | |
969| | |
970+--------------------------------------+--------------------------------------------------------+
971| **Docker images** | onap/cps-and-ncmp:2.0.0 |
972| | |
973+--------------------------------------+--------------------------------------------------------+
974| **Release designation** | 2.0.0 Istanbul |
975| | |
976+--------------------------------------+--------------------------------------------------------+
lukegleeson9c583712021-09-30 17:21:11 +0100977| **Release date** | 2021-14-09 |
shivasubedi44beaa32021-09-13 15:16:30 +0100978| | |
979+--------------------------------------+--------------------------------------------------------+
980
981Features
982--------
DylanB95EST3fcf8692021-10-11 16:29:16 +0100983* Register DMI-Plugins with NCMP for CM Handle registrations.
shivasubedi44beaa32021-09-13 15:16:30 +0100984* Update, Create and Remove CM Handles.
985* Add support for retrieving and writing CM Handle data through NCMP datastores.
986* Automatic retrieval and caching of model information for CM Handles within NCMP.
987
shivasubedi44beaa32021-09-13 15:16:30 +0100988Deliverables
989------------
990
991Software Deliverables
992
993.. csv-table::
994 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
995 :widths: auto
996
997 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
998
999Bug Fixes
1000---------
1001
lukegleeson9c583712021-09-30 17:21:11 +01001002 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
shivasubedi44beaa32021-09-13 15:16:30 +01001003 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
1004 - `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 +01001005 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
1006 - `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 +01001007 - `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 +01001008 - `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 +01001009 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
1010 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
lukegleeson9c583712021-09-30 17:21:11 +01001011 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
1012 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
1013 - `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 +01001014 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
1015 - `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 +01001016 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
shivasubedi44beaa32021-09-13 15:16:30 +01001017 - `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 +01001018 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
1019 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
1020 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
lukegleeson9c583712021-09-30 17:21:11 +01001021 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
1022 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
1023 - `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 -05001024 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
lukegleeson9c583712021-09-30 17:21:11 +01001025 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
1026 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
1027 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
shivasubedi44beaa32021-09-13 15:16:30 +01001028
1029This document provides the release notes for Istanbul release.
1030
1031Summary
1032-------
1033
1034Following CPS components are available with default ONAP/CPS installation.
1035
1036
1037 * Platform components
1038
1039 - CPS (Helm charts)
1040
1041 * Service components
1042
DylanB95EST3fcf8692021-10-11 16:29:16 +01001043 - CPS-NCMP
1044 - CPS-Temporal
1045 - DMI-Plugin
shivasubedi44beaa32021-09-13 15:16:30 +01001046
1047 * Additional resources that CPS utilizes deployed using ONAP common charts
1048
1049 - Postgres Database
1050
1051
1052Below service components (mS) are available to be deployed on-demand.
1053 - CPS-TBDMT
1054
1055
1056Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1057
1058Known Limitations, Issues and Workarounds
1059-----------------------------------------
1060
shivasubedi44beaa32021-09-13 15:16:30 +01001061*System Limitations*
1062
1063Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
1064
1065*Known Vulnerabilities*
1066
lukegleeson9c583712021-09-30 17:21:11 +01001067 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
1068 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
1069 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
shivasubedi44beaa32021-09-13 15:16:30 +01001070
1071*Workarounds*
1072
1073Add recursive method to save list node data to loop through all corresponding child nodes.
1074
1075Security Notes
1076--------------
1077
1078*Fixed Security Issues*
1079
1080 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
shivasubedi44beaa32021-09-13 15:16:30 +01001081
1082*Known Security Issues*
1083
lukegleeson9c583712021-09-30 17:21:11 +01001084 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
1085
shivasubedi44beaa32021-09-13 15:16:30 +01001086Test Results
1087------------
1088 * `Integration tests`
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001089
ToineSiebelinkf0527c52021-07-06 13:03:03 +01001090.. ========================
1091.. * * * HONOLULU * * *
1092.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001093
ToineSiebelinkfd2134d2021-04-09 11:15:48 +01001094Version: 1.0.1
1095==============
1096
1097Release Data
1098------------
1099
1100+--------------------------------------+--------------------------------------------------------+
1101| **CPS Project** | |
1102| | |
1103+--------------------------------------+--------------------------------------------------------+
1104| **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
1105| | |
1106+--------------------------------------+--------------------------------------------------------+
1107| **Release designation** | 1.0.1 Honolulu |
1108| | |
1109+--------------------------------------+--------------------------------------------------------+
1110| **Release date** | 2021-04-09 |
1111| | |
1112+--------------------------------------+--------------------------------------------------------+
1113
1114Bug Fixes
1115---------
1116
puthuparambil.aditya8b584332021-10-12 16:49:03 +01001117 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
ToineSiebelinkfd2134d2021-04-09 11:15:48 +01001118 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
1119 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
1120 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
1121 - `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
1122 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
1123 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
1124 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
1125
1126Security Notes
1127--------------
1128
1129*Fixed Security Issues*
1130
1131 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001132
ToineSiebelinka2d25b52021-04-13 15:10:47 +01001133*Known Security Issues*
1134
1135 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
1136
Rishi.Chail4359d282021-03-03 16:36:26 +00001137Version: 1.0.0
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001138==============
1139
1140
1141Abstract
1142--------
1143
1144This document provides the release notes for Honolulu release.
1145
1146Summary
1147-------
1148
1149Following CPS components are available with default ONAP/CPS installation.
1150
1151
Rishi.Chail4359d282021-03-03 16:36:26 +00001152 * Platform components
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001153
Rishi.Chail4359d282021-03-03 16:36:26 +00001154 - CPS (Helm charts)
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001155
Rishi.Chail4359d282021-03-03 16:36:26 +00001156 * Service components
1157
1158 - CPS Core
1159
1160 * Additional resources that CPS utilizes deployed using ONAP common charts
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001161
1162 - Postgres Database
1163
1164
Rishi.Chail4359d282021-03-03 16:36:26 +00001165Below service components (mS) are available to be deployed on-demand.
1166 - CPS-TBDMT
1167
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001168
1169Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1170
1171
1172Release Data
1173------------
1174
1175+--------------------------------------+--------------------------------------------------------+
1176| **CPS Project** | |
1177| | |
1178+--------------------------------------+--------------------------------------------------------+
1179| **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
1180| | |
1181+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +00001182| **Release designation** | 1.0.0 Honolulu |
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001183| | |
1184+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +00001185| **Release date** | 2021-03-11 |
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001186| | |
1187+--------------------------------------+--------------------------------------------------------+
1188
1189
1190Features
1191--------
Rishi.Chail4359d282021-03-03 16:36:26 +00001192Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
1193CPS has been driven by the needs of the E2E Networking Slicing use case.
1194It currently supports basic (rw) persistence and simple queries.
1195It also provides MVP support for network data access using simulated data.
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001196
1197.. _honolulu_deliverable:
1198
1199Deliverables
1200------------
1201
1202Software Deliverables
1203
1204.. csv-table::
1205 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1206 :widths: auto
1207
Rishi.Chail4359d282021-03-03 16:36:26 +00001208 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001209
1210
1211Known Limitations, Issues and Workarounds
1212-----------------------------------------
1213
Rishi.Chail4359d282021-03-03 16:36:26 +00001214 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1215 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
1216 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
niamhcoredddf7312021-06-21 14:44:01 +01001217 - `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 +00001218
1219*System Limitations*
1220
1221None
1222
1223*Known Vulnerabilities*
1224
1225None
1226
1227*Workarounds*
1228
1229Documented under corresponding jira if applicable.
1230
1231Security Notes
1232--------------
1233
1234*Fixed Security Issues*
ToineSiebelink7c981df2021-03-01 09:53:56 +00001235
1236* `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
Rishi.Chail4359d282021-03-03 16:36:26 +00001237 - Upgrade org.onap.oparent to 3.2.0
ToineSiebelink7c981df2021-03-01 09:53:56 +00001238 - Upgrade spring.boot to 2.3.8.RELEASE
Rishi.Chail4359d282021-03-03 16:36:26 +00001239 - Upgrade yangtools to 5.0.7
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001240
1241*Known Security Issues*
1242
Rishi.Chail4359d282021-03-03 16:36:26 +00001243 * Weak Crytography using md5
1244 * Risk seen in Zip file expansion
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001245
1246*Known Vulnerabilities in Used Modules*
1247
Rishi.Chail4359d282021-03-03 16:36:26 +00001248 None
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001249
Rishi.Chail4359d282021-03-03 16:36:26 +00001250CPS 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 +00001251
1252Test Results
1253------------
Rishi.Chail4359d282021-03-03 16:36:26 +00001254 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001255
1256References
1257----------
1258
ToineSiebelinkcac21862023-06-22 09:24:04 +01001259For more information on the latest ONAP release, please see:
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001260
1261#. `ONAP Home Page`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001262#. `ONAP Wiki Page`_
ToineSiebelinkcac21862023-06-22 09:24:04 +01001263#. `ONAP Documentation`_
1264#. `ONAP CPS Documentation`_
1265#. `ONAP Release Downloads`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001266
1267
1268.. _`ONAP Home Page`: https://www.onap.org
1269.. _`ONAP Wiki Page`: https://wiki.onap.org
1270.. _`ONAP Documentation`: https://docs.onap.org
ToineSiebelinkcac21862023-06-22 09:24:04 +01001271.. _`ONAP CPS Documentation`: https://docs.onap.org/projects/onap-cps
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001272.. _`ONAP Release Downloads`: https://git.onap.org
1273
1274Quick Links:
1275
1276 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
1277 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_