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