blob: 91ba6638acd3a3cba48f5a610d24cc754f652440 [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
mpriyank89e0fe22023-11-09 12:12:38 +000015.. =========================
16.. * * * NEW DELHI * * *
17.. =========================
niamhcoref7b414e2021-11-17 11:02:07 +000018
mpriyank89e0fe22023-11-09 12:12:38 +000019Version: 3.4.0
20==============
mpriyank2c4535d2023-11-06 17:06:15 +000021
22Release Data
23------------
24
25+--------------------------------------+--------------------------------------------------------+
26| **CPS Project** | |
27| | |
28+--------------------------------------+--------------------------------------------------------+
mpriyank89e0fe22023-11-09 12:12:38 +000029| **Docker images** | onap/cps-and-ncmp:3.4.0 |
mpriyank2c4535d2023-11-06 17:06:15 +000030| | |
31+--------------------------------------+--------------------------------------------------------+
mpriyank89e0fe22023-11-09 12:12:38 +000032| **Release designation** | 3.4.0 New Delhi |
mpriyank2c4535d2023-11-06 17:06:15 +000033| | |
34+--------------------------------------+--------------------------------------------------------+
35| **Release date** | Not yet released |
36| | |
37+--------------------------------------+--------------------------------------------------------+
38
39Bug Fixes
40---------
mpriyank89e0fe22023-11-09 12:12:38 +0000413.4.0
42 - `CPS-1956 <https://jira.onap.org/browse/CPS-1956>`_ Bug fix for No yang resources stored during cmhandle discovery.
mpriyank2c4535d2023-11-06 17:06:15 +000043
mpriyank89e0fe22023-11-09 12:12:38 +000044.. ========================
45.. * * * MONTREAL * * *
46.. ========================
mpriyank2c4535d2023-11-06 17:06:15 +000047
egernugd91a7072023-09-29 12:12:36 +010048Version: 3.3.9
49==============
50
51Release Data
52------------
53
54+--------------------------------------+--------------------------------------------------------+
55| **CPS Project** | |
56| | |
57+--------------------------------------+--------------------------------------------------------+
58| **Docker images** | onap/cps-and-ncmp:3.3.9 |
59| | |
60+--------------------------------------+--------------------------------------------------------+
61| **Release designation** | 3.3.9 Montreal |
62| | |
63+--------------------------------------+--------------------------------------------------------+
mpriyank2c4535d2023-11-06 17:06:15 +000064| **Release date** | 2023 November 06 |
egernugd91a7072023-09-29 12:12:36 +010065| | |
66+--------------------------------------+--------------------------------------------------------+
67
68Bug Fixes
69---------
703.3.9
mpriyank02b2d2a2023-10-25 12:23:10 +010071 - `CPS-1923 <https://jira.onap.org/browse/CPS-1923>`_ CPS and NCMP changed management endpoint and port from /manage to /actuator and port same as cps application port.
mpriyankd74c2d22023-11-06 13:25:38 +000072 - `CPS-1933 <https://jira.onap.org/browse/CPS-1933>`_ Setting up the class loader explicitly in hazelcast config.
egernugd91a7072023-09-29 12:12:36 +010073
74Features
75--------
76
danielhanrahan56384d12023-09-20 17:10:40 +010077Version: 3.3.8
78==============
79
80Release Data
81------------
82
83+--------------------------------------+--------------------------------------------------------+
84| **CPS Project** | |
85| | |
86+--------------------------------------+--------------------------------------------------------+
87| **Docker images** | onap/cps-and-ncmp:3.3.8 |
88| | |
89+--------------------------------------+--------------------------------------------------------+
90| **Release designation** | 3.3.8 Montreal |
91| | |
92+--------------------------------------+--------------------------------------------------------+
egernugd91a7072023-09-29 12:12:36 +010093| **Release date** | 2023 September 29 |
danielhanrahan56384d12023-09-20 17:10:40 +010094| | |
95+--------------------------------------+--------------------------------------------------------+
96
97Bug Fixes
98---------
993.3.8
100
101Features
102--------
egernugcb9d1502023-09-28 09:57:44 +0100103 - `CPS-1888 <https://jira.onap.org/browse/CPS-1888>`_ Uplift Spring Boot to 3.1.2.
danielhanrahan56384d12023-09-20 17:10:40 +0100104
leventecsanyid35ad5c2023-08-23 15:55:30 +0200105Version: 3.3.7
106==============
107
108Release Data
109------------
110
111+--------------------------------------+--------------------------------------------------------+
112| **CPS Project** | |
113| | |
114+--------------------------------------+--------------------------------------------------------+
115| **Docker images** | onap/cps-and-ncmp:3.3.7 |
116| | |
117+--------------------------------------+--------------------------------------------------------+
118| **Release designation** | 3.3.7 Montreal |
119| | |
120+--------------------------------------+--------------------------------------------------------+
danielhanrahan56384d12023-09-20 17:10:40 +0100121| **Release date** | 2023 September 20 |
leventecsanyid35ad5c2023-08-23 15:55:30 +0200122| | |
123+--------------------------------------+--------------------------------------------------------+
124
125Bug Fixes
126---------
1273.3.7
danielhanrahanefc55772023-09-15 12:02:35 +0100128 - `CPS-1866 <https://jira.onap.org/browse/CPS-1866>`_ Fix ClassDefNotFoundError in opendaylight Yang parser
leventecsanyid35ad5c2023-08-23 15:55:30 +0200129
130Features
131--------
egernugcb9d1502023-09-28 09:57:44 +0100132 - `CPS-1789 <https://jira.onap.org/browse/CPS-1789>`_ CPS Upgrade to Springboot 3.0.
egernug60a780c2023-09-19 15:26:42 +0100133
134Note
135----
136Migrating 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 +0200137
egernugbdac4402023-07-21 13:27:24 +0100138Version: 3.3.6
139==============
140
141Release Data
142------------
143
144+--------------------------------------+--------------------------------------------------------+
145| **CPS Project** | |
146| | |
147+--------------------------------------+--------------------------------------------------------+
148| **Docker images** | onap/cps-and-ncmp:3.3.6 |
149| | |
150+--------------------------------------+--------------------------------------------------------+
151| **Release designation** | 3.3.6 Montreal |
152| | |
153+--------------------------------------+--------------------------------------------------------+
leventecsanyid35ad5c2023-08-23 15:55:30 +0200154| **Release date** | 2023 August 23 |
egernugbdac4402023-07-21 13:27:24 +0100155| | |
156+--------------------------------------+--------------------------------------------------------+
157
158Bug Fixes
159---------
1603.3.6
danielhanrahan996d0c22023-08-17 15:43:34 +0100161 - `CPS-1841 <https://jira.onap.org/browse/CPS-1841>`_ Update of top-level data node fails with exception
mpriyank41c7d002023-08-22 13:17:46 +0100162 - `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 +0100163
164Features
165--------
danielhanrahan92705462023-05-18 10:18:10 +0100166 - `CPS-1696 <https://jira.onap.org/browse/CPS-1696>`_ Get Data Node to return entire List data node.
mpriyank612fb572023-08-01 15:36:27 +0100167 - `CPS-1819 <https://jira.onap.org/browse/CPS-1819>`_ Ability to disable sending authorization header.
egernugbdac4402023-07-21 13:27:24 +0100168
169
egernug6c9621a2023-07-19 11:05:00 +0100170Version: 3.3.5
171==============
172
173Release Data
174------------
175
176+--------------------------------------+--------------------------------------------------------+
177| **CPS Project** | |
178| | |
179+--------------------------------------+--------------------------------------------------------+
180| **Docker images** | onap/cps-and-ncmp:3.3.5 |
181| | |
182+--------------------------------------+--------------------------------------------------------+
183| **Release designation** | 3.3.5 Montreal |
184| | |
185+--------------------------------------+--------------------------------------------------------+
egernugbdac4402023-07-21 13:27:24 +0100186| **Release date** | 2023 July 21 |
egernug6c9621a2023-07-19 11:05:00 +0100187| | |
188+--------------------------------------+--------------------------------------------------------+
189
190Bug Fixes
191---------
1923.3.5
193
194Features
195--------
danielhanrahan74a47152023-06-28 12:55:20 +0100196 - `CPS-1760 <https://jira.onap.org/browse/CPS-1760>`_ Improve handling of special characters in Cps Paths
egernug6c9621a2023-07-19 11:05:00 +0100197
mpriyank8caa3422023-06-30 11:14:10 +0100198Version: 3.3.4
199==============
200
201Release Data
202------------
203
204+--------------------------------------+--------------------------------------------------------+
205| **CPS Project** | |
206| | |
207+--------------------------------------+--------------------------------------------------------+
208| **Docker images** | onap/cps-and-ncmp:3.3.4 |
209| | |
210+--------------------------------------+--------------------------------------------------------+
211| **Release designation** | 3.3.4 Montreal |
212| | |
213+--------------------------------------+--------------------------------------------------------+
egernug6c9621a2023-07-19 11:05:00 +0100214| **Release date** | 2023 July 19 |
mpriyank8caa3422023-06-30 11:14:10 +0100215| | |
216+--------------------------------------+--------------------------------------------------------+
217
218Bug Fixes
219---------
2203.3.4
221
222Features
223--------
egernugdb62ffb2023-07-18 10:57:42 +0100224 - `CPS-1767 <https://jira.onap.org/browse/CPS-1767>`_ Upgrade CPS to java 17
mpriyank8caa3422023-06-30 11:14:10 +0100225
danielhanrahan19f963b2023-06-15 13:52:34 +0100226Version: 3.3.3
227==============
228
229Release Data
230------------
231
232+--------------------------------------+--------------------------------------------------------+
233| **CPS Project** | |
234| | |
235+--------------------------------------+--------------------------------------------------------+
236| **Docker images** | onap/cps-and-ncmp:3.3.3 |
237| | |
238+--------------------------------------+--------------------------------------------------------+
239| **Release designation** | 3.3.3 Montreal |
240| | |
241+--------------------------------------+--------------------------------------------------------+
mpriyank8caa3422023-06-30 11:14:10 +0100242| **Release date** | 2023 June 30 |
danielhanrahan19f963b2023-06-15 13:52:34 +0100243| | |
244+--------------------------------------+--------------------------------------------------------+
245
246Bug Fixes
247---------
2483.3.3
249
250Features
251--------
mpriyank6da95412023-06-29 16:56:11 +0100252 - `CPS-1515 <https://jira.onap.org/browse/CPS-1515>`_ Support Multiple CM-Handles for NCMP Get Operation
253 - `CPS-1675 <https://jira.onap.org/browse/CPS-1675>`_ Persistence write performance improvement(s)
254 - `CPS-1745 <https://jira.onap.org/browse/CPS-1745>`_ Upgrade to Openapi 3.0.3
danielhanrahan19f963b2023-06-15 13:52:34 +0100255
mpriyank436b75b2023-05-03 11:10:08 +0100256Version: 3.3.2
257==============
258
259Release Data
260------------
261
262+--------------------------------------+--------------------------------------------------------+
263| **CPS Project** | |
264| | |
265+--------------------------------------+--------------------------------------------------------+
266| **Docker images** | onap/cps-and-ncmp:3.3.2 |
267| | |
268+--------------------------------------+--------------------------------------------------------+
269| **Release designation** | 3.3.2 Montreal |
270| | |
271+--------------------------------------+--------------------------------------------------------+
danielhanrahan19f963b2023-06-15 13:52:34 +0100272| **Release date** | 2023 June 15 |
mpriyank436b75b2023-05-03 11:10:08 +0100273| | |
274+--------------------------------------+--------------------------------------------------------+
275
276Bug Fixes
277---------
2783.3.2
danielhanrahan5cec5322023-06-15 11:08:54 +0100279 - `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 +0100280
281Features
282--------
--globalc7e5a802023-04-05 17:08:08 +0530283 - `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 +0100284 - `CPS-1273 <https://jira.onap.org/browse/CPS-1273>`_ Add <,> operators support to cps-path
285 - `CPS-1664 <https://jira.onap.org/browse/CPS-1664>`_ Use recursive SQL to fetch descendants in CpsPath queries to improve query performance
286 - `CPS-1676 <https://jira.onap.org/browse/CPS-1676>`_ Entity ID types do not match types in database definition
287 - `CPS-1677 <https://jira.onap.org/browse/CPS-1677>`_ Remove dataspace_id column from Fragment table
mpriyank436b75b2023-05-03 11:10:08 +0100288
lukegleesond7764c42023-04-20 14:11:20 +0100289Version: 3.3.1
halil.cakal0b8d85d2023-03-23 12:44:27 +0000290==============
291
292Release Data
293------------
294
295+--------------------------------------+--------------------------------------------------------+
296| **CPS Project** | |
297| | |
298+--------------------------------------+--------------------------------------------------------+
lukegleesond7764c42023-04-20 14:11:20 +0100299| **Docker images** | onap/cps-and-ncmp:3.3.1 |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000300| | |
301+--------------------------------------+--------------------------------------------------------+
lukegleesond7764c42023-04-20 14:11:20 +0100302| **Release designation** | 3.3.1 Montreal |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000303| | |
304+--------------------------------------+--------------------------------------------------------+
mpriyank436b75b2023-05-03 11:10:08 +0100305| **Release date** | 2023 May 03 |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000306| | |
307+--------------------------------------+--------------------------------------------------------+
308
309Bug Fixes
310---------
lukegleesond7764c42023-04-20 14:11:20 +01003113.3.1
halil.cakal0b8d85d2023-03-23 12:44:27 +0000312 - None
313
314Features
315--------
mpriyank52c5e542023-05-02 15:58:55 +0100316 - `CPS-1272 <https://jira.onap.org/browse/CPS-1272>`_ Add Contains operation to CPS Path
317 - `CPS-1573 <https://jira.onap.org/browse/CPS-1573>`_ Remove 32K limit for DB operations
318 - `CPS-1627 <https://jira.onap.org/browse/CPS-1627>`_ Dependency versions uplift because of vulnerability issues
319 - `CPS-1629 <https://jira.onap.org/browse/CPS-1629>`_ Ordering of leaf elements to support combination of AND/OR in cps-path
320 - `CPS-1637 <https://jira.onap.org/browse/CPS-1637>`_ Extend hazelcast to work on kubernetes
halil.cakal0b8d85d2023-03-23 12:44:27 +0000321
lukegleesond7764c42023-04-20 14:11:20 +0100322Version: 3.3.0
323==============
324
325Release Data
326------------
327
328+--------------------------------------+--------------------------------------------------------+
329| **CPS Project** | |
330| | |
331+--------------------------------------+--------------------------------------------------------+
332| **Docker images** | onap/cps-and-ncmp:3.3.0 |
333| | |
334+--------------------------------------+--------------------------------------------------------+
335| **Release designation** | 3.3.0 Montreal |
336| | |
337+--------------------------------------+--------------------------------------------------------+
338| **Release date** | 2023 April 20 |
339| | |
340+--------------------------------------+--------------------------------------------------------+
341
342Bug Fixes
343---------
3443.3.0
345 - None
346
347Features
348--------
349 - `CPS-1215 <https://jira.onap.org/browse/CPS-1215>`_ Add OR operation for CPS Path
350 - `CPS-1617 <https://jira.onap.org/browse/CPS-1617>`_ Use cascade delete in fragments table
351
352.. ======================
353.. * * * LONDON * * *
354.. ======================
355
mpriyank0fd4d192023-03-10 13:48:20 +0000356Version: 3.2.6
357==============
358
359Release Data
360------------
361
362+--------------------------------------+--------------------------------------------------------+
363| **CPS Project** | |
364| | |
365+--------------------------------------+--------------------------------------------------------+
366| **Docker images** | onap/cps-and-ncmp:3.2.6 |
367| | |
368+--------------------------------------+--------------------------------------------------------+
369| **Release designation** | 3.2.6 London |
370| | |
371+--------------------------------------+--------------------------------------------------------+
seanbeirnef5a3a212023-03-06 09:12:49 +0000372| **Release date** | 2023 March 22 |
mpriyank0fd4d192023-03-10 13:48:20 +0000373| | |
374+--------------------------------------+--------------------------------------------------------+
375
376Bug Fixes
377---------
3783.2.6
arpitsingh2b4c4882023-03-03 21:38:57 +0530379 - `CPS-1526 <https://jira.onap.org/browse/CPS-1526>`_ Fix response message for PATCH operation
seanbeirnef5a3a212023-03-06 09:12:49 +0000380 - `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 +0000381
382Features
383--------
seanbeirnef5a3a212023-03-06 09:12:49 +0000384 - `CPS-1396 <https://jira.onap.org/browse/CPS-1396>`_ Query data nodes across all anchors under one dataspace
mpriyank0fd4d192023-03-10 13:48:20 +0000385
mpriyankade5a6e2023-03-09 17:58:31 +0000386Version: 3.2.5
387==============
388
389Release Data
390------------
391
392+--------------------------------------+--------------------------------------------------------+
393| **CPS Project** | |
394| | |
395+--------------------------------------+--------------------------------------------------------+
396| **Docker images** | onap/cps-and-ncmp:3.2.5 |
397| | |
398+--------------------------------------+--------------------------------------------------------+
399| **Release designation** | 3.2.5 London |
400| | |
401+--------------------------------------+--------------------------------------------------------+
mpriyank06bfe4e2023-03-10 11:48:23 +0000402| **Release date** | 2023 March 10 |
mpriyankade5a6e2023-03-09 17:58:31 +0000403| | |
404+--------------------------------------+--------------------------------------------------------+
405
406Bug Fixes
407---------
4083.2.5
mpriyank06bfe4e2023-03-10 11:48:23 +0000409 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ Introduce control switch for model loader functionality.
mpriyankade5a6e2023-03-09 17:58:31 +0000410
411Features
412--------
413 - None
414
seanbeirnef0f4fd82023-03-07 13:42:04 +0000415Version: 3.2.4
416==============
417
418Release Data
419------------
420
421+--------------------------------------+--------------------------------------------------------+
422| **CPS Project** | |
423| | |
424+--------------------------------------+--------------------------------------------------------+
425| **Docker images** | onap/cps-and-ncmp:3.2.4 |
426| | |
427+--------------------------------------+--------------------------------------------------------+
428| **Release designation** | 3.2.4 London |
429| | |
430+--------------------------------------+--------------------------------------------------------+
mpriyankbd5ba8d2023-03-09 16:33:02 +0000431| **Release date** | 2023 March 09 |
seanbeirnef0f4fd82023-03-07 13:42:04 +0000432| | |
433+--------------------------------------+--------------------------------------------------------+
434
435Bug Fixes
436---------
4373.2.4
mpriyankbd5ba8d2023-03-09 16:33:02 +0000438 - `CPS-1533 <https://jira.onap.org/browse/CPS-1533>`_ Fix for Temp tables cause Out of shared memory errors in Postgres
439 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ NCMP failed to start due to issue in SubscriptionModelLoader
440
441Features
442--------
443 - None
seanbeirnef0f4fd82023-03-07 13:42:04 +0000444
mpriyankfd43dbe2023-02-08 11:21:08 +0000445Version: 3.2.3
446==============
447
448Release Data
449------------
450
451+--------------------------------------+--------------------------------------------------------+
452| **CPS Project** | |
453| | |
454+--------------------------------------+--------------------------------------------------------+
455| **Docker images** | onap/cps-and-ncmp:3.2.3 |
456| | |
457+--------------------------------------+--------------------------------------------------------+
458| **Release designation** | 3.2.3 London |
459| | |
460+--------------------------------------+--------------------------------------------------------+
seanbeirnef9af5f82023-03-07 10:36:18 +0000461| **Release date** | 2023 March 07 |
mpriyankfd43dbe2023-02-08 11:21:08 +0000462| | |
463+--------------------------------------+--------------------------------------------------------+
464
465Bug Fixes
466---------
4673.2.3
seanbeirnef9af5f82023-03-07 10:36:18 +0000468 - `CPS-1494 <https://jira.onap.org/browse/CPS-1494>`_ NCMP Inventory Performance Improvements
mpriyankfd43dbe2023-02-08 11:21:08 +0000469
470Features
471--------
seanbeirnef9af5f82023-03-07 10:36:18 +0000472 - `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
473 - `CPS-1502 <https://jira.onap.org/browse/CPS-1502>`_ Delete Performance Improvements
mpriyankfd43dbe2023-02-08 11:21:08 +0000474
seanbeirnef8e980a2023-01-27 18:09:33 +0000475Version: 3.2.2
476==============
477
478Release Data
479------------
480
481+--------------------------------------+--------------------------------------------------------+
482| **CPS Project** | |
483| | |
484+--------------------------------------+--------------------------------------------------------+
485| **Docker images** | onap/cps-and-ncmp:3.2.2 |
486| | |
487+--------------------------------------+--------------------------------------------------------+
488| **Release designation** | 3.2.2 London |
489| | |
490+--------------------------------------+--------------------------------------------------------+
mpriyankfd43dbe2023-02-08 11:21:08 +0000491| **Release date** | 2023 February 08 |
seanbeirnef8e980a2023-01-27 18:09:33 +0000492| | |
493+--------------------------------------+--------------------------------------------------------+
494
495Bug Fixes
496---------
mpriyank0b5950d2023-02-07 17:55:10 +00004973.2.2
mpriyankfd43dbe2023-02-08 11:21:08 +0000498 - `CPS-1173 <https://jira.onap.org/browse/CPS-1173>`_ Delete Performance Improvements.
mpriyank0b5950d2023-02-07 17:55:10 +0000499
500Features
501--------
502 - None
seanbeirnef8e980a2023-01-27 18:09:33 +0000503
leventecsanyi37d72852022-10-26 10:44:08 +0200504Version: 3.2.1
505==============
mpriyank4bd450e2022-10-05 09:50:59 +0100506
507Release Data
508------------
509
510+--------------------------------------+--------------------------------------------------------+
511| **CPS Project** | |
512| | |
513+--------------------------------------+--------------------------------------------------------+
lukegleesone0154a62023-01-25 15:06:52 +0000514| **Docker images** | onap/cps-and-ncmp:3.2.1 |
mpriyank4bd450e2022-10-05 09:50:59 +0100515| | |
516+--------------------------------------+--------------------------------------------------------+
leventecsanyi37d72852022-10-26 10:44:08 +0200517| **Release designation** | 3.2.1 London |
mpriyank4bd450e2022-10-05 09:50:59 +0100518| | |
519+--------------------------------------+--------------------------------------------------------+
lukegleesone0154a62023-01-25 15:06:52 +0000520| **Release date** | 2023 January 27 |
mpriyank4bd450e2022-10-05 09:50:59 +0100521| | |
522+--------------------------------------+--------------------------------------------------------+
Cédric Ollivier490b20d2023-03-15 21:40:48 +0100523
lukegleeson3be99242022-10-11 14:34:56 +0100524Features
525--------
leventecsanyi37d72852022-10-26 10:44:08 +02005263.2.1
lukegleesone0154a62023-01-25 15:06:52 +0000527 - `CPS-341 <https://jira.onap.org/browse/CPS-341>`_ Added support for multiple data tree instances under 1 anchor.
528 - `CPS-1002 <https://jira.onap.org/browse/CPS-1002>`_ Add CPS-E-05 endpoint for 'Query data, NCMP-Operational Datastore' using cpsPaths
529 - `CPS-1182 <https://jira.onap.org/browse/CPS-1182>`_ Upgrade Opendaylight
ToineSiebelink294bcb52022-12-23 11:07:42 +0000530 - `CPS-1185 <https://jira.onap.org/browse/CPS-1185>`_ Get all dataspaces.
531 - `CPS-1186 <https://jira.onap.org/browse/CPS-1186>`_ Get single dataspace.
lukegleesonf20b4992022-12-09 15:48:55 +0000532 - `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 +0000533 - `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 +0000534 - `CPS-1257 <https://jira.onap.org/browse/CPS-1257>`_ Added support for application/xml Content-Type (write only).
lukegleesone0154a62023-01-25 15:06:52 +0000535 - `CPS-1381 <https://jira.onap.org/browse/CPS-1381>`_ Query large outputs using limit/depth/pagination
ToineSiebelink294bcb52022-12-23 11:07:42 +0000536 - `CPS-1421 <https://jira.onap.org/browse/CPS-1421>`_ Optimized query for large number of hits with descendants.
lukegleesone0154a62023-01-25 15:06:52 +0000537 - `CPS-1422 <https://jira.onap.org/browse/CPS-1422>`_ Fetch CM handles by collection of xpaths (CPS Core)
538 - `CPS-1424 <https://jira.onap.org/browse/CPS-1424>`_ Updating CmHandleStates using batch operation
539 - `CPS-1439 <https://jira.onap.org/browse/CPS-1439>`_ Use native query to delete data nodes
mpriyank4bd450e2022-10-05 09:50:59 +0100540
541Bug Fixes
542---------
ToineSiebelink294bcb52022-12-23 11:07:42 +00005433.2.1
lukegleesone0154a62023-01-25 15:06:52 +0000544 - `CPS-1171 <https://jira.onap.org/browse/CPS-1171>`_ Optimized retrieval of data nodes with many descendants.
545 - `CPS-1288 <https://jira.onap.org/browse/CPS-1288>`_ Hazelcast TTL for IMap is not working
546 - `CPS-1289 <https://jira.onap.org/browse/CPS-1289>`_ Getting wrong error code for create node api
547 - `CPS-1326 <https://jira.onap.org/browse/CPS-1326>`_ Creation of DataNodeBuilder with module name prefix is very slow
548 - `CPS-1344 <https://jira.onap.org/browse/CPS-1344>`_ Top level container (prefix) is not always the first module
ToineSiebelink74eed2c2023-08-31 17:38:52 +0100549 - `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_ Add Basic Authentication to CPS/NCMP OpenAPI Definitions.
lukegleesone0154a62023-01-25 15:06:52 +0000550 - `CPS-1352 <https://jira.onap.org/browse/CPS-1352>`_ Handle YangChoiceNode in right format.
ToineSiebelink294bcb52022-12-23 11:07:42 +0000551 - `CPS-1409 <https://jira.onap.org/browse/CPS-1409>`_ Fix Delete uses case with '/' in path.
lukegleesone0154a62023-01-25 15:06:52 +0000552 - `CPS-1433 <https://jira.onap.org/browse/CPS-1433>`_ Fix to allow posting data with '/' key fields.
553 - `CPS-1442 <https://jira.onap.org/browse/CPS-1442>`_ CPS PATCH operation does not merge existing data
554 - `CPS-1446 <https://jira.onap.org/browse/CPS-1446>`_ Locked cmhandles and ready to locked state transitions causing long cmHandle discovery
555 - `CPS-1457 <https://jira.onap.org/browse/CPS-1457>`_ CpsDataPersistenceService#getDataNodes uses non-normalized xpaths
556 - `CPS-1458 <https://jira.onap.org/browse/CPS-1458>`_ CpsDataPersistenceService#getDataNodes does not handle root xpath
557 - `CPS-1460 <https://jira.onap.org/browse/CPS-1460>`_ CPS Path Processing Performance Test duration is too low
ToineSiebelink294bcb52022-12-23 11:07:42 +0000558
leventecsanyi37d72852022-10-26 10:44:08 +02005593.2.0
ToineSiebelink294bcb52022-12-23 11:07:42 +0000560 - `CPS-1312 <https://jira.onap.org/browse/CPS-1312>`_ CPS(/NCMP) does not have version control.
mpriyank4bd450e2022-10-05 09:50:59 +0100561
lukegleeson3be99242022-10-11 14:34:56 +0100562Known Limitations, Issues and Workarounds
563-----------------------------------------
564
565*System Limitations*
566
seanbeirne72c267e2022-10-18 12:39:22 +0100567For upgrading, CPS uses Liquibase for database upgrades. CPS/NCMP currently only supports upgrading from Liquibase changelog 11 to Liquibase changelog 16.
568This 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 +0100569
arpitsingh2b4c4882023-03-03 21:38:57 +0530570CPS core Patch operation currently supports updating data of one top level data node. When performing Patch on multiple top level data nodes at once
571a 400 Bad Request is sent as response. This is part of commit CPS-1526.
572
seanbeirnedba2b102022-10-27 09:59:17 +0100573.. ====================
574.. * * * KOHN * * *
575.. ====================
576
mpriyankfe775312022-09-30 14:16:51 +0100577Version: 3.1.4
578==============
579
580Release Data
581------------
582
583+--------------------------------------+--------------------------------------------------------+
584| **CPS Project** | |
585| | |
586+--------------------------------------+--------------------------------------------------------+
587| **Docker images** | onap/cps-and-ncmp:3.1.4 |
588| | |
589+--------------------------------------+--------------------------------------------------------+
590| **Release designation** | 3.1.4 Kohn |
591| | |
592+--------------------------------------+--------------------------------------------------------+
mpriyank4bd450e2022-10-05 09:50:59 +0100593| **Release date** | 2022 October 5 |
mpriyankfe775312022-09-30 14:16:51 +0100594| | |
595+--------------------------------------+--------------------------------------------------------+
596
597Bug Fixes
598---------
lukegleeson8c6b5622022-09-29 15:58:06 +0100599 - `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 +0100600 - `CPS-1294 <https://jira.onap.org/browse/CPS-1294>`_ Kafka communication fault caused cmHandle registration error
mpriyankfe775312022-09-30 14:16:51 +0100601
mpriyank06736cb2022-09-29 14:29:40 +0100602Version: 3.1.3
603==============
604
605Release Data
606------------
607
608+--------------------------------------+--------------------------------------------------------+
609| **CPS Project** | |
610| | |
611+--------------------------------------+--------------------------------------------------------+
612| **Docker images** | onap/cps-and-ncmp:3.1.3 |
613| | |
614+--------------------------------------+--------------------------------------------------------+
615| **Release designation** | 3.1.3 Kohn |
616| | |
617+--------------------------------------+--------------------------------------------------------+
mpriyankfe775312022-09-30 14:16:51 +0100618| **Release date** | 2022 September 29 |
mpriyank06736cb2022-09-29 14:29:40 +0100619| | |
620+--------------------------------------+--------------------------------------------------------+
621
622Bug Fixes
623---------
624 - None
625
mpriyankef0ddfc2022-09-28 12:19:34 +0100626Version: 3.1.2
627==============
628
629Release Data
630------------
631
632+--------------------------------------+--------------------------------------------------------+
633| **CPS Project** | |
634| | |
635+--------------------------------------+--------------------------------------------------------+
636| **Docker images** | onap/cps-and-ncmp:3.1.2 |
637| | |
638+--------------------------------------+--------------------------------------------------------+
639| **Release designation** | 3.1.2 Kohn |
640| | |
641+--------------------------------------+--------------------------------------------------------+
mpriyank06736cb2022-09-29 14:29:40 +0100642| **Release date** | 2022 September 28 |
mpriyankef0ddfc2022-09-28 12:19:34 +0100643| | |
644+--------------------------------------+--------------------------------------------------------+
645
646Bug Fixes
647---------
648 - None
649
mpriyanka3f43502022-09-26 14:57:01 +0100650Version: 3.1.1
651==============
652
653Release Data
654------------
655
656+--------------------------------------+--------------------------------------------------------+
657| **CPS Project** | |
658| | |
659+--------------------------------------+--------------------------------------------------------+
660| **Docker images** | onap/cps-and-ncmp:3.1.1 |
661| | |
662+--------------------------------------+--------------------------------------------------------+
663| **Release designation** | 3.1.1 Kohn |
664| | |
665+--------------------------------------+--------------------------------------------------------+
mpriyankef0ddfc2022-09-28 12:19:34 +0100666| **Release date** | 2022 September 28 |
mpriyanka3f43502022-09-26 14:57:01 +0100667| | |
668+--------------------------------------+--------------------------------------------------------+
669
670Bug Fixes
671---------
672 - None
673
lukegleesonc9ec9152022-09-07 14:21:36 +0100674Security Notes
675--------------
676
677*Fixed Security Issues*
678
679 - `CPS-1226 <https://jira.onap.org/browse/CPS-1226>`_ Security bug in the logs
680
lukegleeson4a34fa52022-09-19 15:31:59 +0100681Version: 3.1.0
682==============
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400683
684Release Data
685------------
686
DylanB95ESTb130fd32022-04-04 13:09:22 +0100687+--------------------------------------+--------------------------------------------------------+
688| **CPS Project** | |
689| | |
690+--------------------------------------+--------------------------------------------------------+
691| **Docker images** | onap/cps-and-ncmp:3.1.0 |
692| | |
693+--------------------------------------+--------------------------------------------------------+
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400694| **Release designation** | 3.1.0 Kohn |
DylanB95ESTb130fd32022-04-04 13:09:22 +0100695| | |
696+--------------------------------------+--------------------------------------------------------+
lukegleeson4a34fa52022-09-19 15:31:59 +0100697| **Release date** | 2022 September 14 |
DylanB95ESTb130fd32022-04-04 13:09:22 +0100698| | |
699+--------------------------------------+--------------------------------------------------------+
700
701Features
702--------
lukegleeson4a34fa52022-09-19 15:31:59 +0100703 - `CPS-340 <https://jira.onap.org/browse/CPS-340>`_ Patch and update the root data node
704 - `CPS-575 <https://jira.onap.org/browse/CPS-575>`_ Write data for cmHandle using ncmp-datastores:passthrough-running (NCMP.)
705 - `CPS-731 <https://jira.onap.org/browse/CPS-731>`_ Query based on Public CM Properties
706 - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_ Async: NCMP Rest impl. including Request ID generation
707 - `CPS-829 <https://jira.onap.org/browse/CPS-829>`_ Async: Internal message topic incl. basic producer & Consumer
708 - `CPS-830 <https://jira.onap.org/browse/CPS-830>`_ DMI-NCMP Asynchronously Publish Response Event to Client Topic
709 - `CPS-869 <https://jira.onap.org/browse/CPS-869>`_ Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072
710 - `CPS-870 <https://jira.onap.org/browse/CPS-870>`_ Align CPS-Core output with SDN-C output (add module name)
711 - `CPS-875 <https://jira.onap.org/browse/CPS-875>`_ CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles
712 - `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'
713 - `CPS-899 <https://jira.onap.org/browse/CPS-899>`_ Start and stop sessions on Java API
714 - `CPS-909 <https://jira.onap.org/browse/CPS-909>`_ Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state
715 - `CPS-917 <https://jira.onap.org/browse/CPS-917>`_ Structured Errors response for passthrough use-cases in NCMP
716 - `CPS-953 <https://jira.onap.org/browse/CPS-953>`_ Update maven deploy plugin version
717 - `CPS-977 <https://jira.onap.org/browse/CPS-977>`_ Query CM Handles using CpsPath
718 - `CPS-1000 <https://jira.onap.org/browse/CPS-1000>`_ Create Data Synchronization watchdog
719 - `CPS-1016 <https://jira.onap.org/browse/CPS-1016>`_ Merge 2 'query' end points in NCMP
720 - `CPS-1034 <https://jira.onap.org/browse/CPS-1034>`_ Publish lifecycle events for ADVISED , READY and LOCKED state transition"
721 - `CPS-1064 <https://jira.onap.org/browse/CPS-1064>`_ Support retrieval of YANG module sources for CM handle on the NCMP interface
722 - `CPS-1099 <https://jira.onap.org/browse/CPS-1099>`_ Expose simplified 'external' lock reason enum state over REST interface
723 - `CPS-1101 <https://jira.onap.org/browse/CPS-1101>`_ Introducing the DELETING and DELETED Cmhandle State
724 - `CPS-1102 <https://jira.onap.org/browse/CPS-1102>`_ Register the Cmhandle Sends Advised State notification.
725 - `CPS-1133 <https://jira.onap.org/browse/CPS-1133>`_ Enable/Disable Data Sync for Cm Handle
726 - `CPS-1136 <https://jira.onap.org/browse/CPS-1136>`_ DMI Audit Support (get all CM Handles for a registered DMI)
727
emacleeafb17362022-09-02 14:40:17 +0100728
729Bug Fixes
730---------
lukegleeson4a34fa52022-09-19 15:31:59 +0100731 - `CPS-896 <https://jira.onap.org/browse/CPS-896>`_ CM Handle Registration Process only partially completes when exception is thrown
732 - `CPS-957 <https://jira.onap.org/browse/CPS-957>`_ NCMP: fix getResourceDataForPassthroughOperational endpoint
733 - `CPS-1020 <https://jira.onap.org/browse/CPS-1020>`_ DuplicatedYangResourceException error at parallel cmHandle registration
734 - `CPS-1056 <https://jira.onap.org/browse/CPS-1056>`_ Wrong error response format in case of Dmi plugin error
ToineSiebelink74eed2c2023-08-31 17:38:52 +0100735 - `CPS-1067 <https://jira.onap.org/browse/CPS-1067>`_ NCMP returns 500 error on searches endpoint when No DMI Handles registered
lukegleeson4a34fa52022-09-19 15:31:59 +0100736 - `CPS-1085 <https://jira.onap.org/browse/CPS-1085>`_ Performance degradation on ncmp/v1/ch/searches endpoint
737 - `CPS-1088 <https://jira.onap.org/browse/CPS-1088>`_ Kafka consumer can not be turned off
738 - `CPS-1097 <https://jira.onap.org/browse/CPS-1097>`_ Unable to change state from LOCKED to ADVISED
739 - `CPS-1126 <https://jira.onap.org/browse/CPS-1126>`_ CmHandle creation performance degradation
740 - `CPS-1175 <https://jira.onap.org/browse/CPS-1175>`_ Incorrect response when empty body executed for cmhandle id-searches
741 - `CPS-1179 <https://jira.onap.org/browse/CPS-1179>`_ Node API - GET method returns invalid response when identifier contains '/'
742 - `CPS-1212 <https://jira.onap.org/browse/CPS-1212>`_ Additional Properties for CM Handles not included when send to DMI Plugin
743 - `CPS-1217 <https://jira.onap.org/browse/CPS-1217>`_ Searches endpoint gives back empty list however there are already available cmhandles
744 - `CPS-1218 <https://jira.onap.org/browse/CPS-1218>`_ NCMP logs are flooded with SyncUtils logs
puthuparambil.adityadd904322022-09-21 10:53:51 +0100745
746Known Limitations, Issues and Workarounds
747-----------------------------------------
748
749*System Limitations*
750
751Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition.
752Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces']
DylanB95ESTb130fd32022-04-04 13:09:22 +0100753
lukegleeson4a34fa52022-09-19 15:31:59 +0100754*Known Vulnerabilities*
755
756None
757
758*Workarounds*
759
760None
761
762Security Notes
763--------------
764
765*Fixed Security Issues*
766
767 - `CPS-963 <https://jira.onap.org/browse/CPS-963>`_ Liquibase has got serious vulnerability, upgrade required
768
769*Known Security Issues*
770
771None
772
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400773.. ========================
774.. * * * JAKARTA * * *
775.. ========================
776
777Version: 3.0.1
778==============
779
780Release Data
781------------
782
783+--------------------------------------+--------------------------------------------------------+
784| **CPS Project** | |
785| | |
786+--------------------------------------+--------------------------------------------------------+
787| **Docker images** | onap/cps-and-ncmp:3.0.1 |
788| | |
789+--------------------------------------+--------------------------------------------------------+
790| **Release designation** | 3.0.1 Jakarta |
791| | |
792+--------------------------------------+--------------------------------------------------------+
793| **Release date** | 2022 April 28 |
794| | |
795+--------------------------------------+--------------------------------------------------------+
796
797Bug Fixes
798---------
799 - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_ Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
800
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400801Version: 3.0.0
802==============
niamhcoref7b414e2021-11-17 11:02:07 +0000803
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400804Release Data
805------------
806
807+--------------------------------------+--------------------------------------------------------+
808| **CPS Project** | |
809| | |
810+--------------------------------------+--------------------------------------------------------+
811| **Docker images** | onap/cps-and-ncmp:3.0.0 |
812| | |
813+--------------------------------------+--------------------------------------------------------+
814| **Release designation** | 3.0.0 Jakarta |
815| | |
816+--------------------------------------+--------------------------------------------------------+
817| **Release date** | 2022 March 15 |
818| | |
819+--------------------------------------+--------------------------------------------------------+
niamhcoref7b414e2021-11-17 11:02:07 +0000820
821Features
822--------
puthuparambil.adityad0007332021-12-08 18:53:39 +0000823 - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_ Define response objects (schemas) in cps-ncmp
niamhcoref7b414e2021-11-17 11:02:07 +0000824 - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_ Update operation for datastore pass through running
825 - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_ Delete operation for datastore pass through running
DylanB95ESTe5573382022-01-27 17:12:52 +0000826 - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_ Support 'public' Cm Handle Properties
niamhcoref7b414e2021-11-17 11:02:07 +0000827 - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
JosephKeenan82ebf532021-12-08 18:16:44 +0000828 - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_ Ensure all DMI operations use POST method
puthuparambil.adityad0007332021-12-08 18:53:39 +0000829 - `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 -0400830 - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
831 - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
DylanB95ESTe5573382022-01-27 17:12:52 +0000832 - `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 +0530833 - `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 +0000834
835Bug Fixes
836---------
837
838 - `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 +0000839 - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
niamhcore65bc4fd2021-12-08 14:19:02 +0000840 - `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 +0000841 - `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 +0000842 - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
JosephKeenane0643ab2022-02-15 18:23:05 +0000843 - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
DylanB95ESTe5573382022-01-27 17:12:52 +0000844 - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
JosephKeenane0643ab2022-02-15 18:23:05 +0000845 - `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 +0530846 - `CPS-892 <https://jira.onap.org/browse/CPS-892>`_ Fixed the response code during CM-Handle Registration from 201 CREATED to 204 NO_CONTENT
ToineSiebelink74eed2c2023-08-31 17:38:52 +0100847 - `CPS-893 <https://jira.onap.org/browse/CPS-893>`_ NCMP Java API depends on NCMP-Rest-API (cyclic) through json properties on Java API
niamhcoref7b414e2021-11-17 11:02:07 +0000848
849Known Limitations, Issues and Workarounds
850-----------------------------------------
851
852*System Limitations*
853
DylanB95ESTe5573382022-01-27 17:12:52 +0000854Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
855`CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
856of cm handle registration.
niamhcoref7b414e2021-11-17 11:02:07 +0000857
Lathishb3550f12022-03-15 12:03:53 +0000858The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
859for more information.
860
niamhcoref7b414e2021-11-17 11:02:07 +0000861*Known Vulnerabilities*
862
863None
864
865*Workarounds*
866
DylanB95ESTe5573382022-01-27 17:12:52 +0000867Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
868pass an empty string as the value if you do not want to include names for these values.
niamhcoref7b414e2021-11-17 11:02:07 +0000869
870Security Notes
871--------------
872
873*Fixed Security Issues*
874
875None
876
877*Known Security Issues*
878
879None
880
881.. ========================
shivasubedi44beaa32021-09-13 15:16:30 +0100882.. * * * ISTANBUL * * *
883.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000884
Bruno Sakoto0eaf3342022-02-11 15:05:29 -0500885Version: 2.0.4
886==============
887
888Release Data
889------------
890
891+--------------------------------------+--------------------------------------------------------+
892| **CPS Project** | |
893| | |
894+--------------------------------------+--------------------------------------------------------+
895| **Docker images** | onap/cps-and-ncmp:2.0.4 |
896| | |
897+--------------------------------------+--------------------------------------------------------+
898| **Release designation** | 2.0.4 Istanbul |
899| | |
900+--------------------------------------+--------------------------------------------------------+
901| **Release date** | 2022 Feb 09 |
902| | |
903+--------------------------------------+--------------------------------------------------------+
904
905Bug Fixes
906---------
907
908 - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_ Fix docker compose for csit test.
909 - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_ Fix intermittent circular dependency error when the application starts.
910
911Version: 2.0.3
912==============
913
914Release Data
915------------
916
917+--------------------------------------+--------------------------------------------------------+
918| **CPS Project** | |
919| | |
920+--------------------------------------+--------------------------------------------------------+
921| **Docker images** | onap/cps-and-ncmp:2.0.3 |
922| | |
923+--------------------------------------+--------------------------------------------------------+
924| **Release designation** | 2.0.3 Istanbul |
925| | |
926+--------------------------------------+--------------------------------------------------------+
927| **Release date** | 2022-07-01 |
928| | |
929+--------------------------------------+--------------------------------------------------------+
930
931Bug Fixes
932---------
933
934 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
935
936Version: 2.0.2
937==============
938
939Release Data
940------------
941
942+--------------------------------------+--------------------------------------------------------+
943| **CPS Project** | |
944| | |
945+--------------------------------------+--------------------------------------------------------+
946| **Docker images** | onap/cps-and-ncmp:2.0.2 |
947| | |
948+--------------------------------------+--------------------------------------------------------+
949| **Release designation** | 2.0.2 Istanbul |
950| | |
951+--------------------------------------+--------------------------------------------------------+
952| **Release date** | 2021-16-12 |
953| | |
954+--------------------------------------+--------------------------------------------------------+
955
956Bug Fixes
957---------
958
959 - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_ Update log4j version due to security vulnerability
960
lukegleeson9c583712021-09-30 17:21:11 +0100961Version: 2.0.1
962==============
963
964Release Data
965------------
966
967+--------------------------------------+--------------------------------------------------------+
968| **CPS Project** | |
969| | |
970+--------------------------------------+--------------------------------------------------------+
971| **Docker images** | onap/cps-and-ncmp:2.0.1 |
972| | |
973+--------------------------------------+--------------------------------------------------------+
974| **Release designation** | 2.0.1 Istanbul |
975| | |
976+--------------------------------------+--------------------------------------------------------+
977| **Release date** | 2021-14-10 |
978| | |
979+--------------------------------------+--------------------------------------------------------+
980
981Bug Fixes
982---------
983
984 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
985 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
986 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
987 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
988
989Known Limitations, Issues and Workarounds
990-----------------------------------------
991
992*System Limitations*
993
994Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
995
996*Known Vulnerabilities*
997
998 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
999
1000*Workarounds*
1001
1002Add recursive method to save list node data to loop through all corresponding child nodes.
1003
1004Security Notes
1005--------------
1006
1007*Fixed Security Issues*
1008
1009 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
1010
1011*Known Security Issues*
1012
1013None
1014
shivasubedi44beaa32021-09-13 15:16:30 +01001015Version: 2.0.0
1016==============
1017
1018Abstract
1019--------
1020
1021This document provides the release notes for Istanbul release.
1022
1023Release Data
1024------------
1025
1026+--------------------------------------+--------------------------------------------------------+
1027| **CPS Project** | |
1028| | |
1029+--------------------------------------+--------------------------------------------------------+
1030| **Docker images** | onap/cps-and-ncmp:2.0.0 |
1031| | |
1032+--------------------------------------+--------------------------------------------------------+
1033| **Release designation** | 2.0.0 Istanbul |
1034| | |
1035+--------------------------------------+--------------------------------------------------------+
lukegleeson9c583712021-09-30 17:21:11 +01001036| **Release date** | 2021-14-09 |
shivasubedi44beaa32021-09-13 15:16:30 +01001037| | |
1038+--------------------------------------+--------------------------------------------------------+
1039
1040Features
1041--------
DylanB95EST3fcf8692021-10-11 16:29:16 +01001042* Register DMI-Plugins with NCMP for CM Handle registrations.
shivasubedi44beaa32021-09-13 15:16:30 +01001043* Update, Create and Remove CM Handles.
1044* Add support for retrieving and writing CM Handle data through NCMP datastores.
1045* Automatic retrieval and caching of model information for CM Handles within NCMP.
1046
shivasubedi44beaa32021-09-13 15:16:30 +01001047Deliverables
1048------------
1049
1050Software Deliverables
1051
1052.. csv-table::
1053 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1054 :widths: auto
1055
1056 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
1057
1058Bug Fixes
1059---------
1060
lukegleeson9c583712021-09-30 17:21:11 +01001061 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
shivasubedi44beaa32021-09-13 15:16:30 +01001062 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
1063 - `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 +01001064 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
1065 - `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 +01001066 - `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 +01001067 - `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 +01001068 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
1069 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
lukegleeson9c583712021-09-30 17:21:11 +01001070 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
1071 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
1072 - `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 +01001073 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
1074 - `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 +01001075 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
shivasubedi44beaa32021-09-13 15:16:30 +01001076 - `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 +01001077 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
1078 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
1079 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
lukegleeson9c583712021-09-30 17:21:11 +01001080 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
1081 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
1082 - `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 -05001083 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
lukegleeson9c583712021-09-30 17:21:11 +01001084 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
1085 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
1086 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
shivasubedi44beaa32021-09-13 15:16:30 +01001087
1088This document provides the release notes for Istanbul release.
1089
1090Summary
1091-------
1092
1093Following CPS components are available with default ONAP/CPS installation.
1094
1095
1096 * Platform components
1097
1098 - CPS (Helm charts)
1099
1100 * Service components
1101
DylanB95EST3fcf8692021-10-11 16:29:16 +01001102 - CPS-NCMP
DylanB95EST3fcf8692021-10-11 16:29:16 +01001103 - DMI-Plugin
shivasubedi44beaa32021-09-13 15:16:30 +01001104
1105 * Additional resources that CPS utilizes deployed using ONAP common charts
1106
1107 - Postgres Database
1108
1109
1110Below service components (mS) are available to be deployed on-demand.
1111 - CPS-TBDMT
1112
1113
1114Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1115
1116Known Limitations, Issues and Workarounds
1117-----------------------------------------
1118
shivasubedi44beaa32021-09-13 15:16:30 +01001119*System Limitations*
1120
1121Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
1122
1123*Known Vulnerabilities*
1124
lukegleeson9c583712021-09-30 17:21:11 +01001125 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
1126 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
1127 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
shivasubedi44beaa32021-09-13 15:16:30 +01001128
1129*Workarounds*
1130
1131Add recursive method to save list node data to loop through all corresponding child nodes.
1132
1133Security Notes
1134--------------
1135
1136*Fixed Security Issues*
1137
1138 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
shivasubedi44beaa32021-09-13 15:16:30 +01001139
1140*Known Security Issues*
1141
lukegleeson9c583712021-09-30 17:21:11 +01001142 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
1143
shivasubedi44beaa32021-09-13 15:16:30 +01001144Test Results
1145------------
1146 * `Integration tests`
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001147
ToineSiebelinkf0527c52021-07-06 13:03:03 +01001148.. ========================
1149.. * * * HONOLULU * * *
1150.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001151
ToineSiebelinkfd2134d2021-04-09 11:15:48 +01001152Version: 1.0.1
1153==============
1154
1155Release Data
1156------------
1157
1158+--------------------------------------+--------------------------------------------------------+
1159| **CPS Project** | |
1160| | |
1161+--------------------------------------+--------------------------------------------------------+
1162| **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
1163| | |
1164+--------------------------------------+--------------------------------------------------------+
1165| **Release designation** | 1.0.1 Honolulu |
1166| | |
1167+--------------------------------------+--------------------------------------------------------+
1168| **Release date** | 2021-04-09 |
1169| | |
1170+--------------------------------------+--------------------------------------------------------+
1171
1172Bug Fixes
1173---------
1174
puthuparambil.aditya8b584332021-10-12 16:49:03 +01001175 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
ToineSiebelinkfd2134d2021-04-09 11:15:48 +01001176 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
1177 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
1178 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
1179 - `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
1180 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
1181 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
1182 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
1183
1184Security Notes
1185--------------
1186
1187*Fixed Security Issues*
1188
1189 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001190
ToineSiebelinka2d25b52021-04-13 15:10:47 +01001191*Known Security Issues*
1192
1193 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
1194
Rishi.Chail4359d282021-03-03 16:36:26 +00001195Version: 1.0.0
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001196==============
1197
1198
1199Abstract
1200--------
1201
1202This document provides the release notes for Honolulu release.
1203
1204Summary
1205-------
1206
1207Following CPS components are available with default ONAP/CPS installation.
1208
1209
Rishi.Chail4359d282021-03-03 16:36:26 +00001210 * Platform components
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001211
Rishi.Chail4359d282021-03-03 16:36:26 +00001212 - CPS (Helm charts)
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001213
Rishi.Chail4359d282021-03-03 16:36:26 +00001214 * Service components
1215
1216 - CPS Core
1217
1218 * Additional resources that CPS utilizes deployed using ONAP common charts
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001219
1220 - Postgres Database
1221
1222
Rishi.Chail4359d282021-03-03 16:36:26 +00001223Below service components (mS) are available to be deployed on-demand.
1224 - CPS-TBDMT
1225
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001226
1227Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1228
1229
1230Release Data
1231------------
1232
1233+--------------------------------------+--------------------------------------------------------+
1234| **CPS Project** | |
1235| | |
1236+--------------------------------------+--------------------------------------------------------+
1237| **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
1238| | |
1239+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +00001240| **Release designation** | 1.0.0 Honolulu |
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001241| | |
1242+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +00001243| **Release date** | 2021-03-11 |
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001244| | |
1245+--------------------------------------+--------------------------------------------------------+
1246
1247
1248Features
1249--------
Rishi.Chail4359d282021-03-03 16:36:26 +00001250Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
1251CPS has been driven by the needs of the E2E Networking Slicing use case.
1252It currently supports basic (rw) persistence and simple queries.
1253It also provides MVP support for network data access using simulated data.
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001254
1255.. _honolulu_deliverable:
1256
1257Deliverables
1258------------
1259
1260Software Deliverables
1261
1262.. csv-table::
1263 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1264 :widths: auto
1265
Rishi.Chail4359d282021-03-03 16:36:26 +00001266 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001267
1268
1269Known Limitations, Issues and Workarounds
1270-----------------------------------------
1271
Rishi.Chail4359d282021-03-03 16:36:26 +00001272 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1273 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
1274 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
niamhcoredddf7312021-06-21 14:44:01 +01001275 - `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 +00001276
1277*System Limitations*
1278
1279None
1280
1281*Known Vulnerabilities*
1282
1283None
1284
1285*Workarounds*
1286
1287Documented under corresponding jira if applicable.
1288
1289Security Notes
1290--------------
1291
1292*Fixed Security Issues*
ToineSiebelink7c981df2021-03-01 09:53:56 +00001293
1294* `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
Rishi.Chail4359d282021-03-03 16:36:26 +00001295 - Upgrade org.onap.oparent to 3.2.0
ToineSiebelink7c981df2021-03-01 09:53:56 +00001296 - Upgrade spring.boot to 2.3.8.RELEASE
Rishi.Chail4359d282021-03-03 16:36:26 +00001297 - Upgrade yangtools to 5.0.7
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001298
1299*Known Security Issues*
1300
ToineSiebelink74eed2c2023-08-31 17:38:52 +01001301 * Weak Cryptography using md5
Rishi.Chail4359d282021-03-03 16:36:26 +00001302 * Risk seen in Zip file expansion
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001303
1304*Known Vulnerabilities in Used Modules*
1305
Rishi.Chail4359d282021-03-03 16:36:26 +00001306 None
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001307
Rishi.Chail4359d282021-03-03 16:36:26 +00001308CPS 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 +00001309
1310Test Results
1311------------
Rishi.Chail4359d282021-03-03 16:36:26 +00001312 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001313
1314References
1315----------
1316
ToineSiebelinkcac21862023-06-22 09:24:04 +01001317For more information on the latest ONAP release, please see:
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001318
1319#. `ONAP Home Page`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001320#. `ONAP Wiki Page`_
ToineSiebelinkcac21862023-06-22 09:24:04 +01001321#. `ONAP Documentation`_
1322#. `ONAP CPS Documentation`_
1323#. `ONAP Release Downloads`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001324
1325
1326.. _`ONAP Home Page`: https://www.onap.org
1327.. _`ONAP Wiki Page`: https://wiki.onap.org
1328.. _`ONAP Documentation`: https://docs.onap.org
ToineSiebelinkcac21862023-06-22 09:24:04 +01001329.. _`ONAP CPS Documentation`: https://docs.onap.org/projects/onap-cps
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001330.. _`ONAP Release Downloads`: https://git.onap.org
1331
1332Quick Links:
1333
1334 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
1335 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_