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