1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright (C) 2021-2022 Nordix Foundation
5 .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
15 .. ========================
16 .. * * * JAKARTA * * *
17 .. ========================
25 +--------------------------------------+--------------------------------------------------------+
28 +--------------------------------------+--------------------------------------------------------+
29 | **Docker images** | onap/cps-and-ncmp:3.0.0 |
31 +--------------------------------------+--------------------------------------------------------+
32 | **Release designation** | 3.0.0 Jakarta |
34 +--------------------------------------+--------------------------------------------------------+
35 | **Release date** | 2022 March 15 |
37 +--------------------------------------+--------------------------------------------------------+
41 - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_ Define response objects (schemas) in cps-ncmp
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
44 - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_ Support 'public' Cm Handle Properties
45 - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
46 - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_ Ensure all DMI operations use POST method
47 - `CPS-780 <https://jira.onap.org/browse/CPS-780>`_ Add examples for parameters, request and response in openapi yaml for cps-core
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
50 - `CPS-817 <https://jira.onap.org/browse/CPS-817>`_ Create Endpoint For Get Cm Handles (incl. public properties) By Name
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
56 - `CPS-762 <https://jira.onap.org/browse/CPS-762>`_ Query cm handles for module names returns incorrect cm handle identifiers
57 - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
58 - `CPS-783 <https://jira.onap.org/browse/CPS-783>`_ Remove cm handle does not completely remove all cm handle information
59 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM
60 - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
61 - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
62 - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
63 - `CPS-887 <https://jira.onap.org/browse/CPS-887>`_ Increase performance of cmHandle registration for large number of schema sets in DB
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
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
67 Known Limitations, Issues and Workarounds
68 -----------------------------------------
72 Null 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
74 of cm handle registration.
76 *Known Vulnerabilities*
82 Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
83 pass an empty string as the value if you do not want to include names for these values.
88 *Fixed Security Issues*
92 *Known Security Issues*
96 .. ========================
97 .. * * * ISTANBUL * * *
98 .. ========================
106 +--------------------------------------+--------------------------------------------------------+
107 | **CPS Project** | |
109 +--------------------------------------+--------------------------------------------------------+
110 | **Docker images** | onap/cps-and-ncmp:2.0.4 |
112 +--------------------------------------+--------------------------------------------------------+
113 | **Release designation** | 2.0.4 Istanbul |
115 +--------------------------------------+--------------------------------------------------------+
116 | **Release date** | 2022 Feb 09 |
118 +--------------------------------------+--------------------------------------------------------+
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.
132 +--------------------------------------+--------------------------------------------------------+
133 | **CPS Project** | |
135 +--------------------------------------+--------------------------------------------------------+
136 | **Docker images** | onap/cps-and-ncmp:2.0.3 |
138 +--------------------------------------+--------------------------------------------------------+
139 | **Release designation** | 2.0.3 Istanbul |
141 +--------------------------------------+--------------------------------------------------------+
142 | **Release date** | 2022-07-01 |
144 +--------------------------------------+--------------------------------------------------------+
149 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
157 +--------------------------------------+--------------------------------------------------------+
158 | **CPS Project** | |
160 +--------------------------------------+--------------------------------------------------------+
161 | **Docker images** | onap/cps-and-ncmp:2.0.2 |
163 +--------------------------------------+--------------------------------------------------------+
164 | **Release designation** | 2.0.2 Istanbul |
166 +--------------------------------------+--------------------------------------------------------+
167 | **Release date** | 2021-16-12 |
169 +--------------------------------------+--------------------------------------------------------+
174 - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_ Update log4j version due to security vulnerability
182 +--------------------------------------+--------------------------------------------------------+
183 | **CPS Project** | |
185 +--------------------------------------+--------------------------------------------------------+
186 | **Docker images** | onap/cps-and-ncmp:2.0.1 |
188 +--------------------------------------+--------------------------------------------------------+
189 | **Release designation** | 2.0.1 Istanbul |
191 +--------------------------------------+--------------------------------------------------------+
192 | **Release date** | 2021-14-10 |
194 +--------------------------------------+--------------------------------------------------------+
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
204 Known Limitations, Issues and Workarounds
205 -----------------------------------------
209 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
211 *Known Vulnerabilities*
213 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
217 Add recursive method to save list node data to loop through all corresponding child nodes.
222 *Fixed Security Issues*
224 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
226 *Known Security Issues*
236 This document provides the release notes for Istanbul release.
241 +--------------------------------------+--------------------------------------------------------+
242 | **CPS Project** | |
244 +--------------------------------------+--------------------------------------------------------+
245 | **Docker images** | onap/cps-and-ncmp:2.0.0 |
247 +--------------------------------------+--------------------------------------------------------+
248 | **Release designation** | 2.0.0 Istanbul |
250 +--------------------------------------+--------------------------------------------------------+
251 | **Release date** | 2021-14-09 |
253 +--------------------------------------+--------------------------------------------------------+
257 * Register DMI-Plugins with NCMP for CM Handle registrations.
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.
265 Software Deliverables
268 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
271 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
276 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
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
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
281 - `CPS-367 <https://jira.onap.org/browse/CPS-367>`_ Get descendent does not support xpaths that end in list values
282 - `CPS-377 <https://jira.onap.org/browse/CPS-377>`_ Init ran model validation is failing error details are not provided
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
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
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
290 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
291 - `CPS-501 <https://jira.onap.org/browse/CPS-501>`_ Put DataNode API has missing transaction and error handling for concurrency issues
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
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
298 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
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
303 This document provides the release notes for Istanbul release.
308 Following CPS components are available with default ONAP/CPS installation.
311 * Platform components
321 * Additional resources that CPS utilizes deployed using ONAP common charts
326 Below service components (mS) are available to be deployed on-demand.
330 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
332 Known Limitations, Issues and Workarounds
333 -----------------------------------------
337 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
339 *Known Vulnerabilities*
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
347 Add recursive method to save list node data to loop through all corresponding child nodes.
352 *Fixed Security Issues*
354 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
356 *Known Security Issues*
358 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
362 * `Integration tests`
364 .. ========================
365 .. * * * HONOLULU * * *
366 .. ========================
374 +--------------------------------------+--------------------------------------------------------+
375 | **CPS Project** | |
377 +--------------------------------------+--------------------------------------------------------+
378 | **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
380 +--------------------------------------+--------------------------------------------------------+
381 | **Release designation** | 1.0.1 Honolulu |
383 +--------------------------------------+--------------------------------------------------------+
384 | **Release date** | 2021-04-09 |
386 +--------------------------------------+--------------------------------------------------------+
391 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
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
403 *Fixed Security Issues*
405 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
407 *Known Security Issues*
409 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
418 This document provides the release notes for Honolulu release.
423 Following CPS components are available with default ONAP/CPS installation.
426 * Platform components
434 * Additional resources that CPS utilizes deployed using ONAP common charts
439 Below service components (mS) are available to be deployed on-demand.
443 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
449 +--------------------------------------+--------------------------------------------------------+
450 | **CPS Project** | |
452 +--------------------------------------+--------------------------------------------------------+
453 | **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
455 +--------------------------------------+--------------------------------------------------------+
456 | **Release designation** | 1.0.0 Honolulu |
458 +--------------------------------------+--------------------------------------------------------+
459 | **Release date** | 2021-03-11 |
461 +--------------------------------------+--------------------------------------------------------+
466 Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
467 CPS has been driven by the needs of the E2E Networking Slicing use case.
468 It currently supports basic (rw) persistence and simple queries.
469 It also provides MVP support for network data access using simulated data.
471 .. _honolulu_deliverable:
476 Software Deliverables
479 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
482 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
485 Known Limitations, Issues and Workarounds
486 -----------------------------------------
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.
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.
497 *Known Vulnerabilities*
503 Documented under corresponding jira if applicable.
508 *Fixed Security Issues*
510 * `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
511 - Upgrade org.onap.oparent to 3.2.0
512 - Upgrade spring.boot to 2.3.8.RELEASE
513 - Upgrade yangtools to 5.0.7
515 *Known Security Issues*
517 * Weak Crytography using md5
518 * Risk seen in Zip file expansion
520 *Known Vulnerabilities in Used Modules*
524 CPS 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.
528 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
533 For more information on the ONAP Honolulu release, please see:
536 #. `ONAP Documentation`_
537 #. `ONAP Release Downloads`_
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
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>`_