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