Gitiles
Code Review Sign In
gerrit.nordix.org / onap / cps / 3be9924d32df7526d19cf278dfb7ae0e156a9364 / . / docs / release-notes.rst
blob: aec3f3b1f2087b68facef7fddaf4d907f12b7657 [file] [log] [blame]
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
JosephKeenane0643ab2022-02-15 18:23:05 +0000[diff] [blame]3.. Copyright (C) 2021-2022 Nordix Foundation
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]4
5.. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
6.. _release_notes:
7
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]8CPS Release Notes
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400[diff] [blame]9#################
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]10
11.. contents::
12 :depth: 2
13..
14
lukegleeson3be99242022-10-11 14:34:56 +0100[diff] [blame^]15.. ======================
16.. * * * LONDON * * *
17.. ======================
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]18
lukegleeson3be99242022-10-11 14:34:56 +0100[diff] [blame^]19Version: 3.2.0 (not yet released)
mpriyank4bd450e2022-10-05 09:50:59 +0100[diff] [blame]20=================================
21
22Release Data
23------------
24
25+--------------------------------------+--------------------------------------------------------+
26| **CPS Project** | |
27| | |
28+--------------------------------------+--------------------------------------------------------+
lukegleeson3be99242022-10-11 14:34:56 +0100[diff] [blame^]29| **Docker images** | onap/cps-and-ncmp:3.2.0 |
mpriyank4bd450e2022-10-05 09:50:59 +0100[diff] [blame]30| | |
31+--------------------------------------+--------------------------------------------------------+
lukegleeson3be99242022-10-11 14:34:56 +0100[diff] [blame^]32| **Release designation** | 3.2.0 London |
mpriyank4bd450e2022-10-05 09:50:59 +0100[diff] [blame]33| | |
34+--------------------------------------+--------------------------------------------------------+
35| **Release date** | (not yet released) |
36| | |
37+--------------------------------------+--------------------------------------------------------+
lukegleeson3be99242022-10-11 14:34:56 +0100[diff] [blame^]38Features
39--------
40 - `CPS-1185 <https://jira.onap.org/browse/CPS-1185>`_ Get all dataspaces
41 - `CPS-1186 <https://jira.onap.org/browse/CPS-1186>`_ Get all schema sets for a dataspace
42 - `CPS-1187 <https://jira.onap.org/browse/CPS-1187>`_ Get single dataspace
43 - `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 +0100[diff] [blame]44
45Bug Fixes
46---------
lukegleeson984d1f22022-10-04 16:07:37 +0100[diff] [blame]47 - `CPS-1312 <https://jira.onap.org/browse/CPS-1312>`_ CPS(/NCMP) does not have version control
mpriyank4bd450e2022-10-05 09:50:59 +0100[diff] [blame]48
lukegleeson3be99242022-10-11 14:34:56 +0100[diff] [blame^]49Known Limitations, Issues and Workarounds
50-----------------------------------------
51
52*System Limitations*
53
54For upgrading, CPS uses Liquibase for database upgrades. CPS currently only supports upgrading from Liquibase changelog 11 to Liquibase changelog 16.
55This 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 London.
56
mpriyankfe775312022-09-30 14:16:51 +0100[diff] [blame]57Version: 3.1.4
58==============
59
60Release Data
61------------
62
63+--------------------------------------+--------------------------------------------------------+
64| **CPS Project** | |
65| | |
66+--------------------------------------+--------------------------------------------------------+
67| **Docker images** | onap/cps-and-ncmp:3.1.4 |
68| | |
69+--------------------------------------+--------------------------------------------------------+
70| **Release designation** | 3.1.4 Kohn |
71| | |
72+--------------------------------------+--------------------------------------------------------+
mpriyank4bd450e2022-10-05 09:50:59 +0100[diff] [blame]73| **Release date** | 2022 October 5 |
mpriyankfe775312022-09-30 14:16:51 +0100[diff] [blame]74| | |
75+--------------------------------------+--------------------------------------------------------+
76
77Bug Fixes
78---------
lukegleeson8c6b5622022-09-29 15:58:06 +0100[diff] [blame]79 - `CPS-1265 <https://jira.onap.org/browse/CPS-1265>`_ Revision field should not be required (NotNull) on cps-ri YangResourceEntity
mpriyankac0bffc2022-10-03 12:26:10 +0100[diff] [blame]80 - `CPS-1294 <https://jira.onap.org/browse/CPS-1294>`_ Kafka communication fault caused cmHandle registration error
mpriyankfe775312022-09-30 14:16:51 +0100[diff] [blame]81
mpriyank06736cb2022-09-29 14:29:40 +0100[diff] [blame]82Version: 3.1.3
83==============
84
85Release Data
86------------
87
88+--------------------------------------+--------------------------------------------------------+
89| **CPS Project** | |
90| | |
91+--------------------------------------+--------------------------------------------------------+
92| **Docker images** | onap/cps-and-ncmp:3.1.3 |
93| | |
94+--------------------------------------+--------------------------------------------------------+
95| **Release designation** | 3.1.3 Kohn |
96| | |
97+--------------------------------------+--------------------------------------------------------+
mpriyankfe775312022-09-30 14:16:51 +0100[diff] [blame]98| **Release date** | 2022 September 29 |
mpriyank06736cb2022-09-29 14:29:40 +0100[diff] [blame]99| | |
100+--------------------------------------+--------------------------------------------------------+
101
102Bug Fixes
103---------
104 - None
105
mpriyankef0ddfc2022-09-28 12:19:34 +0100[diff] [blame]106Version: 3.1.2
107==============
108
109Release Data
110------------
111
112+--------------------------------------+--------------------------------------------------------+
113| **CPS Project** | |
114| | |
115+--------------------------------------+--------------------------------------------------------+
116| **Docker images** | onap/cps-and-ncmp:3.1.2 |
117| | |
118+--------------------------------------+--------------------------------------------------------+
119| **Release designation** | 3.1.2 Kohn |
120| | |
121+--------------------------------------+--------------------------------------------------------+
mpriyank06736cb2022-09-29 14:29:40 +0100[diff] [blame]122| **Release date** | 2022 September 28 |
mpriyankef0ddfc2022-09-28 12:19:34 +0100[diff] [blame]123| | |
124+--------------------------------------+--------------------------------------------------------+
125
126Bug Fixes
127---------
128 - None
129
mpriyanka3f43502022-09-26 14:57:01 +0100[diff] [blame]130Version: 3.1.1
131==============
132
133Release Data
134------------
135
136+--------------------------------------+--------------------------------------------------------+
137| **CPS Project** | |
138| | |
139+--------------------------------------+--------------------------------------------------------+
140| **Docker images** | onap/cps-and-ncmp:3.1.1 |
141| | |
142+--------------------------------------+--------------------------------------------------------+
143| **Release designation** | 3.1.1 Kohn |
144| | |
145+--------------------------------------+--------------------------------------------------------+
mpriyankef0ddfc2022-09-28 12:19:34 +0100[diff] [blame]146| **Release date** | 2022 September 28 |
mpriyanka3f43502022-09-26 14:57:01 +0100[diff] [blame]147| | |
148+--------------------------------------+--------------------------------------------------------+
149
150Bug Fixes
151---------
152 - None
153
lukegleesonc9ec9152022-09-07 14:21:36 +0100[diff] [blame]154Security Notes
155--------------
156
157*Fixed Security Issues*
158
159 - `CPS-1226 <https://jira.onap.org/browse/CPS-1226>`_ Security bug in the logs
160
lukegleeson4a34fa52022-09-19 15:31:59 +0100[diff] [blame]161Version: 3.1.0
162==============
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400[diff] [blame]163
164Release Data
165------------
166
DylanB95ESTb130fd32022-04-04 13:09:22 +0100[diff] [blame]167+--------------------------------------+--------------------------------------------------------+
168| **CPS Project** | |
169| | |
170+--------------------------------------+--------------------------------------------------------+
171| **Docker images** | onap/cps-and-ncmp:3.1.0 |
172| | |
173+--------------------------------------+--------------------------------------------------------+
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400[diff] [blame]174| **Release designation** | 3.1.0 Kohn |
DylanB95ESTb130fd32022-04-04 13:09:22 +0100[diff] [blame]175| | |
176+--------------------------------------+--------------------------------------------------------+
lukegleeson4a34fa52022-09-19 15:31:59 +0100[diff] [blame]177| **Release date** | 2022 September 14 |
DylanB95ESTb130fd32022-04-04 13:09:22 +0100[diff] [blame]178| | |
179+--------------------------------------+--------------------------------------------------------+
180
181Features
182--------
lukegleeson4a34fa52022-09-19 15:31:59 +0100[diff] [blame]183 - `CPS-340 <https://jira.onap.org/browse/CPS-340>`_ Patch and update the root data node
184 - `CPS-575 <https://jira.onap.org/browse/CPS-575>`_ Write data for cmHandle using ncmp-datastores:passthrough-running (NCMP.)
185 - `CPS-731 <https://jira.onap.org/browse/CPS-731>`_ Query based on Public CM Properties
186 - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_ Async: NCMP Rest impl. including Request ID generation
187 - `CPS-829 <https://jira.onap.org/browse/CPS-829>`_ Async: Internal message topic incl. basic producer & Consumer
188 - `CPS-830 <https://jira.onap.org/browse/CPS-830>`_ DMI-NCMP Asynchronously Publish Response Event to Client Topic
189 - `CPS-869 <https://jira.onap.org/browse/CPS-869>`_ Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072
190 - `CPS-870 <https://jira.onap.org/browse/CPS-870>`_ Align CPS-Core output with SDN-C output (add module name)
191 - `CPS-875 <https://jira.onap.org/browse/CPS-875>`_ CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles
192 - `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'
193 - `CPS-899 <https://jira.onap.org/browse/CPS-899>`_ Start and stop sessions on Java API
194 - `CPS-909 <https://jira.onap.org/browse/CPS-909>`_ Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state
195 - `CPS-917 <https://jira.onap.org/browse/CPS-917>`_ Structured Errors response for passthrough use-cases in NCMP
196 - `CPS-953 <https://jira.onap.org/browse/CPS-953>`_ Update maven deploy plugin version
197 - `CPS-977 <https://jira.onap.org/browse/CPS-977>`_ Query CM Handles using CpsPath
198 - `CPS-1000 <https://jira.onap.org/browse/CPS-1000>`_ Create Data Synchronization watchdog
199 - `CPS-1016 <https://jira.onap.org/browse/CPS-1016>`_ Merge 2 'query' end points in NCMP
200 - `CPS-1034 <https://jira.onap.org/browse/CPS-1034>`_ Publish lifecycle events for ADVISED , READY and LOCKED state transition"
201 - `CPS-1064 <https://jira.onap.org/browse/CPS-1064>`_ Support retrieval of YANG module sources for CM handle on the NCMP interface
202 - `CPS-1099 <https://jira.onap.org/browse/CPS-1099>`_ Expose simplified 'external' lock reason enum state over REST interface
203 - `CPS-1101 <https://jira.onap.org/browse/CPS-1101>`_ Introducing the DELETING and DELETED Cmhandle State
204 - `CPS-1102 <https://jira.onap.org/browse/CPS-1102>`_ Register the Cmhandle Sends Advised State notification.
205 - `CPS-1133 <https://jira.onap.org/browse/CPS-1133>`_ Enable/Disable Data Sync for Cm Handle
206 - `CPS-1136 <https://jira.onap.org/browse/CPS-1136>`_ DMI Audit Support (get all CM Handles for a registered DMI)
207
emacleeafb17362022-09-02 14:40:17 +0100[diff] [blame]208
209Bug Fixes
210---------
lukegleeson4a34fa52022-09-19 15:31:59 +0100[diff] [blame]211 - `CPS-896 <https://jira.onap.org/browse/CPS-896>`_ CM Handle Registration Process only partially completes when exception is thrown
212 - `CPS-957 <https://jira.onap.org/browse/CPS-957>`_ NCMP: fix getResourceDataForPassthroughOperational endpoint
213 - `CPS-1020 <https://jira.onap.org/browse/CPS-1020>`_ DuplicatedYangResourceException error at parallel cmHandle registration
214 - `CPS-1056 <https://jira.onap.org/browse/CPS-1056>`_ Wrong error response format in case of Dmi plugin error
215 - `CPS-1067 <https://jira.onap.org/browse/CPS-1067>`_ NCMP returns 500 error on searches endpoint when No DMi Handles registered
216 - `CPS-1085 <https://jira.onap.org/browse/CPS-1085>`_ Performance degradation on ncmp/v1/ch/searches endpoint
217 - `CPS-1088 <https://jira.onap.org/browse/CPS-1088>`_ Kafka consumer can not be turned off
218 - `CPS-1097 <https://jira.onap.org/browse/CPS-1097>`_ Unable to change state from LOCKED to ADVISED
219 - `CPS-1126 <https://jira.onap.org/browse/CPS-1126>`_ CmHandle creation performance degradation
220 - `CPS-1175 <https://jira.onap.org/browse/CPS-1175>`_ Incorrect response when empty body executed for cmhandle id-searches
221 - `CPS-1179 <https://jira.onap.org/browse/CPS-1179>`_ Node API - GET method returns invalid response when identifier contains '/'
222 - `CPS-1212 <https://jira.onap.org/browse/CPS-1212>`_ Additional Properties for CM Handles not included when send to DMI Plugin
223 - `CPS-1217 <https://jira.onap.org/browse/CPS-1217>`_ Searches endpoint gives back empty list however there are already available cmhandles
224 - `CPS-1218 <https://jira.onap.org/browse/CPS-1218>`_ NCMP logs are flooded with SyncUtils logs
puthuparambil.adityadd904322022-09-21 10:53:51 +0100[diff] [blame]225
226Known Limitations, Issues and Workarounds
227-----------------------------------------
228
229*System Limitations*
230
231Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition.
232Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces']
DylanB95ESTb130fd32022-04-04 13:09:22 +0100[diff] [blame]233
lukegleeson4a34fa52022-09-19 15:31:59 +0100[diff] [blame]234*Known Vulnerabilities*
235
236None
237
238*Workarounds*
239
240None
241
242Security Notes
243--------------
244
245*Fixed Security Issues*
246
247 - `CPS-963 <https://jira.onap.org/browse/CPS-963>`_ Liquibase has got serious vulnerability, upgrade required
248
249*Known Security Issues*
250
251None
252
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400[diff] [blame]253.. ========================
254.. * * * JAKARTA * * *
255.. ========================
256
257Version: 3.0.1
258==============
259
260Release Data
261------------
262
263+--------------------------------------+--------------------------------------------------------+
264| **CPS Project** | |
265| | |
266+--------------------------------------+--------------------------------------------------------+
267| **Docker images** | onap/cps-and-ncmp:3.0.1 |
268| | |
269+--------------------------------------+--------------------------------------------------------+
270| **Release designation** | 3.0.1 Jakarta |
271| | |
272+--------------------------------------+--------------------------------------------------------+
273| **Release date** | 2022 April 28 |
274| | |
275+--------------------------------------+--------------------------------------------------------+
276
277Bug Fixes
278---------
279 - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_ Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
280
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400[diff] [blame]281Version: 3.0.0
282==============
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]283
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400[diff] [blame]284Release Data
285------------
286
287+--------------------------------------+--------------------------------------------------------+
288| **CPS Project** | |
289| | |
290+--------------------------------------+--------------------------------------------------------+
291| **Docker images** | onap/cps-and-ncmp:3.0.0 |
292| | |
293+--------------------------------------+--------------------------------------------------------+
294| **Release designation** | 3.0.0 Jakarta |
295| | |
296+--------------------------------------+--------------------------------------------------------+
297| **Release date** | 2022 March 15 |
298| | |
299+--------------------------------------+--------------------------------------------------------+
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]300
301Features
302--------
puthuparambil.adityad0007332021-12-08 18:53:39 +0000[diff] [blame]303 - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_ Define response objects (schemas) in cps-ncmp
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]304 - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_ Update operation for datastore pass through running
305 - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_ Delete operation for datastore pass through running
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame]306 - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_ Support 'public' Cm Handle Properties
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]307 - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
JosephKeenan82ebf532021-12-08 18:16:44 +0000[diff] [blame]308 - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_ Ensure all DMI operations use POST method
puthuparambil.adityad0007332021-12-08 18:53:39 +0000[diff] [blame]309 - `CPS-780 <https://jira.onap.org/browse/CPS-780>`_ Add examples for parameters, request and response in openapi yaml for cps-core
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400[diff] [blame]310 - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
311 - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame]312 - `CPS-817 <https://jira.onap.org/browse/CPS-817>`_ Create Endpoint For Get Cm Handles (incl. public properties) By Name
mpriyank80dee972022-02-23 15:17:23 +0530[diff] [blame]313 - `CPS-837 <https://jira.onap.org/browse/CPS-837>`_ Add Remove and Update properties (DMI and Public) as part of CM Handle Registration update
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]314
315Bug Fixes
316---------
317
318 - `CPS-762 <https://jira.onap.org/browse/CPS-762>`_ Query cm handles for module names returns incorrect cm handle identifiers
ToineSiebelink3f142302021-12-07 11:30:10 +0000[diff] [blame]319 - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
niamhcore65bc4fd2021-12-08 14:19:02 +0000[diff] [blame]320 - `CPS-783 <https://jira.onap.org/browse/CPS-783>`_ Remove cm handle does not completely remove all cm handle information
puthuparambil.aditya71395fb2022-01-05 13:39:31 +0000[diff] [blame]321 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM
puthuparambil.aditya62ac0c32022-02-03 16:42:13 +0000[diff] [blame]322 - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
JosephKeenane0643ab2022-02-15 18:23:05 +0000[diff] [blame]323 - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame]324 - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
JosephKeenane0643ab2022-02-15 18:23:05 +0000[diff] [blame]325 - `CPS-887 <https://jira.onap.org/browse/CPS-887>`_ Increase performance of cmHandle registration for large number of schema sets in DB
mpriyank80dee972022-02-23 15:17:23 +0530[diff] [blame]326 - `CPS-892 <https://jira.onap.org/browse/CPS-892>`_ Fixed the response code during CM-Handle Registration from 201 CREATED to 204 NO_CONTENT
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame]327 - `CPS-893 <https://jira.onap.org/browse/CPS-893>`_ NCMP Java API depends on NCM-Rest-API (cyclic) through json properties on Java API
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]328
329Known Limitations, Issues and Workarounds
330-----------------------------------------
331
332*System Limitations*
333
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame]334Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
335`CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
336of cm handle registration.
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]337
Lathishb3550f12022-03-15 12:03:53 +0000[diff] [blame]338The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
339for more information.
340
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]341*Known Vulnerabilities*
342
343None
344
345*Workarounds*
346
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame]347Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
348pass an empty string as the value if you do not want to include names for these values.
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]349
350Security Notes
351--------------
352
353*Fixed Security Issues*
354
355None
356
357*Known Security Issues*
358
359None
360
361.. ========================
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]362.. * * * ISTANBUL * * *
363.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]364
Bruno Sakoto0eaf3342022-02-11 15:05:29 -0500[diff] [blame]365Version: 2.0.4
366==============
367
368Release Data
369------------
370
371+--------------------------------------+--------------------------------------------------------+
372| **CPS Project** | |
373| | |
374+--------------------------------------+--------------------------------------------------------+
375| **Docker images** | onap/cps-and-ncmp:2.0.4 |
376| | |
377+--------------------------------------+--------------------------------------------------------+
378| **Release designation** | 2.0.4 Istanbul |
379| | |
380+--------------------------------------+--------------------------------------------------------+
381| **Release date** | 2022 Feb 09 |
382| | |
383+--------------------------------------+--------------------------------------------------------+
384
385Bug Fixes
386---------
387
388 - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_ Fix docker compose for csit test.
389 - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_ Fix intermittent circular dependency error when the application starts.
390
391Version: 2.0.3
392==============
393
394Release Data
395------------
396
397+--------------------------------------+--------------------------------------------------------+
398| **CPS Project** | |
399| | |
400+--------------------------------------+--------------------------------------------------------+
401| **Docker images** | onap/cps-and-ncmp:2.0.3 |
402| | |
403+--------------------------------------+--------------------------------------------------------+
404| **Release designation** | 2.0.3 Istanbul |
405| | |
406+--------------------------------------+--------------------------------------------------------+
407| **Release date** | 2022-07-01 |
408| | |
409+--------------------------------------+--------------------------------------------------------+
410
411Bug Fixes
412---------
413
414 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
415
416Version: 2.0.2
417==============
418
419Release Data
420------------
421
422+--------------------------------------+--------------------------------------------------------+
423| **CPS Project** | |
424| | |
425+--------------------------------------+--------------------------------------------------------+
426| **Docker images** | onap/cps-and-ncmp:2.0.2 |
427| | |
428+--------------------------------------+--------------------------------------------------------+
429| **Release designation** | 2.0.2 Istanbul |
430| | |
431+--------------------------------------+--------------------------------------------------------+
432| **Release date** | 2021-16-12 |
433| | |
434+--------------------------------------+--------------------------------------------------------+
435
436Bug Fixes
437---------
438
439 - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_ Update log4j version due to security vulnerability
440
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]441Version: 2.0.1
442==============
443
444Release Data
445------------
446
447+--------------------------------------+--------------------------------------------------------+
448| **CPS Project** | |
449| | |
450+--------------------------------------+--------------------------------------------------------+
451| **Docker images** | onap/cps-and-ncmp:2.0.1 |
452| | |
453+--------------------------------------+--------------------------------------------------------+
454| **Release designation** | 2.0.1 Istanbul |
455| | |
456+--------------------------------------+--------------------------------------------------------+
457| **Release date** | 2021-14-10 |
458| | |
459+--------------------------------------+--------------------------------------------------------+
460
461Bug Fixes
462---------
463
464 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
465 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
466 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
467 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
468
469Known Limitations, Issues and Workarounds
470-----------------------------------------
471
472*System Limitations*
473
474Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
475
476*Known Vulnerabilities*
477
478 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
479
480*Workarounds*
481
482Add recursive method to save list node data to loop through all corresponding child nodes.
483
484Security Notes
485--------------
486
487*Fixed Security Issues*
488
489 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
490
491*Known Security Issues*
492
493None
494
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]495Version: 2.0.0
496==============
497
498Abstract
499--------
500
501This document provides the release notes for Istanbul release.
502
503Release Data
504------------
505
506+--------------------------------------+--------------------------------------------------------+
507| **CPS Project** | |
508| | |
509+--------------------------------------+--------------------------------------------------------+
510| **Docker images** | onap/cps-and-ncmp:2.0.0 |
511| | |
512+--------------------------------------+--------------------------------------------------------+
513| **Release designation** | 2.0.0 Istanbul |
514| | |
515+--------------------------------------+--------------------------------------------------------+
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]516| **Release date** | 2021-14-09 |
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]517| | |
518+--------------------------------------+--------------------------------------------------------+
519
520Features
521--------
DylanB95EST3fcf8692021-10-11 16:29:16 +0100[diff] [blame]522* Register DMI-Plugins with NCMP for CM Handle registrations.
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]523* Update, Create and Remove CM Handles.
524* Add support for retrieving and writing CM Handle data through NCMP datastores.
525* Automatic retrieval and caching of model information for CM Handles within NCMP.
526
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]527Deliverables
528------------
529
530Software Deliverables
531
532.. csv-table::
533 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
534 :widths: auto
535
536 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
537
538Bug Fixes
539---------
540
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]541 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]542 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
543 - `CPS-336 <https://jira.onap.org/browse/CPS-336>`_ Ends-with functionality in cpsPath does not conform with standard xPath behavior
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]544 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
545 - `CPS-357 <https://jira.onap.org/browse/CPS-357>`_ cps-review-verification-maven-master Jenkins job is failing when running csit test
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]546 - `CPS-367 <https://jira.onap.org/browse/CPS-367>`_ Get descendent does not support xpaths that end in list values
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]547 - `CPS-377 <https://jira.onap.org/browse/CPS-377>`_ Init ran model validation is failing error details are not provided
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]548 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
549 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]550 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
551 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
552 - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ Request to update node leaves (patch) responds with json parsing failure
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]553 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
554 - `CPS-479 <https://jira.onap.org/browse/CPS-479>`_ Get Nodes API does not always return the object from the root
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]555 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]556 - `CPS-501 <https://jira.onap.org/browse/CPS-501>`_ Put DataNode API has missing transaction and error handling for concurrency issues
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]557 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
558 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
559 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]560 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
561 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
562 - `CPS-591 <https://jira.onap.org/browse/CPS-591>`_ CPS-Core Leaf stored as integer is being returned from DB as float
Bruno Sakoto0eaf3342022-02-11 15:05:29 -0500[diff] [blame]563 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]564 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
565 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
566 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]567
568This document provides the release notes for Istanbul release.
569
570Summary
571-------
572
573Following CPS components are available with default ONAP/CPS installation.
574
575
576 * Platform components
577
578 - CPS (Helm charts)
579
580 * Service components
581
DylanB95EST3fcf8692021-10-11 16:29:16 +0100[diff] [blame]582 - CPS-NCMP
583 - CPS-Temporal
584 - DMI-Plugin
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]585
586 * Additional resources that CPS utilizes deployed using ONAP common charts
587
588 - Postgres Database
589
590
591Below service components (mS) are available to be deployed on-demand.
592 - CPS-TBDMT
593
594
595Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
596
597Known Limitations, Issues and Workarounds
598-----------------------------------------
599
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]600*System Limitations*
601
602Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
603
604*Known Vulnerabilities*
605
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]606 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
607 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
608 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]609
610*Workarounds*
611
612Add recursive method to save list node data to loop through all corresponding child nodes.
613
614Security Notes
615--------------
616
617*Fixed Security Issues*
618
619 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]620
621*Known Security Issues*
622
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]623 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
624
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]625Test Results
626------------
627 * `Integration tests`
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]628
ToineSiebelinkf0527c52021-07-06 13:03:03 +0100[diff] [blame]629.. ========================
630.. * * * HONOLULU * * *
631.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]632
ToineSiebelinkfd2134d2021-04-09 11:15:48 +0100[diff] [blame]633Version: 1.0.1
634==============
635
636Release Data
637------------
638
639+--------------------------------------+--------------------------------------------------------+
640| **CPS Project** | |
641| | |
642+--------------------------------------+--------------------------------------------------------+
643| **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
644| | |
645+--------------------------------------+--------------------------------------------------------+
646| **Release designation** | 1.0.1 Honolulu |
647| | |
648+--------------------------------------+--------------------------------------------------------+
649| **Release date** | 2021-04-09 |
650| | |
651+--------------------------------------+--------------------------------------------------------+
652
653Bug Fixes
654---------
655
puthuparambil.aditya8b584332021-10-12 16:49:03 +0100[diff] [blame]656 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
ToineSiebelinkfd2134d2021-04-09 11:15:48 +0100[diff] [blame]657 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
658 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
659 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
660 - `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
661 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
662 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
663 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
664
665Security Notes
666--------------
667
668*Fixed Security Issues*
669
670 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]671
ToineSiebelinka2d25b52021-04-13 15:10:47 +0100[diff] [blame]672*Known Security Issues*
673
674 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
675
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]676Version: 1.0.0
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]677==============
678
679
680Abstract
681--------
682
683This document provides the release notes for Honolulu release.
684
685Summary
686-------
687
688Following CPS components are available with default ONAP/CPS installation.
689
690
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]691 * Platform components
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]692
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]693 - CPS (Helm charts)
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]694
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]695 * Service components
696
697 - CPS Core
698
699 * Additional resources that CPS utilizes deployed using ONAP common charts
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]700
701 - Postgres Database
702
703
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]704Below service components (mS) are available to be deployed on-demand.
705 - CPS-TBDMT
706
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]707
708Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
709
710
711Release Data
712------------
713
714+--------------------------------------+--------------------------------------------------------+
715| **CPS Project** | |
716| | |
717+--------------------------------------+--------------------------------------------------------+
718| **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
719| | |
720+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]721| **Release designation** | 1.0.0 Honolulu |
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]722| | |
723+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]724| **Release date** | 2021-03-11 |
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]725| | |
726+--------------------------------------+--------------------------------------------------------+
727
728
729Features
730--------
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]731Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
732CPS has been driven by the needs of the E2E Networking Slicing use case.
733It currently supports basic (rw) persistence and simple queries.
734It also provides MVP support for network data access using simulated data.
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]735
736.. _honolulu_deliverable:
737
738Deliverables
739------------
740
741Software Deliverables
742
743.. csv-table::
744 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
745 :widths: auto
746
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]747 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]748
749
750Known Limitations, Issues and Workarounds
751-----------------------------------------
752
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]753 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
754 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
755 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
niamhcoredddf7312021-06-21 14:44:01 +0100[diff] [blame]756 - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ & `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Update data node leaves API does not support updating a list element with compound keys.
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]757
758*System Limitations*
759
760None
761
762*Known Vulnerabilities*
763
764None
765
766*Workarounds*
767
768Documented under corresponding jira if applicable.
769
770Security Notes
771--------------
772
773*Fixed Security Issues*
ToineSiebelink7c981df2021-03-01 09:53:56 +0000[diff] [blame]774
775* `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]776 - Upgrade org.onap.oparent to 3.2.0
ToineSiebelink7c981df2021-03-01 09:53:56 +0000[diff] [blame]777 - Upgrade spring.boot to 2.3.8.RELEASE
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]778 - Upgrade yangtools to 5.0.7
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]779
780*Known Security Issues*
781
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]782 * Weak Crytography using md5
783 * Risk seen in Zip file expansion
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]784
785*Known Vulnerabilities in Used Modules*
786
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]787 None
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]788
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]789CPS code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive.
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]790
791Test Results
792------------
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]793 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]794
795References
796----------
797
798For more information on the ONAP Honolulu release, please see:
799
800#. `ONAP Home Page`_
801#. `ONAP Documentation`_
802#. `ONAP Release Downloads`_
803#. `ONAP Wiki Page`_
804
805
806.. _`ONAP Home Page`: https://www.onap.org
807.. _`ONAP Wiki Page`: https://wiki.onap.org
808.. _`ONAP Documentation`: https://docs.onap.org
809.. _`ONAP Release Downloads`: https://git.onap.org
810
811Quick Links:
812
813 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
814 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_