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