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
43 .. ========================
44 .. * * * JAKARTA * * *
45 .. ========================
53 +--------------------------------------+--------------------------------------------------------+
56 +--------------------------------------+--------------------------------------------------------+
57 | **Docker images** | onap/cps-and-ncmp:3.0.1 |
59 +--------------------------------------+--------------------------------------------------------+
60 | **Release designation** | 3.0.1 Jakarta |
62 +--------------------------------------+--------------------------------------------------------+
63 | **Release date** | 2022 April 28 |
65 +--------------------------------------+--------------------------------------------------------+
69 - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_ Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
77 +--------------------------------------+--------------------------------------------------------+
80 +--------------------------------------+--------------------------------------------------------+
81 | **Docker images** | onap/cps-and-ncmp:3.0.0 |
83 +--------------------------------------+--------------------------------------------------------+
84 | **Release designation** | 3.0.0 Jakarta |
86 +--------------------------------------+--------------------------------------------------------+
87 | **Release date** | 2022 March 15 |
89 +--------------------------------------+--------------------------------------------------------+
93 - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_ Define response objects (schemas) in cps-ncmp
94 - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_ Update operation for datastore pass through running
95 - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_ Delete operation for datastore pass through running
96 - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_ Support 'public' Cm Handle Properties
97 - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
98 - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_ Ensure all DMI operations use POST method
99 - `CPS-780 <https://jira.onap.org/browse/CPS-780>`_ Add examples for parameters, request and response in openapi yaml for cps-core
100 - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
101 - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
102 - `CPS-817 <https://jira.onap.org/browse/CPS-817>`_ Create Endpoint For Get Cm Handles (incl. public properties) By Name
103 - `CPS-837 <https://jira.onap.org/browse/CPS-837>`_ Add Remove and Update properties (DMI and Public) as part of CM Handle Registration update
108 - `CPS-762 <https://jira.onap.org/browse/CPS-762>`_ Query cm handles for module names returns incorrect cm handle identifiers
109 - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
110 - `CPS-783 <https://jira.onap.org/browse/CPS-783>`_ Remove cm handle does not completely remove all cm handle information
111 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM
112 - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
113 - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
114 - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
115 - `CPS-887 <https://jira.onap.org/browse/CPS-887>`_ Increase performance of cmHandle registration for large number of schema sets in DB
116 - `CPS-892 <https://jira.onap.org/browse/CPS-892>`_ Fixed the response code during CM-Handle Registration from 201 CREATED to 204 NO_CONTENT
117 - `CPS-893 <https://jira.onap.org/browse/CPS-893>`_ NCMP Java API depends on NCM-Rest-API (cyclic) through json properties on Java API
119 Known Limitations, Issues and Workarounds
120 -----------------------------------------
124 Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
125 `CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
126 of cm handle registration.
128 The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
129 for more information.
131 *Known Vulnerabilities*
137 Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
138 pass an empty string as the value if you do not want to include names for these values.
143 *Fixed Security Issues*
147 *Known Security Issues*
151 .. ========================
152 .. * * * ISTANBUL * * *
153 .. ========================
161 +--------------------------------------+--------------------------------------------------------+
162 | **CPS Project** | |
164 +--------------------------------------+--------------------------------------------------------+
165 | **Docker images** | onap/cps-and-ncmp:2.0.4 |
167 +--------------------------------------+--------------------------------------------------------+
168 | **Release designation** | 2.0.4 Istanbul |
170 +--------------------------------------+--------------------------------------------------------+
171 | **Release date** | 2022 Feb 09 |
173 +--------------------------------------+--------------------------------------------------------+
178 - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_ Fix docker compose for csit test.
179 - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_ Fix intermittent circular dependency error when the application starts.
187 +--------------------------------------+--------------------------------------------------------+
188 | **CPS Project** | |
190 +--------------------------------------+--------------------------------------------------------+
191 | **Docker images** | onap/cps-and-ncmp:2.0.3 |
193 +--------------------------------------+--------------------------------------------------------+
194 | **Release designation** | 2.0.3 Istanbul |
196 +--------------------------------------+--------------------------------------------------------+
197 | **Release date** | 2022-07-01 |
199 +--------------------------------------+--------------------------------------------------------+
204 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
212 +--------------------------------------+--------------------------------------------------------+
213 | **CPS Project** | |
215 +--------------------------------------+--------------------------------------------------------+
216 | **Docker images** | onap/cps-and-ncmp:2.0.2 |
218 +--------------------------------------+--------------------------------------------------------+
219 | **Release designation** | 2.0.2 Istanbul |
221 +--------------------------------------+--------------------------------------------------------+
222 | **Release date** | 2021-16-12 |
224 +--------------------------------------+--------------------------------------------------------+
229 - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_ Update log4j version due to security vulnerability
237 +--------------------------------------+--------------------------------------------------------+
238 | **CPS Project** | |
240 +--------------------------------------+--------------------------------------------------------+
241 | **Docker images** | onap/cps-and-ncmp:2.0.1 |
243 +--------------------------------------+--------------------------------------------------------+
244 | **Release designation** | 2.0.1 Istanbul |
246 +--------------------------------------+--------------------------------------------------------+
247 | **Release date** | 2021-14-10 |
249 +--------------------------------------+--------------------------------------------------------+
254 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
255 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
256 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
257 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
259 Known Limitations, Issues and Workarounds
260 -----------------------------------------
264 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
266 *Known Vulnerabilities*
268 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
272 Add recursive method to save list node data to loop through all corresponding child nodes.
277 *Fixed Security Issues*
279 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
281 *Known Security Issues*
291 This document provides the release notes for Istanbul release.
296 +--------------------------------------+--------------------------------------------------------+
297 | **CPS Project** | |
299 +--------------------------------------+--------------------------------------------------------+
300 | **Docker images** | onap/cps-and-ncmp:2.0.0 |
302 +--------------------------------------+--------------------------------------------------------+
303 | **Release designation** | 2.0.0 Istanbul |
305 +--------------------------------------+--------------------------------------------------------+
306 | **Release date** | 2021-14-09 |
308 +--------------------------------------+--------------------------------------------------------+
312 * Register DMI-Plugins with NCMP for CM Handle registrations.
313 * Update, Create and Remove CM Handles.
314 * Add support for retrieving and writing CM Handle data through NCMP datastores.
315 * Automatic retrieval and caching of model information for CM Handles within NCMP.
320 Software Deliverables
323 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
326 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
331 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
332 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
333 - `CPS-336 <https://jira.onap.org/browse/CPS-336>`_ Ends-with functionality in cpsPath does not conform with standard xPath behavior
334 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
335 - `CPS-357 <https://jira.onap.org/browse/CPS-357>`_ cps-review-verification-maven-master Jenkins job is failing when running csit test
336 - `CPS-367 <https://jira.onap.org/browse/CPS-367>`_ Get descendent does not support xpaths that end in list values
337 - `CPS-377 <https://jira.onap.org/browse/CPS-377>`_ Init ran model validation is failing error details are not provided
338 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
339 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
340 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
341 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
342 - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ Request to update node leaves (patch) responds with json parsing failure
343 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
344 - `CPS-479 <https://jira.onap.org/browse/CPS-479>`_ Get Nodes API does not always return the object from the root
345 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
346 - `CPS-501 <https://jira.onap.org/browse/CPS-501>`_ Put DataNode API has missing transaction and error handling for concurrency issues
347 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
348 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
349 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
350 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
351 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
352 - `CPS-591 <https://jira.onap.org/browse/CPS-591>`_ CPS-Core Leaf stored as integer is being returned from DB as float
353 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
354 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
355 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
356 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
358 This document provides the release notes for Istanbul release.
363 Following CPS components are available with default ONAP/CPS installation.
366 * Platform components
376 * Additional resources that CPS utilizes deployed using ONAP common charts
381 Below service components (mS) are available to be deployed on-demand.
385 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
387 Known Limitations, Issues and Workarounds
388 -----------------------------------------
392 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
394 *Known Vulnerabilities*
396 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
397 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
398 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
402 Add recursive method to save list node data to loop through all corresponding child nodes.
407 *Fixed Security Issues*
409 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
411 *Known Security Issues*
413 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
417 * `Integration tests`
419 .. ========================
420 .. * * * HONOLULU * * *
421 .. ========================
429 +--------------------------------------+--------------------------------------------------------+
430 | **CPS Project** | |
432 +--------------------------------------+--------------------------------------------------------+
433 | **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
435 +--------------------------------------+--------------------------------------------------------+
436 | **Release designation** | 1.0.1 Honolulu |
438 +--------------------------------------+--------------------------------------------------------+
439 | **Release date** | 2021-04-09 |
441 +--------------------------------------+--------------------------------------------------------+
446 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
447 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
448 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
449 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
450 - `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
451 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
452 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
453 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
458 *Fixed Security Issues*
460 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
462 *Known Security Issues*
464 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
473 This document provides the release notes for Honolulu release.
478 Following CPS components are available with default ONAP/CPS installation.
481 * Platform components
489 * Additional resources that CPS utilizes deployed using ONAP common charts
494 Below service components (mS) are available to be deployed on-demand.
498 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
504 +--------------------------------------+--------------------------------------------------------+
505 | **CPS Project** | |
507 +--------------------------------------+--------------------------------------------------------+
508 | **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
510 +--------------------------------------+--------------------------------------------------------+
511 | **Release designation** | 1.0.0 Honolulu |
513 +--------------------------------------+--------------------------------------------------------+
514 | **Release date** | 2021-03-11 |
516 +--------------------------------------+--------------------------------------------------------+
521 Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
522 CPS has been driven by the needs of the E2E Networking Slicing use case.
523 It currently supports basic (rw) persistence and simple queries.
524 It also provides MVP support for network data access using simulated data.
526 .. _honolulu_deliverable:
531 Software Deliverables
534 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
537 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
540 Known Limitations, Issues and Workarounds
541 -----------------------------------------
543 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
544 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
545 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
546 - `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.
552 *Known Vulnerabilities*
558 Documented under corresponding jira if applicable.
563 *Fixed Security Issues*
565 * `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
566 - Upgrade org.onap.oparent to 3.2.0
567 - Upgrade spring.boot to 2.3.8.RELEASE
568 - Upgrade yangtools to 5.0.7
570 *Known Security Issues*
572 * Weak Crytography using md5
573 * Risk seen in Zip file expansion
575 *Known Vulnerabilities in Used Modules*
579 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.
583 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
588 For more information on the ONAP Honolulu release, please see:
591 #. `ONAP Documentation`_
592 #. `ONAP Release Downloads`_
596 .. _`ONAP Home Page`: https://www.onap.org
597 .. _`ONAP Wiki Page`: https://wiki.onap.org
598 .. _`ONAP Documentation`: https://docs.onap.org
599 .. _`ONAP Release Downloads`: https://git.onap.org
603 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
604 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_