blob: cd70cf8be7701989e28ce4ceb06e5365a79c7dfb [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.
mpriyank612fb572023-08-01 15:36:27 +010046 - `CPS-1819 <https://jira.onap.org/browse/CPS-1819>`_ Ability to disable sending authorization header.
egernugbdac4402023-07-21 13:27:24 +010047
48
egernug6c9621a2023-07-19 11:05:00 +010049Version: 3.3.5
50==============
51
52Release Data
53------------
54
55+--------------------------------------+--------------------------------------------------------+
56| **CPS Project** | |
57| | |
58+--------------------------------------+--------------------------------------------------------+
59| **Docker images** | onap/cps-and-ncmp:3.3.5 |
60| | |
61+--------------------------------------+--------------------------------------------------------+
62| **Release designation** | 3.3.5 Montreal |
63| | |
64+--------------------------------------+--------------------------------------------------------+
egernugbdac4402023-07-21 13:27:24 +010065| **Release date** | 2023 July 21 |
egernug6c9621a2023-07-19 11:05:00 +010066| | |
67+--------------------------------------+--------------------------------------------------------+
68
69Bug Fixes
70---------
713.3.5
72
73Features
74--------
danielhanrahan74a47152023-06-28 12:55:20 +010075 - `CPS-1760 <https://jira.onap.org/browse/CPS-1760>`_ Improve handling of special characters in Cps Paths
egernug6c9621a2023-07-19 11:05:00 +010076
mpriyank8caa3422023-06-30 11:14:10 +010077Version: 3.3.4
78==============
79
80Release Data
81------------
82
83+--------------------------------------+--------------------------------------------------------+
84| **CPS Project** | |
85| | |
86+--------------------------------------+--------------------------------------------------------+
87| **Docker images** | onap/cps-and-ncmp:3.3.4 |
88| | |
89+--------------------------------------+--------------------------------------------------------+
90| **Release designation** | 3.3.4 Montreal |
91| | |
92+--------------------------------------+--------------------------------------------------------+
egernug6c9621a2023-07-19 11:05:00 +010093| **Release date** | 2023 July 19 |
mpriyank8caa3422023-06-30 11:14:10 +010094| | |
95+--------------------------------------+--------------------------------------------------------+
96
97Bug Fixes
98---------
993.3.4
100
101Features
102--------
egernugdb62ffb2023-07-18 10:57:42 +0100103 - `CPS-1767 <https://jira.onap.org/browse/CPS-1767>`_ Upgrade CPS to java 17
mpriyank8caa3422023-06-30 11:14:10 +0100104
danielhanrahan19f963b2023-06-15 13:52:34 +0100105Version: 3.3.3
106==============
107
108Release Data
109------------
110
111+--------------------------------------+--------------------------------------------------------+
112| **CPS Project** | |
113| | |
114+--------------------------------------+--------------------------------------------------------+
115| **Docker images** | onap/cps-and-ncmp:3.3.3 |
116| | |
117+--------------------------------------+--------------------------------------------------------+
118| **Release designation** | 3.3.3 Montreal |
119| | |
120+--------------------------------------+--------------------------------------------------------+
mpriyank8caa3422023-06-30 11:14:10 +0100121| **Release date** | 2023 June 30 |
danielhanrahan19f963b2023-06-15 13:52:34 +0100122| | |
123+--------------------------------------+--------------------------------------------------------+
124
125Bug Fixes
126---------
1273.3.3
128
129Features
130--------
mpriyank6da95412023-06-29 16:56:11 +0100131 - `CPS-1515 <https://jira.onap.org/browse/CPS-1515>`_ Support Multiple CM-Handles for NCMP Get Operation
132 - `CPS-1675 <https://jira.onap.org/browse/CPS-1675>`_ Persistence write performance improvement(s)
133 - `CPS-1745 <https://jira.onap.org/browse/CPS-1745>`_ Upgrade to Openapi 3.0.3
danielhanrahan19f963b2023-06-15 13:52:34 +0100134
mpriyank436b75b2023-05-03 11:10:08 +0100135Version: 3.3.2
136==============
137
138Release Data
139------------
140
141+--------------------------------------+--------------------------------------------------------+
142| **CPS Project** | |
143| | |
144+--------------------------------------+--------------------------------------------------------+
145| **Docker images** | onap/cps-and-ncmp:3.3.2 |
146| | |
147+--------------------------------------+--------------------------------------------------------+
148| **Release designation** | 3.3.2 Montreal |
149| | |
150+--------------------------------------+--------------------------------------------------------+
danielhanrahan19f963b2023-06-15 13:52:34 +0100151| **Release date** | 2023 June 15 |
mpriyank436b75b2023-05-03 11:10:08 +0100152| | |
153+--------------------------------------+--------------------------------------------------------+
154
155Bug Fixes
156---------
1573.3.2
danielhanrahan5cec5322023-06-15 11:08:54 +0100158 - `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 +0100159
160Features
161--------
--globalc7e5a802023-04-05 17:08:08 +0530162 - `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 +0100163 - `CPS-1273 <https://jira.onap.org/browse/CPS-1273>`_ Add <,> operators support to cps-path
164 - `CPS-1664 <https://jira.onap.org/browse/CPS-1664>`_ Use recursive SQL to fetch descendants in CpsPath queries to improve query performance
165 - `CPS-1676 <https://jira.onap.org/browse/CPS-1676>`_ Entity ID types do not match types in database definition
166 - `CPS-1677 <https://jira.onap.org/browse/CPS-1677>`_ Remove dataspace_id column from Fragment table
mpriyank436b75b2023-05-03 11:10:08 +0100167
lukegleesond7764c42023-04-20 14:11:20 +0100168Version: 3.3.1
halil.cakal0b8d85d2023-03-23 12:44:27 +0000169==============
170
171Release Data
172------------
173
174+--------------------------------------+--------------------------------------------------------+
175| **CPS Project** | |
176| | |
177+--------------------------------------+--------------------------------------------------------+
lukegleesond7764c42023-04-20 14:11:20 +0100178| **Docker images** | onap/cps-and-ncmp:3.3.1 |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000179| | |
180+--------------------------------------+--------------------------------------------------------+
lukegleesond7764c42023-04-20 14:11:20 +0100181| **Release designation** | 3.3.1 Montreal |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000182| | |
183+--------------------------------------+--------------------------------------------------------+
mpriyank436b75b2023-05-03 11:10:08 +0100184| **Release date** | 2023 May 03 |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000185| | |
186+--------------------------------------+--------------------------------------------------------+
187
188Bug Fixes
189---------
lukegleesond7764c42023-04-20 14:11:20 +01001903.3.1
halil.cakal0b8d85d2023-03-23 12:44:27 +0000191 - None
192
193Features
194--------
mpriyank52c5e542023-05-02 15:58:55 +0100195 - `CPS-1272 <https://jira.onap.org/browse/CPS-1272>`_ Add Contains operation to CPS Path
196 - `CPS-1573 <https://jira.onap.org/browse/CPS-1573>`_ Remove 32K limit for DB operations
197 - `CPS-1627 <https://jira.onap.org/browse/CPS-1627>`_ Dependency versions uplift because of vulnerability issues
198 - `CPS-1629 <https://jira.onap.org/browse/CPS-1629>`_ Ordering of leaf elements to support combination of AND/OR in cps-path
199 - `CPS-1637 <https://jira.onap.org/browse/CPS-1637>`_ Extend hazelcast to work on kubernetes
halil.cakal0b8d85d2023-03-23 12:44:27 +0000200
lukegleesond7764c42023-04-20 14:11:20 +0100201Version: 3.3.0
202==============
203
204Release Data
205------------
206
207+--------------------------------------+--------------------------------------------------------+
208| **CPS Project** | |
209| | |
210+--------------------------------------+--------------------------------------------------------+
211| **Docker images** | onap/cps-and-ncmp:3.3.0 |
212| | |
213+--------------------------------------+--------------------------------------------------------+
214| **Release designation** | 3.3.0 Montreal |
215| | |
216+--------------------------------------+--------------------------------------------------------+
217| **Release date** | 2023 April 20 |
218| | |
219+--------------------------------------+--------------------------------------------------------+
220
221Bug Fixes
222---------
2233.3.0
224 - None
225
226Features
227--------
228 - `CPS-1215 <https://jira.onap.org/browse/CPS-1215>`_ Add OR operation for CPS Path
229 - `CPS-1617 <https://jira.onap.org/browse/CPS-1617>`_ Use cascade delete in fragments table
230
231.. ======================
232.. * * * LONDON * * *
233.. ======================
234
mpriyank0fd4d192023-03-10 13:48:20 +0000235Version: 3.2.6
236==============
237
238Release Data
239------------
240
241+--------------------------------------+--------------------------------------------------------+
242| **CPS Project** | |
243| | |
244+--------------------------------------+--------------------------------------------------------+
245| **Docker images** | onap/cps-and-ncmp:3.2.6 |
246| | |
247+--------------------------------------+--------------------------------------------------------+
248| **Release designation** | 3.2.6 London |
249| | |
250+--------------------------------------+--------------------------------------------------------+
seanbeirnef5a3a212023-03-06 09:12:49 +0000251| **Release date** | 2023 March 22 |
mpriyank0fd4d192023-03-10 13:48:20 +0000252| | |
253+--------------------------------------+--------------------------------------------------------+
254
255Bug Fixes
256---------
2573.2.6
arpitsingh2b4c4882023-03-03 21:38:57 +0530258 - `CPS-1526 <https://jira.onap.org/browse/CPS-1526>`_ Fix response message for PATCH operation
seanbeirnef5a3a212023-03-06 09:12:49 +0000259 - `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 +0000260
261Features
262--------
seanbeirnef5a3a212023-03-06 09:12:49 +0000263 - `CPS-1396 <https://jira.onap.org/browse/CPS-1396>`_ Query data nodes across all anchors under one dataspace
mpriyank0fd4d192023-03-10 13:48:20 +0000264
mpriyankade5a6e2023-03-09 17:58:31 +0000265Version: 3.2.5
266==============
267
268Release Data
269------------
270
271+--------------------------------------+--------------------------------------------------------+
272| **CPS Project** | |
273| | |
274+--------------------------------------+--------------------------------------------------------+
275| **Docker images** | onap/cps-and-ncmp:3.2.5 |
276| | |
277+--------------------------------------+--------------------------------------------------------+
278| **Release designation** | 3.2.5 London |
279| | |
280+--------------------------------------+--------------------------------------------------------+
mpriyank06bfe4e2023-03-10 11:48:23 +0000281| **Release date** | 2023 March 10 |
mpriyankade5a6e2023-03-09 17:58:31 +0000282| | |
283+--------------------------------------+--------------------------------------------------------+
284
285Bug Fixes
286---------
2873.2.5
mpriyank06bfe4e2023-03-10 11:48:23 +0000288 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ Introduce control switch for model loader functionality.
mpriyankade5a6e2023-03-09 17:58:31 +0000289
290Features
291--------
292 - None
293
seanbeirnef0f4fd82023-03-07 13:42:04 +0000294Version: 3.2.4
295==============
296
297Release Data
298------------
299
300+--------------------------------------+--------------------------------------------------------+
301| **CPS Project** | |
302| | |
303+--------------------------------------+--------------------------------------------------------+
304| **Docker images** | onap/cps-and-ncmp:3.2.4 |
305| | |
306+--------------------------------------+--------------------------------------------------------+
307| **Release designation** | 3.2.4 London |
308| | |
309+--------------------------------------+--------------------------------------------------------+
mpriyankbd5ba8d2023-03-09 16:33:02 +0000310| **Release date** | 2023 March 09 |
seanbeirnef0f4fd82023-03-07 13:42:04 +0000311| | |
312+--------------------------------------+--------------------------------------------------------+
313
314Bug Fixes
315---------
3163.2.4
mpriyankbd5ba8d2023-03-09 16:33:02 +0000317 - `CPS-1533 <https://jira.onap.org/browse/CPS-1533>`_ Fix for Temp tables cause Out of shared memory errors in Postgres
318 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ NCMP failed to start due to issue in SubscriptionModelLoader
319
320Features
321--------
322 - None
seanbeirnef0f4fd82023-03-07 13:42:04 +0000323
mpriyankfd43dbe2023-02-08 11:21:08 +0000324Version: 3.2.3
325==============
326
327Release Data
328------------
329
330+--------------------------------------+--------------------------------------------------------+
331| **CPS Project** | |
332| | |
333+--------------------------------------+--------------------------------------------------------+
334| **Docker images** | onap/cps-and-ncmp:3.2.3 |
335| | |
336+--------------------------------------+--------------------------------------------------------+
337| **Release designation** | 3.2.3 London |
338| | |
339+--------------------------------------+--------------------------------------------------------+
seanbeirnef9af5f82023-03-07 10:36:18 +0000340| **Release date** | 2023 March 07 |
mpriyankfd43dbe2023-02-08 11:21:08 +0000341| | |
342+--------------------------------------+--------------------------------------------------------+
343
344Bug Fixes
345---------
3463.2.3
seanbeirnef9af5f82023-03-07 10:36:18 +0000347 - `CPS-1494 <https://jira.onap.org/browse/CPS-1494>`_ NCMP Inventory Performance Improvements
mpriyankfd43dbe2023-02-08 11:21:08 +0000348
349Features
350--------
seanbeirnef9af5f82023-03-07 10:36:18 +0000351 - `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
352 - `CPS-1502 <https://jira.onap.org/browse/CPS-1502>`_ Delete Performance Improvements
mpriyankfd43dbe2023-02-08 11:21:08 +0000353
seanbeirnef8e980a2023-01-27 18:09:33 +0000354Version: 3.2.2
355==============
356
357Release Data
358------------
359
360+--------------------------------------+--------------------------------------------------------+
361| **CPS Project** | |
362| | |
363+--------------------------------------+--------------------------------------------------------+
364| **Docker images** | onap/cps-and-ncmp:3.2.2 |
365| | |
366+--------------------------------------+--------------------------------------------------------+
367| **Release designation** | 3.2.2 London |
368| | |
369+--------------------------------------+--------------------------------------------------------+
mpriyankfd43dbe2023-02-08 11:21:08 +0000370| **Release date** | 2023 February 08 |
seanbeirnef8e980a2023-01-27 18:09:33 +0000371| | |
372+--------------------------------------+--------------------------------------------------------+
373
374Bug Fixes
375---------
mpriyank0b5950d2023-02-07 17:55:10 +00003763.2.2
mpriyankfd43dbe2023-02-08 11:21:08 +0000377 - `CPS-1173 <https://jira.onap.org/browse/CPS-1173>`_ Delete Performance Improvements.
mpriyank0b5950d2023-02-07 17:55:10 +0000378
379Features
380--------
381 - None
seanbeirnef8e980a2023-01-27 18:09:33 +0000382
leventecsanyi37d72852022-10-26 10:44:08 +0200383Version: 3.2.1
384==============
mpriyank4bd450e2022-10-05 09:50:59 +0100385
386Release Data
387------------
388
389+--------------------------------------+--------------------------------------------------------+
390| **CPS Project** | |
391| | |
392+--------------------------------------+--------------------------------------------------------+
lukegleesone0154a62023-01-25 15:06:52 +0000393| **Docker images** | onap/cps-and-ncmp:3.2.1 |
mpriyank4bd450e2022-10-05 09:50:59 +0100394| | |
395+--------------------------------------+--------------------------------------------------------+
leventecsanyi37d72852022-10-26 10:44:08 +0200396| **Release designation** | 3.2.1 London |
mpriyank4bd450e2022-10-05 09:50:59 +0100397| | |
398+--------------------------------------+--------------------------------------------------------+
lukegleesone0154a62023-01-25 15:06:52 +0000399| **Release date** | 2023 January 27 |
mpriyank4bd450e2022-10-05 09:50:59 +0100400| | |
401+--------------------------------------+--------------------------------------------------------+
Cédric Ollivier490b20d2023-03-15 21:40:48 +0100402
lukegleeson3be99242022-10-11 14:34:56 +0100403Features
404--------
leventecsanyi37d72852022-10-26 10:44:08 +02004053.2.1
lukegleesone0154a62023-01-25 15:06:52 +0000406 - `CPS-341 <https://jira.onap.org/browse/CPS-341>`_ Added support for multiple data tree instances under 1 anchor.
407 - `CPS-1002 <https://jira.onap.org/browse/CPS-1002>`_ Add CPS-E-05 endpoint for 'Query data, NCMP-Operational Datastore' using cpsPaths
408 - `CPS-1182 <https://jira.onap.org/browse/CPS-1182>`_ Upgrade Opendaylight
ToineSiebelink294bcb52022-12-23 11:07:42 +0000409 - `CPS-1185 <https://jira.onap.org/browse/CPS-1185>`_ Get all dataspaces.
410 - `CPS-1186 <https://jira.onap.org/browse/CPS-1186>`_ Get single dataspace.
lukegleesonf20b4992022-12-09 15:48:55 +0000411 - `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 +0000412 - `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 +0000413 - `CPS-1257 <https://jira.onap.org/browse/CPS-1257>`_ Added support for application/xml Content-Type (write only).
lukegleesone0154a62023-01-25 15:06:52 +0000414 - `CPS-1381 <https://jira.onap.org/browse/CPS-1381>`_ Query large outputs using limit/depth/pagination
ToineSiebelink294bcb52022-12-23 11:07:42 +0000415 - `CPS-1421 <https://jira.onap.org/browse/CPS-1421>`_ Optimized query for large number of hits with descendants.
lukegleesone0154a62023-01-25 15:06:52 +0000416 - `CPS-1422 <https://jira.onap.org/browse/CPS-1422>`_ Fetch CM handles by collection of xpaths (CPS Core)
417 - `CPS-1424 <https://jira.onap.org/browse/CPS-1424>`_ Updating CmHandleStates using batch operation
418 - `CPS-1439 <https://jira.onap.org/browse/CPS-1439>`_ Use native query to delete data nodes
mpriyank4bd450e2022-10-05 09:50:59 +0100419
420Bug Fixes
421---------
ToineSiebelink294bcb52022-12-23 11:07:42 +00004223.2.1
lukegleesone0154a62023-01-25 15:06:52 +0000423 - `CPS-1171 <https://jira.onap.org/browse/CPS-1171>`_ Optimized retrieval of data nodes with many descendants.
424 - `CPS-1288 <https://jira.onap.org/browse/CPS-1288>`_ Hazelcast TTL for IMap is not working
425 - `CPS-1289 <https://jira.onap.org/browse/CPS-1289>`_ Getting wrong error code for create node api
426 - `CPS-1326 <https://jira.onap.org/browse/CPS-1326>`_ Creation of DataNodeBuilder with module name prefix is very slow
427 - `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 +0000428 - `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_ Add Basic Auth to CPS/NCMP OpenAPI Definitions.
lukegleesone0154a62023-01-25 15:06:52 +0000429 - `CPS-1352 <https://jira.onap.org/browse/CPS-1352>`_ Handle YangChoiceNode in right format.
ToineSiebelink294bcb52022-12-23 11:07:42 +0000430 - `CPS-1409 <https://jira.onap.org/browse/CPS-1409>`_ Fix Delete uses case with '/' in path.
lukegleesone0154a62023-01-25 15:06:52 +0000431 - `CPS-1433 <https://jira.onap.org/browse/CPS-1433>`_ Fix to allow posting data with '/' key fields.
432 - `CPS-1442 <https://jira.onap.org/browse/CPS-1442>`_ CPS PATCH operation does not merge existing data
433 - `CPS-1446 <https://jira.onap.org/browse/CPS-1446>`_ Locked cmhandles and ready to locked state transitions causing long cmHandle discovery
434 - `CPS-1457 <https://jira.onap.org/browse/CPS-1457>`_ CpsDataPersistenceService#getDataNodes uses non-normalized xpaths
435 - `CPS-1458 <https://jira.onap.org/browse/CPS-1458>`_ CpsDataPersistenceService#getDataNodes does not handle root xpath
436 - `CPS-1460 <https://jira.onap.org/browse/CPS-1460>`_ CPS Path Processing Performance Test duration is too low
ToineSiebelink294bcb52022-12-23 11:07:42 +0000437
leventecsanyi37d72852022-10-26 10:44:08 +02004383.2.0
ToineSiebelink294bcb52022-12-23 11:07:42 +0000439 - `CPS-1312 <https://jira.onap.org/browse/CPS-1312>`_ CPS(/NCMP) does not have version control.
mpriyank4bd450e2022-10-05 09:50:59 +0100440
lukegleeson3be99242022-10-11 14:34:56 +0100441Known Limitations, Issues and Workarounds
442-----------------------------------------
443
444*System Limitations*
445
seanbeirne72c267e2022-10-18 12:39:22 +0100446For upgrading, CPS uses Liquibase for database upgrades. CPS/NCMP currently only supports upgrading from Liquibase changelog 11 to Liquibase changelog 16.
447This 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 +0100448
arpitsingh2b4c4882023-03-03 21:38:57 +0530449CPS core Patch operation currently supports updating data of one top level data node. When performing Patch on multiple top level data nodes at once
450a 400 Bad Request is sent as response. This is part of commit CPS-1526.
451
seanbeirnedba2b102022-10-27 09:59:17 +0100452.. ====================
453.. * * * KOHN * * *
454.. ====================
455
mpriyankfe775312022-09-30 14:16:51 +0100456Version: 3.1.4
457==============
458
459Release Data
460------------
461
462+--------------------------------------+--------------------------------------------------------+
463| **CPS Project** | |
464| | |
465+--------------------------------------+--------------------------------------------------------+
466| **Docker images** | onap/cps-and-ncmp:3.1.4 |
467| | |
468+--------------------------------------+--------------------------------------------------------+
469| **Release designation** | 3.1.4 Kohn |
470| | |
471+--------------------------------------+--------------------------------------------------------+
mpriyank4bd450e2022-10-05 09:50:59 +0100472| **Release date** | 2022 October 5 |
mpriyankfe775312022-09-30 14:16:51 +0100473| | |
474+--------------------------------------+--------------------------------------------------------+
475
476Bug Fixes
477---------
lukegleeson8c6b5622022-09-29 15:58:06 +0100478 - `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 +0100479 - `CPS-1294 <https://jira.onap.org/browse/CPS-1294>`_ Kafka communication fault caused cmHandle registration error
mpriyankfe775312022-09-30 14:16:51 +0100480
mpriyank06736cb2022-09-29 14:29:40 +0100481Version: 3.1.3
482==============
483
484Release Data
485------------
486
487+--------------------------------------+--------------------------------------------------------+
488| **CPS Project** | |
489| | |
490+--------------------------------------+--------------------------------------------------------+
491| **Docker images** | onap/cps-and-ncmp:3.1.3 |
492| | |
493+--------------------------------------+--------------------------------------------------------+
494| **Release designation** | 3.1.3 Kohn |
495| | |
496+--------------------------------------+--------------------------------------------------------+
mpriyankfe775312022-09-30 14:16:51 +0100497| **Release date** | 2022 September 29 |
mpriyank06736cb2022-09-29 14:29:40 +0100498| | |
499+--------------------------------------+--------------------------------------------------------+
500
501Bug Fixes
502---------
503 - None
504
mpriyankef0ddfc2022-09-28 12:19:34 +0100505Version: 3.1.2
506==============
507
508Release Data
509------------
510
511+--------------------------------------+--------------------------------------------------------+
512| **CPS Project** | |
513| | |
514+--------------------------------------+--------------------------------------------------------+
515| **Docker images** | onap/cps-and-ncmp:3.1.2 |
516| | |
517+--------------------------------------+--------------------------------------------------------+
518| **Release designation** | 3.1.2 Kohn |
519| | |
520+--------------------------------------+--------------------------------------------------------+
mpriyank06736cb2022-09-29 14:29:40 +0100521| **Release date** | 2022 September 28 |
mpriyankef0ddfc2022-09-28 12:19:34 +0100522| | |
523+--------------------------------------+--------------------------------------------------------+
524
525Bug Fixes
526---------
527 - None
528
mpriyanka3f43502022-09-26 14:57:01 +0100529Version: 3.1.1
530==============
531
532Release Data
533------------
534
535+--------------------------------------+--------------------------------------------------------+
536| **CPS Project** | |
537| | |
538+--------------------------------------+--------------------------------------------------------+
539| **Docker images** | onap/cps-and-ncmp:3.1.1 |
540| | |
541+--------------------------------------+--------------------------------------------------------+
542| **Release designation** | 3.1.1 Kohn |
543| | |
544+--------------------------------------+--------------------------------------------------------+
mpriyankef0ddfc2022-09-28 12:19:34 +0100545| **Release date** | 2022 September 28 |
mpriyanka3f43502022-09-26 14:57:01 +0100546| | |
547+--------------------------------------+--------------------------------------------------------+
548
549Bug Fixes
550---------
551 - None
552
lukegleesonc9ec9152022-09-07 14:21:36 +0100553Security Notes
554--------------
555
556*Fixed Security Issues*
557
558 - `CPS-1226 <https://jira.onap.org/browse/CPS-1226>`_ Security bug in the logs
559
lukegleeson4a34fa52022-09-19 15:31:59 +0100560Version: 3.1.0
561==============
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400562
563Release Data
564------------
565
DylanB95ESTb130fd32022-04-04 13:09:22 +0100566+--------------------------------------+--------------------------------------------------------+
567| **CPS Project** | |
568| | |
569+--------------------------------------+--------------------------------------------------------+
570| **Docker images** | onap/cps-and-ncmp:3.1.0 |
571| | |
572+--------------------------------------+--------------------------------------------------------+
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400573| **Release designation** | 3.1.0 Kohn |
DylanB95ESTb130fd32022-04-04 13:09:22 +0100574| | |
575+--------------------------------------+--------------------------------------------------------+
lukegleeson4a34fa52022-09-19 15:31:59 +0100576| **Release date** | 2022 September 14 |
DylanB95ESTb130fd32022-04-04 13:09:22 +0100577| | |
578+--------------------------------------+--------------------------------------------------------+
579
580Features
581--------
lukegleeson4a34fa52022-09-19 15:31:59 +0100582 - `CPS-340 <https://jira.onap.org/browse/CPS-340>`_ Patch and update the root data node
583 - `CPS-575 <https://jira.onap.org/browse/CPS-575>`_ Write data for cmHandle using ncmp-datastores:passthrough-running (NCMP.)
584 - `CPS-731 <https://jira.onap.org/browse/CPS-731>`_ Query based on Public CM Properties
585 - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_ Async: NCMP Rest impl. including Request ID generation
586 - `CPS-829 <https://jira.onap.org/browse/CPS-829>`_ Async: Internal message topic incl. basic producer & Consumer
587 - `CPS-830 <https://jira.onap.org/browse/CPS-830>`_ DMI-NCMP Asynchronously Publish Response Event to Client Topic
588 - `CPS-869 <https://jira.onap.org/browse/CPS-869>`_ Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072
589 - `CPS-870 <https://jira.onap.org/browse/CPS-870>`_ Align CPS-Core output with SDN-C output (add module name)
590 - `CPS-875 <https://jira.onap.org/browse/CPS-875>`_ CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles
591 - `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'
592 - `CPS-899 <https://jira.onap.org/browse/CPS-899>`_ Start and stop sessions on Java API
593 - `CPS-909 <https://jira.onap.org/browse/CPS-909>`_ Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state
594 - `CPS-917 <https://jira.onap.org/browse/CPS-917>`_ Structured Errors response for passthrough use-cases in NCMP
595 - `CPS-953 <https://jira.onap.org/browse/CPS-953>`_ Update maven deploy plugin version
596 - `CPS-977 <https://jira.onap.org/browse/CPS-977>`_ Query CM Handles using CpsPath
597 - `CPS-1000 <https://jira.onap.org/browse/CPS-1000>`_ Create Data Synchronization watchdog
598 - `CPS-1016 <https://jira.onap.org/browse/CPS-1016>`_ Merge 2 'query' end points in NCMP
599 - `CPS-1034 <https://jira.onap.org/browse/CPS-1034>`_ Publish lifecycle events for ADVISED , READY and LOCKED state transition"
600 - `CPS-1064 <https://jira.onap.org/browse/CPS-1064>`_ Support retrieval of YANG module sources for CM handle on the NCMP interface
601 - `CPS-1099 <https://jira.onap.org/browse/CPS-1099>`_ Expose simplified 'external' lock reason enum state over REST interface
602 - `CPS-1101 <https://jira.onap.org/browse/CPS-1101>`_ Introducing the DELETING and DELETED Cmhandle State
603 - `CPS-1102 <https://jira.onap.org/browse/CPS-1102>`_ Register the Cmhandle Sends Advised State notification.
604 - `CPS-1133 <https://jira.onap.org/browse/CPS-1133>`_ Enable/Disable Data Sync for Cm Handle
605 - `CPS-1136 <https://jira.onap.org/browse/CPS-1136>`_ DMI Audit Support (get all CM Handles for a registered DMI)
606
emacleeafb17362022-09-02 14:40:17 +0100607
608Bug Fixes
609---------
lukegleeson4a34fa52022-09-19 15:31:59 +0100610 - `CPS-896 <https://jira.onap.org/browse/CPS-896>`_ CM Handle Registration Process only partially completes when exception is thrown
611 - `CPS-957 <https://jira.onap.org/browse/CPS-957>`_ NCMP: fix getResourceDataForPassthroughOperational endpoint
612 - `CPS-1020 <https://jira.onap.org/browse/CPS-1020>`_ DuplicatedYangResourceException error at parallel cmHandle registration
613 - `CPS-1056 <https://jira.onap.org/browse/CPS-1056>`_ Wrong error response format in case of Dmi plugin error
614 - `CPS-1067 <https://jira.onap.org/browse/CPS-1067>`_ NCMP returns 500 error on searches endpoint when No DMi Handles registered
615 - `CPS-1085 <https://jira.onap.org/browse/CPS-1085>`_ Performance degradation on ncmp/v1/ch/searches endpoint
616 - `CPS-1088 <https://jira.onap.org/browse/CPS-1088>`_ Kafka consumer can not be turned off
617 - `CPS-1097 <https://jira.onap.org/browse/CPS-1097>`_ Unable to change state from LOCKED to ADVISED
618 - `CPS-1126 <https://jira.onap.org/browse/CPS-1126>`_ CmHandle creation performance degradation
619 - `CPS-1175 <https://jira.onap.org/browse/CPS-1175>`_ Incorrect response when empty body executed for cmhandle id-searches
620 - `CPS-1179 <https://jira.onap.org/browse/CPS-1179>`_ Node API - GET method returns invalid response when identifier contains '/'
621 - `CPS-1212 <https://jira.onap.org/browse/CPS-1212>`_ Additional Properties for CM Handles not included when send to DMI Plugin
622 - `CPS-1217 <https://jira.onap.org/browse/CPS-1217>`_ Searches endpoint gives back empty list however there are already available cmhandles
623 - `CPS-1218 <https://jira.onap.org/browse/CPS-1218>`_ NCMP logs are flooded with SyncUtils logs
puthuparambil.adityadd904322022-09-21 10:53:51 +0100624
625Known Limitations, Issues and Workarounds
626-----------------------------------------
627
628*System Limitations*
629
630Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition.
631Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces']
DylanB95ESTb130fd32022-04-04 13:09:22 +0100632
lukegleeson4a34fa52022-09-19 15:31:59 +0100633*Known Vulnerabilities*
634
635None
636
637*Workarounds*
638
639None
640
641Security Notes
642--------------
643
644*Fixed Security Issues*
645
646 - `CPS-963 <https://jira.onap.org/browse/CPS-963>`_ Liquibase has got serious vulnerability, upgrade required
647
648*Known Security Issues*
649
650None
651
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400652.. ========================
653.. * * * JAKARTA * * *
654.. ========================
655
656Version: 3.0.1
657==============
658
659Release Data
660------------
661
662+--------------------------------------+--------------------------------------------------------+
663| **CPS Project** | |
664| | |
665+--------------------------------------+--------------------------------------------------------+
666| **Docker images** | onap/cps-and-ncmp:3.0.1 |
667| | |
668+--------------------------------------+--------------------------------------------------------+
669| **Release designation** | 3.0.1 Jakarta |
670| | |
671+--------------------------------------+--------------------------------------------------------+
672| **Release date** | 2022 April 28 |
673| | |
674+--------------------------------------+--------------------------------------------------------+
675
676Bug Fixes
677---------
678 - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_ Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
679
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400680Version: 3.0.0
681==============
niamhcoref7b414e2021-11-17 11:02:07 +0000682
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400683Release Data
684------------
685
686+--------------------------------------+--------------------------------------------------------+
687| **CPS Project** | |
688| | |
689+--------------------------------------+--------------------------------------------------------+
690| **Docker images** | onap/cps-and-ncmp:3.0.0 |
691| | |
692+--------------------------------------+--------------------------------------------------------+
693| **Release designation** | 3.0.0 Jakarta |
694| | |
695+--------------------------------------+--------------------------------------------------------+
696| **Release date** | 2022 March 15 |
697| | |
698+--------------------------------------+--------------------------------------------------------+
niamhcoref7b414e2021-11-17 11:02:07 +0000699
700Features
701--------
puthuparambil.adityad0007332021-12-08 18:53:39 +0000702 - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_ Define response objects (schemas) in cps-ncmp
niamhcoref7b414e2021-11-17 11:02:07 +0000703 - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_ Update operation for datastore pass through running
704 - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_ Delete operation for datastore pass through running
DylanB95ESTe5573382022-01-27 17:12:52 +0000705 - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_ Support 'public' Cm Handle Properties
niamhcoref7b414e2021-11-17 11:02:07 +0000706 - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
JosephKeenan82ebf532021-12-08 18:16:44 +0000707 - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_ Ensure all DMI operations use POST method
puthuparambil.adityad0007332021-12-08 18:53:39 +0000708 - `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 -0400709 - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
710 - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
DylanB95ESTe5573382022-01-27 17:12:52 +0000711 - `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 +0530712 - `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 +0000713
714Bug Fixes
715---------
716
717 - `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 +0000718 - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
niamhcore65bc4fd2021-12-08 14:19:02 +0000719 - `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 +0000720 - `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 +0000721 - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
JosephKeenane0643ab2022-02-15 18:23:05 +0000722 - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
DylanB95ESTe5573382022-01-27 17:12:52 +0000723 - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
JosephKeenane0643ab2022-02-15 18:23:05 +0000724 - `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 +0530725 - `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 +0000726 - `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 +0000727
728Known Limitations, Issues and Workarounds
729-----------------------------------------
730
731*System Limitations*
732
DylanB95ESTe5573382022-01-27 17:12:52 +0000733Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
734`CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
735of cm handle registration.
niamhcoref7b414e2021-11-17 11:02:07 +0000736
Lathishb3550f12022-03-15 12:03:53 +0000737The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
738for more information.
739
niamhcoref7b414e2021-11-17 11:02:07 +0000740*Known Vulnerabilities*
741
742None
743
744*Workarounds*
745
DylanB95ESTe5573382022-01-27 17:12:52 +0000746Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
747pass an empty string as the value if you do not want to include names for these values.
niamhcoref7b414e2021-11-17 11:02:07 +0000748
749Security Notes
750--------------
751
752*Fixed Security Issues*
753
754None
755
756*Known Security Issues*
757
758None
759
760.. ========================
shivasubedi44beaa32021-09-13 15:16:30 +0100761.. * * * ISTANBUL * * *
762.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000763
Bruno Sakoto0eaf3342022-02-11 15:05:29 -0500764Version: 2.0.4
765==============
766
767Release Data
768------------
769
770+--------------------------------------+--------------------------------------------------------+
771| **CPS Project** | |
772| | |
773+--------------------------------------+--------------------------------------------------------+
774| **Docker images** | onap/cps-and-ncmp:2.0.4 |
775| | |
776+--------------------------------------+--------------------------------------------------------+
777| **Release designation** | 2.0.4 Istanbul |
778| | |
779+--------------------------------------+--------------------------------------------------------+
780| **Release date** | 2022 Feb 09 |
781| | |
782+--------------------------------------+--------------------------------------------------------+
783
784Bug Fixes
785---------
786
787 - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_ Fix docker compose for csit test.
788 - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_ Fix intermittent circular dependency error when the application starts.
789
790Version: 2.0.3
791==============
792
793Release Data
794------------
795
796+--------------------------------------+--------------------------------------------------------+
797| **CPS Project** | |
798| | |
799+--------------------------------------+--------------------------------------------------------+
800| **Docker images** | onap/cps-and-ncmp:2.0.3 |
801| | |
802+--------------------------------------+--------------------------------------------------------+
803| **Release designation** | 2.0.3 Istanbul |
804| | |
805+--------------------------------------+--------------------------------------------------------+
806| **Release date** | 2022-07-01 |
807| | |
808+--------------------------------------+--------------------------------------------------------+
809
810Bug Fixes
811---------
812
813 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
814
815Version: 2.0.2
816==============
817
818Release Data
819------------
820
821+--------------------------------------+--------------------------------------------------------+
822| **CPS Project** | |
823| | |
824+--------------------------------------+--------------------------------------------------------+
825| **Docker images** | onap/cps-and-ncmp:2.0.2 |
826| | |
827+--------------------------------------+--------------------------------------------------------+
828| **Release designation** | 2.0.2 Istanbul |
829| | |
830+--------------------------------------+--------------------------------------------------------+
831| **Release date** | 2021-16-12 |
832| | |
833+--------------------------------------+--------------------------------------------------------+
834
835Bug Fixes
836---------
837
838 - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_ Update log4j version due to security vulnerability
839
lukegleeson9c583712021-09-30 17:21:11 +0100840Version: 2.0.1
841==============
842
843Release Data
844------------
845
846+--------------------------------------+--------------------------------------------------------+
847| **CPS Project** | |
848| | |
849+--------------------------------------+--------------------------------------------------------+
850| **Docker images** | onap/cps-and-ncmp:2.0.1 |
851| | |
852+--------------------------------------+--------------------------------------------------------+
853| **Release designation** | 2.0.1 Istanbul |
854| | |
855+--------------------------------------+--------------------------------------------------------+
856| **Release date** | 2021-14-10 |
857| | |
858+--------------------------------------+--------------------------------------------------------+
859
860Bug Fixes
861---------
862
863 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
864 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
865 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
866 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
867
868Known Limitations, Issues and Workarounds
869-----------------------------------------
870
871*System Limitations*
872
873Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
874
875*Known Vulnerabilities*
876
877 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
878
879*Workarounds*
880
881Add recursive method to save list node data to loop through all corresponding child nodes.
882
883Security Notes
884--------------
885
886*Fixed Security Issues*
887
888 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
889
890*Known Security Issues*
891
892None
893
shivasubedi44beaa32021-09-13 15:16:30 +0100894Version: 2.0.0
895==============
896
897Abstract
898--------
899
900This document provides the release notes for Istanbul release.
901
902Release Data
903------------
904
905+--------------------------------------+--------------------------------------------------------+
906| **CPS Project** | |
907| | |
908+--------------------------------------+--------------------------------------------------------+
909| **Docker images** | onap/cps-and-ncmp:2.0.0 |
910| | |
911+--------------------------------------+--------------------------------------------------------+
912| **Release designation** | 2.0.0 Istanbul |
913| | |
914+--------------------------------------+--------------------------------------------------------+
lukegleeson9c583712021-09-30 17:21:11 +0100915| **Release date** | 2021-14-09 |
shivasubedi44beaa32021-09-13 15:16:30 +0100916| | |
917+--------------------------------------+--------------------------------------------------------+
918
919Features
920--------
DylanB95EST3fcf8692021-10-11 16:29:16 +0100921* Register DMI-Plugins with NCMP for CM Handle registrations.
shivasubedi44beaa32021-09-13 15:16:30 +0100922* Update, Create and Remove CM Handles.
923* Add support for retrieving and writing CM Handle data through NCMP datastores.
924* Automatic retrieval and caching of model information for CM Handles within NCMP.
925
shivasubedi44beaa32021-09-13 15:16:30 +0100926Deliverables
927------------
928
929Software Deliverables
930
931.. csv-table::
932 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
933 :widths: auto
934
935 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
936
937Bug Fixes
938---------
939
lukegleeson9c583712021-09-30 17:21:11 +0100940 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
shivasubedi44beaa32021-09-13 15:16:30 +0100941 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
942 - `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 +0100943 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
944 - `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 +0100945 - `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 +0100946 - `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 +0100947 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
948 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
lukegleeson9c583712021-09-30 17:21:11 +0100949 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
950 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
951 - `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 +0100952 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
953 - `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 +0100954 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
shivasubedi44beaa32021-09-13 15:16:30 +0100955 - `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 +0100956 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
957 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
958 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
lukegleeson9c583712021-09-30 17:21:11 +0100959 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
960 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
961 - `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 -0500962 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
lukegleeson9c583712021-09-30 17:21:11 +0100963 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
964 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
965 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
shivasubedi44beaa32021-09-13 15:16:30 +0100966
967This document provides the release notes for Istanbul release.
968
969Summary
970-------
971
972Following CPS components are available with default ONAP/CPS installation.
973
974
975 * Platform components
976
977 - CPS (Helm charts)
978
979 * Service components
980
DylanB95EST3fcf8692021-10-11 16:29:16 +0100981 - CPS-NCMP
982 - CPS-Temporal
983 - DMI-Plugin
shivasubedi44beaa32021-09-13 15:16:30 +0100984
985 * Additional resources that CPS utilizes deployed using ONAP common charts
986
987 - Postgres Database
988
989
990Below service components (mS) are available to be deployed on-demand.
991 - CPS-TBDMT
992
993
994Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
995
996Known Limitations, Issues and Workarounds
997-----------------------------------------
998
shivasubedi44beaa32021-09-13 15:16:30 +0100999*System Limitations*
1000
1001Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
1002
1003*Known Vulnerabilities*
1004
lukegleeson9c583712021-09-30 17:21:11 +01001005 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
1006 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
1007 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
shivasubedi44beaa32021-09-13 15:16:30 +01001008
1009*Workarounds*
1010
1011Add recursive method to save list node data to loop through all corresponding child nodes.
1012
1013Security Notes
1014--------------
1015
1016*Fixed Security Issues*
1017
1018 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
shivasubedi44beaa32021-09-13 15:16:30 +01001019
1020*Known Security Issues*
1021
lukegleeson9c583712021-09-30 17:21:11 +01001022 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
1023
shivasubedi44beaa32021-09-13 15:16:30 +01001024Test Results
1025------------
1026 * `Integration tests`
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001027
ToineSiebelinkf0527c52021-07-06 13:03:03 +01001028.. ========================
1029.. * * * HONOLULU * * *
1030.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001031
ToineSiebelinkfd2134d2021-04-09 11:15:48 +01001032Version: 1.0.1
1033==============
1034
1035Release Data
1036------------
1037
1038+--------------------------------------+--------------------------------------------------------+
1039| **CPS Project** | |
1040| | |
1041+--------------------------------------+--------------------------------------------------------+
1042| **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
1043| | |
1044+--------------------------------------+--------------------------------------------------------+
1045| **Release designation** | 1.0.1 Honolulu |
1046| | |
1047+--------------------------------------+--------------------------------------------------------+
1048| **Release date** | 2021-04-09 |
1049| | |
1050+--------------------------------------+--------------------------------------------------------+
1051
1052Bug Fixes
1053---------
1054
puthuparambil.aditya8b584332021-10-12 16:49:03 +01001055 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
ToineSiebelinkfd2134d2021-04-09 11:15:48 +01001056 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
1057 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
1058 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
1059 - `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
1060 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
1061 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
1062 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
1063
1064Security Notes
1065--------------
1066
1067*Fixed Security Issues*
1068
1069 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001070
ToineSiebelinka2d25b52021-04-13 15:10:47 +01001071*Known Security Issues*
1072
1073 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
1074
Rishi.Chail4359d282021-03-03 16:36:26 +00001075Version: 1.0.0
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001076==============
1077
1078
1079Abstract
1080--------
1081
1082This document provides the release notes for Honolulu release.
1083
1084Summary
1085-------
1086
1087Following CPS components are available with default ONAP/CPS installation.
1088
1089
Rishi.Chail4359d282021-03-03 16:36:26 +00001090 * Platform components
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001091
Rishi.Chail4359d282021-03-03 16:36:26 +00001092 - CPS (Helm charts)
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001093
Rishi.Chail4359d282021-03-03 16:36:26 +00001094 * Service components
1095
1096 - CPS Core
1097
1098 * Additional resources that CPS utilizes deployed using ONAP common charts
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001099
1100 - Postgres Database
1101
1102
Rishi.Chail4359d282021-03-03 16:36:26 +00001103Below service components (mS) are available to be deployed on-demand.
1104 - CPS-TBDMT
1105
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001106
1107Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1108
1109
1110Release Data
1111------------
1112
1113+--------------------------------------+--------------------------------------------------------+
1114| **CPS Project** | |
1115| | |
1116+--------------------------------------+--------------------------------------------------------+
1117| **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
1118| | |
1119+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +00001120| **Release designation** | 1.0.0 Honolulu |
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001121| | |
1122+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +00001123| **Release date** | 2021-03-11 |
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001124| | |
1125+--------------------------------------+--------------------------------------------------------+
1126
1127
1128Features
1129--------
Rishi.Chail4359d282021-03-03 16:36:26 +00001130Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
1131CPS has been driven by the needs of the E2E Networking Slicing use case.
1132It currently supports basic (rw) persistence and simple queries.
1133It also provides MVP support for network data access using simulated data.
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001134
1135.. _honolulu_deliverable:
1136
1137Deliverables
1138------------
1139
1140Software Deliverables
1141
1142.. csv-table::
1143 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1144 :widths: auto
1145
Rishi.Chail4359d282021-03-03 16:36:26 +00001146 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001147
1148
1149Known Limitations, Issues and Workarounds
1150-----------------------------------------
1151
Rishi.Chail4359d282021-03-03 16:36:26 +00001152 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1153 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
1154 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
niamhcoredddf7312021-06-21 14:44:01 +01001155 - `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 +00001156
1157*System Limitations*
1158
1159None
1160
1161*Known Vulnerabilities*
1162
1163None
1164
1165*Workarounds*
1166
1167Documented under corresponding jira if applicable.
1168
1169Security Notes
1170--------------
1171
1172*Fixed Security Issues*
ToineSiebelink7c981df2021-03-01 09:53:56 +00001173
1174* `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
Rishi.Chail4359d282021-03-03 16:36:26 +00001175 - Upgrade org.onap.oparent to 3.2.0
ToineSiebelink7c981df2021-03-01 09:53:56 +00001176 - Upgrade spring.boot to 2.3.8.RELEASE
Rishi.Chail4359d282021-03-03 16:36:26 +00001177 - Upgrade yangtools to 5.0.7
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001178
1179*Known Security Issues*
1180
Rishi.Chail4359d282021-03-03 16:36:26 +00001181 * Weak Crytography using md5
1182 * Risk seen in Zip file expansion
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001183
1184*Known Vulnerabilities in Used Modules*
1185
Rishi.Chail4359d282021-03-03 16:36:26 +00001186 None
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001187
Rishi.Chail4359d282021-03-03 16:36:26 +00001188CPS 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 +00001189
1190Test Results
1191------------
Rishi.Chail4359d282021-03-03 16:36:26 +00001192 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001193
1194References
1195----------
1196
ToineSiebelinkcac21862023-06-22 09:24:04 +01001197For more information on the latest ONAP release, please see:
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001198
1199#. `ONAP Home Page`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001200#. `ONAP Wiki Page`_
ToineSiebelinkcac21862023-06-22 09:24:04 +01001201#. `ONAP Documentation`_
1202#. `ONAP CPS Documentation`_
1203#. `ONAP Release Downloads`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001204
1205
1206.. _`ONAP Home Page`: https://www.onap.org
1207.. _`ONAP Wiki Page`: https://wiki.onap.org
1208.. _`ONAP Documentation`: https://docs.onap.org
ToineSiebelinkcac21862023-06-22 09:24:04 +01001209.. _`ONAP CPS Documentation`: https://docs.onap.org/projects/onap-cps
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001210.. _`ONAP Release Downloads`: https://git.onap.org
1211
1212Quick Links:
1213
1214 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
1215 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_