blob: b757f19d85fdd58207d0001d0198345db36455a6 [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
JosephKeenane0643ab2022-02-15 18:23:05 +00003.. Copyright (C) 2021-2022 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
lukegleeson3be99242022-10-11 14:34:56 +010019Version: 3.2.0 (not yet released)
mpriyank4bd450e2022-10-05 09:50:59 +010020=================================
21
22Release Data
23------------
24
25+--------------------------------------+--------------------------------------------------------+
26| **CPS Project** | |
27| | |
28+--------------------------------------+--------------------------------------------------------+
lukegleeson3be99242022-10-11 14:34:56 +010029| **Docker images** | onap/cps-and-ncmp:3.2.0 |
mpriyank4bd450e2022-10-05 09:50:59 +010030| | |
31+--------------------------------------+--------------------------------------------------------+
lukegleeson3be99242022-10-11 14:34:56 +010032| **Release designation** | 3.2.0 London |
mpriyank4bd450e2022-10-05 09:50:59 +010033| | |
34+--------------------------------------+--------------------------------------------------------+
35| **Release date** | (not yet released) |
36| | |
37+--------------------------------------+--------------------------------------------------------+
lukegleeson3be99242022-10-11 14:34:56 +010038Features
39--------
lukegleeson20e7a732022-10-20 10:14:00 +010040 - `CPS-1002 <https://jira.onap.org/browse/CPS-1002>`_ Query data NCMP-Operational with CPSpath
lukegleeson3be99242022-10-11 14:34:56 +010041 - `CPS-1185 <https://jira.onap.org/browse/CPS-1185>`_ Get all dataspaces
42 - `CPS-1186 <https://jira.onap.org/browse/CPS-1186>`_ Get all schema sets for a dataspace
43 - `CPS-1187 <https://jira.onap.org/browse/CPS-1187>`_ Get single dataspace
44 - `CPS-1189 <https://jira.onap.org/browse/CPS-1189>`_ Various create endpoints should return 201 response with empty body
mpriyank4bd450e2022-10-05 09:50:59 +010045
46Bug Fixes
47---------
lukegleeson984d1f22022-10-04 16:07:37 +010048 - `CPS-1312 <https://jira.onap.org/browse/CPS-1312>`_ CPS(/NCMP) does not have version control
JosephKeenan1a650232022-10-20 10:33:24 +010049 - `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_ [CPS/NCMP] Add Basic Auth to CPS/NCMP OpenAPI Definitions
mpriyank4bd450e2022-10-05 09:50:59 +010050
lukegleeson3be99242022-10-11 14:34:56 +010051Known Limitations, Issues and Workarounds
52-----------------------------------------
53
54*System Limitations*
55
seanbeirne72c267e2022-10-18 12:39:22 +010056For upgrading, CPS uses Liquibase for database upgrades. CPS/NCMP currently only supports upgrading from Liquibase changelog 11 to Liquibase changelog 16.
57This 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 +010058
seanbeirnedba2b102022-10-27 09:59:17 +010059.. ====================
60.. * * * KOHN * * *
61.. ====================
62
mpriyankfe775312022-09-30 14:16:51 +010063Version: 3.1.4
64==============
65
66Release Data
67------------
68
69+--------------------------------------+--------------------------------------------------------+
70| **CPS Project** | |
71| | |
72+--------------------------------------+--------------------------------------------------------+
73| **Docker images** | onap/cps-and-ncmp:3.1.4 |
74| | |
75+--------------------------------------+--------------------------------------------------------+
76| **Release designation** | 3.1.4 Kohn |
77| | |
78+--------------------------------------+--------------------------------------------------------+
mpriyank4bd450e2022-10-05 09:50:59 +010079| **Release date** | 2022 October 5 |
mpriyankfe775312022-09-30 14:16:51 +010080| | |
81+--------------------------------------+--------------------------------------------------------+
82
83Bug Fixes
84---------
lukegleeson8c6b5622022-09-29 15:58:06 +010085 - `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 +010086 - `CPS-1294 <https://jira.onap.org/browse/CPS-1294>`_ Kafka communication fault caused cmHandle registration error
mpriyankfe775312022-09-30 14:16:51 +010087
mpriyank06736cb2022-09-29 14:29:40 +010088Version: 3.1.3
89==============
90
91Release Data
92------------
93
94+--------------------------------------+--------------------------------------------------------+
95| **CPS Project** | |
96| | |
97+--------------------------------------+--------------------------------------------------------+
98| **Docker images** | onap/cps-and-ncmp:3.1.3 |
99| | |
100+--------------------------------------+--------------------------------------------------------+
101| **Release designation** | 3.1.3 Kohn |
102| | |
103+--------------------------------------+--------------------------------------------------------+
mpriyankfe775312022-09-30 14:16:51 +0100104| **Release date** | 2022 September 29 |
mpriyank06736cb2022-09-29 14:29:40 +0100105| | |
106+--------------------------------------+--------------------------------------------------------+
107
108Bug Fixes
109---------
110 - None
111
mpriyankef0ddfc2022-09-28 12:19:34 +0100112Version: 3.1.2
113==============
114
115Release Data
116------------
117
118+--------------------------------------+--------------------------------------------------------+
119| **CPS Project** | |
120| | |
121+--------------------------------------+--------------------------------------------------------+
122| **Docker images** | onap/cps-and-ncmp:3.1.2 |
123| | |
124+--------------------------------------+--------------------------------------------------------+
125| **Release designation** | 3.1.2 Kohn |
126| | |
127+--------------------------------------+--------------------------------------------------------+
mpriyank06736cb2022-09-29 14:29:40 +0100128| **Release date** | 2022 September 28 |
mpriyankef0ddfc2022-09-28 12:19:34 +0100129| | |
130+--------------------------------------+--------------------------------------------------------+
131
132Bug Fixes
133---------
134 - None
135
mpriyanka3f43502022-09-26 14:57:01 +0100136Version: 3.1.1
137==============
138
139Release Data
140------------
141
142+--------------------------------------+--------------------------------------------------------+
143| **CPS Project** | |
144| | |
145+--------------------------------------+--------------------------------------------------------+
146| **Docker images** | onap/cps-and-ncmp:3.1.1 |
147| | |
148+--------------------------------------+--------------------------------------------------------+
149| **Release designation** | 3.1.1 Kohn |
150| | |
151+--------------------------------------+--------------------------------------------------------+
mpriyankef0ddfc2022-09-28 12:19:34 +0100152| **Release date** | 2022 September 28 |
mpriyanka3f43502022-09-26 14:57:01 +0100153| | |
154+--------------------------------------+--------------------------------------------------------+
155
156Bug Fixes
157---------
158 - None
159
lukegleesonc9ec9152022-09-07 14:21:36 +0100160Security Notes
161--------------
162
163*Fixed Security Issues*
164
165 - `CPS-1226 <https://jira.onap.org/browse/CPS-1226>`_ Security bug in the logs
166
lukegleeson4a34fa52022-09-19 15:31:59 +0100167Version: 3.1.0
168==============
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400169
170Release Data
171------------
172
DylanB95ESTb130fd32022-04-04 13:09:22 +0100173+--------------------------------------+--------------------------------------------------------+
174| **CPS Project** | |
175| | |
176+--------------------------------------+--------------------------------------------------------+
177| **Docker images** | onap/cps-and-ncmp:3.1.0 |
178| | |
179+--------------------------------------+--------------------------------------------------------+
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400180| **Release designation** | 3.1.0 Kohn |
DylanB95ESTb130fd32022-04-04 13:09:22 +0100181| | |
182+--------------------------------------+--------------------------------------------------------+
lukegleeson4a34fa52022-09-19 15:31:59 +0100183| **Release date** | 2022 September 14 |
DylanB95ESTb130fd32022-04-04 13:09:22 +0100184| | |
185+--------------------------------------+--------------------------------------------------------+
186
187Features
188--------
lukegleeson4a34fa52022-09-19 15:31:59 +0100189 - `CPS-340 <https://jira.onap.org/browse/CPS-340>`_ Patch and update the root data node
190 - `CPS-575 <https://jira.onap.org/browse/CPS-575>`_ Write data for cmHandle using ncmp-datastores:passthrough-running (NCMP.)
191 - `CPS-731 <https://jira.onap.org/browse/CPS-731>`_ Query based on Public CM Properties
192 - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_ Async: NCMP Rest impl. including Request ID generation
193 - `CPS-829 <https://jira.onap.org/browse/CPS-829>`_ Async: Internal message topic incl. basic producer & Consumer
194 - `CPS-830 <https://jira.onap.org/browse/CPS-830>`_ DMI-NCMP Asynchronously Publish Response Event to Client Topic
195 - `CPS-869 <https://jira.onap.org/browse/CPS-869>`_ Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072
196 - `CPS-870 <https://jira.onap.org/browse/CPS-870>`_ Align CPS-Core output with SDN-C output (add module name)
197 - `CPS-875 <https://jira.onap.org/browse/CPS-875>`_ CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles
198 - `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'
199 - `CPS-899 <https://jira.onap.org/browse/CPS-899>`_ Start and stop sessions on Java API
200 - `CPS-909 <https://jira.onap.org/browse/CPS-909>`_ Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state
201 - `CPS-917 <https://jira.onap.org/browse/CPS-917>`_ Structured Errors response for passthrough use-cases in NCMP
202 - `CPS-953 <https://jira.onap.org/browse/CPS-953>`_ Update maven deploy plugin version
203 - `CPS-977 <https://jira.onap.org/browse/CPS-977>`_ Query CM Handles using CpsPath
204 - `CPS-1000 <https://jira.onap.org/browse/CPS-1000>`_ Create Data Synchronization watchdog
205 - `CPS-1016 <https://jira.onap.org/browse/CPS-1016>`_ Merge 2 'query' end points in NCMP
206 - `CPS-1034 <https://jira.onap.org/browse/CPS-1034>`_ Publish lifecycle events for ADVISED , READY and LOCKED state transition"
207 - `CPS-1064 <https://jira.onap.org/browse/CPS-1064>`_ Support retrieval of YANG module sources for CM handle on the NCMP interface
208 - `CPS-1099 <https://jira.onap.org/browse/CPS-1099>`_ Expose simplified 'external' lock reason enum state over REST interface
209 - `CPS-1101 <https://jira.onap.org/browse/CPS-1101>`_ Introducing the DELETING and DELETED Cmhandle State
210 - `CPS-1102 <https://jira.onap.org/browse/CPS-1102>`_ Register the Cmhandle Sends Advised State notification.
211 - `CPS-1133 <https://jira.onap.org/browse/CPS-1133>`_ Enable/Disable Data Sync for Cm Handle
212 - `CPS-1136 <https://jira.onap.org/browse/CPS-1136>`_ DMI Audit Support (get all CM Handles for a registered DMI)
213
emacleeafb17362022-09-02 14:40:17 +0100214
215Bug Fixes
216---------
lukegleeson4a34fa52022-09-19 15:31:59 +0100217 - `CPS-896 <https://jira.onap.org/browse/CPS-896>`_ CM Handle Registration Process only partially completes when exception is thrown
218 - `CPS-957 <https://jira.onap.org/browse/CPS-957>`_ NCMP: fix getResourceDataForPassthroughOperational endpoint
219 - `CPS-1020 <https://jira.onap.org/browse/CPS-1020>`_ DuplicatedYangResourceException error at parallel cmHandle registration
220 - `CPS-1056 <https://jira.onap.org/browse/CPS-1056>`_ Wrong error response format in case of Dmi plugin error
221 - `CPS-1067 <https://jira.onap.org/browse/CPS-1067>`_ NCMP returns 500 error on searches endpoint when No DMi Handles registered
222 - `CPS-1085 <https://jira.onap.org/browse/CPS-1085>`_ Performance degradation on ncmp/v1/ch/searches endpoint
223 - `CPS-1088 <https://jira.onap.org/browse/CPS-1088>`_ Kafka consumer can not be turned off
224 - `CPS-1097 <https://jira.onap.org/browse/CPS-1097>`_ Unable to change state from LOCKED to ADVISED
225 - `CPS-1126 <https://jira.onap.org/browse/CPS-1126>`_ CmHandle creation performance degradation
226 - `CPS-1175 <https://jira.onap.org/browse/CPS-1175>`_ Incorrect response when empty body executed for cmhandle id-searches
227 - `CPS-1179 <https://jira.onap.org/browse/CPS-1179>`_ Node API - GET method returns invalid response when identifier contains '/'
228 - `CPS-1212 <https://jira.onap.org/browse/CPS-1212>`_ Additional Properties for CM Handles not included when send to DMI Plugin
229 - `CPS-1217 <https://jira.onap.org/browse/CPS-1217>`_ Searches endpoint gives back empty list however there are already available cmhandles
230 - `CPS-1218 <https://jira.onap.org/browse/CPS-1218>`_ NCMP logs are flooded with SyncUtils logs
puthuparambil.adityadd904322022-09-21 10:53:51 +0100231
232Known Limitations, Issues and Workarounds
233-----------------------------------------
234
235*System Limitations*
236
237Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition.
238Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces']
DylanB95ESTb130fd32022-04-04 13:09:22 +0100239
lukegleeson4a34fa52022-09-19 15:31:59 +0100240*Known Vulnerabilities*
241
242None
243
244*Workarounds*
245
246None
247
248Security Notes
249--------------
250
251*Fixed Security Issues*
252
253 - `CPS-963 <https://jira.onap.org/browse/CPS-963>`_ Liquibase has got serious vulnerability, upgrade required
254
255*Known Security Issues*
256
257None
258
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400259.. ========================
260.. * * * JAKARTA * * *
261.. ========================
262
263Version: 3.0.1
264==============
265
266Release Data
267------------
268
269+--------------------------------------+--------------------------------------------------------+
270| **CPS Project** | |
271| | |
272+--------------------------------------+--------------------------------------------------------+
273| **Docker images** | onap/cps-and-ncmp:3.0.1 |
274| | |
275+--------------------------------------+--------------------------------------------------------+
276| **Release designation** | 3.0.1 Jakarta |
277| | |
278+--------------------------------------+--------------------------------------------------------+
279| **Release date** | 2022 April 28 |
280| | |
281+--------------------------------------+--------------------------------------------------------+
282
283Bug Fixes
284---------
285 - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_ Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
286
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400287Version: 3.0.0
288==============
niamhcoref7b414e2021-11-17 11:02:07 +0000289
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400290Release Data
291------------
292
293+--------------------------------------+--------------------------------------------------------+
294| **CPS Project** | |
295| | |
296+--------------------------------------+--------------------------------------------------------+
297| **Docker images** | onap/cps-and-ncmp:3.0.0 |
298| | |
299+--------------------------------------+--------------------------------------------------------+
300| **Release designation** | 3.0.0 Jakarta |
301| | |
302+--------------------------------------+--------------------------------------------------------+
303| **Release date** | 2022 March 15 |
304| | |
305+--------------------------------------+--------------------------------------------------------+
niamhcoref7b414e2021-11-17 11:02:07 +0000306
307Features
308--------
puthuparambil.adityad0007332021-12-08 18:53:39 +0000309 - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_ Define response objects (schemas) in cps-ncmp
niamhcoref7b414e2021-11-17 11:02:07 +0000310 - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_ Update operation for datastore pass through running
311 - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_ Delete operation for datastore pass through running
DylanB95ESTe5573382022-01-27 17:12:52 +0000312 - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_ Support 'public' Cm Handle Properties
niamhcoref7b414e2021-11-17 11:02:07 +0000313 - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
JosephKeenan82ebf532021-12-08 18:16:44 +0000314 - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_ Ensure all DMI operations use POST method
puthuparambil.adityad0007332021-12-08 18:53:39 +0000315 - `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 -0400316 - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
317 - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
DylanB95ESTe5573382022-01-27 17:12:52 +0000318 - `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 +0530319 - `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 +0000320
321Bug Fixes
322---------
323
324 - `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 +0000325 - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
niamhcore65bc4fd2021-12-08 14:19:02 +0000326 - `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 +0000327 - `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 +0000328 - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
JosephKeenane0643ab2022-02-15 18:23:05 +0000329 - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
DylanB95ESTe5573382022-01-27 17:12:52 +0000330 - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
JosephKeenane0643ab2022-02-15 18:23:05 +0000331 - `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 +0530332 - `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 +0000333 - `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 +0000334
335Known Limitations, Issues and Workarounds
336-----------------------------------------
337
338*System Limitations*
339
DylanB95ESTe5573382022-01-27 17:12:52 +0000340Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
341`CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
342of cm handle registration.
niamhcoref7b414e2021-11-17 11:02:07 +0000343
Lathishb3550f12022-03-15 12:03:53 +0000344The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
345for more information.
346
niamhcoref7b414e2021-11-17 11:02:07 +0000347*Known Vulnerabilities*
348
349None
350
351*Workarounds*
352
DylanB95ESTe5573382022-01-27 17:12:52 +0000353Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
354pass an empty string as the value if you do not want to include names for these values.
niamhcoref7b414e2021-11-17 11:02:07 +0000355
356Security Notes
357--------------
358
359*Fixed Security Issues*
360
361None
362
363*Known Security Issues*
364
365None
366
367.. ========================
shivasubedi44beaa32021-09-13 15:16:30 +0100368.. * * * ISTANBUL * * *
369.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000370
Bruno Sakoto0eaf3342022-02-11 15:05:29 -0500371Version: 2.0.4
372==============
373
374Release Data
375------------
376
377+--------------------------------------+--------------------------------------------------------+
378| **CPS Project** | |
379| | |
380+--------------------------------------+--------------------------------------------------------+
381| **Docker images** | onap/cps-and-ncmp:2.0.4 |
382| | |
383+--------------------------------------+--------------------------------------------------------+
384| **Release designation** | 2.0.4 Istanbul |
385| | |
386+--------------------------------------+--------------------------------------------------------+
387| **Release date** | 2022 Feb 09 |
388| | |
389+--------------------------------------+--------------------------------------------------------+
390
391Bug Fixes
392---------
393
394 - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_ Fix docker compose for csit test.
395 - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_ Fix intermittent circular dependency error when the application starts.
396
397Version: 2.0.3
398==============
399
400Release Data
401------------
402
403+--------------------------------------+--------------------------------------------------------+
404| **CPS Project** | |
405| | |
406+--------------------------------------+--------------------------------------------------------+
407| **Docker images** | onap/cps-and-ncmp:2.0.3 |
408| | |
409+--------------------------------------+--------------------------------------------------------+
410| **Release designation** | 2.0.3 Istanbul |
411| | |
412+--------------------------------------+--------------------------------------------------------+
413| **Release date** | 2022-07-01 |
414| | |
415+--------------------------------------+--------------------------------------------------------+
416
417Bug Fixes
418---------
419
420 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
421
422Version: 2.0.2
423==============
424
425Release Data
426------------
427
428+--------------------------------------+--------------------------------------------------------+
429| **CPS Project** | |
430| | |
431+--------------------------------------+--------------------------------------------------------+
432| **Docker images** | onap/cps-and-ncmp:2.0.2 |
433| | |
434+--------------------------------------+--------------------------------------------------------+
435| **Release designation** | 2.0.2 Istanbul |
436| | |
437+--------------------------------------+--------------------------------------------------------+
438| **Release date** | 2021-16-12 |
439| | |
440+--------------------------------------+--------------------------------------------------------+
441
442Bug Fixes
443---------
444
445 - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_ Update log4j version due to security vulnerability
446
lukegleeson9c583712021-09-30 17:21:11 +0100447Version: 2.0.1
448==============
449
450Release Data
451------------
452
453+--------------------------------------+--------------------------------------------------------+
454| **CPS Project** | |
455| | |
456+--------------------------------------+--------------------------------------------------------+
457| **Docker images** | onap/cps-and-ncmp:2.0.1 |
458| | |
459+--------------------------------------+--------------------------------------------------------+
460| **Release designation** | 2.0.1 Istanbul |
461| | |
462+--------------------------------------+--------------------------------------------------------+
463| **Release date** | 2021-14-10 |
464| | |
465+--------------------------------------+--------------------------------------------------------+
466
467Bug Fixes
468---------
469
470 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
471 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
472 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
473 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
474
475Known Limitations, Issues and Workarounds
476-----------------------------------------
477
478*System Limitations*
479
480Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
481
482*Known Vulnerabilities*
483
484 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
485
486*Workarounds*
487
488Add recursive method to save list node data to loop through all corresponding child nodes.
489
490Security Notes
491--------------
492
493*Fixed Security Issues*
494
495 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
496
497*Known Security Issues*
498
499None
500
shivasubedi44beaa32021-09-13 15:16:30 +0100501Version: 2.0.0
502==============
503
504Abstract
505--------
506
507This document provides the release notes for Istanbul release.
508
509Release Data
510------------
511
512+--------------------------------------+--------------------------------------------------------+
513| **CPS Project** | |
514| | |
515+--------------------------------------+--------------------------------------------------------+
516| **Docker images** | onap/cps-and-ncmp:2.0.0 |
517| | |
518+--------------------------------------+--------------------------------------------------------+
519| **Release designation** | 2.0.0 Istanbul |
520| | |
521+--------------------------------------+--------------------------------------------------------+
lukegleeson9c583712021-09-30 17:21:11 +0100522| **Release date** | 2021-14-09 |
shivasubedi44beaa32021-09-13 15:16:30 +0100523| | |
524+--------------------------------------+--------------------------------------------------------+
525
526Features
527--------
DylanB95EST3fcf8692021-10-11 16:29:16 +0100528* Register DMI-Plugins with NCMP for CM Handle registrations.
shivasubedi44beaa32021-09-13 15:16:30 +0100529* Update, Create and Remove CM Handles.
530* Add support for retrieving and writing CM Handle data through NCMP datastores.
531* Automatic retrieval and caching of model information for CM Handles within NCMP.
532
shivasubedi44beaa32021-09-13 15:16:30 +0100533Deliverables
534------------
535
536Software Deliverables
537
538.. csv-table::
539 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
540 :widths: auto
541
542 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
543
544Bug Fixes
545---------
546
lukegleeson9c583712021-09-30 17:21:11 +0100547 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
shivasubedi44beaa32021-09-13 15:16:30 +0100548 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
549 - `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 +0100550 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
551 - `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 +0100552 - `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 +0100553 - `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 +0100554 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
555 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
lukegleeson9c583712021-09-30 17:21:11 +0100556 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
557 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
558 - `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 +0100559 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
560 - `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 +0100561 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
shivasubedi44beaa32021-09-13 15:16:30 +0100562 - `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 +0100563 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
564 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
565 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
lukegleeson9c583712021-09-30 17:21:11 +0100566 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
567 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
568 - `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 -0500569 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
lukegleeson9c583712021-09-30 17:21:11 +0100570 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
571 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
572 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
shivasubedi44beaa32021-09-13 15:16:30 +0100573
574This document provides the release notes for Istanbul release.
575
576Summary
577-------
578
579Following CPS components are available with default ONAP/CPS installation.
580
581
582 * Platform components
583
584 - CPS (Helm charts)
585
586 * Service components
587
DylanB95EST3fcf8692021-10-11 16:29:16 +0100588 - CPS-NCMP
589 - CPS-Temporal
590 - DMI-Plugin
shivasubedi44beaa32021-09-13 15:16:30 +0100591
592 * Additional resources that CPS utilizes deployed using ONAP common charts
593
594 - Postgres Database
595
596
597Below service components (mS) are available to be deployed on-demand.
598 - CPS-TBDMT
599
600
601Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
602
603Known Limitations, Issues and Workarounds
604-----------------------------------------
605
shivasubedi44beaa32021-09-13 15:16:30 +0100606*System Limitations*
607
608Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
609
610*Known Vulnerabilities*
611
lukegleeson9c583712021-09-30 17:21:11 +0100612 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
613 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
614 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
shivasubedi44beaa32021-09-13 15:16:30 +0100615
616*Workarounds*
617
618Add recursive method to save list node data to loop through all corresponding child nodes.
619
620Security Notes
621--------------
622
623*Fixed Security Issues*
624
625 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
shivasubedi44beaa32021-09-13 15:16:30 +0100626
627*Known Security Issues*
628
lukegleeson9c583712021-09-30 17:21:11 +0100629 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
630
shivasubedi44beaa32021-09-13 15:16:30 +0100631Test Results
632------------
633 * `Integration tests`
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000634
ToineSiebelinkf0527c52021-07-06 13:03:03 +0100635.. ========================
636.. * * * HONOLULU * * *
637.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000638
ToineSiebelinkfd2134d2021-04-09 11:15:48 +0100639Version: 1.0.1
640==============
641
642Release Data
643------------
644
645+--------------------------------------+--------------------------------------------------------+
646| **CPS Project** | |
647| | |
648+--------------------------------------+--------------------------------------------------------+
649| **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
650| | |
651+--------------------------------------+--------------------------------------------------------+
652| **Release designation** | 1.0.1 Honolulu |
653| | |
654+--------------------------------------+--------------------------------------------------------+
655| **Release date** | 2021-04-09 |
656| | |
657+--------------------------------------+--------------------------------------------------------+
658
659Bug Fixes
660---------
661
puthuparambil.aditya8b584332021-10-12 16:49:03 +0100662 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
ToineSiebelinkfd2134d2021-04-09 11:15:48 +0100663 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
664 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
665 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
666 - `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
667 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
668 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
669 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
670
671Security Notes
672--------------
673
674*Fixed Security Issues*
675
676 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000677
ToineSiebelinka2d25b52021-04-13 15:10:47 +0100678*Known Security Issues*
679
680 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
681
Rishi.Chail4359d282021-03-03 16:36:26 +0000682Version: 1.0.0
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000683==============
684
685
686Abstract
687--------
688
689This document provides the release notes for Honolulu release.
690
691Summary
692-------
693
694Following CPS components are available with default ONAP/CPS installation.
695
696
Rishi.Chail4359d282021-03-03 16:36:26 +0000697 * Platform components
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000698
Rishi.Chail4359d282021-03-03 16:36:26 +0000699 - CPS (Helm charts)
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000700
Rishi.Chail4359d282021-03-03 16:36:26 +0000701 * Service components
702
703 - CPS Core
704
705 * Additional resources that CPS utilizes deployed using ONAP common charts
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000706
707 - Postgres Database
708
709
Rishi.Chail4359d282021-03-03 16:36:26 +0000710Below service components (mS) are available to be deployed on-demand.
711 - CPS-TBDMT
712
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000713
714Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
715
716
717Release Data
718------------
719
720+--------------------------------------+--------------------------------------------------------+
721| **CPS Project** | |
722| | |
723+--------------------------------------+--------------------------------------------------------+
724| **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
725| | |
726+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +0000727| **Release designation** | 1.0.0 Honolulu |
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000728| | |
729+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +0000730| **Release date** | 2021-03-11 |
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000731| | |
732+--------------------------------------+--------------------------------------------------------+
733
734
735Features
736--------
Rishi.Chail4359d282021-03-03 16:36:26 +0000737Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
738CPS has been driven by the needs of the E2E Networking Slicing use case.
739It currently supports basic (rw) persistence and simple queries.
740It also provides MVP support for network data access using simulated data.
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000741
742.. _honolulu_deliverable:
743
744Deliverables
745------------
746
747Software Deliverables
748
749.. csv-table::
750 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
751 :widths: auto
752
Rishi.Chail4359d282021-03-03 16:36:26 +0000753 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000754
755
756Known Limitations, Issues and Workarounds
757-----------------------------------------
758
Rishi.Chail4359d282021-03-03 16:36:26 +0000759 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
760 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
761 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
niamhcoredddf7312021-06-21 14:44:01 +0100762 - `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 +0000763
764*System Limitations*
765
766None
767
768*Known Vulnerabilities*
769
770None
771
772*Workarounds*
773
774Documented under corresponding jira if applicable.
775
776Security Notes
777--------------
778
779*Fixed Security Issues*
ToineSiebelink7c981df2021-03-01 09:53:56 +0000780
781* `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
Rishi.Chail4359d282021-03-03 16:36:26 +0000782 - Upgrade org.onap.oparent to 3.2.0
ToineSiebelink7c981df2021-03-01 09:53:56 +0000783 - Upgrade spring.boot to 2.3.8.RELEASE
Rishi.Chail4359d282021-03-03 16:36:26 +0000784 - Upgrade yangtools to 5.0.7
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000785
786*Known Security Issues*
787
Rishi.Chail4359d282021-03-03 16:36:26 +0000788 * Weak Crytography using md5
789 * Risk seen in Zip file expansion
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000790
791*Known Vulnerabilities in Used Modules*
792
Rishi.Chail4359d282021-03-03 16:36:26 +0000793 None
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000794
Rishi.Chail4359d282021-03-03 16:36:26 +0000795CPS 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 +0000796
797Test Results
798------------
Rishi.Chail4359d282021-03-03 16:36:26 +0000799 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000800
801References
802----------
803
804For more information on the ONAP Honolulu release, please see:
805
806#. `ONAP Home Page`_
807#. `ONAP Documentation`_
808#. `ONAP Release Downloads`_
809#. `ONAP Wiki Page`_
810
811
812.. _`ONAP Home Page`: https://www.onap.org
813.. _`ONAP Wiki Page`: https://wiki.onap.org
814.. _`ONAP Documentation`: https://docs.onap.org
815.. _`ONAP Release Downloads`: https://git.onap.org
816
817Quick Links:
818
819 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
820 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_