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