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