blob: 1f2d6b9dffe2a58bae6be864ce46c0678b36522b [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
lukegleeson3be99242022-10-11 14:34:56 +010015.. ======================
16.. * * * LONDON * * *
17.. ======================
niamhcoref7b414e2021-11-17 11:02:07 +000018
seanbeirnef8e980a2023-01-27 18:09:33 +000019Version: 3.2.2
20==============
21
22Release Data
23------------
24
25+--------------------------------------+--------------------------------------------------------+
26| **CPS Project** | |
27| | |
28+--------------------------------------+--------------------------------------------------------+
29| **Docker images** | onap/cps-and-ncmp:3.2.2 |
30| | |
31+--------------------------------------+--------------------------------------------------------+
32| **Release designation** | 3.2.2 London |
33| | |
34+--------------------------------------+--------------------------------------------------------+
35| **Release date** | Not been released yet |
36| | |
37+--------------------------------------+--------------------------------------------------------+
38
39Bug Fixes
40---------
mpriyank0b5950d2023-02-07 17:55:10 +0000413.2.2
42 - `CPS-1173 <https://jira.onap.org/browse/CPS-1173>`_ Delete Performance Improvements.
43
44Features
45--------
46 - None
seanbeirnef8e980a2023-01-27 18:09:33 +000047
leventecsanyi37d72852022-10-26 10:44:08 +020048Version: 3.2.1
49==============
mpriyank4bd450e2022-10-05 09:50:59 +010050
51Release Data
52------------
53
54+--------------------------------------+--------------------------------------------------------+
55| **CPS Project** | |
56| | |
57+--------------------------------------+--------------------------------------------------------+
lukegleesone0154a62023-01-25 15:06:52 +000058| **Docker images** | onap/cps-and-ncmp:3.2.1 |
mpriyank4bd450e2022-10-05 09:50:59 +010059| | |
60+--------------------------------------+--------------------------------------------------------+
leventecsanyi37d72852022-10-26 10:44:08 +020061| **Release designation** | 3.2.1 London |
mpriyank4bd450e2022-10-05 09:50:59 +010062| | |
63+--------------------------------------+--------------------------------------------------------+
lukegleesone0154a62023-01-25 15:06:52 +000064| **Release date** | 2023 January 27 |
mpriyank4bd450e2022-10-05 09:50:59 +010065| | |
66+--------------------------------------+--------------------------------------------------------+
lukegleeson3be99242022-10-11 14:34:56 +010067Features
68--------
leventecsanyi37d72852022-10-26 10:44:08 +0200693.2.1
lukegleesone0154a62023-01-25 15:06:52 +000070 - `CPS-341 <https://jira.onap.org/browse/CPS-341>`_ Added support for multiple data tree instances under 1 anchor.
71 - `CPS-1002 <https://jira.onap.org/browse/CPS-1002>`_ Add CPS-E-05 endpoint for 'Query data, NCMP-Operational Datastore' using cpsPaths
72 - `CPS-1182 <https://jira.onap.org/browse/CPS-1182>`_ Upgrade Opendaylight
ToineSiebelink294bcb52022-12-23 11:07:42 +000073 - `CPS-1185 <https://jira.onap.org/browse/CPS-1185>`_ Get all dataspaces.
74 - `CPS-1186 <https://jira.onap.org/browse/CPS-1186>`_ Get single dataspace.
lukegleesonf20b4992022-12-09 15:48:55 +000075 - `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 +000076 - `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 +000077 - `CPS-1257 <https://jira.onap.org/browse/CPS-1257>`_ Added support for application/xml Content-Type (write only).
lukegleesone0154a62023-01-25 15:06:52 +000078 - `CPS-1381 <https://jira.onap.org/browse/CPS-1381>`_ Query large outputs using limit/depth/pagination
ToineSiebelink294bcb52022-12-23 11:07:42 +000079 - `CPS-1421 <https://jira.onap.org/browse/CPS-1421>`_ Optimized query for large number of hits with descendants.
lukegleesone0154a62023-01-25 15:06:52 +000080 - `CPS-1422 <https://jira.onap.org/browse/CPS-1422>`_ Fetch CM handles by collection of xpaths (CPS Core)
81 - `CPS-1424 <https://jira.onap.org/browse/CPS-1424>`_ Updating CmHandleStates using batch operation
82 - `CPS-1439 <https://jira.onap.org/browse/CPS-1439>`_ Use native query to delete data nodes
mpriyank4bd450e2022-10-05 09:50:59 +010083
84Bug Fixes
85---------
ToineSiebelink294bcb52022-12-23 11:07:42 +0000863.2.1
lukegleesone0154a62023-01-25 15:06:52 +000087 - `CPS-1171 <https://jira.onap.org/browse/CPS-1171>`_ Optimized retrieval of data nodes with many descendants.
88 - `CPS-1288 <https://jira.onap.org/browse/CPS-1288>`_ Hazelcast TTL for IMap is not working
89 - `CPS-1289 <https://jira.onap.org/browse/CPS-1289>`_ Getting wrong error code for create node api
90 - `CPS-1326 <https://jira.onap.org/browse/CPS-1326>`_ Creation of DataNodeBuilder with module name prefix is very slow
91 - `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 +000092 - `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_ Add Basic Auth to CPS/NCMP OpenAPI Definitions.
lukegleesone0154a62023-01-25 15:06:52 +000093 - `CPS-1352 <https://jira.onap.org/browse/CPS-1352>`_ Handle YangChoiceNode in right format.
ToineSiebelink294bcb52022-12-23 11:07:42 +000094 - `CPS-1409 <https://jira.onap.org/browse/CPS-1409>`_ Fix Delete uses case with '/' in path.
lukegleesone0154a62023-01-25 15:06:52 +000095 - `CPS-1433 <https://jira.onap.org/browse/CPS-1433>`_ Fix to allow posting data with '/' key fields.
96 - `CPS-1442 <https://jira.onap.org/browse/CPS-1442>`_ CPS PATCH operation does not merge existing data
97 - `CPS-1446 <https://jira.onap.org/browse/CPS-1446>`_ Locked cmhandles and ready to locked state transitions causing long cmHandle discovery
98 - `CPS-1457 <https://jira.onap.org/browse/CPS-1457>`_ CpsDataPersistenceService#getDataNodes uses non-normalized xpaths
99 - `CPS-1458 <https://jira.onap.org/browse/CPS-1458>`_ CpsDataPersistenceService#getDataNodes does not handle root xpath
100 - `CPS-1460 <https://jira.onap.org/browse/CPS-1460>`_ CPS Path Processing Performance Test duration is too low
ToineSiebelink294bcb52022-12-23 11:07:42 +0000101
leventecsanyi37d72852022-10-26 10:44:08 +02001023.2.0
ToineSiebelink294bcb52022-12-23 11:07:42 +0000103 - `CPS-1312 <https://jira.onap.org/browse/CPS-1312>`_ CPS(/NCMP) does not have version control.
mpriyank4bd450e2022-10-05 09:50:59 +0100104
lukegleeson3be99242022-10-11 14:34:56 +0100105Known Limitations, Issues and Workarounds
106-----------------------------------------
107
108*System Limitations*
109
seanbeirne72c267e2022-10-18 12:39:22 +0100110For upgrading, CPS uses Liquibase for database upgrades. CPS/NCMP currently only supports upgrading from Liquibase changelog 11 to Liquibase changelog 16.
111This 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 +0100112
seanbeirnedba2b102022-10-27 09:59:17 +0100113.. ====================
114.. * * * KOHN * * *
115.. ====================
116
mpriyankfe775312022-09-30 14:16:51 +0100117Version: 3.1.4
118==============
119
120Release Data
121------------
122
123+--------------------------------------+--------------------------------------------------------+
124| **CPS Project** | |
125| | |
126+--------------------------------------+--------------------------------------------------------+
127| **Docker images** | onap/cps-and-ncmp:3.1.4 |
128| | |
129+--------------------------------------+--------------------------------------------------------+
130| **Release designation** | 3.1.4 Kohn |
131| | |
132+--------------------------------------+--------------------------------------------------------+
mpriyank4bd450e2022-10-05 09:50:59 +0100133| **Release date** | 2022 October 5 |
mpriyankfe775312022-09-30 14:16:51 +0100134| | |
135+--------------------------------------+--------------------------------------------------------+
136
137Bug Fixes
138---------
lukegleeson8c6b5622022-09-29 15:58:06 +0100139 - `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 +0100140 - `CPS-1294 <https://jira.onap.org/browse/CPS-1294>`_ Kafka communication fault caused cmHandle registration error
mpriyankfe775312022-09-30 14:16:51 +0100141
mpriyank06736cb2022-09-29 14:29:40 +0100142Version: 3.1.3
143==============
144
145Release Data
146------------
147
148+--------------------------------------+--------------------------------------------------------+
149| **CPS Project** | |
150| | |
151+--------------------------------------+--------------------------------------------------------+
152| **Docker images** | onap/cps-and-ncmp:3.1.3 |
153| | |
154+--------------------------------------+--------------------------------------------------------+
155| **Release designation** | 3.1.3 Kohn |
156| | |
157+--------------------------------------+--------------------------------------------------------+
mpriyankfe775312022-09-30 14:16:51 +0100158| **Release date** | 2022 September 29 |
mpriyank06736cb2022-09-29 14:29:40 +0100159| | |
160+--------------------------------------+--------------------------------------------------------+
161
162Bug Fixes
163---------
164 - None
165
mpriyankef0ddfc2022-09-28 12:19:34 +0100166Version: 3.1.2
167==============
168
169Release Data
170------------
171
172+--------------------------------------+--------------------------------------------------------+
173| **CPS Project** | |
174| | |
175+--------------------------------------+--------------------------------------------------------+
176| **Docker images** | onap/cps-and-ncmp:3.1.2 |
177| | |
178+--------------------------------------+--------------------------------------------------------+
179| **Release designation** | 3.1.2 Kohn |
180| | |
181+--------------------------------------+--------------------------------------------------------+
mpriyank06736cb2022-09-29 14:29:40 +0100182| **Release date** | 2022 September 28 |
mpriyankef0ddfc2022-09-28 12:19:34 +0100183| | |
184+--------------------------------------+--------------------------------------------------------+
185
186Bug Fixes
187---------
188 - None
189
mpriyanka3f43502022-09-26 14:57:01 +0100190Version: 3.1.1
191==============
192
193Release Data
194------------
195
196+--------------------------------------+--------------------------------------------------------+
197| **CPS Project** | |
198| | |
199+--------------------------------------+--------------------------------------------------------+
200| **Docker images** | onap/cps-and-ncmp:3.1.1 |
201| | |
202+--------------------------------------+--------------------------------------------------------+
203| **Release designation** | 3.1.1 Kohn |
204| | |
205+--------------------------------------+--------------------------------------------------------+
mpriyankef0ddfc2022-09-28 12:19:34 +0100206| **Release date** | 2022 September 28 |
mpriyanka3f43502022-09-26 14:57:01 +0100207| | |
208+--------------------------------------+--------------------------------------------------------+
209
210Bug Fixes
211---------
212 - None
213
lukegleesonc9ec9152022-09-07 14:21:36 +0100214Security Notes
215--------------
216
217*Fixed Security Issues*
218
219 - `CPS-1226 <https://jira.onap.org/browse/CPS-1226>`_ Security bug in the logs
220
lukegleeson4a34fa52022-09-19 15:31:59 +0100221Version: 3.1.0
222==============
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400223
224Release Data
225------------
226
DylanB95ESTb130fd32022-04-04 13:09:22 +0100227+--------------------------------------+--------------------------------------------------------+
228| **CPS Project** | |
229| | |
230+--------------------------------------+--------------------------------------------------------+
231| **Docker images** | onap/cps-and-ncmp:3.1.0 |
232| | |
233+--------------------------------------+--------------------------------------------------------+
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400234| **Release designation** | 3.1.0 Kohn |
DylanB95ESTb130fd32022-04-04 13:09:22 +0100235| | |
236+--------------------------------------+--------------------------------------------------------+
lukegleeson4a34fa52022-09-19 15:31:59 +0100237| **Release date** | 2022 September 14 |
DylanB95ESTb130fd32022-04-04 13:09:22 +0100238| | |
239+--------------------------------------+--------------------------------------------------------+
240
241Features
242--------
lukegleeson4a34fa52022-09-19 15:31:59 +0100243 - `CPS-340 <https://jira.onap.org/browse/CPS-340>`_ Patch and update the root data node
244 - `CPS-575 <https://jira.onap.org/browse/CPS-575>`_ Write data for cmHandle using ncmp-datastores:passthrough-running (NCMP.)
245 - `CPS-731 <https://jira.onap.org/browse/CPS-731>`_ Query based on Public CM Properties
246 - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_ Async: NCMP Rest impl. including Request ID generation
247 - `CPS-829 <https://jira.onap.org/browse/CPS-829>`_ Async: Internal message topic incl. basic producer & Consumer
248 - `CPS-830 <https://jira.onap.org/browse/CPS-830>`_ DMI-NCMP Asynchronously Publish Response Event to Client Topic
249 - `CPS-869 <https://jira.onap.org/browse/CPS-869>`_ Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072
250 - `CPS-870 <https://jira.onap.org/browse/CPS-870>`_ Align CPS-Core output with SDN-C output (add module name)
251 - `CPS-875 <https://jira.onap.org/browse/CPS-875>`_ CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles
252 - `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'
253 - `CPS-899 <https://jira.onap.org/browse/CPS-899>`_ Start and stop sessions on Java API
254 - `CPS-909 <https://jira.onap.org/browse/CPS-909>`_ Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state
255 - `CPS-917 <https://jira.onap.org/browse/CPS-917>`_ Structured Errors response for passthrough use-cases in NCMP
256 - `CPS-953 <https://jira.onap.org/browse/CPS-953>`_ Update maven deploy plugin version
257 - `CPS-977 <https://jira.onap.org/browse/CPS-977>`_ Query CM Handles using CpsPath
258 - `CPS-1000 <https://jira.onap.org/browse/CPS-1000>`_ Create Data Synchronization watchdog
259 - `CPS-1016 <https://jira.onap.org/browse/CPS-1016>`_ Merge 2 'query' end points in NCMP
260 - `CPS-1034 <https://jira.onap.org/browse/CPS-1034>`_ Publish lifecycle events for ADVISED , READY and LOCKED state transition"
261 - `CPS-1064 <https://jira.onap.org/browse/CPS-1064>`_ Support retrieval of YANG module sources for CM handle on the NCMP interface
262 - `CPS-1099 <https://jira.onap.org/browse/CPS-1099>`_ Expose simplified 'external' lock reason enum state over REST interface
263 - `CPS-1101 <https://jira.onap.org/browse/CPS-1101>`_ Introducing the DELETING and DELETED Cmhandle State
264 - `CPS-1102 <https://jira.onap.org/browse/CPS-1102>`_ Register the Cmhandle Sends Advised State notification.
265 - `CPS-1133 <https://jira.onap.org/browse/CPS-1133>`_ Enable/Disable Data Sync for Cm Handle
266 - `CPS-1136 <https://jira.onap.org/browse/CPS-1136>`_ DMI Audit Support (get all CM Handles for a registered DMI)
267
emacleeafb17362022-09-02 14:40:17 +0100268
269Bug Fixes
270---------
lukegleeson4a34fa52022-09-19 15:31:59 +0100271 - `CPS-896 <https://jira.onap.org/browse/CPS-896>`_ CM Handle Registration Process only partially completes when exception is thrown
272 - `CPS-957 <https://jira.onap.org/browse/CPS-957>`_ NCMP: fix getResourceDataForPassthroughOperational endpoint
273 - `CPS-1020 <https://jira.onap.org/browse/CPS-1020>`_ DuplicatedYangResourceException error at parallel cmHandle registration
274 - `CPS-1056 <https://jira.onap.org/browse/CPS-1056>`_ Wrong error response format in case of Dmi plugin error
275 - `CPS-1067 <https://jira.onap.org/browse/CPS-1067>`_ NCMP returns 500 error on searches endpoint when No DMi Handles registered
276 - `CPS-1085 <https://jira.onap.org/browse/CPS-1085>`_ Performance degradation on ncmp/v1/ch/searches endpoint
277 - `CPS-1088 <https://jira.onap.org/browse/CPS-1088>`_ Kafka consumer can not be turned off
278 - `CPS-1097 <https://jira.onap.org/browse/CPS-1097>`_ Unable to change state from LOCKED to ADVISED
279 - `CPS-1126 <https://jira.onap.org/browse/CPS-1126>`_ CmHandle creation performance degradation
280 - `CPS-1175 <https://jira.onap.org/browse/CPS-1175>`_ Incorrect response when empty body executed for cmhandle id-searches
281 - `CPS-1179 <https://jira.onap.org/browse/CPS-1179>`_ Node API - GET method returns invalid response when identifier contains '/'
282 - `CPS-1212 <https://jira.onap.org/browse/CPS-1212>`_ Additional Properties for CM Handles not included when send to DMI Plugin
283 - `CPS-1217 <https://jira.onap.org/browse/CPS-1217>`_ Searches endpoint gives back empty list however there are already available cmhandles
284 - `CPS-1218 <https://jira.onap.org/browse/CPS-1218>`_ NCMP logs are flooded with SyncUtils logs
puthuparambil.adityadd904322022-09-21 10:53:51 +0100285
286Known Limitations, Issues and Workarounds
287-----------------------------------------
288
289*System Limitations*
290
291Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition.
292Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces']
DylanB95ESTb130fd32022-04-04 13:09:22 +0100293
lukegleeson4a34fa52022-09-19 15:31:59 +0100294*Known Vulnerabilities*
295
296None
297
298*Workarounds*
299
300None
301
302Security Notes
303--------------
304
305*Fixed Security Issues*
306
307 - `CPS-963 <https://jira.onap.org/browse/CPS-963>`_ Liquibase has got serious vulnerability, upgrade required
308
309*Known Security Issues*
310
311None
312
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400313.. ========================
314.. * * * JAKARTA * * *
315.. ========================
316
317Version: 3.0.1
318==============
319
320Release Data
321------------
322
323+--------------------------------------+--------------------------------------------------------+
324| **CPS Project** | |
325| | |
326+--------------------------------------+--------------------------------------------------------+
327| **Docker images** | onap/cps-and-ncmp:3.0.1 |
328| | |
329+--------------------------------------+--------------------------------------------------------+
330| **Release designation** | 3.0.1 Jakarta |
331| | |
332+--------------------------------------+--------------------------------------------------------+
333| **Release date** | 2022 April 28 |
334| | |
335+--------------------------------------+--------------------------------------------------------+
336
337Bug Fixes
338---------
339 - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_ Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
340
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400341Version: 3.0.0
342==============
niamhcoref7b414e2021-11-17 11:02:07 +0000343
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400344Release Data
345------------
346
347+--------------------------------------+--------------------------------------------------------+
348| **CPS Project** | |
349| | |
350+--------------------------------------+--------------------------------------------------------+
351| **Docker images** | onap/cps-and-ncmp:3.0.0 |
352| | |
353+--------------------------------------+--------------------------------------------------------+
354| **Release designation** | 3.0.0 Jakarta |
355| | |
356+--------------------------------------+--------------------------------------------------------+
357| **Release date** | 2022 March 15 |
358| | |
359+--------------------------------------+--------------------------------------------------------+
niamhcoref7b414e2021-11-17 11:02:07 +0000360
361Features
362--------
puthuparambil.adityad0007332021-12-08 18:53:39 +0000363 - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_ Define response objects (schemas) in cps-ncmp
niamhcoref7b414e2021-11-17 11:02:07 +0000364 - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_ Update operation for datastore pass through running
365 - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_ Delete operation for datastore pass through running
DylanB95ESTe5573382022-01-27 17:12:52 +0000366 - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_ Support 'public' Cm Handle Properties
niamhcoref7b414e2021-11-17 11:02:07 +0000367 - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
JosephKeenan82ebf532021-12-08 18:16:44 +0000368 - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_ Ensure all DMI operations use POST method
puthuparambil.adityad0007332021-12-08 18:53:39 +0000369 - `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 -0400370 - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
371 - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
DylanB95ESTe5573382022-01-27 17:12:52 +0000372 - `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 +0530373 - `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 +0000374
375Bug Fixes
376---------
377
378 - `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 +0000379 - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
niamhcore65bc4fd2021-12-08 14:19:02 +0000380 - `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 +0000381 - `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 +0000382 - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
JosephKeenane0643ab2022-02-15 18:23:05 +0000383 - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
DylanB95ESTe5573382022-01-27 17:12:52 +0000384 - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
JosephKeenane0643ab2022-02-15 18:23:05 +0000385 - `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 +0530386 - `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 +0000387 - `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 +0000388
389Known Limitations, Issues and Workarounds
390-----------------------------------------
391
392*System Limitations*
393
DylanB95ESTe5573382022-01-27 17:12:52 +0000394Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
395`CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
396of cm handle registration.
niamhcoref7b414e2021-11-17 11:02:07 +0000397
Lathishb3550f12022-03-15 12:03:53 +0000398The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
399for more information.
400
niamhcoref7b414e2021-11-17 11:02:07 +0000401*Known Vulnerabilities*
402
403None
404
405*Workarounds*
406
DylanB95ESTe5573382022-01-27 17:12:52 +0000407Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
408pass an empty string as the value if you do not want to include names for these values.
niamhcoref7b414e2021-11-17 11:02:07 +0000409
410Security Notes
411--------------
412
413*Fixed Security Issues*
414
415None
416
417*Known Security Issues*
418
419None
420
421.. ========================
shivasubedi44beaa32021-09-13 15:16:30 +0100422.. * * * ISTANBUL * * *
423.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000424
Bruno Sakoto0eaf3342022-02-11 15:05:29 -0500425Version: 2.0.4
426==============
427
428Release Data
429------------
430
431+--------------------------------------+--------------------------------------------------------+
432| **CPS Project** | |
433| | |
434+--------------------------------------+--------------------------------------------------------+
435| **Docker images** | onap/cps-and-ncmp:2.0.4 |
436| | |
437+--------------------------------------+--------------------------------------------------------+
438| **Release designation** | 2.0.4 Istanbul |
439| | |
440+--------------------------------------+--------------------------------------------------------+
441| **Release date** | 2022 Feb 09 |
442| | |
443+--------------------------------------+--------------------------------------------------------+
444
445Bug Fixes
446---------
447
448 - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_ Fix docker compose for csit test.
449 - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_ Fix intermittent circular dependency error when the application starts.
450
451Version: 2.0.3
452==============
453
454Release Data
455------------
456
457+--------------------------------------+--------------------------------------------------------+
458| **CPS Project** | |
459| | |
460+--------------------------------------+--------------------------------------------------------+
461| **Docker images** | onap/cps-and-ncmp:2.0.3 |
462| | |
463+--------------------------------------+--------------------------------------------------------+
464| **Release designation** | 2.0.3 Istanbul |
465| | |
466+--------------------------------------+--------------------------------------------------------+
467| **Release date** | 2022-07-01 |
468| | |
469+--------------------------------------+--------------------------------------------------------+
470
471Bug Fixes
472---------
473
474 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
475
476Version: 2.0.2
477==============
478
479Release Data
480------------
481
482+--------------------------------------+--------------------------------------------------------+
483| **CPS Project** | |
484| | |
485+--------------------------------------+--------------------------------------------------------+
486| **Docker images** | onap/cps-and-ncmp:2.0.2 |
487| | |
488+--------------------------------------+--------------------------------------------------------+
489| **Release designation** | 2.0.2 Istanbul |
490| | |
491+--------------------------------------+--------------------------------------------------------+
492| **Release date** | 2021-16-12 |
493| | |
494+--------------------------------------+--------------------------------------------------------+
495
496Bug Fixes
497---------
498
499 - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_ Update log4j version due to security vulnerability
500
lukegleeson9c583712021-09-30 17:21:11 +0100501Version: 2.0.1
502==============
503
504Release Data
505------------
506
507+--------------------------------------+--------------------------------------------------------+
508| **CPS Project** | |
509| | |
510+--------------------------------------+--------------------------------------------------------+
511| **Docker images** | onap/cps-and-ncmp:2.0.1 |
512| | |
513+--------------------------------------+--------------------------------------------------------+
514| **Release designation** | 2.0.1 Istanbul |
515| | |
516+--------------------------------------+--------------------------------------------------------+
517| **Release date** | 2021-14-10 |
518| | |
519+--------------------------------------+--------------------------------------------------------+
520
521Bug Fixes
522---------
523
524 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
525 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
526 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
527 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
528
529Known Limitations, Issues and Workarounds
530-----------------------------------------
531
532*System Limitations*
533
534Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
535
536*Known Vulnerabilities*
537
538 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
539
540*Workarounds*
541
542Add recursive method to save list node data to loop through all corresponding child nodes.
543
544Security Notes
545--------------
546
547*Fixed Security Issues*
548
549 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
550
551*Known Security Issues*
552
553None
554
shivasubedi44beaa32021-09-13 15:16:30 +0100555Version: 2.0.0
556==============
557
558Abstract
559--------
560
561This document provides the release notes for Istanbul release.
562
563Release Data
564------------
565
566+--------------------------------------+--------------------------------------------------------+
567| **CPS Project** | |
568| | |
569+--------------------------------------+--------------------------------------------------------+
570| **Docker images** | onap/cps-and-ncmp:2.0.0 |
571| | |
572+--------------------------------------+--------------------------------------------------------+
573| **Release designation** | 2.0.0 Istanbul |
574| | |
575+--------------------------------------+--------------------------------------------------------+
lukegleeson9c583712021-09-30 17:21:11 +0100576| **Release date** | 2021-14-09 |
shivasubedi44beaa32021-09-13 15:16:30 +0100577| | |
578+--------------------------------------+--------------------------------------------------------+
579
580Features
581--------
DylanB95EST3fcf8692021-10-11 16:29:16 +0100582* Register DMI-Plugins with NCMP for CM Handle registrations.
shivasubedi44beaa32021-09-13 15:16:30 +0100583* Update, Create and Remove CM Handles.
584* Add support for retrieving and writing CM Handle data through NCMP datastores.
585* Automatic retrieval and caching of model information for CM Handles within NCMP.
586
shivasubedi44beaa32021-09-13 15:16:30 +0100587Deliverables
588------------
589
590Software Deliverables
591
592.. csv-table::
593 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
594 :widths: auto
595
596 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
597
598Bug Fixes
599---------
600
lukegleeson9c583712021-09-30 17:21:11 +0100601 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
shivasubedi44beaa32021-09-13 15:16:30 +0100602 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
603 - `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 +0100604 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
605 - `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 +0100606 - `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 +0100607 - `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 +0100608 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
609 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
lukegleeson9c583712021-09-30 17:21:11 +0100610 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
611 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
612 - `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 +0100613 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
614 - `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 +0100615 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
shivasubedi44beaa32021-09-13 15:16:30 +0100616 - `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 +0100617 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
618 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
619 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
lukegleeson9c583712021-09-30 17:21:11 +0100620 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
621 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
622 - `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 -0500623 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
lukegleeson9c583712021-09-30 17:21:11 +0100624 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
625 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
626 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
shivasubedi44beaa32021-09-13 15:16:30 +0100627
628This document provides the release notes for Istanbul release.
629
630Summary
631-------
632
633Following CPS components are available with default ONAP/CPS installation.
634
635
636 * Platform components
637
638 - CPS (Helm charts)
639
640 * Service components
641
DylanB95EST3fcf8692021-10-11 16:29:16 +0100642 - CPS-NCMP
643 - CPS-Temporal
644 - DMI-Plugin
shivasubedi44beaa32021-09-13 15:16:30 +0100645
646 * Additional resources that CPS utilizes deployed using ONAP common charts
647
648 - Postgres Database
649
650
651Below service components (mS) are available to be deployed on-demand.
652 - CPS-TBDMT
653
654
655Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
656
657Known Limitations, Issues and Workarounds
658-----------------------------------------
659
shivasubedi44beaa32021-09-13 15:16:30 +0100660*System Limitations*
661
662Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
663
664*Known Vulnerabilities*
665
lukegleeson9c583712021-09-30 17:21:11 +0100666 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
667 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
668 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
shivasubedi44beaa32021-09-13 15:16:30 +0100669
670*Workarounds*
671
672Add recursive method to save list node data to loop through all corresponding child nodes.
673
674Security Notes
675--------------
676
677*Fixed Security Issues*
678
679 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
shivasubedi44beaa32021-09-13 15:16:30 +0100680
681*Known Security Issues*
682
lukegleeson9c583712021-09-30 17:21:11 +0100683 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
684
shivasubedi44beaa32021-09-13 15:16:30 +0100685Test Results
686------------
687 * `Integration tests`
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000688
ToineSiebelinkf0527c52021-07-06 13:03:03 +0100689.. ========================
690.. * * * HONOLULU * * *
691.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000692
ToineSiebelinkfd2134d2021-04-09 11:15:48 +0100693Version: 1.0.1
694==============
695
696Release Data
697------------
698
699+--------------------------------------+--------------------------------------------------------+
700| **CPS Project** | |
701| | |
702+--------------------------------------+--------------------------------------------------------+
703| **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
704| | |
705+--------------------------------------+--------------------------------------------------------+
706| **Release designation** | 1.0.1 Honolulu |
707| | |
708+--------------------------------------+--------------------------------------------------------+
709| **Release date** | 2021-04-09 |
710| | |
711+--------------------------------------+--------------------------------------------------------+
712
713Bug Fixes
714---------
715
puthuparambil.aditya8b584332021-10-12 16:49:03 +0100716 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
ToineSiebelinkfd2134d2021-04-09 11:15:48 +0100717 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
718 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
719 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
720 - `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
721 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
722 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
723 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
724
725Security Notes
726--------------
727
728*Fixed Security Issues*
729
730 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000731
ToineSiebelinka2d25b52021-04-13 15:10:47 +0100732*Known Security Issues*
733
734 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
735
Rishi.Chail4359d282021-03-03 16:36:26 +0000736Version: 1.0.0
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000737==============
738
739
740Abstract
741--------
742
743This document provides the release notes for Honolulu release.
744
745Summary
746-------
747
748Following CPS components are available with default ONAP/CPS installation.
749
750
Rishi.Chail4359d282021-03-03 16:36:26 +0000751 * Platform components
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000752
Rishi.Chail4359d282021-03-03 16:36:26 +0000753 - CPS (Helm charts)
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000754
Rishi.Chail4359d282021-03-03 16:36:26 +0000755 * Service components
756
757 - CPS Core
758
759 * Additional resources that CPS utilizes deployed using ONAP common charts
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000760
761 - Postgres Database
762
763
Rishi.Chail4359d282021-03-03 16:36:26 +0000764Below service components (mS) are available to be deployed on-demand.
765 - CPS-TBDMT
766
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000767
768Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
769
770
771Release Data
772------------
773
774+--------------------------------------+--------------------------------------------------------+
775| **CPS Project** | |
776| | |
777+--------------------------------------+--------------------------------------------------------+
778| **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
779| | |
780+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +0000781| **Release designation** | 1.0.0 Honolulu |
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000782| | |
783+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +0000784| **Release date** | 2021-03-11 |
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000785| | |
786+--------------------------------------+--------------------------------------------------------+
787
788
789Features
790--------
Rishi.Chail4359d282021-03-03 16:36:26 +0000791Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
792CPS has been driven by the needs of the E2E Networking Slicing use case.
793It currently supports basic (rw) persistence and simple queries.
794It also provides MVP support for network data access using simulated data.
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000795
796.. _honolulu_deliverable:
797
798Deliverables
799------------
800
801Software Deliverables
802
803.. csv-table::
804 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
805 :widths: auto
806
Rishi.Chail4359d282021-03-03 16:36:26 +0000807 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000808
809
810Known Limitations, Issues and Workarounds
811-----------------------------------------
812
Rishi.Chail4359d282021-03-03 16:36:26 +0000813 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
814 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
815 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
niamhcoredddf7312021-06-21 14:44:01 +0100816 - `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 +0000817
818*System Limitations*
819
820None
821
822*Known Vulnerabilities*
823
824None
825
826*Workarounds*
827
828Documented under corresponding jira if applicable.
829
830Security Notes
831--------------
832
833*Fixed Security Issues*
ToineSiebelink7c981df2021-03-01 09:53:56 +0000834
835* `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
Rishi.Chail4359d282021-03-03 16:36:26 +0000836 - Upgrade org.onap.oparent to 3.2.0
ToineSiebelink7c981df2021-03-01 09:53:56 +0000837 - Upgrade spring.boot to 2.3.8.RELEASE
Rishi.Chail4359d282021-03-03 16:36:26 +0000838 - Upgrade yangtools to 5.0.7
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000839
840*Known Security Issues*
841
Rishi.Chail4359d282021-03-03 16:36:26 +0000842 * Weak Crytography using md5
843 * Risk seen in Zip file expansion
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000844
845*Known Vulnerabilities in Used Modules*
846
Rishi.Chail4359d282021-03-03 16:36:26 +0000847 None
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000848
Rishi.Chail4359d282021-03-03 16:36:26 +0000849CPS 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 +0000850
851Test Results
852------------
Rishi.Chail4359d282021-03-03 16:36:26 +0000853 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000854
855References
856----------
857
858For more information on the ONAP Honolulu release, please see:
859
860#. `ONAP Home Page`_
861#. `ONAP Documentation`_
862#. `ONAP Release Downloads`_
863#. `ONAP Wiki Page`_
864
865
866.. _`ONAP Home Page`: https://www.onap.org
867.. _`ONAP Wiki Page`: https://wiki.onap.org
868.. _`ONAP Documentation`: https://docs.onap.org
869.. _`ONAP Release Downloads`: https://git.onap.org
870
871Quick Links:
872
873 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
874 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_