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
47 .. ========================
48 .. * * * JAKARTA * * *
49 .. ========================
57 +--------------------------------------+--------------------------------------------------------+
60 +--------------------------------------+--------------------------------------------------------+
61 | **Docker images** | onap/cps-and-ncmp:3.0.1 |
63 +--------------------------------------+--------------------------------------------------------+
64 | **Release designation** | 3.0.1 Jakarta |
66 +--------------------------------------+--------------------------------------------------------+
67 | **Release date** | 2022 April 28 |
69 +--------------------------------------+--------------------------------------------------------+
73 - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_ Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
81 +--------------------------------------+--------------------------------------------------------+
84 +--------------------------------------+--------------------------------------------------------+
85 | **Docker images** | onap/cps-and-ncmp:3.0.0 |
87 +--------------------------------------+--------------------------------------------------------+
88 | **Release designation** | 3.0.0 Jakarta |
90 +--------------------------------------+--------------------------------------------------------+
91 | **Release date** | 2022 March 15 |
93 +--------------------------------------+--------------------------------------------------------+
97 - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_ Define response objects (schemas) in cps-ncmp
98 - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_ Update operation for datastore pass through running
99 - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_ Delete operation for datastore pass through running
100 - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_ Support 'public' Cm Handle Properties
101 - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
102 - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_ Ensure all DMI operations use POST method
103 - `CPS-780 <https://jira.onap.org/browse/CPS-780>`_ Add examples for parameters, request and response in openapi yaml for cps-core
104 - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
105 - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
106 - `CPS-817 <https://jira.onap.org/browse/CPS-817>`_ Create Endpoint For Get Cm Handles (incl. public properties) By Name
107 - `CPS-837 <https://jira.onap.org/browse/CPS-837>`_ Add Remove and Update properties (DMI and Public) as part of CM Handle Registration update
112 - `CPS-762 <https://jira.onap.org/browse/CPS-762>`_ Query cm handles for module names returns incorrect cm handle identifiers
113 - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
114 - `CPS-783 <https://jira.onap.org/browse/CPS-783>`_ Remove cm handle does not completely remove all cm handle information
115 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM
116 - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
117 - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
118 - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
119 - `CPS-887 <https://jira.onap.org/browse/CPS-887>`_ Increase performance of cmHandle registration for large number of schema sets in DB
120 - `CPS-892 <https://jira.onap.org/browse/CPS-892>`_ Fixed the response code during CM-Handle Registration from 201 CREATED to 204 NO_CONTENT
121 - `CPS-893 <https://jira.onap.org/browse/CPS-893>`_ NCMP Java API depends on NCM-Rest-API (cyclic) through json properties on Java API
123 Known Limitations, Issues and Workarounds
124 -----------------------------------------
128 Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
129 `CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
130 of cm handle registration.
132 The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
133 for more information.
135 *Known Vulnerabilities*
141 Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
142 pass an empty string as the value if you do not want to include names for these values.
147 *Fixed Security Issues*
151 *Known Security Issues*
155 .. ========================
156 .. * * * ISTANBUL * * *
157 .. ========================
165 +--------------------------------------+--------------------------------------------------------+
166 | **CPS Project** | |
168 +--------------------------------------+--------------------------------------------------------+
169 | **Docker images** | onap/cps-and-ncmp:2.0.4 |
171 +--------------------------------------+--------------------------------------------------------+
172 | **Release designation** | 2.0.4 Istanbul |
174 +--------------------------------------+--------------------------------------------------------+
175 | **Release date** | 2022 Feb 09 |
177 +--------------------------------------+--------------------------------------------------------+
182 - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_ Fix docker compose for csit test.
183 - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_ Fix intermittent circular dependency error when the application starts.
191 +--------------------------------------+--------------------------------------------------------+
192 | **CPS Project** | |
194 +--------------------------------------+--------------------------------------------------------+
195 | **Docker images** | onap/cps-and-ncmp:2.0.3 |
197 +--------------------------------------+--------------------------------------------------------+
198 | **Release designation** | 2.0.3 Istanbul |
200 +--------------------------------------+--------------------------------------------------------+
201 | **Release date** | 2022-07-01 |
203 +--------------------------------------+--------------------------------------------------------+
208 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
216 +--------------------------------------+--------------------------------------------------------+
217 | **CPS Project** | |
219 +--------------------------------------+--------------------------------------------------------+
220 | **Docker images** | onap/cps-and-ncmp:2.0.2 |
222 +--------------------------------------+--------------------------------------------------------+
223 | **Release designation** | 2.0.2 Istanbul |
225 +--------------------------------------+--------------------------------------------------------+
226 | **Release date** | 2021-16-12 |
228 +--------------------------------------+--------------------------------------------------------+
233 - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_ Update log4j version due to security vulnerability
241 +--------------------------------------+--------------------------------------------------------+
242 | **CPS Project** | |
244 +--------------------------------------+--------------------------------------------------------+
245 | **Docker images** | onap/cps-and-ncmp:2.0.1 |
247 +--------------------------------------+--------------------------------------------------------+
248 | **Release designation** | 2.0.1 Istanbul |
250 +--------------------------------------+--------------------------------------------------------+
251 | **Release date** | 2021-14-10 |
253 +--------------------------------------+--------------------------------------------------------+
258 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
259 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
260 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
261 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
263 Known Limitations, Issues and Workarounds
264 -----------------------------------------
268 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
270 *Known Vulnerabilities*
272 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
276 Add recursive method to save list node data to loop through all corresponding child nodes.
281 *Fixed Security Issues*
283 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
285 *Known Security Issues*
295 This document provides the release notes for Istanbul release.
300 +--------------------------------------+--------------------------------------------------------+
301 | **CPS Project** | |
303 +--------------------------------------+--------------------------------------------------------+
304 | **Docker images** | onap/cps-and-ncmp:2.0.0 |
306 +--------------------------------------+--------------------------------------------------------+
307 | **Release designation** | 2.0.0 Istanbul |
309 +--------------------------------------+--------------------------------------------------------+
310 | **Release date** | 2021-14-09 |
312 +--------------------------------------+--------------------------------------------------------+
316 * Register DMI-Plugins with NCMP for CM Handle registrations.
317 * Update, Create and Remove CM Handles.
318 * Add support for retrieving and writing CM Handle data through NCMP datastores.
319 * Automatic retrieval and caching of model information for CM Handles within NCMP.
324 Software Deliverables
327 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
330 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
335 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
336 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
337 - `CPS-336 <https://jira.onap.org/browse/CPS-336>`_ Ends-with functionality in cpsPath does not conform with standard xPath behavior
338 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
339 - `CPS-357 <https://jira.onap.org/browse/CPS-357>`_ cps-review-verification-maven-master Jenkins job is failing when running csit test
340 - `CPS-367 <https://jira.onap.org/browse/CPS-367>`_ Get descendent does not support xpaths that end in list values
341 - `CPS-377 <https://jira.onap.org/browse/CPS-377>`_ Init ran model validation is failing error details are not provided
342 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
343 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
344 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
345 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
346 - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ Request to update node leaves (patch) responds with json parsing failure
347 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
348 - `CPS-479 <https://jira.onap.org/browse/CPS-479>`_ Get Nodes API does not always return the object from the root
349 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
350 - `CPS-501 <https://jira.onap.org/browse/CPS-501>`_ Put DataNode API has missing transaction and error handling for concurrency issues
351 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
352 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
353 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
354 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
355 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
356 - `CPS-591 <https://jira.onap.org/browse/CPS-591>`_ CPS-Core Leaf stored as integer is being returned from DB as float
357 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
358 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
359 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
360 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
362 This document provides the release notes for Istanbul release.
367 Following CPS components are available with default ONAP/CPS installation.
370 * Platform components
380 * Additional resources that CPS utilizes deployed using ONAP common charts
385 Below service components (mS) are available to be deployed on-demand.
389 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
391 Known Limitations, Issues and Workarounds
392 -----------------------------------------
396 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
398 *Known Vulnerabilities*
400 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
401 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
402 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
406 Add recursive method to save list node data to loop through all corresponding child nodes.
411 *Fixed Security Issues*
413 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
415 *Known Security Issues*
417 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
421 * `Integration tests`
423 .. ========================
424 .. * * * HONOLULU * * *
425 .. ========================
433 +--------------------------------------+--------------------------------------------------------+
434 | **CPS Project** | |
436 +--------------------------------------+--------------------------------------------------------+
437 | **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
439 +--------------------------------------+--------------------------------------------------------+
440 | **Release designation** | 1.0.1 Honolulu |
442 +--------------------------------------+--------------------------------------------------------+
443 | **Release date** | 2021-04-09 |
445 +--------------------------------------+--------------------------------------------------------+
450 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
451 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
452 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
453 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
454 - `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
455 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
456 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
457 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
462 *Fixed Security Issues*
464 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
466 *Known Security Issues*
468 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
477 This document provides the release notes for Honolulu release.
482 Following CPS components are available with default ONAP/CPS installation.
485 * Platform components
493 * Additional resources that CPS utilizes deployed using ONAP common charts
498 Below service components (mS) are available to be deployed on-demand.
502 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
508 +--------------------------------------+--------------------------------------------------------+
509 | **CPS Project** | |
511 +--------------------------------------+--------------------------------------------------------+
512 | **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
514 +--------------------------------------+--------------------------------------------------------+
515 | **Release designation** | 1.0.0 Honolulu |
517 +--------------------------------------+--------------------------------------------------------+
518 | **Release date** | 2021-03-11 |
520 +--------------------------------------+--------------------------------------------------------+
525 Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
526 CPS has been driven by the needs of the E2E Networking Slicing use case.
527 It currently supports basic (rw) persistence and simple queries.
528 It also provides MVP support for network data access using simulated data.
530 .. _honolulu_deliverable:
535 Software Deliverables
538 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
541 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
544 Known Limitations, Issues and Workarounds
545 -----------------------------------------
547 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
548 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
549 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
550 - `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.
556 *Known Vulnerabilities*
562 Documented under corresponding jira if applicable.
567 *Fixed Security Issues*
569 * `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
570 - Upgrade org.onap.oparent to 3.2.0
571 - Upgrade spring.boot to 2.3.8.RELEASE
572 - Upgrade yangtools to 5.0.7
574 *Known Security Issues*
576 * Weak Crytography using md5
577 * Risk seen in Zip file expansion
579 *Known Vulnerabilities in Used Modules*
583 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.
587 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
592 For more information on the ONAP Honolulu release, please see:
595 #. `ONAP Documentation`_
596 #. `ONAP Release Downloads`_
600 .. _`ONAP Home Page`: https://www.onap.org
601 .. _`ONAP Wiki Page`: https://wiki.onap.org
602 .. _`ONAP Documentation`: https://docs.onap.org
603 .. _`ONAP Release Downloads`: https://git.onap.org
607 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
608 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_