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