blob: ebcf766a36a1d1a2e52f90659a56a0ce0b0db780 [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
leventecsanyi37d72852022-10-26 10:44:08 +020019Version: 3.2.1
20==============
mpriyank4bd450e2022-10-05 09:50:59 +010021
22Release Data
23------------
24
25+--------------------------------------+--------------------------------------------------------+
26| **CPS Project** | |
27| | |
28+--------------------------------------+--------------------------------------------------------+
lukegleesone0154a62023-01-25 15:06:52 +000029| **Docker images** | onap/cps-and-ncmp:3.2.1 |
mpriyank4bd450e2022-10-05 09:50:59 +010030| | |
31+--------------------------------------+--------------------------------------------------------+
leventecsanyi37d72852022-10-26 10:44:08 +020032| **Release designation** | 3.2.1 London |
mpriyank4bd450e2022-10-05 09:50:59 +010033| | |
34+--------------------------------------+--------------------------------------------------------+
lukegleesone0154a62023-01-25 15:06:52 +000035| **Release date** | 2023 January 27 |
mpriyank4bd450e2022-10-05 09:50:59 +010036| | |
37+--------------------------------------+--------------------------------------------------------+
lukegleeson3be99242022-10-11 14:34:56 +010038Features
39--------
leventecsanyi37d72852022-10-26 10:44:08 +0200403.2.1
lukegleesone0154a62023-01-25 15:06:52 +000041 - `CPS-341 <https://jira.onap.org/browse/CPS-341>`_ Added support for multiple data tree instances under 1 anchor.
42 - `CPS-1002 <https://jira.onap.org/browse/CPS-1002>`_ Add CPS-E-05 endpoint for 'Query data, NCMP-Operational Datastore' using cpsPaths
43 - `CPS-1182 <https://jira.onap.org/browse/CPS-1182>`_ Upgrade Opendaylight
ToineSiebelink294bcb52022-12-23 11:07:42 +000044 - `CPS-1185 <https://jira.onap.org/browse/CPS-1185>`_ Get all dataspaces.
45 - `CPS-1186 <https://jira.onap.org/browse/CPS-1186>`_ Get single dataspace.
lukegleesonf20b4992022-12-09 15:48:55 +000046 - `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 +000047 - `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 +000048 - `CPS-1257 <https://jira.onap.org/browse/CPS-1257>`_ Added support for application/xml Content-Type (write only).
lukegleesone0154a62023-01-25 15:06:52 +000049 - `CPS-1381 <https://jira.onap.org/browse/CPS-1381>`_ Query large outputs using limit/depth/pagination
ToineSiebelink294bcb52022-12-23 11:07:42 +000050 - `CPS-1421 <https://jira.onap.org/browse/CPS-1421>`_ Optimized query for large number of hits with descendants.
lukegleesone0154a62023-01-25 15:06:52 +000051 - `CPS-1422 <https://jira.onap.org/browse/CPS-1422>`_ Fetch CM handles by collection of xpaths (CPS Core)
52 - `CPS-1424 <https://jira.onap.org/browse/CPS-1424>`_ Updating CmHandleStates using batch operation
53 - `CPS-1439 <https://jira.onap.org/browse/CPS-1439>`_ Use native query to delete data nodes
mpriyank4bd450e2022-10-05 09:50:59 +010054
55Bug Fixes
56---------
ToineSiebelink294bcb52022-12-23 11:07:42 +0000573.2.1
lukegleesone0154a62023-01-25 15:06:52 +000058 - `CPS-1171 <https://jira.onap.org/browse/CPS-1171>`_ Optimized retrieval of data nodes with many descendants.
59 - `CPS-1288 <https://jira.onap.org/browse/CPS-1288>`_ Hazelcast TTL for IMap is not working
60 - `CPS-1289 <https://jira.onap.org/browse/CPS-1289>`_ Getting wrong error code for create node api
61 - `CPS-1326 <https://jira.onap.org/browse/CPS-1326>`_ Creation of DataNodeBuilder with module name prefix is very slow
62 - `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 +000063 - `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_ Add Basic Auth to CPS/NCMP OpenAPI Definitions.
lukegleesone0154a62023-01-25 15:06:52 +000064 - `CPS-1352 <https://jira.onap.org/browse/CPS-1352>`_ Handle YangChoiceNode in right format.
ToineSiebelink294bcb52022-12-23 11:07:42 +000065 - `CPS-1409 <https://jira.onap.org/browse/CPS-1409>`_ Fix Delete uses case with '/' in path.
lukegleesone0154a62023-01-25 15:06:52 +000066 - `CPS-1433 <https://jira.onap.org/browse/CPS-1433>`_ Fix to allow posting data with '/' key fields.
67 - `CPS-1442 <https://jira.onap.org/browse/CPS-1442>`_ CPS PATCH operation does not merge existing data
68 - `CPS-1446 <https://jira.onap.org/browse/CPS-1446>`_ Locked cmhandles and ready to locked state transitions causing long cmHandle discovery
69 - `CPS-1457 <https://jira.onap.org/browse/CPS-1457>`_ CpsDataPersistenceService#getDataNodes uses non-normalized xpaths
70 - `CPS-1458 <https://jira.onap.org/browse/CPS-1458>`_ CpsDataPersistenceService#getDataNodes does not handle root xpath
71 - `CPS-1460 <https://jira.onap.org/browse/CPS-1460>`_ CPS Path Processing Performance Test duration is too low
ToineSiebelink294bcb52022-12-23 11:07:42 +000072
leventecsanyi37d72852022-10-26 10:44:08 +0200733.2.0
ToineSiebelink294bcb52022-12-23 11:07:42 +000074 - `CPS-1312 <https://jira.onap.org/browse/CPS-1312>`_ CPS(/NCMP) does not have version control.
mpriyank4bd450e2022-10-05 09:50:59 +010075
lukegleeson3be99242022-10-11 14:34:56 +010076Known Limitations, Issues and Workarounds
77-----------------------------------------
78
79*System Limitations*
80
seanbeirne72c267e2022-10-18 12:39:22 +010081For upgrading, CPS uses Liquibase for database upgrades. CPS/NCMP currently only supports upgrading from Liquibase changelog 11 to Liquibase changelog 16.
82This 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 +010083
seanbeirnedba2b102022-10-27 09:59:17 +010084.. ====================
85.. * * * KOHN * * *
86.. ====================
87
mpriyankfe775312022-09-30 14:16:51 +010088Version: 3.1.4
89==============
90
91Release Data
92------------
93
94+--------------------------------------+--------------------------------------------------------+
95| **CPS Project** | |
96| | |
97+--------------------------------------+--------------------------------------------------------+
98| **Docker images** | onap/cps-and-ncmp:3.1.4 |
99| | |
100+--------------------------------------+--------------------------------------------------------+
101| **Release designation** | 3.1.4 Kohn |
102| | |
103+--------------------------------------+--------------------------------------------------------+
mpriyank4bd450e2022-10-05 09:50:59 +0100104| **Release date** | 2022 October 5 |
mpriyankfe775312022-09-30 14:16:51 +0100105| | |
106+--------------------------------------+--------------------------------------------------------+
107
108Bug Fixes
109---------
lukegleeson8c6b5622022-09-29 15:58:06 +0100110 - `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 +0100111 - `CPS-1294 <https://jira.onap.org/browse/CPS-1294>`_ Kafka communication fault caused cmHandle registration error
mpriyankfe775312022-09-30 14:16:51 +0100112
mpriyank06736cb2022-09-29 14:29:40 +0100113Version: 3.1.3
114==============
115
116Release Data
117------------
118
119+--------------------------------------+--------------------------------------------------------+
120| **CPS Project** | |
121| | |
122+--------------------------------------+--------------------------------------------------------+
123| **Docker images** | onap/cps-and-ncmp:3.1.3 |
124| | |
125+--------------------------------------+--------------------------------------------------------+
126| **Release designation** | 3.1.3 Kohn |
127| | |
128+--------------------------------------+--------------------------------------------------------+
mpriyankfe775312022-09-30 14:16:51 +0100129| **Release date** | 2022 September 29 |
mpriyank06736cb2022-09-29 14:29:40 +0100130| | |
131+--------------------------------------+--------------------------------------------------------+
132
133Bug Fixes
134---------
135 - None
136
mpriyankef0ddfc2022-09-28 12:19:34 +0100137Version: 3.1.2
138==============
139
140Release Data
141------------
142
143+--------------------------------------+--------------------------------------------------------+
144| **CPS Project** | |
145| | |
146+--------------------------------------+--------------------------------------------------------+
147| **Docker images** | onap/cps-and-ncmp:3.1.2 |
148| | |
149+--------------------------------------+--------------------------------------------------------+
150| **Release designation** | 3.1.2 Kohn |
151| | |
152+--------------------------------------+--------------------------------------------------------+
mpriyank06736cb2022-09-29 14:29:40 +0100153| **Release date** | 2022 September 28 |
mpriyankef0ddfc2022-09-28 12:19:34 +0100154| | |
155+--------------------------------------+--------------------------------------------------------+
156
157Bug Fixes
158---------
159 - None
160
mpriyanka3f43502022-09-26 14:57:01 +0100161Version: 3.1.1
162==============
163
164Release Data
165------------
166
167+--------------------------------------+--------------------------------------------------------+
168| **CPS Project** | |
169| | |
170+--------------------------------------+--------------------------------------------------------+
171| **Docker images** | onap/cps-and-ncmp:3.1.1 |
172| | |
173+--------------------------------------+--------------------------------------------------------+
174| **Release designation** | 3.1.1 Kohn |
175| | |
176+--------------------------------------+--------------------------------------------------------+
mpriyankef0ddfc2022-09-28 12:19:34 +0100177| **Release date** | 2022 September 28 |
mpriyanka3f43502022-09-26 14:57:01 +0100178| | |
179+--------------------------------------+--------------------------------------------------------+
180
181Bug Fixes
182---------
183 - None
184
lukegleesonc9ec9152022-09-07 14:21:36 +0100185Security Notes
186--------------
187
188*Fixed Security Issues*
189
190 - `CPS-1226 <https://jira.onap.org/browse/CPS-1226>`_ Security bug in the logs
191
lukegleeson4a34fa52022-09-19 15:31:59 +0100192Version: 3.1.0
193==============
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400194
195Release Data
196------------
197
DylanB95ESTb130fd32022-04-04 13:09:22 +0100198+--------------------------------------+--------------------------------------------------------+
199| **CPS Project** | |
200| | |
201+--------------------------------------+--------------------------------------------------------+
202| **Docker images** | onap/cps-and-ncmp:3.1.0 |
203| | |
204+--------------------------------------+--------------------------------------------------------+
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400205| **Release designation** | 3.1.0 Kohn |
DylanB95ESTb130fd32022-04-04 13:09:22 +0100206| | |
207+--------------------------------------+--------------------------------------------------------+
lukegleeson4a34fa52022-09-19 15:31:59 +0100208| **Release date** | 2022 September 14 |
DylanB95ESTb130fd32022-04-04 13:09:22 +0100209| | |
210+--------------------------------------+--------------------------------------------------------+
211
212Features
213--------
lukegleeson4a34fa52022-09-19 15:31:59 +0100214 - `CPS-340 <https://jira.onap.org/browse/CPS-340>`_ Patch and update the root data node
215 - `CPS-575 <https://jira.onap.org/browse/CPS-575>`_ Write data for cmHandle using ncmp-datastores:passthrough-running (NCMP.)
216 - `CPS-731 <https://jira.onap.org/browse/CPS-731>`_ Query based on Public CM Properties
217 - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_ Async: NCMP Rest impl. including Request ID generation
218 - `CPS-829 <https://jira.onap.org/browse/CPS-829>`_ Async: Internal message topic incl. basic producer & Consumer
219 - `CPS-830 <https://jira.onap.org/browse/CPS-830>`_ DMI-NCMP Asynchronously Publish Response Event to Client Topic
220 - `CPS-869 <https://jira.onap.org/browse/CPS-869>`_ Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072
221 - `CPS-870 <https://jira.onap.org/browse/CPS-870>`_ Align CPS-Core output with SDN-C output (add module name)
222 - `CPS-875 <https://jira.onap.org/browse/CPS-875>`_ CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles
223 - `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'
224 - `CPS-899 <https://jira.onap.org/browse/CPS-899>`_ Start and stop sessions on Java API
225 - `CPS-909 <https://jira.onap.org/browse/CPS-909>`_ Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state
226 - `CPS-917 <https://jira.onap.org/browse/CPS-917>`_ Structured Errors response for passthrough use-cases in NCMP
227 - `CPS-953 <https://jira.onap.org/browse/CPS-953>`_ Update maven deploy plugin version
228 - `CPS-977 <https://jira.onap.org/browse/CPS-977>`_ Query CM Handles using CpsPath
229 - `CPS-1000 <https://jira.onap.org/browse/CPS-1000>`_ Create Data Synchronization watchdog
230 - `CPS-1016 <https://jira.onap.org/browse/CPS-1016>`_ Merge 2 'query' end points in NCMP
231 - `CPS-1034 <https://jira.onap.org/browse/CPS-1034>`_ Publish lifecycle events for ADVISED , READY and LOCKED state transition"
232 - `CPS-1064 <https://jira.onap.org/browse/CPS-1064>`_ Support retrieval of YANG module sources for CM handle on the NCMP interface
233 - `CPS-1099 <https://jira.onap.org/browse/CPS-1099>`_ Expose simplified 'external' lock reason enum state over REST interface
234 - `CPS-1101 <https://jira.onap.org/browse/CPS-1101>`_ Introducing the DELETING and DELETED Cmhandle State
235 - `CPS-1102 <https://jira.onap.org/browse/CPS-1102>`_ Register the Cmhandle Sends Advised State notification.
236 - `CPS-1133 <https://jira.onap.org/browse/CPS-1133>`_ Enable/Disable Data Sync for Cm Handle
237 - `CPS-1136 <https://jira.onap.org/browse/CPS-1136>`_ DMI Audit Support (get all CM Handles for a registered DMI)
238
emacleeafb17362022-09-02 14:40:17 +0100239
240Bug Fixes
241---------
lukegleeson4a34fa52022-09-19 15:31:59 +0100242 - `CPS-896 <https://jira.onap.org/browse/CPS-896>`_ CM Handle Registration Process only partially completes when exception is thrown
243 - `CPS-957 <https://jira.onap.org/browse/CPS-957>`_ NCMP: fix getResourceDataForPassthroughOperational endpoint
244 - `CPS-1020 <https://jira.onap.org/browse/CPS-1020>`_ DuplicatedYangResourceException error at parallel cmHandle registration
245 - `CPS-1056 <https://jira.onap.org/browse/CPS-1056>`_ Wrong error response format in case of Dmi plugin error
246 - `CPS-1067 <https://jira.onap.org/browse/CPS-1067>`_ NCMP returns 500 error on searches endpoint when No DMi Handles registered
247 - `CPS-1085 <https://jira.onap.org/browse/CPS-1085>`_ Performance degradation on ncmp/v1/ch/searches endpoint
248 - `CPS-1088 <https://jira.onap.org/browse/CPS-1088>`_ Kafka consumer can not be turned off
249 - `CPS-1097 <https://jira.onap.org/browse/CPS-1097>`_ Unable to change state from LOCKED to ADVISED
250 - `CPS-1126 <https://jira.onap.org/browse/CPS-1126>`_ CmHandle creation performance degradation
251 - `CPS-1175 <https://jira.onap.org/browse/CPS-1175>`_ Incorrect response when empty body executed for cmhandle id-searches
252 - `CPS-1179 <https://jira.onap.org/browse/CPS-1179>`_ Node API - GET method returns invalid response when identifier contains '/'
253 - `CPS-1212 <https://jira.onap.org/browse/CPS-1212>`_ Additional Properties for CM Handles not included when send to DMI Plugin
254 - `CPS-1217 <https://jira.onap.org/browse/CPS-1217>`_ Searches endpoint gives back empty list however there are already available cmhandles
255 - `CPS-1218 <https://jira.onap.org/browse/CPS-1218>`_ NCMP logs are flooded with SyncUtils logs
puthuparambil.adityadd904322022-09-21 10:53:51 +0100256
257Known Limitations, Issues and Workarounds
258-----------------------------------------
259
260*System Limitations*
261
262Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition.
263Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces']
DylanB95ESTb130fd32022-04-04 13:09:22 +0100264
lukegleeson4a34fa52022-09-19 15:31:59 +0100265*Known Vulnerabilities*
266
267None
268
269*Workarounds*
270
271None
272
273Security Notes
274--------------
275
276*Fixed Security Issues*
277
278 - `CPS-963 <https://jira.onap.org/browse/CPS-963>`_ Liquibase has got serious vulnerability, upgrade required
279
280*Known Security Issues*
281
282None
283
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400284.. ========================
285.. * * * JAKARTA * * *
286.. ========================
287
288Version: 3.0.1
289==============
290
291Release Data
292------------
293
294+--------------------------------------+--------------------------------------------------------+
295| **CPS Project** | |
296| | |
297+--------------------------------------+--------------------------------------------------------+
298| **Docker images** | onap/cps-and-ncmp:3.0.1 |
299| | |
300+--------------------------------------+--------------------------------------------------------+
301| **Release designation** | 3.0.1 Jakarta |
302| | |
303+--------------------------------------+--------------------------------------------------------+
304| **Release date** | 2022 April 28 |
305| | |
306+--------------------------------------+--------------------------------------------------------+
307
308Bug Fixes
309---------
310 - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_ Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
311
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400312Version: 3.0.0
313==============
niamhcoref7b414e2021-11-17 11:02:07 +0000314
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400315Release Data
316------------
317
318+--------------------------------------+--------------------------------------------------------+
319| **CPS Project** | |
320| | |
321+--------------------------------------+--------------------------------------------------------+
322| **Docker images** | onap/cps-and-ncmp:3.0.0 |
323| | |
324+--------------------------------------+--------------------------------------------------------+
325| **Release designation** | 3.0.0 Jakarta |
326| | |
327+--------------------------------------+--------------------------------------------------------+
328| **Release date** | 2022 March 15 |
329| | |
330+--------------------------------------+--------------------------------------------------------+
niamhcoref7b414e2021-11-17 11:02:07 +0000331
332Features
333--------
puthuparambil.adityad0007332021-12-08 18:53:39 +0000334 - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_ Define response objects (schemas) in cps-ncmp
niamhcoref7b414e2021-11-17 11:02:07 +0000335 - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_ Update operation for datastore pass through running
336 - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_ Delete operation for datastore pass through running
DylanB95ESTe5573382022-01-27 17:12:52 +0000337 - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_ Support 'public' Cm Handle Properties
niamhcoref7b414e2021-11-17 11:02:07 +0000338 - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
JosephKeenan82ebf532021-12-08 18:16:44 +0000339 - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_ Ensure all DMI operations use POST method
puthuparambil.adityad0007332021-12-08 18:53:39 +0000340 - `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 -0400341 - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
342 - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
DylanB95ESTe5573382022-01-27 17:12:52 +0000343 - `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 +0530344 - `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 +0000345
346Bug Fixes
347---------
348
349 - `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 +0000350 - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
niamhcore65bc4fd2021-12-08 14:19:02 +0000351 - `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 +0000352 - `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 +0000353 - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
JosephKeenane0643ab2022-02-15 18:23:05 +0000354 - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
DylanB95ESTe5573382022-01-27 17:12:52 +0000355 - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
JosephKeenane0643ab2022-02-15 18:23:05 +0000356 - `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 +0530357 - `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 +0000358 - `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 +0000359
360Known Limitations, Issues and Workarounds
361-----------------------------------------
362
363*System Limitations*
364
DylanB95ESTe5573382022-01-27 17:12:52 +0000365Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
366`CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
367of cm handle registration.
niamhcoref7b414e2021-11-17 11:02:07 +0000368
Lathishb3550f12022-03-15 12:03:53 +0000369The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
370for more information.
371
niamhcoref7b414e2021-11-17 11:02:07 +0000372*Known Vulnerabilities*
373
374None
375
376*Workarounds*
377
DylanB95ESTe5573382022-01-27 17:12:52 +0000378Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
379pass an empty string as the value if you do not want to include names for these values.
niamhcoref7b414e2021-11-17 11:02:07 +0000380
381Security Notes
382--------------
383
384*Fixed Security Issues*
385
386None
387
388*Known Security Issues*
389
390None
391
392.. ========================
shivasubedi44beaa32021-09-13 15:16:30 +0100393.. * * * ISTANBUL * * *
394.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000395
Bruno Sakoto0eaf3342022-02-11 15:05:29 -0500396Version: 2.0.4
397==============
398
399Release Data
400------------
401
402+--------------------------------------+--------------------------------------------------------+
403| **CPS Project** | |
404| | |
405+--------------------------------------+--------------------------------------------------------+
406| **Docker images** | onap/cps-and-ncmp:2.0.4 |
407| | |
408+--------------------------------------+--------------------------------------------------------+
409| **Release designation** | 2.0.4 Istanbul |
410| | |
411+--------------------------------------+--------------------------------------------------------+
412| **Release date** | 2022 Feb 09 |
413| | |
414+--------------------------------------+--------------------------------------------------------+
415
416Bug Fixes
417---------
418
419 - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_ Fix docker compose for csit test.
420 - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_ Fix intermittent circular dependency error when the application starts.
421
422Version: 2.0.3
423==============
424
425Release Data
426------------
427
428+--------------------------------------+--------------------------------------------------------+
429| **CPS Project** | |
430| | |
431+--------------------------------------+--------------------------------------------------------+
432| **Docker images** | onap/cps-and-ncmp:2.0.3 |
433| | |
434+--------------------------------------+--------------------------------------------------------+
435| **Release designation** | 2.0.3 Istanbul |
436| | |
437+--------------------------------------+--------------------------------------------------------+
438| **Release date** | 2022-07-01 |
439| | |
440+--------------------------------------+--------------------------------------------------------+
441
442Bug Fixes
443---------
444
445 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
446
447Version: 2.0.2
448==============
449
450Release Data
451------------
452
453+--------------------------------------+--------------------------------------------------------+
454| **CPS Project** | |
455| | |
456+--------------------------------------+--------------------------------------------------------+
457| **Docker images** | onap/cps-and-ncmp:2.0.2 |
458| | |
459+--------------------------------------+--------------------------------------------------------+
460| **Release designation** | 2.0.2 Istanbul |
461| | |
462+--------------------------------------+--------------------------------------------------------+
463| **Release date** | 2021-16-12 |
464| | |
465+--------------------------------------+--------------------------------------------------------+
466
467Bug Fixes
468---------
469
470 - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_ Update log4j version due to security vulnerability
471
lukegleeson9c583712021-09-30 17:21:11 +0100472Version: 2.0.1
473==============
474
475Release Data
476------------
477
478+--------------------------------------+--------------------------------------------------------+
479| **CPS Project** | |
480| | |
481+--------------------------------------+--------------------------------------------------------+
482| **Docker images** | onap/cps-and-ncmp:2.0.1 |
483| | |
484+--------------------------------------+--------------------------------------------------------+
485| **Release designation** | 2.0.1 Istanbul |
486| | |
487+--------------------------------------+--------------------------------------------------------+
488| **Release date** | 2021-14-10 |
489| | |
490+--------------------------------------+--------------------------------------------------------+
491
492Bug Fixes
493---------
494
495 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
496 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
497 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
498 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
499
500Known Limitations, Issues and Workarounds
501-----------------------------------------
502
503*System Limitations*
504
505Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
506
507*Known Vulnerabilities*
508
509 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
510
511*Workarounds*
512
513Add recursive method to save list node data to loop through all corresponding child nodes.
514
515Security Notes
516--------------
517
518*Fixed Security Issues*
519
520 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
521
522*Known Security Issues*
523
524None
525
shivasubedi44beaa32021-09-13 15:16:30 +0100526Version: 2.0.0
527==============
528
529Abstract
530--------
531
532This document provides the release notes for Istanbul release.
533
534Release Data
535------------
536
537+--------------------------------------+--------------------------------------------------------+
538| **CPS Project** | |
539| | |
540+--------------------------------------+--------------------------------------------------------+
541| **Docker images** | onap/cps-and-ncmp:2.0.0 |
542| | |
543+--------------------------------------+--------------------------------------------------------+
544| **Release designation** | 2.0.0 Istanbul |
545| | |
546+--------------------------------------+--------------------------------------------------------+
lukegleeson9c583712021-09-30 17:21:11 +0100547| **Release date** | 2021-14-09 |
shivasubedi44beaa32021-09-13 15:16:30 +0100548| | |
549+--------------------------------------+--------------------------------------------------------+
550
551Features
552--------
DylanB95EST3fcf8692021-10-11 16:29:16 +0100553* Register DMI-Plugins with NCMP for CM Handle registrations.
shivasubedi44beaa32021-09-13 15:16:30 +0100554* Update, Create and Remove CM Handles.
555* Add support for retrieving and writing CM Handle data through NCMP datastores.
556* Automatic retrieval and caching of model information for CM Handles within NCMP.
557
shivasubedi44beaa32021-09-13 15:16:30 +0100558Deliverables
559------------
560
561Software Deliverables
562
563.. csv-table::
564 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
565 :widths: auto
566
567 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
568
569Bug Fixes
570---------
571
lukegleeson9c583712021-09-30 17:21:11 +0100572 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
shivasubedi44beaa32021-09-13 15:16:30 +0100573 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
574 - `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 +0100575 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
576 - `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 +0100577 - `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 +0100578 - `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 +0100579 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
580 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
lukegleeson9c583712021-09-30 17:21:11 +0100581 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
582 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
583 - `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 +0100584 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
585 - `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 +0100586 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
shivasubedi44beaa32021-09-13 15:16:30 +0100587 - `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 +0100588 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
589 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
590 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
lukegleeson9c583712021-09-30 17:21:11 +0100591 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
592 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
593 - `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 -0500594 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
lukegleeson9c583712021-09-30 17:21:11 +0100595 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
596 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
597 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
shivasubedi44beaa32021-09-13 15:16:30 +0100598
599This document provides the release notes for Istanbul release.
600
601Summary
602-------
603
604Following CPS components are available with default ONAP/CPS installation.
605
606
607 * Platform components
608
609 - CPS (Helm charts)
610
611 * Service components
612
DylanB95EST3fcf8692021-10-11 16:29:16 +0100613 - CPS-NCMP
614 - CPS-Temporal
615 - DMI-Plugin
shivasubedi44beaa32021-09-13 15:16:30 +0100616
617 * Additional resources that CPS utilizes deployed using ONAP common charts
618
619 - Postgres Database
620
621
622Below service components (mS) are available to be deployed on-demand.
623 - CPS-TBDMT
624
625
626Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
627
628Known Limitations, Issues and Workarounds
629-----------------------------------------
630
shivasubedi44beaa32021-09-13 15:16:30 +0100631*System Limitations*
632
633Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
634
635*Known Vulnerabilities*
636
lukegleeson9c583712021-09-30 17:21:11 +0100637 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
638 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
639 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
shivasubedi44beaa32021-09-13 15:16:30 +0100640
641*Workarounds*
642
643Add recursive method to save list node data to loop through all corresponding child nodes.
644
645Security Notes
646--------------
647
648*Fixed Security Issues*
649
650 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
shivasubedi44beaa32021-09-13 15:16:30 +0100651
652*Known Security Issues*
653
lukegleeson9c583712021-09-30 17:21:11 +0100654 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
655
shivasubedi44beaa32021-09-13 15:16:30 +0100656Test Results
657------------
658 * `Integration tests`
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000659
ToineSiebelinkf0527c52021-07-06 13:03:03 +0100660.. ========================
661.. * * * HONOLULU * * *
662.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000663
ToineSiebelinkfd2134d2021-04-09 11:15:48 +0100664Version: 1.0.1
665==============
666
667Release Data
668------------
669
670+--------------------------------------+--------------------------------------------------------+
671| **CPS Project** | |
672| | |
673+--------------------------------------+--------------------------------------------------------+
674| **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
675| | |
676+--------------------------------------+--------------------------------------------------------+
677| **Release designation** | 1.0.1 Honolulu |
678| | |
679+--------------------------------------+--------------------------------------------------------+
680| **Release date** | 2021-04-09 |
681| | |
682+--------------------------------------+--------------------------------------------------------+
683
684Bug Fixes
685---------
686
puthuparambil.aditya8b584332021-10-12 16:49:03 +0100687 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
ToineSiebelinkfd2134d2021-04-09 11:15:48 +0100688 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
689 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
690 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
691 - `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
692 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
693 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
694 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
695
696Security Notes
697--------------
698
699*Fixed Security Issues*
700
701 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000702
ToineSiebelinka2d25b52021-04-13 15:10:47 +0100703*Known Security Issues*
704
705 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
706
Rishi.Chail4359d282021-03-03 16:36:26 +0000707Version: 1.0.0
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000708==============
709
710
711Abstract
712--------
713
714This document provides the release notes for Honolulu release.
715
716Summary
717-------
718
719Following CPS components are available with default ONAP/CPS installation.
720
721
Rishi.Chail4359d282021-03-03 16:36:26 +0000722 * Platform components
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000723
Rishi.Chail4359d282021-03-03 16:36:26 +0000724 - CPS (Helm charts)
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000725
Rishi.Chail4359d282021-03-03 16:36:26 +0000726 * Service components
727
728 - CPS Core
729
730 * Additional resources that CPS utilizes deployed using ONAP common charts
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000731
732 - Postgres Database
733
734
Rishi.Chail4359d282021-03-03 16:36:26 +0000735Below service components (mS) are available to be deployed on-demand.
736 - CPS-TBDMT
737
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000738
739Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
740
741
742Release Data
743------------
744
745+--------------------------------------+--------------------------------------------------------+
746| **CPS Project** | |
747| | |
748+--------------------------------------+--------------------------------------------------------+
749| **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
750| | |
751+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +0000752| **Release designation** | 1.0.0 Honolulu |
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000753| | |
754+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +0000755| **Release date** | 2021-03-11 |
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000756| | |
757+--------------------------------------+--------------------------------------------------------+
758
759
760Features
761--------
Rishi.Chail4359d282021-03-03 16:36:26 +0000762Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
763CPS has been driven by the needs of the E2E Networking Slicing use case.
764It currently supports basic (rw) persistence and simple queries.
765It also provides MVP support for network data access using simulated data.
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000766
767.. _honolulu_deliverable:
768
769Deliverables
770------------
771
772Software Deliverables
773
774.. csv-table::
775 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
776 :widths: auto
777
Rishi.Chail4359d282021-03-03 16:36:26 +0000778 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000779
780
781Known Limitations, Issues and Workarounds
782-----------------------------------------
783
Rishi.Chail4359d282021-03-03 16:36:26 +0000784 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
785 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
786 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
niamhcoredddf7312021-06-21 14:44:01 +0100787 - `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 +0000788
789*System Limitations*
790
791None
792
793*Known Vulnerabilities*
794
795None
796
797*Workarounds*
798
799Documented under corresponding jira if applicable.
800
801Security Notes
802--------------
803
804*Fixed Security Issues*
ToineSiebelink7c981df2021-03-01 09:53:56 +0000805
806* `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
Rishi.Chail4359d282021-03-03 16:36:26 +0000807 - Upgrade org.onap.oparent to 3.2.0
ToineSiebelink7c981df2021-03-01 09:53:56 +0000808 - Upgrade spring.boot to 2.3.8.RELEASE
Rishi.Chail4359d282021-03-03 16:36:26 +0000809 - Upgrade yangtools to 5.0.7
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000810
811*Known Security Issues*
812
Rishi.Chail4359d282021-03-03 16:36:26 +0000813 * Weak Crytography using md5
814 * Risk seen in Zip file expansion
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000815
816*Known Vulnerabilities in Used Modules*
817
Rishi.Chail4359d282021-03-03 16:36:26 +0000818 None
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000819
Rishi.Chail4359d282021-03-03 16:36:26 +0000820CPS 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 +0000821
822Test Results
823------------
Rishi.Chail4359d282021-03-03 16:36:26 +0000824 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000825
826References
827----------
828
829For more information on the ONAP Honolulu release, please see:
830
831#. `ONAP Home Page`_
832#. `ONAP Documentation`_
833#. `ONAP Release Downloads`_
834#. `ONAP Wiki Page`_
835
836
837.. _`ONAP Home Page`: https://www.onap.org
838.. _`ONAP Wiki Page`: https://wiki.onap.org
839.. _`ONAP Documentation`: https://docs.onap.org
840.. _`ONAP Release Downloads`: https://git.onap.org
841
842Quick Links:
843
844 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
845 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_