blob: 66dde1cfb769618159eb813eac2a89cd518de451 [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
egernugbdac4402023-07-21 13:27:24 +010019Version: 3.3.6
20==============
21
22Release Data
23------------
24
25+--------------------------------------+--------------------------------------------------------+
26| **CPS Project** | |
27| | |
28+--------------------------------------+--------------------------------------------------------+
29| **Docker images** | onap/cps-and-ncmp:3.3.6 |
30| | |
31+--------------------------------------+--------------------------------------------------------+
32| **Release designation** | 3.3.6 Montreal |
33| | |
34+--------------------------------------+--------------------------------------------------------+
35| **Release date** | Not yet released |
36| | |
37+--------------------------------------+--------------------------------------------------------+
38
39Bug Fixes
40---------
413.3.6
42
43Features
44--------
danielhanrahan92705462023-05-18 10:18:10 +010045 - `CPS-1696 <https://jira.onap.org/browse/CPS-1696>`_ Get Data Node to return entire List data node.
egernugbdac4402023-07-21 13:27:24 +010046
47
egernug6c9621a2023-07-19 11:05:00 +010048Version: 3.3.5
49==============
50
51Release Data
52------------
53
54+--------------------------------------+--------------------------------------------------------+
55| **CPS Project** | |
56| | |
57+--------------------------------------+--------------------------------------------------------+
58| **Docker images** | onap/cps-and-ncmp:3.3.5 |
59| | |
60+--------------------------------------+--------------------------------------------------------+
61| **Release designation** | 3.3.5 Montreal |
62| | |
63+--------------------------------------+--------------------------------------------------------+
egernugbdac4402023-07-21 13:27:24 +010064| **Release date** | 2023 July 21 |
egernug6c9621a2023-07-19 11:05:00 +010065| | |
66+--------------------------------------+--------------------------------------------------------+
67
68Bug Fixes
69---------
703.3.5
71
72Features
73--------
danielhanrahan74a47152023-06-28 12:55:20 +010074 - `CPS-1760 <https://jira.onap.org/browse/CPS-1760>`_ Improve handling of special characters in Cps Paths
egernug6c9621a2023-07-19 11:05:00 +010075
mpriyank8caa3422023-06-30 11:14:10 +010076Version: 3.3.4
77==============
78
79Release Data
80------------
81
82+--------------------------------------+--------------------------------------------------------+
83| **CPS Project** | |
84| | |
85+--------------------------------------+--------------------------------------------------------+
86| **Docker images** | onap/cps-and-ncmp:3.3.4 |
87| | |
88+--------------------------------------+--------------------------------------------------------+
89| **Release designation** | 3.3.4 Montreal |
90| | |
91+--------------------------------------+--------------------------------------------------------+
egernug6c9621a2023-07-19 11:05:00 +010092| **Release date** | 2023 July 19 |
mpriyank8caa3422023-06-30 11:14:10 +010093| | |
94+--------------------------------------+--------------------------------------------------------+
95
96Bug Fixes
97---------
983.3.4
99
100Features
101--------
egernugdb62ffb2023-07-18 10:57:42 +0100102 - `CPS-1767 <https://jira.onap.org/browse/CPS-1767>`_ Upgrade CPS to java 17
mpriyank8caa3422023-06-30 11:14:10 +0100103
danielhanrahan19f963b2023-06-15 13:52:34 +0100104Version: 3.3.3
105==============
106
107Release Data
108------------
109
110+--------------------------------------+--------------------------------------------------------+
111| **CPS Project** | |
112| | |
113+--------------------------------------+--------------------------------------------------------+
114| **Docker images** | onap/cps-and-ncmp:3.3.3 |
115| | |
116+--------------------------------------+--------------------------------------------------------+
117| **Release designation** | 3.3.3 Montreal |
118| | |
119+--------------------------------------+--------------------------------------------------------+
mpriyank8caa3422023-06-30 11:14:10 +0100120| **Release date** | 2023 June 30 |
danielhanrahan19f963b2023-06-15 13:52:34 +0100121| | |
122+--------------------------------------+--------------------------------------------------------+
123
124Bug Fixes
125---------
1263.3.3
127
128Features
129--------
mpriyank6da95412023-06-29 16:56:11 +0100130 - `CPS-1515 <https://jira.onap.org/browse/CPS-1515>`_ Support Multiple CM-Handles for NCMP Get Operation
131 - `CPS-1675 <https://jira.onap.org/browse/CPS-1675>`_ Persistence write performance improvement(s)
132 - `CPS-1745 <https://jira.onap.org/browse/CPS-1745>`_ Upgrade to Openapi 3.0.3
danielhanrahan19f963b2023-06-15 13:52:34 +0100133
mpriyank436b75b2023-05-03 11:10:08 +0100134Version: 3.3.2
135==============
136
137Release Data
138------------
139
140+--------------------------------------+--------------------------------------------------------+
141| **CPS Project** | |
142| | |
143+--------------------------------------+--------------------------------------------------------+
144| **Docker images** | onap/cps-and-ncmp:3.3.2 |
145| | |
146+--------------------------------------+--------------------------------------------------------+
147| **Release designation** | 3.3.2 Montreal |
148| | |
149+--------------------------------------+--------------------------------------------------------+
danielhanrahan19f963b2023-06-15 13:52:34 +0100150| **Release date** | 2023 June 15 |
mpriyank436b75b2023-05-03 11:10:08 +0100151| | |
152+--------------------------------------+--------------------------------------------------------+
153
154Bug Fixes
155---------
1563.3.2
danielhanrahan5cec5322023-06-15 11:08:54 +0100157 - `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 +0100158
159Features
160--------
--globalc7e5a802023-04-05 17:08:08 +0530161 - `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 +0100162 - `CPS-1273 <https://jira.onap.org/browse/CPS-1273>`_ Add <,> operators support to cps-path
163 - `CPS-1664 <https://jira.onap.org/browse/CPS-1664>`_ Use recursive SQL to fetch descendants in CpsPath queries to improve query performance
164 - `CPS-1676 <https://jira.onap.org/browse/CPS-1676>`_ Entity ID types do not match types in database definition
165 - `CPS-1677 <https://jira.onap.org/browse/CPS-1677>`_ Remove dataspace_id column from Fragment table
mpriyank436b75b2023-05-03 11:10:08 +0100166
lukegleesond7764c42023-04-20 14:11:20 +0100167Version: 3.3.1
halil.cakal0b8d85d2023-03-23 12:44:27 +0000168==============
169
170Release Data
171------------
172
173+--------------------------------------+--------------------------------------------------------+
174| **CPS Project** | |
175| | |
176+--------------------------------------+--------------------------------------------------------+
lukegleesond7764c42023-04-20 14:11:20 +0100177| **Docker images** | onap/cps-and-ncmp:3.3.1 |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000178| | |
179+--------------------------------------+--------------------------------------------------------+
lukegleesond7764c42023-04-20 14:11:20 +0100180| **Release designation** | 3.3.1 Montreal |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000181| | |
182+--------------------------------------+--------------------------------------------------------+
mpriyank436b75b2023-05-03 11:10:08 +0100183| **Release date** | 2023 May 03 |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000184| | |
185+--------------------------------------+--------------------------------------------------------+
186
187Bug Fixes
188---------
lukegleesond7764c42023-04-20 14:11:20 +01001893.3.1
halil.cakal0b8d85d2023-03-23 12:44:27 +0000190 - None
191
192Features
193--------
mpriyank52c5e542023-05-02 15:58:55 +0100194 - `CPS-1272 <https://jira.onap.org/browse/CPS-1272>`_ Add Contains operation to CPS Path
195 - `CPS-1573 <https://jira.onap.org/browse/CPS-1573>`_ Remove 32K limit for DB operations
196 - `CPS-1627 <https://jira.onap.org/browse/CPS-1627>`_ Dependency versions uplift because of vulnerability issues
197 - `CPS-1629 <https://jira.onap.org/browse/CPS-1629>`_ Ordering of leaf elements to support combination of AND/OR in cps-path
198 - `CPS-1637 <https://jira.onap.org/browse/CPS-1637>`_ Extend hazelcast to work on kubernetes
halil.cakal0b8d85d2023-03-23 12:44:27 +0000199
lukegleesond7764c42023-04-20 14:11:20 +0100200Version: 3.3.0
201==============
202
203Release Data
204------------
205
206+--------------------------------------+--------------------------------------------------------+
207| **CPS Project** | |
208| | |
209+--------------------------------------+--------------------------------------------------------+
210| **Docker images** | onap/cps-and-ncmp:3.3.0 |
211| | |
212+--------------------------------------+--------------------------------------------------------+
213| **Release designation** | 3.3.0 Montreal |
214| | |
215+--------------------------------------+--------------------------------------------------------+
216| **Release date** | 2023 April 20 |
217| | |
218+--------------------------------------+--------------------------------------------------------+
219
220Bug Fixes
221---------
2223.3.0
223 - None
224
225Features
226--------
227 - `CPS-1215 <https://jira.onap.org/browse/CPS-1215>`_ Add OR operation for CPS Path
228 - `CPS-1617 <https://jira.onap.org/browse/CPS-1617>`_ Use cascade delete in fragments table
229
230.. ======================
231.. * * * LONDON * * *
232.. ======================
233
mpriyank0fd4d192023-03-10 13:48:20 +0000234Version: 3.2.6
235==============
236
237Release Data
238------------
239
240+--------------------------------------+--------------------------------------------------------+
241| **CPS Project** | |
242| | |
243+--------------------------------------+--------------------------------------------------------+
244| **Docker images** | onap/cps-and-ncmp:3.2.6 |
245| | |
246+--------------------------------------+--------------------------------------------------------+
247| **Release designation** | 3.2.6 London |
248| | |
249+--------------------------------------+--------------------------------------------------------+
seanbeirnef5a3a212023-03-06 09:12:49 +0000250| **Release date** | 2023 March 22 |
mpriyank0fd4d192023-03-10 13:48:20 +0000251| | |
252+--------------------------------------+--------------------------------------------------------+
253
254Bug Fixes
255---------
2563.2.6
arpitsingh2b4c4882023-03-03 21:38:57 +0530257 - `CPS-1526 <https://jira.onap.org/browse/CPS-1526>`_ Fix response message for PATCH operation
seanbeirnef5a3a212023-03-06 09:12:49 +0000258 - `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 +0000259
260Features
261--------
seanbeirnef5a3a212023-03-06 09:12:49 +0000262 - `CPS-1396 <https://jira.onap.org/browse/CPS-1396>`_ Query data nodes across all anchors under one dataspace
mpriyank0fd4d192023-03-10 13:48:20 +0000263
mpriyankade5a6e2023-03-09 17:58:31 +0000264Version: 3.2.5
265==============
266
267Release Data
268------------
269
270+--------------------------------------+--------------------------------------------------------+
271| **CPS Project** | |
272| | |
273+--------------------------------------+--------------------------------------------------------+
274| **Docker images** | onap/cps-and-ncmp:3.2.5 |
275| | |
276+--------------------------------------+--------------------------------------------------------+
277| **Release designation** | 3.2.5 London |
278| | |
279+--------------------------------------+--------------------------------------------------------+
mpriyank06bfe4e2023-03-10 11:48:23 +0000280| **Release date** | 2023 March 10 |
mpriyankade5a6e2023-03-09 17:58:31 +0000281| | |
282+--------------------------------------+--------------------------------------------------------+
283
284Bug Fixes
285---------
2863.2.5
mpriyank06bfe4e2023-03-10 11:48:23 +0000287 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ Introduce control switch for model loader functionality.
mpriyankade5a6e2023-03-09 17:58:31 +0000288
289Features
290--------
291 - None
292
seanbeirnef0f4fd82023-03-07 13:42:04 +0000293Version: 3.2.4
294==============
295
296Release Data
297------------
298
299+--------------------------------------+--------------------------------------------------------+
300| **CPS Project** | |
301| | |
302+--------------------------------------+--------------------------------------------------------+
303| **Docker images** | onap/cps-and-ncmp:3.2.4 |
304| | |
305+--------------------------------------+--------------------------------------------------------+
306| **Release designation** | 3.2.4 London |
307| | |
308+--------------------------------------+--------------------------------------------------------+
mpriyankbd5ba8d2023-03-09 16:33:02 +0000309| **Release date** | 2023 March 09 |
seanbeirnef0f4fd82023-03-07 13:42:04 +0000310| | |
311+--------------------------------------+--------------------------------------------------------+
312
313Bug Fixes
314---------
3153.2.4
mpriyankbd5ba8d2023-03-09 16:33:02 +0000316 - `CPS-1533 <https://jira.onap.org/browse/CPS-1533>`_ Fix for Temp tables cause Out of shared memory errors in Postgres
317 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ NCMP failed to start due to issue in SubscriptionModelLoader
318
319Features
320--------
321 - None
seanbeirnef0f4fd82023-03-07 13:42:04 +0000322
mpriyankfd43dbe2023-02-08 11:21:08 +0000323Version: 3.2.3
324==============
325
326Release Data
327------------
328
329+--------------------------------------+--------------------------------------------------------+
330| **CPS Project** | |
331| | |
332+--------------------------------------+--------------------------------------------------------+
333| **Docker images** | onap/cps-and-ncmp:3.2.3 |
334| | |
335+--------------------------------------+--------------------------------------------------------+
336| **Release designation** | 3.2.3 London |
337| | |
338+--------------------------------------+--------------------------------------------------------+
seanbeirnef9af5f82023-03-07 10:36:18 +0000339| **Release date** | 2023 March 07 |
mpriyankfd43dbe2023-02-08 11:21:08 +0000340| | |
341+--------------------------------------+--------------------------------------------------------+
342
343Bug Fixes
344---------
3453.2.3
seanbeirnef9af5f82023-03-07 10:36:18 +0000346 - `CPS-1494 <https://jira.onap.org/browse/CPS-1494>`_ NCMP Inventory Performance Improvements
mpriyankfd43dbe2023-02-08 11:21:08 +0000347
348Features
349--------
seanbeirnef9af5f82023-03-07 10:36:18 +0000350 - `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
351 - `CPS-1502 <https://jira.onap.org/browse/CPS-1502>`_ Delete Performance Improvements
mpriyankfd43dbe2023-02-08 11:21:08 +0000352
seanbeirnef8e980a2023-01-27 18:09:33 +0000353Version: 3.2.2
354==============
355
356Release Data
357------------
358
359+--------------------------------------+--------------------------------------------------------+
360| **CPS Project** | |
361| | |
362+--------------------------------------+--------------------------------------------------------+
363| **Docker images** | onap/cps-and-ncmp:3.2.2 |
364| | |
365+--------------------------------------+--------------------------------------------------------+
366| **Release designation** | 3.2.2 London |
367| | |
368+--------------------------------------+--------------------------------------------------------+
mpriyankfd43dbe2023-02-08 11:21:08 +0000369| **Release date** | 2023 February 08 |
seanbeirnef8e980a2023-01-27 18:09:33 +0000370| | |
371+--------------------------------------+--------------------------------------------------------+
372
373Bug Fixes
374---------
mpriyank0b5950d2023-02-07 17:55:10 +00003753.2.2
mpriyankfd43dbe2023-02-08 11:21:08 +0000376 - `CPS-1173 <https://jira.onap.org/browse/CPS-1173>`_ Delete Performance Improvements.
mpriyank0b5950d2023-02-07 17:55:10 +0000377
378Features
379--------
380 - None
seanbeirnef8e980a2023-01-27 18:09:33 +0000381
leventecsanyi37d72852022-10-26 10:44:08 +0200382Version: 3.2.1
383==============
mpriyank4bd450e2022-10-05 09:50:59 +0100384
385Release Data
386------------
387
388+--------------------------------------+--------------------------------------------------------+
389| **CPS Project** | |
390| | |
391+--------------------------------------+--------------------------------------------------------+
lukegleesone0154a62023-01-25 15:06:52 +0000392| **Docker images** | onap/cps-and-ncmp:3.2.1 |
mpriyank4bd450e2022-10-05 09:50:59 +0100393| | |
394+--------------------------------------+--------------------------------------------------------+
leventecsanyi37d72852022-10-26 10:44:08 +0200395| **Release designation** | 3.2.1 London |
mpriyank4bd450e2022-10-05 09:50:59 +0100396| | |
397+--------------------------------------+--------------------------------------------------------+
lukegleesone0154a62023-01-25 15:06:52 +0000398| **Release date** | 2023 January 27 |
mpriyank4bd450e2022-10-05 09:50:59 +0100399| | |
400+--------------------------------------+--------------------------------------------------------+
Cédric Ollivier490b20d2023-03-15 21:40:48 +0100401
lukegleeson3be99242022-10-11 14:34:56 +0100402Features
403--------
leventecsanyi37d72852022-10-26 10:44:08 +02004043.2.1
lukegleesone0154a62023-01-25 15:06:52 +0000405 - `CPS-341 <https://jira.onap.org/browse/CPS-341>`_ Added support for multiple data tree instances under 1 anchor.
406 - `CPS-1002 <https://jira.onap.org/browse/CPS-1002>`_ Add CPS-E-05 endpoint for 'Query data, NCMP-Operational Datastore' using cpsPaths
407 - `CPS-1182 <https://jira.onap.org/browse/CPS-1182>`_ Upgrade Opendaylight
ToineSiebelink294bcb52022-12-23 11:07:42 +0000408 - `CPS-1185 <https://jira.onap.org/browse/CPS-1185>`_ Get all dataspaces.
409 - `CPS-1186 <https://jira.onap.org/browse/CPS-1186>`_ Get single dataspace.
lukegleesonf20b4992022-12-09 15:48:55 +0000410 - `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 +0000411 - `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 +0000412 - `CPS-1257 <https://jira.onap.org/browse/CPS-1257>`_ Added support for application/xml Content-Type (write only).
lukegleesone0154a62023-01-25 15:06:52 +0000413 - `CPS-1381 <https://jira.onap.org/browse/CPS-1381>`_ Query large outputs using limit/depth/pagination
ToineSiebelink294bcb52022-12-23 11:07:42 +0000414 - `CPS-1421 <https://jira.onap.org/browse/CPS-1421>`_ Optimized query for large number of hits with descendants.
lukegleesone0154a62023-01-25 15:06:52 +0000415 - `CPS-1422 <https://jira.onap.org/browse/CPS-1422>`_ Fetch CM handles by collection of xpaths (CPS Core)
416 - `CPS-1424 <https://jira.onap.org/browse/CPS-1424>`_ Updating CmHandleStates using batch operation
417 - `CPS-1439 <https://jira.onap.org/browse/CPS-1439>`_ Use native query to delete data nodes
mpriyank4bd450e2022-10-05 09:50:59 +0100418
419Bug Fixes
420---------
ToineSiebelink294bcb52022-12-23 11:07:42 +00004213.2.1
lukegleesone0154a62023-01-25 15:06:52 +0000422 - `CPS-1171 <https://jira.onap.org/browse/CPS-1171>`_ Optimized retrieval of data nodes with many descendants.
423 - `CPS-1288 <https://jira.onap.org/browse/CPS-1288>`_ Hazelcast TTL for IMap is not working
424 - `CPS-1289 <https://jira.onap.org/browse/CPS-1289>`_ Getting wrong error code for create node api
425 - `CPS-1326 <https://jira.onap.org/browse/CPS-1326>`_ Creation of DataNodeBuilder with module name prefix is very slow
426 - `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 +0000427 - `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_ Add Basic Auth to CPS/NCMP OpenAPI Definitions.
lukegleesone0154a62023-01-25 15:06:52 +0000428 - `CPS-1352 <https://jira.onap.org/browse/CPS-1352>`_ Handle YangChoiceNode in right format.
ToineSiebelink294bcb52022-12-23 11:07:42 +0000429 - `CPS-1409 <https://jira.onap.org/browse/CPS-1409>`_ Fix Delete uses case with '/' in path.
lukegleesone0154a62023-01-25 15:06:52 +0000430 - `CPS-1433 <https://jira.onap.org/browse/CPS-1433>`_ Fix to allow posting data with '/' key fields.
431 - `CPS-1442 <https://jira.onap.org/browse/CPS-1442>`_ CPS PATCH operation does not merge existing data
432 - `CPS-1446 <https://jira.onap.org/browse/CPS-1446>`_ Locked cmhandles and ready to locked state transitions causing long cmHandle discovery
433 - `CPS-1457 <https://jira.onap.org/browse/CPS-1457>`_ CpsDataPersistenceService#getDataNodes uses non-normalized xpaths
434 - `CPS-1458 <https://jira.onap.org/browse/CPS-1458>`_ CpsDataPersistenceService#getDataNodes does not handle root xpath
435 - `CPS-1460 <https://jira.onap.org/browse/CPS-1460>`_ CPS Path Processing Performance Test duration is too low
ToineSiebelink294bcb52022-12-23 11:07:42 +0000436
leventecsanyi37d72852022-10-26 10:44:08 +02004373.2.0
ToineSiebelink294bcb52022-12-23 11:07:42 +0000438 - `CPS-1312 <https://jira.onap.org/browse/CPS-1312>`_ CPS(/NCMP) does not have version control.
mpriyank4bd450e2022-10-05 09:50:59 +0100439
lukegleeson3be99242022-10-11 14:34:56 +0100440Known Limitations, Issues and Workarounds
441-----------------------------------------
442
443*System Limitations*
444
seanbeirne72c267e2022-10-18 12:39:22 +0100445For upgrading, CPS uses Liquibase for database upgrades. CPS/NCMP currently only supports upgrading from Liquibase changelog 11 to Liquibase changelog 16.
446This 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 +0100447
arpitsingh2b4c4882023-03-03 21:38:57 +0530448CPS core Patch operation currently supports updating data of one top level data node. When performing Patch on multiple top level data nodes at once
449a 400 Bad Request is sent as response. This is part of commit CPS-1526.
450
seanbeirnedba2b102022-10-27 09:59:17 +0100451.. ====================
452.. * * * KOHN * * *
453.. ====================
454
mpriyankfe775312022-09-30 14:16:51 +0100455Version: 3.1.4
456==============
457
458Release Data
459------------
460
461+--------------------------------------+--------------------------------------------------------+
462| **CPS Project** | |
463| | |
464+--------------------------------------+--------------------------------------------------------+
465| **Docker images** | onap/cps-and-ncmp:3.1.4 |
466| | |
467+--------------------------------------+--------------------------------------------------------+
468| **Release designation** | 3.1.4 Kohn |
469| | |
470+--------------------------------------+--------------------------------------------------------+
mpriyank4bd450e2022-10-05 09:50:59 +0100471| **Release date** | 2022 October 5 |
mpriyankfe775312022-09-30 14:16:51 +0100472| | |
473+--------------------------------------+--------------------------------------------------------+
474
475Bug Fixes
476---------
lukegleeson8c6b5622022-09-29 15:58:06 +0100477 - `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 +0100478 - `CPS-1294 <https://jira.onap.org/browse/CPS-1294>`_ Kafka communication fault caused cmHandle registration error
mpriyankfe775312022-09-30 14:16:51 +0100479
mpriyank06736cb2022-09-29 14:29:40 +0100480Version: 3.1.3
481==============
482
483Release Data
484------------
485
486+--------------------------------------+--------------------------------------------------------+
487| **CPS Project** | |
488| | |
489+--------------------------------------+--------------------------------------------------------+
490| **Docker images** | onap/cps-and-ncmp:3.1.3 |
491| | |
492+--------------------------------------+--------------------------------------------------------+
493| **Release designation** | 3.1.3 Kohn |
494| | |
495+--------------------------------------+--------------------------------------------------------+
mpriyankfe775312022-09-30 14:16:51 +0100496| **Release date** | 2022 September 29 |
mpriyank06736cb2022-09-29 14:29:40 +0100497| | |
498+--------------------------------------+--------------------------------------------------------+
499
500Bug Fixes
501---------
502 - None
503
mpriyankef0ddfc2022-09-28 12:19:34 +0100504Version: 3.1.2
505==============
506
507Release Data
508------------
509
510+--------------------------------------+--------------------------------------------------------+
511| **CPS Project** | |
512| | |
513+--------------------------------------+--------------------------------------------------------+
514| **Docker images** | onap/cps-and-ncmp:3.1.2 |
515| | |
516+--------------------------------------+--------------------------------------------------------+
517| **Release designation** | 3.1.2 Kohn |
518| | |
519+--------------------------------------+--------------------------------------------------------+
mpriyank06736cb2022-09-29 14:29:40 +0100520| **Release date** | 2022 September 28 |
mpriyankef0ddfc2022-09-28 12:19:34 +0100521| | |
522+--------------------------------------+--------------------------------------------------------+
523
524Bug Fixes
525---------
526 - None
527
mpriyanka3f43502022-09-26 14:57:01 +0100528Version: 3.1.1
529==============
530
531Release Data
532------------
533
534+--------------------------------------+--------------------------------------------------------+
535| **CPS Project** | |
536| | |
537+--------------------------------------+--------------------------------------------------------+
538| **Docker images** | onap/cps-and-ncmp:3.1.1 |
539| | |
540+--------------------------------------+--------------------------------------------------------+
541| **Release designation** | 3.1.1 Kohn |
542| | |
543+--------------------------------------+--------------------------------------------------------+
mpriyankef0ddfc2022-09-28 12:19:34 +0100544| **Release date** | 2022 September 28 |
mpriyanka3f43502022-09-26 14:57:01 +0100545| | |
546+--------------------------------------+--------------------------------------------------------+
547
548Bug Fixes
549---------
550 - None
551
lukegleesonc9ec9152022-09-07 14:21:36 +0100552Security Notes
553--------------
554
555*Fixed Security Issues*
556
557 - `CPS-1226 <https://jira.onap.org/browse/CPS-1226>`_ Security bug in the logs
558
lukegleeson4a34fa52022-09-19 15:31:59 +0100559Version: 3.1.0
560==============
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400561
562Release Data
563------------
564
DylanB95ESTb130fd32022-04-04 13:09:22 +0100565+--------------------------------------+--------------------------------------------------------+
566| **CPS Project** | |
567| | |
568+--------------------------------------+--------------------------------------------------------+
569| **Docker images** | onap/cps-and-ncmp:3.1.0 |
570| | |
571+--------------------------------------+--------------------------------------------------------+
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400572| **Release designation** | 3.1.0 Kohn |
DylanB95ESTb130fd32022-04-04 13:09:22 +0100573| | |
574+--------------------------------------+--------------------------------------------------------+
lukegleeson4a34fa52022-09-19 15:31:59 +0100575| **Release date** | 2022 September 14 |
DylanB95ESTb130fd32022-04-04 13:09:22 +0100576| | |
577+--------------------------------------+--------------------------------------------------------+
578
579Features
580--------
lukegleeson4a34fa52022-09-19 15:31:59 +0100581 - `CPS-340 <https://jira.onap.org/browse/CPS-340>`_ Patch and update the root data node
582 - `CPS-575 <https://jira.onap.org/browse/CPS-575>`_ Write data for cmHandle using ncmp-datastores:passthrough-running (NCMP.)
583 - `CPS-731 <https://jira.onap.org/browse/CPS-731>`_ Query based on Public CM Properties
584 - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_ Async: NCMP Rest impl. including Request ID generation
585 - `CPS-829 <https://jira.onap.org/browse/CPS-829>`_ Async: Internal message topic incl. basic producer & Consumer
586 - `CPS-830 <https://jira.onap.org/browse/CPS-830>`_ DMI-NCMP Asynchronously Publish Response Event to Client Topic
587 - `CPS-869 <https://jira.onap.org/browse/CPS-869>`_ Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072
588 - `CPS-870 <https://jira.onap.org/browse/CPS-870>`_ Align CPS-Core output with SDN-C output (add module name)
589 - `CPS-875 <https://jira.onap.org/browse/CPS-875>`_ CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles
590 - `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'
591 - `CPS-899 <https://jira.onap.org/browse/CPS-899>`_ Start and stop sessions on Java API
592 - `CPS-909 <https://jira.onap.org/browse/CPS-909>`_ Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state
593 - `CPS-917 <https://jira.onap.org/browse/CPS-917>`_ Structured Errors response for passthrough use-cases in NCMP
594 - `CPS-953 <https://jira.onap.org/browse/CPS-953>`_ Update maven deploy plugin version
595 - `CPS-977 <https://jira.onap.org/browse/CPS-977>`_ Query CM Handles using CpsPath
596 - `CPS-1000 <https://jira.onap.org/browse/CPS-1000>`_ Create Data Synchronization watchdog
597 - `CPS-1016 <https://jira.onap.org/browse/CPS-1016>`_ Merge 2 'query' end points in NCMP
598 - `CPS-1034 <https://jira.onap.org/browse/CPS-1034>`_ Publish lifecycle events for ADVISED , READY and LOCKED state transition"
599 - `CPS-1064 <https://jira.onap.org/browse/CPS-1064>`_ Support retrieval of YANG module sources for CM handle on the NCMP interface
600 - `CPS-1099 <https://jira.onap.org/browse/CPS-1099>`_ Expose simplified 'external' lock reason enum state over REST interface
601 - `CPS-1101 <https://jira.onap.org/browse/CPS-1101>`_ Introducing the DELETING and DELETED Cmhandle State
602 - `CPS-1102 <https://jira.onap.org/browse/CPS-1102>`_ Register the Cmhandle Sends Advised State notification.
603 - `CPS-1133 <https://jira.onap.org/browse/CPS-1133>`_ Enable/Disable Data Sync for Cm Handle
604 - `CPS-1136 <https://jira.onap.org/browse/CPS-1136>`_ DMI Audit Support (get all CM Handles for a registered DMI)
605
emacleeafb17362022-09-02 14:40:17 +0100606
607Bug Fixes
608---------
lukegleeson4a34fa52022-09-19 15:31:59 +0100609 - `CPS-896 <https://jira.onap.org/browse/CPS-896>`_ CM Handle Registration Process only partially completes when exception is thrown
610 - `CPS-957 <https://jira.onap.org/browse/CPS-957>`_ NCMP: fix getResourceDataForPassthroughOperational endpoint
611 - `CPS-1020 <https://jira.onap.org/browse/CPS-1020>`_ DuplicatedYangResourceException error at parallel cmHandle registration
612 - `CPS-1056 <https://jira.onap.org/browse/CPS-1056>`_ Wrong error response format in case of Dmi plugin error
613 - `CPS-1067 <https://jira.onap.org/browse/CPS-1067>`_ NCMP returns 500 error on searches endpoint when No DMi Handles registered
614 - `CPS-1085 <https://jira.onap.org/browse/CPS-1085>`_ Performance degradation on ncmp/v1/ch/searches endpoint
615 - `CPS-1088 <https://jira.onap.org/browse/CPS-1088>`_ Kafka consumer can not be turned off
616 - `CPS-1097 <https://jira.onap.org/browse/CPS-1097>`_ Unable to change state from LOCKED to ADVISED
617 - `CPS-1126 <https://jira.onap.org/browse/CPS-1126>`_ CmHandle creation performance degradation
618 - `CPS-1175 <https://jira.onap.org/browse/CPS-1175>`_ Incorrect response when empty body executed for cmhandle id-searches
619 - `CPS-1179 <https://jira.onap.org/browse/CPS-1179>`_ Node API - GET method returns invalid response when identifier contains '/'
620 - `CPS-1212 <https://jira.onap.org/browse/CPS-1212>`_ Additional Properties for CM Handles not included when send to DMI Plugin
621 - `CPS-1217 <https://jira.onap.org/browse/CPS-1217>`_ Searches endpoint gives back empty list however there are already available cmhandles
622 - `CPS-1218 <https://jira.onap.org/browse/CPS-1218>`_ NCMP logs are flooded with SyncUtils logs
puthuparambil.adityadd904322022-09-21 10:53:51 +0100623
624Known Limitations, Issues and Workarounds
625-----------------------------------------
626
627*System Limitations*
628
629Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition.
630Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces']
DylanB95ESTb130fd32022-04-04 13:09:22 +0100631
lukegleeson4a34fa52022-09-19 15:31:59 +0100632*Known Vulnerabilities*
633
634None
635
636*Workarounds*
637
638None
639
640Security Notes
641--------------
642
643*Fixed Security Issues*
644
645 - `CPS-963 <https://jira.onap.org/browse/CPS-963>`_ Liquibase has got serious vulnerability, upgrade required
646
647*Known Security Issues*
648
649None
650
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400651.. ========================
652.. * * * JAKARTA * * *
653.. ========================
654
655Version: 3.0.1
656==============
657
658Release Data
659------------
660
661+--------------------------------------+--------------------------------------------------------+
662| **CPS Project** | |
663| | |
664+--------------------------------------+--------------------------------------------------------+
665| **Docker images** | onap/cps-and-ncmp:3.0.1 |
666| | |
667+--------------------------------------+--------------------------------------------------------+
668| **Release designation** | 3.0.1 Jakarta |
669| | |
670+--------------------------------------+--------------------------------------------------------+
671| **Release date** | 2022 April 28 |
672| | |
673+--------------------------------------+--------------------------------------------------------+
674
675Bug Fixes
676---------
677 - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_ Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
678
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400679Version: 3.0.0
680==============
niamhcoref7b414e2021-11-17 11:02:07 +0000681
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400682Release Data
683------------
684
685+--------------------------------------+--------------------------------------------------------+
686| **CPS Project** | |
687| | |
688+--------------------------------------+--------------------------------------------------------+
689| **Docker images** | onap/cps-and-ncmp:3.0.0 |
690| | |
691+--------------------------------------+--------------------------------------------------------+
692| **Release designation** | 3.0.0 Jakarta |
693| | |
694+--------------------------------------+--------------------------------------------------------+
695| **Release date** | 2022 March 15 |
696| | |
697+--------------------------------------+--------------------------------------------------------+
niamhcoref7b414e2021-11-17 11:02:07 +0000698
699Features
700--------
puthuparambil.adityad0007332021-12-08 18:53:39 +0000701 - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_ Define response objects (schemas) in cps-ncmp
niamhcoref7b414e2021-11-17 11:02:07 +0000702 - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_ Update operation for datastore pass through running
703 - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_ Delete operation for datastore pass through running
DylanB95ESTe5573382022-01-27 17:12:52 +0000704 - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_ Support 'public' Cm Handle Properties
niamhcoref7b414e2021-11-17 11:02:07 +0000705 - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
JosephKeenan82ebf532021-12-08 18:16:44 +0000706 - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_ Ensure all DMI operations use POST method
puthuparambil.adityad0007332021-12-08 18:53:39 +0000707 - `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 -0400708 - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
709 - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
DylanB95ESTe5573382022-01-27 17:12:52 +0000710 - `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 +0530711 - `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 +0000712
713Bug Fixes
714---------
715
716 - `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 +0000717 - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
niamhcore65bc4fd2021-12-08 14:19:02 +0000718 - `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 +0000719 - `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 +0000720 - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
JosephKeenane0643ab2022-02-15 18:23:05 +0000721 - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
DylanB95ESTe5573382022-01-27 17:12:52 +0000722 - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
JosephKeenane0643ab2022-02-15 18:23:05 +0000723 - `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 +0530724 - `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 +0000725 - `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 +0000726
727Known Limitations, Issues and Workarounds
728-----------------------------------------
729
730*System Limitations*
731
DylanB95ESTe5573382022-01-27 17:12:52 +0000732Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
733`CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
734of cm handle registration.
niamhcoref7b414e2021-11-17 11:02:07 +0000735
Lathishb3550f12022-03-15 12:03:53 +0000736The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
737for more information.
738
niamhcoref7b414e2021-11-17 11:02:07 +0000739*Known Vulnerabilities*
740
741None
742
743*Workarounds*
744
DylanB95ESTe5573382022-01-27 17:12:52 +0000745Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
746pass an empty string as the value if you do not want to include names for these values.
niamhcoref7b414e2021-11-17 11:02:07 +0000747
748Security Notes
749--------------
750
751*Fixed Security Issues*
752
753None
754
755*Known Security Issues*
756
757None
758
759.. ========================
shivasubedi44beaa32021-09-13 15:16:30 +0100760.. * * * ISTANBUL * * *
761.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000762
Bruno Sakoto0eaf3342022-02-11 15:05:29 -0500763Version: 2.0.4
764==============
765
766Release Data
767------------
768
769+--------------------------------------+--------------------------------------------------------+
770| **CPS Project** | |
771| | |
772+--------------------------------------+--------------------------------------------------------+
773| **Docker images** | onap/cps-and-ncmp:2.0.4 |
774| | |
775+--------------------------------------+--------------------------------------------------------+
776| **Release designation** | 2.0.4 Istanbul |
777| | |
778+--------------------------------------+--------------------------------------------------------+
779| **Release date** | 2022 Feb 09 |
780| | |
781+--------------------------------------+--------------------------------------------------------+
782
783Bug Fixes
784---------
785
786 - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_ Fix docker compose for csit test.
787 - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_ Fix intermittent circular dependency error when the application starts.
788
789Version: 2.0.3
790==============
791
792Release Data
793------------
794
795+--------------------------------------+--------------------------------------------------------+
796| **CPS Project** | |
797| | |
798+--------------------------------------+--------------------------------------------------------+
799| **Docker images** | onap/cps-and-ncmp:2.0.3 |
800| | |
801+--------------------------------------+--------------------------------------------------------+
802| **Release designation** | 2.0.3 Istanbul |
803| | |
804+--------------------------------------+--------------------------------------------------------+
805| **Release date** | 2022-07-01 |
806| | |
807+--------------------------------------+--------------------------------------------------------+
808
809Bug Fixes
810---------
811
812 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
813
814Version: 2.0.2
815==============
816
817Release Data
818------------
819
820+--------------------------------------+--------------------------------------------------------+
821| **CPS Project** | |
822| | |
823+--------------------------------------+--------------------------------------------------------+
824| **Docker images** | onap/cps-and-ncmp:2.0.2 |
825| | |
826+--------------------------------------+--------------------------------------------------------+
827| **Release designation** | 2.0.2 Istanbul |
828| | |
829+--------------------------------------+--------------------------------------------------------+
830| **Release date** | 2021-16-12 |
831| | |
832+--------------------------------------+--------------------------------------------------------+
833
834Bug Fixes
835---------
836
837 - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_ Update log4j version due to security vulnerability
838
lukegleeson9c583712021-09-30 17:21:11 +0100839Version: 2.0.1
840==============
841
842Release Data
843------------
844
845+--------------------------------------+--------------------------------------------------------+
846| **CPS Project** | |
847| | |
848+--------------------------------------+--------------------------------------------------------+
849| **Docker images** | onap/cps-and-ncmp:2.0.1 |
850| | |
851+--------------------------------------+--------------------------------------------------------+
852| **Release designation** | 2.0.1 Istanbul |
853| | |
854+--------------------------------------+--------------------------------------------------------+
855| **Release date** | 2021-14-10 |
856| | |
857+--------------------------------------+--------------------------------------------------------+
858
859Bug Fixes
860---------
861
862 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
863 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
864 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
865 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
866
867Known Limitations, Issues and Workarounds
868-----------------------------------------
869
870*System Limitations*
871
872Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
873
874*Known Vulnerabilities*
875
876 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
877
878*Workarounds*
879
880Add recursive method to save list node data to loop through all corresponding child nodes.
881
882Security Notes
883--------------
884
885*Fixed Security Issues*
886
887 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
888
889*Known Security Issues*
890
891None
892
shivasubedi44beaa32021-09-13 15:16:30 +0100893Version: 2.0.0
894==============
895
896Abstract
897--------
898
899This document provides the release notes for Istanbul release.
900
901Release Data
902------------
903
904+--------------------------------------+--------------------------------------------------------+
905| **CPS Project** | |
906| | |
907+--------------------------------------+--------------------------------------------------------+
908| **Docker images** | onap/cps-and-ncmp:2.0.0 |
909| | |
910+--------------------------------------+--------------------------------------------------------+
911| **Release designation** | 2.0.0 Istanbul |
912| | |
913+--------------------------------------+--------------------------------------------------------+
lukegleeson9c583712021-09-30 17:21:11 +0100914| **Release date** | 2021-14-09 |
shivasubedi44beaa32021-09-13 15:16:30 +0100915| | |
916+--------------------------------------+--------------------------------------------------------+
917
918Features
919--------
DylanB95EST3fcf8692021-10-11 16:29:16 +0100920* Register DMI-Plugins with NCMP for CM Handle registrations.
shivasubedi44beaa32021-09-13 15:16:30 +0100921* Update, Create and Remove CM Handles.
922* Add support for retrieving and writing CM Handle data through NCMP datastores.
923* Automatic retrieval and caching of model information for CM Handles within NCMP.
924
shivasubedi44beaa32021-09-13 15:16:30 +0100925Deliverables
926------------
927
928Software Deliverables
929
930.. csv-table::
931 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
932 :widths: auto
933
934 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
935
936Bug Fixes
937---------
938
lukegleeson9c583712021-09-30 17:21:11 +0100939 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
shivasubedi44beaa32021-09-13 15:16:30 +0100940 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
941 - `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 +0100942 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
943 - `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 +0100944 - `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 +0100945 - `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 +0100946 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
947 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
lukegleeson9c583712021-09-30 17:21:11 +0100948 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
949 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
950 - `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 +0100951 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
952 - `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 +0100953 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
shivasubedi44beaa32021-09-13 15:16:30 +0100954 - `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 +0100955 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
956 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
957 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
lukegleeson9c583712021-09-30 17:21:11 +0100958 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
959 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
960 - `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 -0500961 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
lukegleeson9c583712021-09-30 17:21:11 +0100962 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
963 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
964 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
shivasubedi44beaa32021-09-13 15:16:30 +0100965
966This document provides the release notes for Istanbul release.
967
968Summary
969-------
970
971Following CPS components are available with default ONAP/CPS installation.
972
973
974 * Platform components
975
976 - CPS (Helm charts)
977
978 * Service components
979
DylanB95EST3fcf8692021-10-11 16:29:16 +0100980 - CPS-NCMP
981 - CPS-Temporal
982 - DMI-Plugin
shivasubedi44beaa32021-09-13 15:16:30 +0100983
984 * Additional resources that CPS utilizes deployed using ONAP common charts
985
986 - Postgres Database
987
988
989Below service components (mS) are available to be deployed on-demand.
990 - CPS-TBDMT
991
992
993Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
994
995Known Limitations, Issues and Workarounds
996-----------------------------------------
997
shivasubedi44beaa32021-09-13 15:16:30 +0100998*System Limitations*
999
1000Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
1001
1002*Known Vulnerabilities*
1003
lukegleeson9c583712021-09-30 17:21:11 +01001004 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
1005 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
1006 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
shivasubedi44beaa32021-09-13 15:16:30 +01001007
1008*Workarounds*
1009
1010Add recursive method to save list node data to loop through all corresponding child nodes.
1011
1012Security Notes
1013--------------
1014
1015*Fixed Security Issues*
1016
1017 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
shivasubedi44beaa32021-09-13 15:16:30 +01001018
1019*Known Security Issues*
1020
lukegleeson9c583712021-09-30 17:21:11 +01001021 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
1022
shivasubedi44beaa32021-09-13 15:16:30 +01001023Test Results
1024------------
1025 * `Integration tests`
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001026
ToineSiebelinkf0527c52021-07-06 13:03:03 +01001027.. ========================
1028.. * * * HONOLULU * * *
1029.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001030
ToineSiebelinkfd2134d2021-04-09 11:15:48 +01001031Version: 1.0.1
1032==============
1033
1034Release Data
1035------------
1036
1037+--------------------------------------+--------------------------------------------------------+
1038| **CPS Project** | |
1039| | |
1040+--------------------------------------+--------------------------------------------------------+
1041| **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
1042| | |
1043+--------------------------------------+--------------------------------------------------------+
1044| **Release designation** | 1.0.1 Honolulu |
1045| | |
1046+--------------------------------------+--------------------------------------------------------+
1047| **Release date** | 2021-04-09 |
1048| | |
1049+--------------------------------------+--------------------------------------------------------+
1050
1051Bug Fixes
1052---------
1053
puthuparambil.aditya8b584332021-10-12 16:49:03 +01001054 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
ToineSiebelinkfd2134d2021-04-09 11:15:48 +01001055 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
1056 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
1057 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
1058 - `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
1059 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
1060 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
1061 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
1062
1063Security Notes
1064--------------
1065
1066*Fixed Security Issues*
1067
1068 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001069
ToineSiebelinka2d25b52021-04-13 15:10:47 +01001070*Known Security Issues*
1071
1072 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
1073
Rishi.Chail4359d282021-03-03 16:36:26 +00001074Version: 1.0.0
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001075==============
1076
1077
1078Abstract
1079--------
1080
1081This document provides the release notes for Honolulu release.
1082
1083Summary
1084-------
1085
1086Following CPS components are available with default ONAP/CPS installation.
1087
1088
Rishi.Chail4359d282021-03-03 16:36:26 +00001089 * Platform components
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001090
Rishi.Chail4359d282021-03-03 16:36:26 +00001091 - CPS (Helm charts)
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001092
Rishi.Chail4359d282021-03-03 16:36:26 +00001093 * Service components
1094
1095 - CPS Core
1096
1097 * Additional resources that CPS utilizes deployed using ONAP common charts
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001098
1099 - Postgres Database
1100
1101
Rishi.Chail4359d282021-03-03 16:36:26 +00001102Below service components (mS) are available to be deployed on-demand.
1103 - CPS-TBDMT
1104
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001105
1106Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1107
1108
1109Release Data
1110------------
1111
1112+--------------------------------------+--------------------------------------------------------+
1113| **CPS Project** | |
1114| | |
1115+--------------------------------------+--------------------------------------------------------+
1116| **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
1117| | |
1118+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +00001119| **Release designation** | 1.0.0 Honolulu |
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001120| | |
1121+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +00001122| **Release date** | 2021-03-11 |
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001123| | |
1124+--------------------------------------+--------------------------------------------------------+
1125
1126
1127Features
1128--------
Rishi.Chail4359d282021-03-03 16:36:26 +00001129Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
1130CPS has been driven by the needs of the E2E Networking Slicing use case.
1131It currently supports basic (rw) persistence and simple queries.
1132It also provides MVP support for network data access using simulated data.
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001133
1134.. _honolulu_deliverable:
1135
1136Deliverables
1137------------
1138
1139Software Deliverables
1140
1141.. csv-table::
1142 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1143 :widths: auto
1144
Rishi.Chail4359d282021-03-03 16:36:26 +00001145 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001146
1147
1148Known Limitations, Issues and Workarounds
1149-----------------------------------------
1150
Rishi.Chail4359d282021-03-03 16:36:26 +00001151 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1152 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
1153 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
niamhcoredddf7312021-06-21 14:44:01 +01001154 - `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 +00001155
1156*System Limitations*
1157
1158None
1159
1160*Known Vulnerabilities*
1161
1162None
1163
1164*Workarounds*
1165
1166Documented under corresponding jira if applicable.
1167
1168Security Notes
1169--------------
1170
1171*Fixed Security Issues*
ToineSiebelink7c981df2021-03-01 09:53:56 +00001172
1173* `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
Rishi.Chail4359d282021-03-03 16:36:26 +00001174 - Upgrade org.onap.oparent to 3.2.0
ToineSiebelink7c981df2021-03-01 09:53:56 +00001175 - Upgrade spring.boot to 2.3.8.RELEASE
Rishi.Chail4359d282021-03-03 16:36:26 +00001176 - Upgrade yangtools to 5.0.7
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001177
1178*Known Security Issues*
1179
Rishi.Chail4359d282021-03-03 16:36:26 +00001180 * Weak Crytography using md5
1181 * Risk seen in Zip file expansion
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001182
1183*Known Vulnerabilities in Used Modules*
1184
Rishi.Chail4359d282021-03-03 16:36:26 +00001185 None
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001186
Rishi.Chail4359d282021-03-03 16:36:26 +00001187CPS 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 +00001188
1189Test Results
1190------------
Rishi.Chail4359d282021-03-03 16:36:26 +00001191 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001192
1193References
1194----------
1195
ToineSiebelinkcac21862023-06-22 09:24:04 +01001196For more information on the latest ONAP release, please see:
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001197
1198#. `ONAP Home Page`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001199#. `ONAP Wiki Page`_
ToineSiebelinkcac21862023-06-22 09:24:04 +01001200#. `ONAP Documentation`_
1201#. `ONAP CPS Documentation`_
1202#. `ONAP Release Downloads`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001203
1204
1205.. _`ONAP Home Page`: https://www.onap.org
1206.. _`ONAP Wiki Page`: https://wiki.onap.org
1207.. _`ONAP Documentation`: https://docs.onap.org
ToineSiebelinkcac21862023-06-22 09:24:04 +01001208.. _`ONAP CPS Documentation`: https://docs.onap.org/projects/onap-cps
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001209.. _`ONAP Release Downloads`: https://git.onap.org
1210
1211Quick Links:
1212
1213 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
1214 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_