Gitiles
Code Review Sign In
gerrit.nordix.org / onap / cps / 643d043b36686b1b64ac07ad5bca83ff15580fdd / . / docs / release-notes.rst
blob: 8ceb61600a5bc40e4b19a2d8531f9af3e7c9ed3d [file] [log] [blame]
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
lukegleesone0154a62023-01-25 15:06:52 +0000[diff] [blame]3.. Copyright (C) 2021-2023 Nordix Foundation
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]4
5.. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
6.. _release_notes:
7
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]8CPS Release Notes
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400[diff] [blame]9#################
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]10
11.. contents::
12 :depth: 2
13..
14
lukegleesond7764c42023-04-20 14:11:20 +0100[diff] [blame]15.. ========================
16.. * * * MONTREAL * * *
17.. ========================
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]18
danielhanrahan19f963b2023-06-15 13:52:34 +0100[diff] [blame]19Version: 3.3.3
20==============
21
22Release Data
23------------
24
25+--------------------------------------+--------------------------------------------------------+
26| **CPS Project** | |
27| | |
28+--------------------------------------+--------------------------------------------------------+
29| **Docker images** | onap/cps-and-ncmp:3.3.3 |
30| | |
31+--------------------------------------+--------------------------------------------------------+
32| **Release designation** | 3.3.3 Montreal |
33| | |
34+--------------------------------------+--------------------------------------------------------+
35| **Release date** | Not yet released |
36| | |
37+--------------------------------------+--------------------------------------------------------+
38
39Bug Fixes
40---------
413.3.3
42
43Features
44--------
mpriyank6da95412023-06-29 16:56:11 +0100[diff] [blame]45 - `CPS-1515 <https://jira.onap.org/browse/CPS-1515>`_ Support Multiple CM-Handles for NCMP Get Operation
46 - `CPS-1675 <https://jira.onap.org/browse/CPS-1675>`_ Persistence write performance improvement(s)
47 - `CPS-1745 <https://jira.onap.org/browse/CPS-1745>`_ Upgrade to Openapi 3.0.3
danielhanrahan19f963b2023-06-15 13:52:34 +0100[diff] [blame]48
mpriyank436b75b2023-05-03 11:10:08 +0100[diff] [blame]49Version: 3.3.2
50==============
51
52Release Data
53------------
54
55+--------------------------------------+--------------------------------------------------------+
56| **CPS Project** | |
57| | |
58+--------------------------------------+--------------------------------------------------------+
59| **Docker images** | onap/cps-and-ncmp:3.3.2 |
60| | |
61+--------------------------------------+--------------------------------------------------------+
62| **Release designation** | 3.3.2 Montreal |
63| | |
64+--------------------------------------+--------------------------------------------------------+
danielhanrahan19f963b2023-06-15 13:52:34 +0100[diff] [blame]65| **Release date** | 2023 June 15 |
mpriyank436b75b2023-05-03 11:10:08 +0100[diff] [blame]66| | |
67+--------------------------------------+--------------------------------------------------------+
68
69Bug Fixes
70---------
713.3.2
danielhanrahan5cec5322023-06-15 11:08:54 +0100[diff] [blame]72 - `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 +0100[diff] [blame]73
74Features
75--------
--globalc7e5a802023-04-05 17:08:08 +0530[diff] [blame]76 - `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 +0100[diff] [blame]77 - `CPS-1273 <https://jira.onap.org/browse/CPS-1273>`_ Add <,> operators support to cps-path
78 - `CPS-1664 <https://jira.onap.org/browse/CPS-1664>`_ Use recursive SQL to fetch descendants in CpsPath queries to improve query performance
79 - `CPS-1676 <https://jira.onap.org/browse/CPS-1676>`_ Entity ID types do not match types in database definition
80 - `CPS-1677 <https://jira.onap.org/browse/CPS-1677>`_ Remove dataspace_id column from Fragment table
mpriyank436b75b2023-05-03 11:10:08 +0100[diff] [blame]81
lukegleesond7764c42023-04-20 14:11:20 +0100[diff] [blame]82Version: 3.3.1
halil.cakal0b8d85d2023-03-23 12:44:27 +0000[diff] [blame]83==============
84
85Release Data
86------------
87
88+--------------------------------------+--------------------------------------------------------+
89| **CPS Project** | |
90| | |
91+--------------------------------------+--------------------------------------------------------+
lukegleesond7764c42023-04-20 14:11:20 +0100[diff] [blame]92| **Docker images** | onap/cps-and-ncmp:3.3.1 |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000[diff] [blame]93| | |
94+--------------------------------------+--------------------------------------------------------+
lukegleesond7764c42023-04-20 14:11:20 +0100[diff] [blame]95| **Release designation** | 3.3.1 Montreal |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000[diff] [blame]96| | |
97+--------------------------------------+--------------------------------------------------------+
mpriyank436b75b2023-05-03 11:10:08 +0100[diff] [blame]98| **Release date** | 2023 May 03 |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000[diff] [blame]99| | |
100+--------------------------------------+--------------------------------------------------------+
101
102Bug Fixes
103---------
lukegleesond7764c42023-04-20 14:11:20 +0100[diff] [blame]1043.3.1
halil.cakal0b8d85d2023-03-23 12:44:27 +0000[diff] [blame]105 - None
106
107Features
108--------
mpriyank52c5e542023-05-02 15:58:55 +0100[diff] [blame]109 - `CPS-1272 <https://jira.onap.org/browse/CPS-1272>`_ Add Contains operation to CPS Path
110 - `CPS-1573 <https://jira.onap.org/browse/CPS-1573>`_ Remove 32K limit for DB operations
111 - `CPS-1627 <https://jira.onap.org/browse/CPS-1627>`_ Dependency versions uplift because of vulnerability issues
112 - `CPS-1629 <https://jira.onap.org/browse/CPS-1629>`_ Ordering of leaf elements to support combination of AND/OR in cps-path
113 - `CPS-1637 <https://jira.onap.org/browse/CPS-1637>`_ Extend hazelcast to work on kubernetes
halil.cakal0b8d85d2023-03-23 12:44:27 +0000[diff] [blame]114
lukegleesond7764c42023-04-20 14:11:20 +0100[diff] [blame]115Version: 3.3.0
116==============
117
118Release Data
119------------
120
121+--------------------------------------+--------------------------------------------------------+
122| **CPS Project** | |
123| | |
124+--------------------------------------+--------------------------------------------------------+
125| **Docker images** | onap/cps-and-ncmp:3.3.0 |
126| | |
127+--------------------------------------+--------------------------------------------------------+
128| **Release designation** | 3.3.0 Montreal |
129| | |
130+--------------------------------------+--------------------------------------------------------+
131| **Release date** | 2023 April 20 |
132| | |
133+--------------------------------------+--------------------------------------------------------+
134
135Bug Fixes
136---------
1373.3.0
138 - None
139
140Features
141--------
142 - `CPS-1215 <https://jira.onap.org/browse/CPS-1215>`_ Add OR operation for CPS Path
143 - `CPS-1617 <https://jira.onap.org/browse/CPS-1617>`_ Use cascade delete in fragments table
144
145.. ======================
146.. * * * LONDON * * *
147.. ======================
148
mpriyank0fd4d192023-03-10 13:48:20 +0000[diff] [blame]149Version: 3.2.6
150==============
151
152Release Data
153------------
154
155+--------------------------------------+--------------------------------------------------------+
156| **CPS Project** | |
157| | |
158+--------------------------------------+--------------------------------------------------------+
159| **Docker images** | onap/cps-and-ncmp:3.2.6 |
160| | |
161+--------------------------------------+--------------------------------------------------------+
162| **Release designation** | 3.2.6 London |
163| | |
164+--------------------------------------+--------------------------------------------------------+
seanbeirnef5a3a212023-03-06 09:12:49 +0000[diff] [blame]165| **Release date** | 2023 March 22 |
mpriyank0fd4d192023-03-10 13:48:20 +0000[diff] [blame]166| | |
167+--------------------------------------+--------------------------------------------------------+
168
169Bug Fixes
170---------
1713.2.6
arpitsingh2b4c4882023-03-03 21:38:57 +0530[diff] [blame]172 - `CPS-1526 <https://jira.onap.org/browse/CPS-1526>`_ Fix response message for PATCH operation
seanbeirnef5a3a212023-03-06 09:12:49 +0000[diff] [blame]173 - `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 +0000[diff] [blame]174
175Features
176--------
seanbeirnef5a3a212023-03-06 09:12:49 +0000[diff] [blame]177 - `CPS-1396 <https://jira.onap.org/browse/CPS-1396>`_ Query data nodes across all anchors under one dataspace
mpriyank0fd4d192023-03-10 13:48:20 +0000[diff] [blame]178
mpriyankade5a6e2023-03-09 17:58:31 +0000[diff] [blame]179Version: 3.2.5
180==============
181
182Release Data
183------------
184
185+--------------------------------------+--------------------------------------------------------+
186| **CPS Project** | |
187| | |
188+--------------------------------------+--------------------------------------------------------+
189| **Docker images** | onap/cps-and-ncmp:3.2.5 |
190| | |
191+--------------------------------------+--------------------------------------------------------+
192| **Release designation** | 3.2.5 London |
193| | |
194+--------------------------------------+--------------------------------------------------------+
mpriyank06bfe4e2023-03-10 11:48:23 +0000[diff] [blame]195| **Release date** | 2023 March 10 |
mpriyankade5a6e2023-03-09 17:58:31 +0000[diff] [blame]196| | |
197+--------------------------------------+--------------------------------------------------------+
198
199Bug Fixes
200---------
2013.2.5
mpriyank06bfe4e2023-03-10 11:48:23 +0000[diff] [blame]202 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ Introduce control switch for model loader functionality.
mpriyankade5a6e2023-03-09 17:58:31 +0000[diff] [blame]203
204Features
205--------
206 - None
207
seanbeirnef0f4fd82023-03-07 13:42:04 +0000[diff] [blame]208Version: 3.2.4
209==============
210
211Release Data
212------------
213
214+--------------------------------------+--------------------------------------------------------+
215| **CPS Project** | |
216| | |
217+--------------------------------------+--------------------------------------------------------+
218| **Docker images** | onap/cps-and-ncmp:3.2.4 |
219| | |
220+--------------------------------------+--------------------------------------------------------+
221| **Release designation** | 3.2.4 London |
222| | |
223+--------------------------------------+--------------------------------------------------------+
mpriyankbd5ba8d2023-03-09 16:33:02 +0000[diff] [blame]224| **Release date** | 2023 March 09 |
seanbeirnef0f4fd82023-03-07 13:42:04 +0000[diff] [blame]225| | |
226+--------------------------------------+--------------------------------------------------------+
227
228Bug Fixes
229---------
2303.2.4
mpriyankbd5ba8d2023-03-09 16:33:02 +0000[diff] [blame]231 - `CPS-1533 <https://jira.onap.org/browse/CPS-1533>`_ Fix for Temp tables cause Out of shared memory errors in Postgres
232 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ NCMP failed to start due to issue in SubscriptionModelLoader
233
234Features
235--------
236 - None
seanbeirnef0f4fd82023-03-07 13:42:04 +0000[diff] [blame]237
mpriyankfd43dbe2023-02-08 11:21:08 +0000[diff] [blame]238Version: 3.2.3
239==============
240
241Release Data
242------------
243
244+--------------------------------------+--------------------------------------------------------+
245| **CPS Project** | |
246| | |
247+--------------------------------------+--------------------------------------------------------+
248| **Docker images** | onap/cps-and-ncmp:3.2.3 |
249| | |
250+--------------------------------------+--------------------------------------------------------+
251| **Release designation** | 3.2.3 London |
252| | |
253+--------------------------------------+--------------------------------------------------------+
seanbeirnef9af5f82023-03-07 10:36:18 +0000[diff] [blame]254| **Release date** | 2023 March 07 |
mpriyankfd43dbe2023-02-08 11:21:08 +0000[diff] [blame]255| | |
256+--------------------------------------+--------------------------------------------------------+
257
258Bug Fixes
259---------
2603.2.3
seanbeirnef9af5f82023-03-07 10:36:18 +0000[diff] [blame]261 - `CPS-1494 <https://jira.onap.org/browse/CPS-1494>`_ NCMP Inventory Performance Improvements
mpriyankfd43dbe2023-02-08 11:21:08 +0000[diff] [blame]262
263Features
264--------
seanbeirnef9af5f82023-03-07 10:36:18 +0000[diff] [blame]265 - `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
266 - `CPS-1502 <https://jira.onap.org/browse/CPS-1502>`_ Delete Performance Improvements
mpriyankfd43dbe2023-02-08 11:21:08 +0000[diff] [blame]267
seanbeirnef8e980a2023-01-27 18:09:33 +0000[diff] [blame]268Version: 3.2.2
269==============
270
271Release Data
272------------
273
274+--------------------------------------+--------------------------------------------------------+
275| **CPS Project** | |
276| | |
277+--------------------------------------+--------------------------------------------------------+
278| **Docker images** | onap/cps-and-ncmp:3.2.2 |
279| | |
280+--------------------------------------+--------------------------------------------------------+
281| **Release designation** | 3.2.2 London |
282| | |
283+--------------------------------------+--------------------------------------------------------+
mpriyankfd43dbe2023-02-08 11:21:08 +0000[diff] [blame]284| **Release date** | 2023 February 08 |
seanbeirnef8e980a2023-01-27 18:09:33 +0000[diff] [blame]285| | |
286+--------------------------------------+--------------------------------------------------------+
287
288Bug Fixes
289---------
mpriyank0b5950d2023-02-07 17:55:10 +0000[diff] [blame]2903.2.2
mpriyankfd43dbe2023-02-08 11:21:08 +0000[diff] [blame]291 - `CPS-1173 <https://jira.onap.org/browse/CPS-1173>`_ Delete Performance Improvements.
mpriyank0b5950d2023-02-07 17:55:10 +0000[diff] [blame]292
293Features
294--------
295 - None
seanbeirnef8e980a2023-01-27 18:09:33 +0000[diff] [blame]296
leventecsanyi37d72852022-10-26 10:44:08 +0200[diff] [blame]297Version: 3.2.1
298==============
mpriyank4bd450e2022-10-05 09:50:59 +0100[diff] [blame]299
300Release Data
301------------
302
303+--------------------------------------+--------------------------------------------------------+
304| **CPS Project** | |
305| | |
306+--------------------------------------+--------------------------------------------------------+
lukegleesone0154a62023-01-25 15:06:52 +0000[diff] [blame]307| **Docker images** | onap/cps-and-ncmp:3.2.1 |
mpriyank4bd450e2022-10-05 09:50:59 +0100[diff] [blame]308| | |
309+--------------------------------------+--------------------------------------------------------+
leventecsanyi37d72852022-10-26 10:44:08 +0200[diff] [blame]310| **Release designation** | 3.2.1 London |
mpriyank4bd450e2022-10-05 09:50:59 +0100[diff] [blame]311| | |
312+--------------------------------------+--------------------------------------------------------+
lukegleesone0154a62023-01-25 15:06:52 +0000[diff] [blame]313| **Release date** | 2023 January 27 |
mpriyank4bd450e2022-10-05 09:50:59 +0100[diff] [blame]314| | |
315+--------------------------------------+--------------------------------------------------------+
Cédric Ollivier490b20d2023-03-15 21:40:48 +0100[diff] [blame]316
lukegleeson3be99242022-10-11 14:34:56 +0100[diff] [blame]317Features
318--------
leventecsanyi37d72852022-10-26 10:44:08 +0200[diff] [blame]3193.2.1
lukegleesone0154a62023-01-25 15:06:52 +0000[diff] [blame]320 - `CPS-341 <https://jira.onap.org/browse/CPS-341>`_ Added support for multiple data tree instances under 1 anchor.
321 - `CPS-1002 <https://jira.onap.org/browse/CPS-1002>`_ Add CPS-E-05 endpoint for 'Query data, NCMP-Operational Datastore' using cpsPaths
322 - `CPS-1182 <https://jira.onap.org/browse/CPS-1182>`_ Upgrade Opendaylight
ToineSiebelink294bcb52022-12-23 11:07:42 +0000[diff] [blame]323 - `CPS-1185 <https://jira.onap.org/browse/CPS-1185>`_ Get all dataspaces.
324 - `CPS-1186 <https://jira.onap.org/browse/CPS-1186>`_ Get single dataspace.
lukegleesonf20b4992022-12-09 15:48:55 +0000[diff] [blame]325 - `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 +0000[diff] [blame]326 - `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 +0000[diff] [blame]327 - `CPS-1257 <https://jira.onap.org/browse/CPS-1257>`_ Added support for application/xml Content-Type (write only).
lukegleesone0154a62023-01-25 15:06:52 +0000[diff] [blame]328 - `CPS-1381 <https://jira.onap.org/browse/CPS-1381>`_ Query large outputs using limit/depth/pagination
ToineSiebelink294bcb52022-12-23 11:07:42 +0000[diff] [blame]329 - `CPS-1421 <https://jira.onap.org/browse/CPS-1421>`_ Optimized query for large number of hits with descendants.
lukegleesone0154a62023-01-25 15:06:52 +0000[diff] [blame]330 - `CPS-1422 <https://jira.onap.org/browse/CPS-1422>`_ Fetch CM handles by collection of xpaths (CPS Core)
331 - `CPS-1424 <https://jira.onap.org/browse/CPS-1424>`_ Updating CmHandleStates using batch operation
332 - `CPS-1439 <https://jira.onap.org/browse/CPS-1439>`_ Use native query to delete data nodes
mpriyank4bd450e2022-10-05 09:50:59 +0100[diff] [blame]333
334Bug Fixes
335---------
ToineSiebelink294bcb52022-12-23 11:07:42 +0000[diff] [blame]3363.2.1
lukegleesone0154a62023-01-25 15:06:52 +0000[diff] [blame]337 - `CPS-1171 <https://jira.onap.org/browse/CPS-1171>`_ Optimized retrieval of data nodes with many descendants.
338 - `CPS-1288 <https://jira.onap.org/browse/CPS-1288>`_ Hazelcast TTL for IMap is not working
339 - `CPS-1289 <https://jira.onap.org/browse/CPS-1289>`_ Getting wrong error code for create node api
340 - `CPS-1326 <https://jira.onap.org/browse/CPS-1326>`_ Creation of DataNodeBuilder with module name prefix is very slow
341 - `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 +0000[diff] [blame]342 - `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_ Add Basic Auth to CPS/NCMP OpenAPI Definitions.
lukegleesone0154a62023-01-25 15:06:52 +0000[diff] [blame]343 - `CPS-1352 <https://jira.onap.org/browse/CPS-1352>`_ Handle YangChoiceNode in right format.
ToineSiebelink294bcb52022-12-23 11:07:42 +0000[diff] [blame]344 - `CPS-1409 <https://jira.onap.org/browse/CPS-1409>`_ Fix Delete uses case with '/' in path.
lukegleesone0154a62023-01-25 15:06:52 +0000[diff] [blame]345 - `CPS-1433 <https://jira.onap.org/browse/CPS-1433>`_ Fix to allow posting data with '/' key fields.
346 - `CPS-1442 <https://jira.onap.org/browse/CPS-1442>`_ CPS PATCH operation does not merge existing data
347 - `CPS-1446 <https://jira.onap.org/browse/CPS-1446>`_ Locked cmhandles and ready to locked state transitions causing long cmHandle discovery
348 - `CPS-1457 <https://jira.onap.org/browse/CPS-1457>`_ CpsDataPersistenceService#getDataNodes uses non-normalized xpaths
349 - `CPS-1458 <https://jira.onap.org/browse/CPS-1458>`_ CpsDataPersistenceService#getDataNodes does not handle root xpath
350 - `CPS-1460 <https://jira.onap.org/browse/CPS-1460>`_ CPS Path Processing Performance Test duration is too low
ToineSiebelink294bcb52022-12-23 11:07:42 +0000[diff] [blame]351
leventecsanyi37d72852022-10-26 10:44:08 +0200[diff] [blame]3523.2.0
ToineSiebelink294bcb52022-12-23 11:07:42 +0000[diff] [blame]353 - `CPS-1312 <https://jira.onap.org/browse/CPS-1312>`_ CPS(/NCMP) does not have version control.
mpriyank4bd450e2022-10-05 09:50:59 +0100[diff] [blame]354
lukegleeson3be99242022-10-11 14:34:56 +0100[diff] [blame]355Known Limitations, Issues and Workarounds
356-----------------------------------------
357
358*System Limitations*
359
seanbeirne72c267e2022-10-18 12:39:22 +0100[diff] [blame]360For upgrading, CPS uses Liquibase for database upgrades. CPS/NCMP currently only supports upgrading from Liquibase changelog 11 to Liquibase changelog 16.
361This is from commit CPS-506: List all known modules and revision to CPS-1312: Default CMHandles to READY during upgrade or from ONAP release Honolulu to Kohn.
lukegleeson3be99242022-10-11 14:34:56 +0100[diff] [blame]362
arpitsingh2b4c4882023-03-03 21:38:57 +0530[diff] [blame]363CPS core Patch operation currently supports updating data of one top level data node. When performing Patch on multiple top level data nodes at once
364a 400 Bad Request is sent as response. This is part of commit CPS-1526.
365
seanbeirnedba2b102022-10-27 09:59:17 +0100[diff] [blame]366.. ====================
367.. * * * KOHN * * *
368.. ====================
369
mpriyankfe775312022-09-30 14:16:51 +0100[diff] [blame]370Version: 3.1.4
371==============
372
373Release Data
374------------
375
376+--------------------------------------+--------------------------------------------------------+
377| **CPS Project** | |
378| | |
379+--------------------------------------+--------------------------------------------------------+
380| **Docker images** | onap/cps-and-ncmp:3.1.4 |
381| | |
382+--------------------------------------+--------------------------------------------------------+
383| **Release designation** | 3.1.4 Kohn |
384| | |
385+--------------------------------------+--------------------------------------------------------+
mpriyank4bd450e2022-10-05 09:50:59 +0100[diff] [blame]386| **Release date** | 2022 October 5 |
mpriyankfe775312022-09-30 14:16:51 +0100[diff] [blame]387| | |
388+--------------------------------------+--------------------------------------------------------+
389
390Bug Fixes
391---------
lukegleeson8c6b5622022-09-29 15:58:06 +0100[diff] [blame]392 - `CPS-1265 <https://jira.onap.org/browse/CPS-1265>`_ Revision field should not be required (NotNull) on cps-ri YangResourceEntity
mpriyankac0bffc2022-10-03 12:26:10 +0100[diff] [blame]393 - `CPS-1294 <https://jira.onap.org/browse/CPS-1294>`_ Kafka communication fault caused cmHandle registration error
mpriyankfe775312022-09-30 14:16:51 +0100[diff] [blame]394
mpriyank06736cb2022-09-29 14:29:40 +0100[diff] [blame]395Version: 3.1.3
396==============
397
398Release Data
399------------
400
401+--------------------------------------+--------------------------------------------------------+
402| **CPS Project** | |
403| | |
404+--------------------------------------+--------------------------------------------------------+
405| **Docker images** | onap/cps-and-ncmp:3.1.3 |
406| | |
407+--------------------------------------+--------------------------------------------------------+
408| **Release designation** | 3.1.3 Kohn |
409| | |
410+--------------------------------------+--------------------------------------------------------+
mpriyankfe775312022-09-30 14:16:51 +0100[diff] [blame]411| **Release date** | 2022 September 29 |
mpriyank06736cb2022-09-29 14:29:40 +0100[diff] [blame]412| | |
413+--------------------------------------+--------------------------------------------------------+
414
415Bug Fixes
416---------
417 - None
418
mpriyankef0ddfc2022-09-28 12:19:34 +0100[diff] [blame]419Version: 3.1.2
420==============
421
422Release Data
423------------
424
425+--------------------------------------+--------------------------------------------------------+
426| **CPS Project** | |
427| | |
428+--------------------------------------+--------------------------------------------------------+
429| **Docker images** | onap/cps-and-ncmp:3.1.2 |
430| | |
431+--------------------------------------+--------------------------------------------------------+
432| **Release designation** | 3.1.2 Kohn |
433| | |
434+--------------------------------------+--------------------------------------------------------+
mpriyank06736cb2022-09-29 14:29:40 +0100[diff] [blame]435| **Release date** | 2022 September 28 |
mpriyankef0ddfc2022-09-28 12:19:34 +0100[diff] [blame]436| | |
437+--------------------------------------+--------------------------------------------------------+
438
439Bug Fixes
440---------
441 - None
442
mpriyanka3f43502022-09-26 14:57:01 +0100[diff] [blame]443Version: 3.1.1
444==============
445
446Release Data
447------------
448
449+--------------------------------------+--------------------------------------------------------+
450| **CPS Project** | |
451| | |
452+--------------------------------------+--------------------------------------------------------+
453| **Docker images** | onap/cps-and-ncmp:3.1.1 |
454| | |
455+--------------------------------------+--------------------------------------------------------+
456| **Release designation** | 3.1.1 Kohn |
457| | |
458+--------------------------------------+--------------------------------------------------------+
mpriyankef0ddfc2022-09-28 12:19:34 +0100[diff] [blame]459| **Release date** | 2022 September 28 |
mpriyanka3f43502022-09-26 14:57:01 +0100[diff] [blame]460| | |
461+--------------------------------------+--------------------------------------------------------+
462
463Bug Fixes
464---------
465 - None
466
lukegleesonc9ec9152022-09-07 14:21:36 +0100[diff] [blame]467Security Notes
468--------------
469
470*Fixed Security Issues*
471
472 - `CPS-1226 <https://jira.onap.org/browse/CPS-1226>`_ Security bug in the logs
473
lukegleeson4a34fa52022-09-19 15:31:59 +0100[diff] [blame]474Version: 3.1.0
475==============
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400[diff] [blame]476
477Release Data
478------------
479
DylanB95ESTb130fd32022-04-04 13:09:22 +0100[diff] [blame]480+--------------------------------------+--------------------------------------------------------+
481| **CPS Project** | |
482| | |
483+--------------------------------------+--------------------------------------------------------+
484| **Docker images** | onap/cps-and-ncmp:3.1.0 |
485| | |
486+--------------------------------------+--------------------------------------------------------+
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400[diff] [blame]487| **Release designation** | 3.1.0 Kohn |
DylanB95ESTb130fd32022-04-04 13:09:22 +0100[diff] [blame]488| | |
489+--------------------------------------+--------------------------------------------------------+
lukegleeson4a34fa52022-09-19 15:31:59 +0100[diff] [blame]490| **Release date** | 2022 September 14 |
DylanB95ESTb130fd32022-04-04 13:09:22 +0100[diff] [blame]491| | |
492+--------------------------------------+--------------------------------------------------------+
493
494Features
495--------
lukegleeson4a34fa52022-09-19 15:31:59 +0100[diff] [blame]496 - `CPS-340 <https://jira.onap.org/browse/CPS-340>`_ Patch and update the root data node
497 - `CPS-575 <https://jira.onap.org/browse/CPS-575>`_ Write data for cmHandle using ncmp-datastores:passthrough-running (NCMP.)
498 - `CPS-731 <https://jira.onap.org/browse/CPS-731>`_ Query based on Public CM Properties
499 - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_ Async: NCMP Rest impl. including Request ID generation
500 - `CPS-829 <https://jira.onap.org/browse/CPS-829>`_ Async: Internal message topic incl. basic producer & Consumer
501 - `CPS-830 <https://jira.onap.org/browse/CPS-830>`_ DMI-NCMP Asynchronously Publish Response Event to Client Topic
502 - `CPS-869 <https://jira.onap.org/browse/CPS-869>`_ Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072
503 - `CPS-870 <https://jira.onap.org/browse/CPS-870>`_ Align CPS-Core output with SDN-C output (add module name)
504 - `CPS-875 <https://jira.onap.org/browse/CPS-875>`_ CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles
505 - `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'
506 - `CPS-899 <https://jira.onap.org/browse/CPS-899>`_ Start and stop sessions on Java API
507 - `CPS-909 <https://jira.onap.org/browse/CPS-909>`_ Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state
508 - `CPS-917 <https://jira.onap.org/browse/CPS-917>`_ Structured Errors response for passthrough use-cases in NCMP
509 - `CPS-953 <https://jira.onap.org/browse/CPS-953>`_ Update maven deploy plugin version
510 - `CPS-977 <https://jira.onap.org/browse/CPS-977>`_ Query CM Handles using CpsPath
511 - `CPS-1000 <https://jira.onap.org/browse/CPS-1000>`_ Create Data Synchronization watchdog
512 - `CPS-1016 <https://jira.onap.org/browse/CPS-1016>`_ Merge 2 'query' end points in NCMP
513 - `CPS-1034 <https://jira.onap.org/browse/CPS-1034>`_ Publish lifecycle events for ADVISED , READY and LOCKED state transition"
514 - `CPS-1064 <https://jira.onap.org/browse/CPS-1064>`_ Support retrieval of YANG module sources for CM handle on the NCMP interface
515 - `CPS-1099 <https://jira.onap.org/browse/CPS-1099>`_ Expose simplified 'external' lock reason enum state over REST interface
516 - `CPS-1101 <https://jira.onap.org/browse/CPS-1101>`_ Introducing the DELETING and DELETED Cmhandle State
517 - `CPS-1102 <https://jira.onap.org/browse/CPS-1102>`_ Register the Cmhandle Sends Advised State notification.
518 - `CPS-1133 <https://jira.onap.org/browse/CPS-1133>`_ Enable/Disable Data Sync for Cm Handle
519 - `CPS-1136 <https://jira.onap.org/browse/CPS-1136>`_ DMI Audit Support (get all CM Handles for a registered DMI)
520
emacleeafb17362022-09-02 14:40:17 +0100[diff] [blame]521
522Bug Fixes
523---------
lukegleeson4a34fa52022-09-19 15:31:59 +0100[diff] [blame]524 - `CPS-896 <https://jira.onap.org/browse/CPS-896>`_ CM Handle Registration Process only partially completes when exception is thrown
525 - `CPS-957 <https://jira.onap.org/browse/CPS-957>`_ NCMP: fix getResourceDataForPassthroughOperational endpoint
526 - `CPS-1020 <https://jira.onap.org/browse/CPS-1020>`_ DuplicatedYangResourceException error at parallel cmHandle registration
527 - `CPS-1056 <https://jira.onap.org/browse/CPS-1056>`_ Wrong error response format in case of Dmi plugin error
528 - `CPS-1067 <https://jira.onap.org/browse/CPS-1067>`_ NCMP returns 500 error on searches endpoint when No DMi Handles registered
529 - `CPS-1085 <https://jira.onap.org/browse/CPS-1085>`_ Performance degradation on ncmp/v1/ch/searches endpoint
530 - `CPS-1088 <https://jira.onap.org/browse/CPS-1088>`_ Kafka consumer can not be turned off
531 - `CPS-1097 <https://jira.onap.org/browse/CPS-1097>`_ Unable to change state from LOCKED to ADVISED
532 - `CPS-1126 <https://jira.onap.org/browse/CPS-1126>`_ CmHandle creation performance degradation
533 - `CPS-1175 <https://jira.onap.org/browse/CPS-1175>`_ Incorrect response when empty body executed for cmhandle id-searches
534 - `CPS-1179 <https://jira.onap.org/browse/CPS-1179>`_ Node API - GET method returns invalid response when identifier contains '/'
535 - `CPS-1212 <https://jira.onap.org/browse/CPS-1212>`_ Additional Properties for CM Handles not included when send to DMI Plugin
536 - `CPS-1217 <https://jira.onap.org/browse/CPS-1217>`_ Searches endpoint gives back empty list however there are already available cmhandles
537 - `CPS-1218 <https://jira.onap.org/browse/CPS-1218>`_ NCMP logs are flooded with SyncUtils logs
puthuparambil.adityadd904322022-09-21 10:53:51 +0100[diff] [blame]538
539Known Limitations, Issues and Workarounds
540-----------------------------------------
541
542*System Limitations*
543
544Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition.
545Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces']
DylanB95ESTb130fd32022-04-04 13:09:22 +0100[diff] [blame]546
lukegleeson4a34fa52022-09-19 15:31:59 +0100[diff] [blame]547*Known Vulnerabilities*
548
549None
550
551*Workarounds*
552
553None
554
555Security Notes
556--------------
557
558*Fixed Security Issues*
559
560 - `CPS-963 <https://jira.onap.org/browse/CPS-963>`_ Liquibase has got serious vulnerability, upgrade required
561
562*Known Security Issues*
563
564None
565
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400[diff] [blame]566.. ========================
567.. * * * JAKARTA * * *
568.. ========================
569
570Version: 3.0.1
571==============
572
573Release Data
574------------
575
576+--------------------------------------+--------------------------------------------------------+
577| **CPS Project** | |
578| | |
579+--------------------------------------+--------------------------------------------------------+
580| **Docker images** | onap/cps-and-ncmp:3.0.1 |
581| | |
582+--------------------------------------+--------------------------------------------------------+
583| **Release designation** | 3.0.1 Jakarta |
584| | |
585+--------------------------------------+--------------------------------------------------------+
586| **Release date** | 2022 April 28 |
587| | |
588+--------------------------------------+--------------------------------------------------------+
589
590Bug Fixes
591---------
592 - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_ Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
593
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400[diff] [blame]594Version: 3.0.0
595==============
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]596
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400[diff] [blame]597Release Data
598------------
599
600+--------------------------------------+--------------------------------------------------------+
601| **CPS Project** | |
602| | |
603+--------------------------------------+--------------------------------------------------------+
604| **Docker images** | onap/cps-and-ncmp:3.0.0 |
605| | |
606+--------------------------------------+--------------------------------------------------------+
607| **Release designation** | 3.0.0 Jakarta |
608| | |
609+--------------------------------------+--------------------------------------------------------+
610| **Release date** | 2022 March 15 |
611| | |
612+--------------------------------------+--------------------------------------------------------+
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]613
614Features
615--------
puthuparambil.adityad0007332021-12-08 18:53:39 +0000[diff] [blame]616 - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_ Define response objects (schemas) in cps-ncmp
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]617 - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_ Update operation for datastore pass through running
618 - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_ Delete operation for datastore pass through running
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame]619 - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_ Support 'public' Cm Handle Properties
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]620 - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
JosephKeenan82ebf532021-12-08 18:16:44 +0000[diff] [blame]621 - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_ Ensure all DMI operations use POST method
puthuparambil.adityad0007332021-12-08 18:53:39 +0000[diff] [blame]622 - `CPS-780 <https://jira.onap.org/browse/CPS-780>`_ Add examples for parameters, request and response in openapi yaml for cps-core
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400[diff] [blame]623 - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
624 - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame]625 - `CPS-817 <https://jira.onap.org/browse/CPS-817>`_ Create Endpoint For Get Cm Handles (incl. public properties) By Name
mpriyank80dee972022-02-23 15:17:23 +0530[diff] [blame]626 - `CPS-837 <https://jira.onap.org/browse/CPS-837>`_ Add Remove and Update properties (DMI and Public) as part of CM Handle Registration update
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]627
628Bug Fixes
629---------
630
631 - `CPS-762 <https://jira.onap.org/browse/CPS-762>`_ Query cm handles for module names returns incorrect cm handle identifiers
ToineSiebelink3f142302021-12-07 11:30:10 +0000[diff] [blame]632 - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
niamhcore65bc4fd2021-12-08 14:19:02 +0000[diff] [blame]633 - `CPS-783 <https://jira.onap.org/browse/CPS-783>`_ Remove cm handle does not completely remove all cm handle information
puthuparambil.aditya71395fb2022-01-05 13:39:31 +0000[diff] [blame]634 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM
puthuparambil.aditya62ac0c32022-02-03 16:42:13 +0000[diff] [blame]635 - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
JosephKeenane0643ab2022-02-15 18:23:05 +0000[diff] [blame]636 - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame]637 - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
JosephKeenane0643ab2022-02-15 18:23:05 +0000[diff] [blame]638 - `CPS-887 <https://jira.onap.org/browse/CPS-887>`_ Increase performance of cmHandle registration for large number of schema sets in DB
mpriyank80dee972022-02-23 15:17:23 +0530[diff] [blame]639 - `CPS-892 <https://jira.onap.org/browse/CPS-892>`_ Fixed the response code during CM-Handle Registration from 201 CREATED to 204 NO_CONTENT
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame]640 - `CPS-893 <https://jira.onap.org/browse/CPS-893>`_ NCMP Java API depends on NCM-Rest-API (cyclic) through json properties on Java API
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]641
642Known Limitations, Issues and Workarounds
643-----------------------------------------
644
645*System Limitations*
646
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame]647Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
648`CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
649of cm handle registration.
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]650
Lathishb3550f12022-03-15 12:03:53 +0000[diff] [blame]651The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
652for more information.
653
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]654*Known Vulnerabilities*
655
656None
657
658*Workarounds*
659
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame]660Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
661pass an empty string as the value if you do not want to include names for these values.
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]662
663Security Notes
664--------------
665
666*Fixed Security Issues*
667
668None
669
670*Known Security Issues*
671
672None
673
674.. ========================
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]675.. * * * ISTANBUL * * *
676.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]677
Bruno Sakoto0eaf3342022-02-11 15:05:29 -0500[diff] [blame]678Version: 2.0.4
679==============
680
681Release Data
682------------
683
684+--------------------------------------+--------------------------------------------------------+
685| **CPS Project** | |
686| | |
687+--------------------------------------+--------------------------------------------------------+
688| **Docker images** | onap/cps-and-ncmp:2.0.4 |
689| | |
690+--------------------------------------+--------------------------------------------------------+
691| **Release designation** | 2.0.4 Istanbul |
692| | |
693+--------------------------------------+--------------------------------------------------------+
694| **Release date** | 2022 Feb 09 |
695| | |
696+--------------------------------------+--------------------------------------------------------+
697
698Bug Fixes
699---------
700
701 - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_ Fix docker compose for csit test.
702 - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_ Fix intermittent circular dependency error when the application starts.
703
704Version: 2.0.3
705==============
706
707Release Data
708------------
709
710+--------------------------------------+--------------------------------------------------------+
711| **CPS Project** | |
712| | |
713+--------------------------------------+--------------------------------------------------------+
714| **Docker images** | onap/cps-and-ncmp:2.0.3 |
715| | |
716+--------------------------------------+--------------------------------------------------------+
717| **Release designation** | 2.0.3 Istanbul |
718| | |
719+--------------------------------------+--------------------------------------------------------+
720| **Release date** | 2022-07-01 |
721| | |
722+--------------------------------------+--------------------------------------------------------+
723
724Bug Fixes
725---------
726
727 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
728
729Version: 2.0.2
730==============
731
732Release Data
733------------
734
735+--------------------------------------+--------------------------------------------------------+
736| **CPS Project** | |
737| | |
738+--------------------------------------+--------------------------------------------------------+
739| **Docker images** | onap/cps-and-ncmp:2.0.2 |
740| | |
741+--------------------------------------+--------------------------------------------------------+
742| **Release designation** | 2.0.2 Istanbul |
743| | |
744+--------------------------------------+--------------------------------------------------------+
745| **Release date** | 2021-16-12 |
746| | |
747+--------------------------------------+--------------------------------------------------------+
748
749Bug Fixes
750---------
751
752 - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_ Update log4j version due to security vulnerability
753
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]754Version: 2.0.1
755==============
756
757Release Data
758------------
759
760+--------------------------------------+--------------------------------------------------------+
761| **CPS Project** | |
762| | |
763+--------------------------------------+--------------------------------------------------------+
764| **Docker images** | onap/cps-and-ncmp:2.0.1 |
765| | |
766+--------------------------------------+--------------------------------------------------------+
767| **Release designation** | 2.0.1 Istanbul |
768| | |
769+--------------------------------------+--------------------------------------------------------+
770| **Release date** | 2021-14-10 |
771| | |
772+--------------------------------------+--------------------------------------------------------+
773
774Bug Fixes
775---------
776
777 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
778 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
779 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
780 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
781
782Known Limitations, Issues and Workarounds
783-----------------------------------------
784
785*System Limitations*
786
787Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
788
789*Known Vulnerabilities*
790
791 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
792
793*Workarounds*
794
795Add recursive method to save list node data to loop through all corresponding child nodes.
796
797Security Notes
798--------------
799
800*Fixed Security Issues*
801
802 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
803
804*Known Security Issues*
805
806None
807
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]808Version: 2.0.0
809==============
810
811Abstract
812--------
813
814This document provides the release notes for Istanbul release.
815
816Release Data
817------------
818
819+--------------------------------------+--------------------------------------------------------+
820| **CPS Project** | |
821| | |
822+--------------------------------------+--------------------------------------------------------+
823| **Docker images** | onap/cps-and-ncmp:2.0.0 |
824| | |
825+--------------------------------------+--------------------------------------------------------+
826| **Release designation** | 2.0.0 Istanbul |
827| | |
828+--------------------------------------+--------------------------------------------------------+
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]829| **Release date** | 2021-14-09 |
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]830| | |
831+--------------------------------------+--------------------------------------------------------+
832
833Features
834--------
DylanB95EST3fcf8692021-10-11 16:29:16 +0100[diff] [blame]835* Register DMI-Plugins with NCMP for CM Handle registrations.
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]836* Update, Create and Remove CM Handles.
837* Add support for retrieving and writing CM Handle data through NCMP datastores.
838* Automatic retrieval and caching of model information for CM Handles within NCMP.
839
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]840Deliverables
841------------
842
843Software Deliverables
844
845.. csv-table::
846 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
847 :widths: auto
848
849 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
850
851Bug Fixes
852---------
853
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]854 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]855 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
856 - `CPS-336 <https://jira.onap.org/browse/CPS-336>`_ Ends-with functionality in cpsPath does not conform with standard xPath behavior
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]857 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
858 - `CPS-357 <https://jira.onap.org/browse/CPS-357>`_ cps-review-verification-maven-master Jenkins job is failing when running csit test
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]859 - `CPS-367 <https://jira.onap.org/browse/CPS-367>`_ Get descendent does not support xpaths that end in list values
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]860 - `CPS-377 <https://jira.onap.org/browse/CPS-377>`_ Init ran model validation is failing error details are not provided
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]861 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
862 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]863 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
864 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
865 - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ Request to update node leaves (patch) responds with json parsing failure
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]866 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
867 - `CPS-479 <https://jira.onap.org/browse/CPS-479>`_ Get Nodes API does not always return the object from the root
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]868 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]869 - `CPS-501 <https://jira.onap.org/browse/CPS-501>`_ Put DataNode API has missing transaction and error handling for concurrency issues
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]870 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
871 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
872 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]873 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
874 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
875 - `CPS-591 <https://jira.onap.org/browse/CPS-591>`_ CPS-Core Leaf stored as integer is being returned from DB as float
Bruno Sakoto0eaf3342022-02-11 15:05:29 -0500[diff] [blame]876 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]877 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
878 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
879 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]880
881This document provides the release notes for Istanbul release.
882
883Summary
884-------
885
886Following CPS components are available with default ONAP/CPS installation.
887
888
889 * Platform components
890
891 - CPS (Helm charts)
892
893 * Service components
894
DylanB95EST3fcf8692021-10-11 16:29:16 +0100[diff] [blame]895 - CPS-NCMP
896 - CPS-Temporal
897 - DMI-Plugin
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]898
899 * Additional resources that CPS utilizes deployed using ONAP common charts
900
901 - Postgres Database
902
903
904Below service components (mS) are available to be deployed on-demand.
905 - CPS-TBDMT
906
907
908Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
909
910Known Limitations, Issues and Workarounds
911-----------------------------------------
912
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]913*System Limitations*
914
915Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
916
917*Known Vulnerabilities*
918
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]919 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
920 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
921 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]922
923*Workarounds*
924
925Add recursive method to save list node data to loop through all corresponding child nodes.
926
927Security Notes
928--------------
929
930*Fixed Security Issues*
931
932 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]933
934*Known Security Issues*
935
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]936 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
937
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]938Test Results
939------------
940 * `Integration tests`
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]941
ToineSiebelinkf0527c52021-07-06 13:03:03 +0100[diff] [blame]942.. ========================
943.. * * * HONOLULU * * *
944.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]945
ToineSiebelinkfd2134d2021-04-09 11:15:48 +0100[diff] [blame]946Version: 1.0.1
947==============
948
949Release Data
950------------
951
952+--------------------------------------+--------------------------------------------------------+
953| **CPS Project** | |
954| | |
955+--------------------------------------+--------------------------------------------------------+
956| **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
957| | |
958+--------------------------------------+--------------------------------------------------------+
959| **Release designation** | 1.0.1 Honolulu |
960| | |
961+--------------------------------------+--------------------------------------------------------+
962| **Release date** | 2021-04-09 |
963| | |
964+--------------------------------------+--------------------------------------------------------+
965
966Bug Fixes
967---------
968
puthuparambil.aditya8b584332021-10-12 16:49:03 +0100[diff] [blame]969 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
ToineSiebelinkfd2134d2021-04-09 11:15:48 +0100[diff] [blame]970 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
971 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
972 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
973 - `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
974 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
975 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
976 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
977
978Security Notes
979--------------
980
981*Fixed Security Issues*
982
983 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]984
ToineSiebelinka2d25b52021-04-13 15:10:47 +0100[diff] [blame]985*Known Security Issues*
986
987 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
988
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]989Version: 1.0.0
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]990==============
991
992
993Abstract
994--------
995
996This document provides the release notes for Honolulu release.
997
998Summary
999-------
1000
1001Following CPS components are available with default ONAP/CPS installation.
1002
1003
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1004 * Platform components
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1005
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1006 - CPS (Helm charts)
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1007
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1008 * Service components
1009
1010 - CPS Core
1011
1012 * Additional resources that CPS utilizes deployed using ONAP common charts
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1013
1014 - Postgres Database
1015
1016
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1017Below service components (mS) are available to be deployed on-demand.
1018 - CPS-TBDMT
1019
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1020
1021Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1022
1023
1024Release Data
1025------------
1026
1027+--------------------------------------+--------------------------------------------------------+
1028| **CPS Project** | |
1029| | |
1030+--------------------------------------+--------------------------------------------------------+
1031| **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
1032| | |
1033+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1034| **Release designation** | 1.0.0 Honolulu |
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1035| | |
1036+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1037| **Release date** | 2021-03-11 |
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1038| | |
1039+--------------------------------------+--------------------------------------------------------+
1040
1041
1042Features
1043--------
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1044Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
1045CPS has been driven by the needs of the E2E Networking Slicing use case.
1046It currently supports basic (rw) persistence and simple queries.
1047It also provides MVP support for network data access using simulated data.
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1048
1049.. _honolulu_deliverable:
1050
1051Deliverables
1052------------
1053
1054Software Deliverables
1055
1056.. csv-table::
1057 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1058 :widths: auto
1059
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1060 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1061
1062
1063Known Limitations, Issues and Workarounds
1064-----------------------------------------
1065
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1066 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1067 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
1068 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
niamhcoredddf7312021-06-21 14:44:01 +0100[diff] [blame]1069 - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ & `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Update data node leaves API does not support updating a list element with compound keys.
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1070
1071*System Limitations*
1072
1073None
1074
1075*Known Vulnerabilities*
1076
1077None
1078
1079*Workarounds*
1080
1081Documented under corresponding jira if applicable.
1082
1083Security Notes
1084--------------
1085
1086*Fixed Security Issues*
ToineSiebelink7c981df2021-03-01 09:53:56 +0000[diff] [blame]1087
1088* `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1089 - Upgrade org.onap.oparent to 3.2.0
ToineSiebelink7c981df2021-03-01 09:53:56 +0000[diff] [blame]1090 - Upgrade spring.boot to 2.3.8.RELEASE
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1091 - Upgrade yangtools to 5.0.7
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1092
1093*Known Security Issues*
1094
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1095 * Weak Crytography using md5
1096 * Risk seen in Zip file expansion
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1097
1098*Known Vulnerabilities in Used Modules*
1099
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1100 None
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1101
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1102CPS code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive.
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1103
1104Test Results
1105------------
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1106 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1107
1108References
1109----------
1110
ToineSiebelinkcac21862023-06-22 09:24:04 +0100[diff] [blame]1111For more information on the latest ONAP release, please see:
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1112
1113#. `ONAP Home Page`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1114#. `ONAP Wiki Page`_
ToineSiebelinkcac21862023-06-22 09:24:04 +0100[diff] [blame]1115#. `ONAP Documentation`_
1116#. `ONAP CPS Documentation`_
1117#. `ONAP Release Downloads`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1118
1119
1120.. _`ONAP Home Page`: https://www.onap.org
1121.. _`ONAP Wiki Page`: https://wiki.onap.org
1122.. _`ONAP Documentation`: https://docs.onap.org
ToineSiebelinkcac21862023-06-22 09:24:04 +0100[diff] [blame]1123.. _`ONAP CPS Documentation`: https://docs.onap.org/projects/onap-cps
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1124.. _`ONAP Release Downloads`: https://git.onap.org
1125
1126Quick Links:
1127
1128 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
1129 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_