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