blob: b2f5e68b761e92a5ae9fcd8a4386e04c248b2806 [file] [log] [blame]
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
JosephKeenane0643ab2022-02-15 18:23:05 +00003.. Copyright (C) 2021-2022 Nordix Foundation
ToineSiebelinkb87f3232021-02-26 12:05:30 +00004
5.. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
6.. _release_notes:
7
ToineSiebelinkb87f3232021-02-26 12:05:30 +00008CPS Release Notes
Bruno Sakotoa1129b62022-03-15 08:09:07 -04009#################
ToineSiebelinkb87f3232021-02-26 12:05:30 +000010
11.. contents::
12 :depth: 2
13..
14
Bruno Sakoto9c3541e2022-06-15 07:57:42 -040015.. ====================
16.. * * * KOHN * * *
17.. ====================
niamhcoref7b414e2021-11-17 11:02:07 +000018
mpriyank06736cb2022-09-29 14:29:40 +010019Version: 3.1.3
20==============
21
22Release Data
23------------
24
25+--------------------------------------+--------------------------------------------------------+
26| **CPS Project** | |
27| | |
28+--------------------------------------+--------------------------------------------------------+
29| **Docker images** | onap/cps-and-ncmp:3.1.3 |
30| | |
31+--------------------------------------+--------------------------------------------------------+
32| **Release designation** | 3.1.3 Kohn |
33| | |
34+--------------------------------------+--------------------------------------------------------+
35| **Release date** | (yet to release) |
36| | |
37+--------------------------------------+--------------------------------------------------------+
38
39Bug Fixes
40---------
41 - None
42
mpriyankef0ddfc2022-09-28 12:19:34 +010043Version: 3.1.2
44==============
45
46Release Data
47------------
48
49+--------------------------------------+--------------------------------------------------------+
50| **CPS Project** | |
51| | |
52+--------------------------------------+--------------------------------------------------------+
53| **Docker images** | onap/cps-and-ncmp:3.1.2 |
54| | |
55+--------------------------------------+--------------------------------------------------------+
56| **Release designation** | 3.1.2 Kohn |
57| | |
58+--------------------------------------+--------------------------------------------------------+
mpriyank06736cb2022-09-29 14:29:40 +010059| **Release date** | 2022 September 28 |
mpriyankef0ddfc2022-09-28 12:19:34 +010060| | |
61+--------------------------------------+--------------------------------------------------------+
62
63Bug Fixes
64---------
65 - None
66
mpriyanka3f43502022-09-26 14:57:01 +010067Version: 3.1.1
68==============
69
70Release Data
71------------
72
73+--------------------------------------+--------------------------------------------------------+
74| **CPS Project** | |
75| | |
76+--------------------------------------+--------------------------------------------------------+
77| **Docker images** | onap/cps-and-ncmp:3.1.1 |
78| | |
79+--------------------------------------+--------------------------------------------------------+
80| **Release designation** | 3.1.1 Kohn |
81| | |
82+--------------------------------------+--------------------------------------------------------+
mpriyankef0ddfc2022-09-28 12:19:34 +010083| **Release date** | 2022 September 28 |
mpriyanka3f43502022-09-26 14:57:01 +010084| | |
85+--------------------------------------+--------------------------------------------------------+
86
87Bug Fixes
88---------
89 - None
90
lukegleesonc9ec9152022-09-07 14:21:36 +010091Security Notes
92--------------
93
94*Fixed Security Issues*
95
96 - `CPS-1226 <https://jira.onap.org/browse/CPS-1226>`_ Security bug in the logs
97
lukegleeson4a34fa52022-09-19 15:31:59 +010098Version: 3.1.0
99==============
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400100
101Release Data
102------------
103
DylanB95ESTb130fd32022-04-04 13:09:22 +0100104+--------------------------------------+--------------------------------------------------------+
105| **CPS Project** | |
106| | |
107+--------------------------------------+--------------------------------------------------------+
108| **Docker images** | onap/cps-and-ncmp:3.1.0 |
109| | |
110+--------------------------------------+--------------------------------------------------------+
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400111| **Release designation** | 3.1.0 Kohn |
DylanB95ESTb130fd32022-04-04 13:09:22 +0100112| | |
113+--------------------------------------+--------------------------------------------------------+
lukegleeson4a34fa52022-09-19 15:31:59 +0100114| **Release date** | 2022 September 14 |
DylanB95ESTb130fd32022-04-04 13:09:22 +0100115| | |
116+--------------------------------------+--------------------------------------------------------+
117
118Features
119--------
lukegleeson4a34fa52022-09-19 15:31:59 +0100120 - `CPS-340 <https://jira.onap.org/browse/CPS-340>`_ Patch and update the root data node
121 - `CPS-575 <https://jira.onap.org/browse/CPS-575>`_ Write data for cmHandle using ncmp-datastores:passthrough-running (NCMP.)
122 - `CPS-731 <https://jira.onap.org/browse/CPS-731>`_ Query based on Public CM Properties
123 - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_ Async: NCMP Rest impl. including Request ID generation
124 - `CPS-829 <https://jira.onap.org/browse/CPS-829>`_ Async: Internal message topic incl. basic producer & Consumer
125 - `CPS-830 <https://jira.onap.org/browse/CPS-830>`_ DMI-NCMP Asynchronously Publish Response Event to Client Topic
126 - `CPS-869 <https://jira.onap.org/browse/CPS-869>`_ Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072
127 - `CPS-870 <https://jira.onap.org/browse/CPS-870>`_ Align CPS-Core output with SDN-C output (add module name)
128 - `CPS-875 <https://jira.onap.org/browse/CPS-875>`_ CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles
129 - `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'
130 - `CPS-899 <https://jira.onap.org/browse/CPS-899>`_ Start and stop sessions on Java API
131 - `CPS-909 <https://jira.onap.org/browse/CPS-909>`_ Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state
132 - `CPS-917 <https://jira.onap.org/browse/CPS-917>`_ Structured Errors response for passthrough use-cases in NCMP
133 - `CPS-953 <https://jira.onap.org/browse/CPS-953>`_ Update maven deploy plugin version
134 - `CPS-977 <https://jira.onap.org/browse/CPS-977>`_ Query CM Handles using CpsPath
135 - `CPS-1000 <https://jira.onap.org/browse/CPS-1000>`_ Create Data Synchronization watchdog
136 - `CPS-1016 <https://jira.onap.org/browse/CPS-1016>`_ Merge 2 'query' end points in NCMP
137 - `CPS-1034 <https://jira.onap.org/browse/CPS-1034>`_ Publish lifecycle events for ADVISED , READY and LOCKED state transition"
138 - `CPS-1064 <https://jira.onap.org/browse/CPS-1064>`_ Support retrieval of YANG module sources for CM handle on the NCMP interface
139 - `CPS-1099 <https://jira.onap.org/browse/CPS-1099>`_ Expose simplified 'external' lock reason enum state over REST interface
140 - `CPS-1101 <https://jira.onap.org/browse/CPS-1101>`_ Introducing the DELETING and DELETED Cmhandle State
141 - `CPS-1102 <https://jira.onap.org/browse/CPS-1102>`_ Register the Cmhandle Sends Advised State notification.
142 - `CPS-1133 <https://jira.onap.org/browse/CPS-1133>`_ Enable/Disable Data Sync for Cm Handle
143 - `CPS-1136 <https://jira.onap.org/browse/CPS-1136>`_ DMI Audit Support (get all CM Handles for a registered DMI)
144
emacleeafb17362022-09-02 14:40:17 +0100145
146Bug Fixes
147---------
lukegleeson4a34fa52022-09-19 15:31:59 +0100148 - `CPS-896 <https://jira.onap.org/browse/CPS-896>`_ CM Handle Registration Process only partially completes when exception is thrown
149 - `CPS-957 <https://jira.onap.org/browse/CPS-957>`_ NCMP: fix getResourceDataForPassthroughOperational endpoint
150 - `CPS-1020 <https://jira.onap.org/browse/CPS-1020>`_ DuplicatedYangResourceException error at parallel cmHandle registration
151 - `CPS-1056 <https://jira.onap.org/browse/CPS-1056>`_ Wrong error response format in case of Dmi plugin error
152 - `CPS-1067 <https://jira.onap.org/browse/CPS-1067>`_ NCMP returns 500 error on searches endpoint when No DMi Handles registered
153 - `CPS-1085 <https://jira.onap.org/browse/CPS-1085>`_ Performance degradation on ncmp/v1/ch/searches endpoint
154 - `CPS-1088 <https://jira.onap.org/browse/CPS-1088>`_ Kafka consumer can not be turned off
155 - `CPS-1097 <https://jira.onap.org/browse/CPS-1097>`_ Unable to change state from LOCKED to ADVISED
156 - `CPS-1126 <https://jira.onap.org/browse/CPS-1126>`_ CmHandle creation performance degradation
157 - `CPS-1175 <https://jira.onap.org/browse/CPS-1175>`_ Incorrect response when empty body executed for cmhandle id-searches
158 - `CPS-1179 <https://jira.onap.org/browse/CPS-1179>`_ Node API - GET method returns invalid response when identifier contains '/'
159 - `CPS-1212 <https://jira.onap.org/browse/CPS-1212>`_ Additional Properties for CM Handles not included when send to DMI Plugin
160 - `CPS-1217 <https://jira.onap.org/browse/CPS-1217>`_ Searches endpoint gives back empty list however there are already available cmhandles
161 - `CPS-1218 <https://jira.onap.org/browse/CPS-1218>`_ NCMP logs are flooded with SyncUtils logs
puthuparambil.adityadd904322022-09-21 10:53:51 +0100162
163Known Limitations, Issues and Workarounds
164-----------------------------------------
165
166*System Limitations*
167
168Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition.
169Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces']
DylanB95ESTb130fd32022-04-04 13:09:22 +0100170
lukegleeson4a34fa52022-09-19 15:31:59 +0100171*Known Vulnerabilities*
172
173None
174
175*Workarounds*
176
177None
178
179Security Notes
180--------------
181
182*Fixed Security Issues*
183
184 - `CPS-963 <https://jira.onap.org/browse/CPS-963>`_ Liquibase has got serious vulnerability, upgrade required
185
186*Known Security Issues*
187
188None
189
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400190.. ========================
191.. * * * JAKARTA * * *
192.. ========================
193
194Version: 3.0.1
195==============
196
197Release Data
198------------
199
200+--------------------------------------+--------------------------------------------------------+
201| **CPS Project** | |
202| | |
203+--------------------------------------+--------------------------------------------------------+
204| **Docker images** | onap/cps-and-ncmp:3.0.1 |
205| | |
206+--------------------------------------+--------------------------------------------------------+
207| **Release designation** | 3.0.1 Jakarta |
208| | |
209+--------------------------------------+--------------------------------------------------------+
210| **Release date** | 2022 April 28 |
211| | |
212+--------------------------------------+--------------------------------------------------------+
213
214Bug Fixes
215---------
216 - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_ Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
217
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400218Version: 3.0.0
219==============
niamhcoref7b414e2021-11-17 11:02:07 +0000220
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400221Release Data
222------------
223
224+--------------------------------------+--------------------------------------------------------+
225| **CPS Project** | |
226| | |
227+--------------------------------------+--------------------------------------------------------+
228| **Docker images** | onap/cps-and-ncmp:3.0.0 |
229| | |
230+--------------------------------------+--------------------------------------------------------+
231| **Release designation** | 3.0.0 Jakarta |
232| | |
233+--------------------------------------+--------------------------------------------------------+
234| **Release date** | 2022 March 15 |
235| | |
236+--------------------------------------+--------------------------------------------------------+
niamhcoref7b414e2021-11-17 11:02:07 +0000237
238Features
239--------
puthuparambil.adityad0007332021-12-08 18:53:39 +0000240 - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_ Define response objects (schemas) in cps-ncmp
niamhcoref7b414e2021-11-17 11:02:07 +0000241 - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_ Update operation for datastore pass through running
242 - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_ Delete operation for datastore pass through running
DylanB95ESTe5573382022-01-27 17:12:52 +0000243 - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_ Support 'public' Cm Handle Properties
niamhcoref7b414e2021-11-17 11:02:07 +0000244 - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
JosephKeenan82ebf532021-12-08 18:16:44 +0000245 - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_ Ensure all DMI operations use POST method
puthuparambil.adityad0007332021-12-08 18:53:39 +0000246 - `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 -0400247 - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
248 - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
DylanB95ESTe5573382022-01-27 17:12:52 +0000249 - `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 +0530250 - `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 +0000251
252Bug Fixes
253---------
254
255 - `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 +0000256 - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
niamhcore65bc4fd2021-12-08 14:19:02 +0000257 - `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 +0000258 - `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 +0000259 - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
JosephKeenane0643ab2022-02-15 18:23:05 +0000260 - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
DylanB95ESTe5573382022-01-27 17:12:52 +0000261 - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
JosephKeenane0643ab2022-02-15 18:23:05 +0000262 - `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 +0530263 - `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 +0000264 - `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 +0000265
266Known Limitations, Issues and Workarounds
267-----------------------------------------
268
269*System Limitations*
270
DylanB95ESTe5573382022-01-27 17:12:52 +0000271Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
272`CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
273of cm handle registration.
niamhcoref7b414e2021-11-17 11:02:07 +0000274
Lathishb3550f12022-03-15 12:03:53 +0000275The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
276for more information.
277
niamhcoref7b414e2021-11-17 11:02:07 +0000278*Known Vulnerabilities*
279
280None
281
282*Workarounds*
283
DylanB95ESTe5573382022-01-27 17:12:52 +0000284Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
285pass an empty string as the value if you do not want to include names for these values.
niamhcoref7b414e2021-11-17 11:02:07 +0000286
287Security Notes
288--------------
289
290*Fixed Security Issues*
291
292None
293
294*Known Security Issues*
295
296None
297
298.. ========================
shivasubedi44beaa32021-09-13 15:16:30 +0100299.. * * * ISTANBUL * * *
300.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000301
Bruno Sakoto0eaf3342022-02-11 15:05:29 -0500302Version: 2.0.4
303==============
304
305Release Data
306------------
307
308+--------------------------------------+--------------------------------------------------------+
309| **CPS Project** | |
310| | |
311+--------------------------------------+--------------------------------------------------------+
312| **Docker images** | onap/cps-and-ncmp:2.0.4 |
313| | |
314+--------------------------------------+--------------------------------------------------------+
315| **Release designation** | 2.0.4 Istanbul |
316| | |
317+--------------------------------------+--------------------------------------------------------+
318| **Release date** | 2022 Feb 09 |
319| | |
320+--------------------------------------+--------------------------------------------------------+
321
322Bug Fixes
323---------
324
325 - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_ Fix docker compose for csit test.
326 - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_ Fix intermittent circular dependency error when the application starts.
327
328Version: 2.0.3
329==============
330
331Release Data
332------------
333
334+--------------------------------------+--------------------------------------------------------+
335| **CPS Project** | |
336| | |
337+--------------------------------------+--------------------------------------------------------+
338| **Docker images** | onap/cps-and-ncmp:2.0.3 |
339| | |
340+--------------------------------------+--------------------------------------------------------+
341| **Release designation** | 2.0.3 Istanbul |
342| | |
343+--------------------------------------+--------------------------------------------------------+
344| **Release date** | 2022-07-01 |
345| | |
346+--------------------------------------+--------------------------------------------------------+
347
348Bug Fixes
349---------
350
351 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
352
353Version: 2.0.2
354==============
355
356Release Data
357------------
358
359+--------------------------------------+--------------------------------------------------------+
360| **CPS Project** | |
361| | |
362+--------------------------------------+--------------------------------------------------------+
363| **Docker images** | onap/cps-and-ncmp:2.0.2 |
364| | |
365+--------------------------------------+--------------------------------------------------------+
366| **Release designation** | 2.0.2 Istanbul |
367| | |
368+--------------------------------------+--------------------------------------------------------+
369| **Release date** | 2021-16-12 |
370| | |
371+--------------------------------------+--------------------------------------------------------+
372
373Bug Fixes
374---------
375
376 - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_ Update log4j version due to security vulnerability
377
lukegleeson9c583712021-09-30 17:21:11 +0100378Version: 2.0.1
379==============
380
381Release Data
382------------
383
384+--------------------------------------+--------------------------------------------------------+
385| **CPS Project** | |
386| | |
387+--------------------------------------+--------------------------------------------------------+
388| **Docker images** | onap/cps-and-ncmp:2.0.1 |
389| | |
390+--------------------------------------+--------------------------------------------------------+
391| **Release designation** | 2.0.1 Istanbul |
392| | |
393+--------------------------------------+--------------------------------------------------------+
394| **Release date** | 2021-14-10 |
395| | |
396+--------------------------------------+--------------------------------------------------------+
397
398Bug Fixes
399---------
400
401 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
402 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
403 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
404 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
405
406Known Limitations, Issues and Workarounds
407-----------------------------------------
408
409*System Limitations*
410
411Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
412
413*Known Vulnerabilities*
414
415 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
416
417*Workarounds*
418
419Add recursive method to save list node data to loop through all corresponding child nodes.
420
421Security Notes
422--------------
423
424*Fixed Security Issues*
425
426 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
427
428*Known Security Issues*
429
430None
431
shivasubedi44beaa32021-09-13 15:16:30 +0100432Version: 2.0.0
433==============
434
435Abstract
436--------
437
438This document provides the release notes for Istanbul release.
439
440Release Data
441------------
442
443+--------------------------------------+--------------------------------------------------------+
444| **CPS Project** | |
445| | |
446+--------------------------------------+--------------------------------------------------------+
447| **Docker images** | onap/cps-and-ncmp:2.0.0 |
448| | |
449+--------------------------------------+--------------------------------------------------------+
450| **Release designation** | 2.0.0 Istanbul |
451| | |
452+--------------------------------------+--------------------------------------------------------+
lukegleeson9c583712021-09-30 17:21:11 +0100453| **Release date** | 2021-14-09 |
shivasubedi44beaa32021-09-13 15:16:30 +0100454| | |
455+--------------------------------------+--------------------------------------------------------+
456
457Features
458--------
DylanB95EST3fcf8692021-10-11 16:29:16 +0100459* Register DMI-Plugins with NCMP for CM Handle registrations.
shivasubedi44beaa32021-09-13 15:16:30 +0100460* Update, Create and Remove CM Handles.
461* Add support for retrieving and writing CM Handle data through NCMP datastores.
462* Automatic retrieval and caching of model information for CM Handles within NCMP.
463
shivasubedi44beaa32021-09-13 15:16:30 +0100464Deliverables
465------------
466
467Software Deliverables
468
469.. csv-table::
470 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
471 :widths: auto
472
473 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
474
475Bug Fixes
476---------
477
lukegleeson9c583712021-09-30 17:21:11 +0100478 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
shivasubedi44beaa32021-09-13 15:16:30 +0100479 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
480 - `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 +0100481 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
482 - `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 +0100483 - `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 +0100484 - `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 +0100485 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
486 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
lukegleeson9c583712021-09-30 17:21:11 +0100487 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
488 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
489 - `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 +0100490 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
491 - `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 +0100492 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
shivasubedi44beaa32021-09-13 15:16:30 +0100493 - `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 +0100494 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
495 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
496 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
lukegleeson9c583712021-09-30 17:21:11 +0100497 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
498 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
499 - `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 -0500500 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
lukegleeson9c583712021-09-30 17:21:11 +0100501 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
502 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
503 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
shivasubedi44beaa32021-09-13 15:16:30 +0100504
505This document provides the release notes for Istanbul release.
506
507Summary
508-------
509
510Following CPS components are available with default ONAP/CPS installation.
511
512
513 * Platform components
514
515 - CPS (Helm charts)
516
517 * Service components
518
DylanB95EST3fcf8692021-10-11 16:29:16 +0100519 - CPS-NCMP
520 - CPS-Temporal
521 - DMI-Plugin
shivasubedi44beaa32021-09-13 15:16:30 +0100522
523 * Additional resources that CPS utilizes deployed using ONAP common charts
524
525 - Postgres Database
526
527
528Below service components (mS) are available to be deployed on-demand.
529 - CPS-TBDMT
530
531
532Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
533
534Known Limitations, Issues and Workarounds
535-----------------------------------------
536
shivasubedi44beaa32021-09-13 15:16:30 +0100537*System Limitations*
538
539Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
540
541*Known Vulnerabilities*
542
lukegleeson9c583712021-09-30 17:21:11 +0100543 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
544 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
545 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
shivasubedi44beaa32021-09-13 15:16:30 +0100546
547*Workarounds*
548
549Add recursive method to save list node data to loop through all corresponding child nodes.
550
551Security Notes
552--------------
553
554*Fixed Security Issues*
555
556 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
shivasubedi44beaa32021-09-13 15:16:30 +0100557
558*Known Security Issues*
559
lukegleeson9c583712021-09-30 17:21:11 +0100560 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
561
shivasubedi44beaa32021-09-13 15:16:30 +0100562Test Results
563------------
564 * `Integration tests`
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000565
ToineSiebelinkf0527c52021-07-06 13:03:03 +0100566.. ========================
567.. * * * HONOLULU * * *
568.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000569
ToineSiebelinkfd2134d2021-04-09 11:15:48 +0100570Version: 1.0.1
571==============
572
573Release Data
574------------
575
576+--------------------------------------+--------------------------------------------------------+
577| **CPS Project** | |
578| | |
579+--------------------------------------+--------------------------------------------------------+
580| **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
581| | |
582+--------------------------------------+--------------------------------------------------------+
583| **Release designation** | 1.0.1 Honolulu |
584| | |
585+--------------------------------------+--------------------------------------------------------+
586| **Release date** | 2021-04-09 |
587| | |
588+--------------------------------------+--------------------------------------------------------+
589
590Bug Fixes
591---------
592
puthuparambil.aditya8b584332021-10-12 16:49:03 +0100593 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
ToineSiebelinkfd2134d2021-04-09 11:15:48 +0100594 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
595 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
596 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
597 - `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
598 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
599 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
600 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
601
602Security Notes
603--------------
604
605*Fixed Security Issues*
606
607 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000608
ToineSiebelinka2d25b52021-04-13 15:10:47 +0100609*Known Security Issues*
610
611 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
612
Rishi.Chail4359d282021-03-03 16:36:26 +0000613Version: 1.0.0
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000614==============
615
616
617Abstract
618--------
619
620This document provides the release notes for Honolulu release.
621
622Summary
623-------
624
625Following CPS components are available with default ONAP/CPS installation.
626
627
Rishi.Chail4359d282021-03-03 16:36:26 +0000628 * Platform components
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000629
Rishi.Chail4359d282021-03-03 16:36:26 +0000630 - CPS (Helm charts)
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000631
Rishi.Chail4359d282021-03-03 16:36:26 +0000632 * Service components
633
634 - CPS Core
635
636 * Additional resources that CPS utilizes deployed using ONAP common charts
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000637
638 - Postgres Database
639
640
Rishi.Chail4359d282021-03-03 16:36:26 +0000641Below service components (mS) are available to be deployed on-demand.
642 - CPS-TBDMT
643
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000644
645Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
646
647
648Release Data
649------------
650
651+--------------------------------------+--------------------------------------------------------+
652| **CPS Project** | |
653| | |
654+--------------------------------------+--------------------------------------------------------+
655| **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
656| | |
657+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +0000658| **Release designation** | 1.0.0 Honolulu |
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000659| | |
660+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +0000661| **Release date** | 2021-03-11 |
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000662| | |
663+--------------------------------------+--------------------------------------------------------+
664
665
666Features
667--------
Rishi.Chail4359d282021-03-03 16:36:26 +0000668Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
669CPS has been driven by the needs of the E2E Networking Slicing use case.
670It currently supports basic (rw) persistence and simple queries.
671It also provides MVP support for network data access using simulated data.
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000672
673.. _honolulu_deliverable:
674
675Deliverables
676------------
677
678Software Deliverables
679
680.. csv-table::
681 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
682 :widths: auto
683
Rishi.Chail4359d282021-03-03 16:36:26 +0000684 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000685
686
687Known Limitations, Issues and Workarounds
688-----------------------------------------
689
Rishi.Chail4359d282021-03-03 16:36:26 +0000690 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
691 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
692 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
niamhcoredddf7312021-06-21 14:44:01 +0100693 - `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 +0000694
695*System Limitations*
696
697None
698
699*Known Vulnerabilities*
700
701None
702
703*Workarounds*
704
705Documented under corresponding jira if applicable.
706
707Security Notes
708--------------
709
710*Fixed Security Issues*
ToineSiebelink7c981df2021-03-01 09:53:56 +0000711
712* `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
Rishi.Chail4359d282021-03-03 16:36:26 +0000713 - Upgrade org.onap.oparent to 3.2.0
ToineSiebelink7c981df2021-03-01 09:53:56 +0000714 - Upgrade spring.boot to 2.3.8.RELEASE
Rishi.Chail4359d282021-03-03 16:36:26 +0000715 - Upgrade yangtools to 5.0.7
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000716
717*Known Security Issues*
718
Rishi.Chail4359d282021-03-03 16:36:26 +0000719 * Weak Crytography using md5
720 * Risk seen in Zip file expansion
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000721
722*Known Vulnerabilities in Used Modules*
723
Rishi.Chail4359d282021-03-03 16:36:26 +0000724 None
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000725
Rishi.Chail4359d282021-03-03 16:36:26 +0000726CPS 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 +0000727
728Test Results
729------------
Rishi.Chail4359d282021-03-03 16:36:26 +0000730 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000731
732References
733----------
734
735For more information on the ONAP Honolulu release, please see:
736
737#. `ONAP Home Page`_
738#. `ONAP Documentation`_
739#. `ONAP Release Downloads`_
740#. `ONAP Wiki Page`_
741
742
743.. _`ONAP Home Page`: https://www.onap.org
744.. _`ONAP Wiki Page`: https://wiki.onap.org
745.. _`ONAP Documentation`: https://docs.onap.org
746.. _`ONAP Release Downloads`: https://git.onap.org
747
748Quick Links:
749
750 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
751 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_