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