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