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 .. ====================
17 .. ====================
19 Version: 3.1.0 (not released yet)
20 =================================
25 +--------------------------------------+--------------------------------------------------------+
28 +--------------------------------------+--------------------------------------------------------+
29 | **Docker images** | onap/cps-and-ncmp:3.1.0 |
31 +--------------------------------------+--------------------------------------------------------+
32 | **Release designation** | 3.1.0 Kohn |
34 +--------------------------------------+--------------------------------------------------------+
35 | **Release date** | N/A |
37 +--------------------------------------+--------------------------------------------------------+
41 - `CPS-322 <https://jira.onap.org/browse/CPS-322>`_ Implement additional validation for names and identifiers
42 - `CPS-1136 <https://jira.onap.org/browse/CPS-1136>`_ Get all cm handles by DMI plugin Identifier
43 - `CPS-1001 <https://jira.onap.org/browse/CPS-1001>`_ Add CPS-E-05 endpoint for Read data, NCMP-Operational Datastore
48 .. ========================
49 .. * * * JAKARTA * * *
50 .. ========================
58 +--------------------------------------+--------------------------------------------------------+
61 +--------------------------------------+--------------------------------------------------------+
62 | **Docker images** | onap/cps-and-ncmp:3.0.1 |
64 +--------------------------------------+--------------------------------------------------------+
65 | **Release designation** | 3.0.1 Jakarta |
67 +--------------------------------------+--------------------------------------------------------+
68 | **Release date** | 2022 April 28 |
70 +--------------------------------------+--------------------------------------------------------+
74 - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_ Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
82 +--------------------------------------+--------------------------------------------------------+
85 +--------------------------------------+--------------------------------------------------------+
86 | **Docker images** | onap/cps-and-ncmp:3.0.0 |
88 +--------------------------------------+--------------------------------------------------------+
89 | **Release designation** | 3.0.0 Jakarta |
91 +--------------------------------------+--------------------------------------------------------+
92 | **Release date** | 2022 March 15 |
94 +--------------------------------------+--------------------------------------------------------+
98 - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_ Define response objects (schemas) in cps-ncmp
99 - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_ Update operation for datastore pass through running
100 - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_ Delete operation for datastore pass through running
101 - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_ Support 'public' Cm Handle Properties
102 - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
103 - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_ Ensure all DMI operations use POST method
104 - `CPS-780 <https://jira.onap.org/browse/CPS-780>`_ Add examples for parameters, request and response in openapi yaml for cps-core
105 - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
106 - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
107 - `CPS-817 <https://jira.onap.org/browse/CPS-817>`_ Create Endpoint For Get Cm Handles (incl. public properties) By Name
108 - `CPS-837 <https://jira.onap.org/browse/CPS-837>`_ Add Remove and Update properties (DMI and Public) as part of CM Handle Registration update
113 - `CPS-762 <https://jira.onap.org/browse/CPS-762>`_ Query cm handles for module names returns incorrect cm handle identifiers
114 - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
115 - `CPS-783 <https://jira.onap.org/browse/CPS-783>`_ Remove cm handle does not completely remove all cm handle information
116 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM
117 - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
118 - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
119 - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
120 - `CPS-887 <https://jira.onap.org/browse/CPS-887>`_ Increase performance of cmHandle registration for large number of schema sets in DB
121 - `CPS-892 <https://jira.onap.org/browse/CPS-892>`_ Fixed the response code during CM-Handle Registration from 201 CREATED to 204 NO_CONTENT
122 - `CPS-893 <https://jira.onap.org/browse/CPS-893>`_ NCMP Java API depends on NCM-Rest-API (cyclic) through json properties on Java API
124 Known Limitations, Issues and Workarounds
125 -----------------------------------------
129 Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
130 `CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
131 of cm handle registration.
133 The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
134 for more information.
136 *Known Vulnerabilities*
142 Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
143 pass an empty string as the value if you do not want to include names for these values.
148 *Fixed Security Issues*
152 *Known Security Issues*
156 .. ========================
157 .. * * * ISTANBUL * * *
158 .. ========================
166 +--------------------------------------+--------------------------------------------------------+
167 | **CPS Project** | |
169 +--------------------------------------+--------------------------------------------------------+
170 | **Docker images** | onap/cps-and-ncmp:2.0.4 |
172 +--------------------------------------+--------------------------------------------------------+
173 | **Release designation** | 2.0.4 Istanbul |
175 +--------------------------------------+--------------------------------------------------------+
176 | **Release date** | 2022 Feb 09 |
178 +--------------------------------------+--------------------------------------------------------+
183 - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_ Fix docker compose for csit test.
184 - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_ Fix intermittent circular dependency error when the application starts.
192 +--------------------------------------+--------------------------------------------------------+
193 | **CPS Project** | |
195 +--------------------------------------+--------------------------------------------------------+
196 | **Docker images** | onap/cps-and-ncmp:2.0.3 |
198 +--------------------------------------+--------------------------------------------------------+
199 | **Release designation** | 2.0.3 Istanbul |
201 +--------------------------------------+--------------------------------------------------------+
202 | **Release date** | 2022-07-01 |
204 +--------------------------------------+--------------------------------------------------------+
209 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
217 +--------------------------------------+--------------------------------------------------------+
218 | **CPS Project** | |
220 +--------------------------------------+--------------------------------------------------------+
221 | **Docker images** | onap/cps-and-ncmp:2.0.2 |
223 +--------------------------------------+--------------------------------------------------------+
224 | **Release designation** | 2.0.2 Istanbul |
226 +--------------------------------------+--------------------------------------------------------+
227 | **Release date** | 2021-16-12 |
229 +--------------------------------------+--------------------------------------------------------+
234 - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_ Update log4j version due to security vulnerability
242 +--------------------------------------+--------------------------------------------------------+
243 | **CPS Project** | |
245 +--------------------------------------+--------------------------------------------------------+
246 | **Docker images** | onap/cps-and-ncmp:2.0.1 |
248 +--------------------------------------+--------------------------------------------------------+
249 | **Release designation** | 2.0.1 Istanbul |
251 +--------------------------------------+--------------------------------------------------------+
252 | **Release date** | 2021-14-10 |
254 +--------------------------------------+--------------------------------------------------------+
259 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
260 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
261 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
262 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
264 Known Limitations, Issues and Workarounds
265 -----------------------------------------
269 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
271 *Known Vulnerabilities*
273 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
277 Add recursive method to save list node data to loop through all corresponding child nodes.
282 *Fixed Security Issues*
284 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
286 *Known Security Issues*
296 This document provides the release notes for Istanbul release.
301 +--------------------------------------+--------------------------------------------------------+
302 | **CPS Project** | |
304 +--------------------------------------+--------------------------------------------------------+
305 | **Docker images** | onap/cps-and-ncmp:2.0.0 |
307 +--------------------------------------+--------------------------------------------------------+
308 | **Release designation** | 2.0.0 Istanbul |
310 +--------------------------------------+--------------------------------------------------------+
311 | **Release date** | 2021-14-09 |
313 +--------------------------------------+--------------------------------------------------------+
317 * Register DMI-Plugins with NCMP for CM Handle registrations.
318 * Update, Create and Remove CM Handles.
319 * Add support for retrieving and writing CM Handle data through NCMP datastores.
320 * Automatic retrieval and caching of model information for CM Handles within NCMP.
325 Software Deliverables
328 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
331 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
336 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
337 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
338 - `CPS-336 <https://jira.onap.org/browse/CPS-336>`_ Ends-with functionality in cpsPath does not conform with standard xPath behavior
339 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
340 - `CPS-357 <https://jira.onap.org/browse/CPS-357>`_ cps-review-verification-maven-master Jenkins job is failing when running csit test
341 - `CPS-367 <https://jira.onap.org/browse/CPS-367>`_ Get descendent does not support xpaths that end in list values
342 - `CPS-377 <https://jira.onap.org/browse/CPS-377>`_ Init ran model validation is failing error details are not provided
343 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
344 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
345 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
346 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
347 - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ Request to update node leaves (patch) responds with json parsing failure
348 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
349 - `CPS-479 <https://jira.onap.org/browse/CPS-479>`_ Get Nodes API does not always return the object from the root
350 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
351 - `CPS-501 <https://jira.onap.org/browse/CPS-501>`_ Put DataNode API has missing transaction and error handling for concurrency issues
352 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
353 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
354 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
355 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
356 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
357 - `CPS-591 <https://jira.onap.org/browse/CPS-591>`_ CPS-Core Leaf stored as integer is being returned from DB as float
358 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
359 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
360 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
361 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
363 This document provides the release notes for Istanbul release.
368 Following CPS components are available with default ONAP/CPS installation.
371 * Platform components
381 * Additional resources that CPS utilizes deployed using ONAP common charts
386 Below service components (mS) are available to be deployed on-demand.
390 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
392 Known Limitations, Issues and Workarounds
393 -----------------------------------------
397 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
399 *Known Vulnerabilities*
401 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
402 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
403 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
407 Add recursive method to save list node data to loop through all corresponding child nodes.
412 *Fixed Security Issues*
414 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
416 *Known Security Issues*
418 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
422 * `Integration tests`
424 .. ========================
425 .. * * * HONOLULU * * *
426 .. ========================
434 +--------------------------------------+--------------------------------------------------------+
435 | **CPS Project** | |
437 +--------------------------------------+--------------------------------------------------------+
438 | **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
440 +--------------------------------------+--------------------------------------------------------+
441 | **Release designation** | 1.0.1 Honolulu |
443 +--------------------------------------+--------------------------------------------------------+
444 | **Release date** | 2021-04-09 |
446 +--------------------------------------+--------------------------------------------------------+
451 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
452 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
453 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
454 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
455 - `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
456 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
457 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
458 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
463 *Fixed Security Issues*
465 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
467 *Known Security Issues*
469 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
478 This document provides the release notes for Honolulu release.
483 Following CPS components are available with default ONAP/CPS installation.
486 * Platform components
494 * Additional resources that CPS utilizes deployed using ONAP common charts
499 Below service components (mS) are available to be deployed on-demand.
503 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
509 +--------------------------------------+--------------------------------------------------------+
510 | **CPS Project** | |
512 +--------------------------------------+--------------------------------------------------------+
513 | **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
515 +--------------------------------------+--------------------------------------------------------+
516 | **Release designation** | 1.0.0 Honolulu |
518 +--------------------------------------+--------------------------------------------------------+
519 | **Release date** | 2021-03-11 |
521 +--------------------------------------+--------------------------------------------------------+
526 Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
527 CPS has been driven by the needs of the E2E Networking Slicing use case.
528 It currently supports basic (rw) persistence and simple queries.
529 It also provides MVP support for network data access using simulated data.
531 .. _honolulu_deliverable:
536 Software Deliverables
539 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
542 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
545 Known Limitations, Issues and Workarounds
546 -----------------------------------------
548 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
549 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
550 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
551 - `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.
557 *Known Vulnerabilities*
563 Documented under corresponding jira if applicable.
568 *Fixed Security Issues*
570 * `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
571 - Upgrade org.onap.oparent to 3.2.0
572 - Upgrade spring.boot to 2.3.8.RELEASE
573 - Upgrade yangtools to 5.0.7
575 *Known Security Issues*
577 * Weak Crytography using md5
578 * Risk seen in Zip file expansion
580 *Known Vulnerabilities in Used Modules*
584 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.
588 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
593 For more information on the ONAP Honolulu release, please see:
596 #. `ONAP Documentation`_
597 #. `ONAP Release Downloads`_
601 .. _`ONAP Home Page`: https://www.onap.org
602 .. _`ONAP Wiki Page`: https://wiki.onap.org
603 .. _`ONAP Documentation`: https://docs.onap.org
604 .. _`ONAP Release Downloads`: https://git.onap.org
608 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
609 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_