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 Nordix Foundation
5 .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
18 .. ========================
19 .. * * * JAKARTA * * *
20 .. ========================
22 Version: 3.0.0-SNAPSHOT
23 =======================
25 This 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.
29 - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_ Define response objects (schemas) in cps-ncmp
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
32 - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
33 - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_ Ensure all DMI operations use POST method
34 - `CPS-780 <https://jira.onap.org/browse/CPS-780>`_ Add examples for parameters, request and response in openapi yaml for cps-core
39 - `CPS-762 <https://jira.onap.org/browse/CPS-762>`_ Query cm handles for module names returns incorrect cm handle identifiers
40 - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
41 - `CPS-783 <https://jira.onap.org/browse/CPS-783>`_ Remove cm handle does not completely remove all cm handle information
42 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM
43 - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
44 - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
46 Known Limitations, Issues and Workarounds
47 -----------------------------------------
53 *Known Vulnerabilities*
64 *Fixed Security Issues*
68 *Known Security Issues*
72 .. ========================
73 .. * * * ISTANBUL * * *
74 .. ========================
82 +--------------------------------------+--------------------------------------------------------+
85 +--------------------------------------+--------------------------------------------------------+
86 | **Docker images** | onap/cps-and-ncmp:2.0.4 |
88 +--------------------------------------+--------------------------------------------------------+
89 | **Release designation** | 2.0.4 Istanbul |
91 +--------------------------------------+--------------------------------------------------------+
92 | **Release date** | 2022 Feb 09 |
94 +--------------------------------------+--------------------------------------------------------+
99 - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_ Fix docker compose for csit test.
100 - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_ Fix intermittent circular dependency error when the application starts.
108 +--------------------------------------+--------------------------------------------------------+
109 | **CPS Project** | |
111 +--------------------------------------+--------------------------------------------------------+
112 | **Docker images** | onap/cps-and-ncmp:2.0.3 |
114 +--------------------------------------+--------------------------------------------------------+
115 | **Release designation** | 2.0.3 Istanbul |
117 +--------------------------------------+--------------------------------------------------------+
118 | **Release date** | 2022-07-01 |
120 +--------------------------------------+--------------------------------------------------------+
125 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
133 +--------------------------------------+--------------------------------------------------------+
134 | **CPS Project** | |
136 +--------------------------------------+--------------------------------------------------------+
137 | **Docker images** | onap/cps-and-ncmp:2.0.2 |
139 +--------------------------------------+--------------------------------------------------------+
140 | **Release designation** | 2.0.2 Istanbul |
142 +--------------------------------------+--------------------------------------------------------+
143 | **Release date** | 2021-16-12 |
145 +--------------------------------------+--------------------------------------------------------+
150 - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_ Update log4j version due to security vulnerability
158 +--------------------------------------+--------------------------------------------------------+
159 | **CPS Project** | |
161 +--------------------------------------+--------------------------------------------------------+
162 | **Docker images** | onap/cps-and-ncmp:2.0.1 |
164 +--------------------------------------+--------------------------------------------------------+
165 | **Release designation** | 2.0.1 Istanbul |
167 +--------------------------------------+--------------------------------------------------------+
168 | **Release date** | 2021-14-10 |
170 +--------------------------------------+--------------------------------------------------------+
175 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
176 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
177 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
178 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
180 Known Limitations, Issues and Workarounds
181 -----------------------------------------
185 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
187 *Known Vulnerabilities*
189 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
193 Add recursive method to save list node data to loop through all corresponding child nodes.
198 *Fixed Security Issues*
200 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
202 *Known Security Issues*
212 This document provides the release notes for Istanbul release.
217 +--------------------------------------+--------------------------------------------------------+
218 | **CPS Project** | |
220 +--------------------------------------+--------------------------------------------------------+
221 | **Docker images** | onap/cps-and-ncmp:2.0.0 |
223 +--------------------------------------+--------------------------------------------------------+
224 | **Release designation** | 2.0.0 Istanbul |
226 +--------------------------------------+--------------------------------------------------------+
227 | **Release date** | 2021-14-09 |
229 +--------------------------------------+--------------------------------------------------------+
233 * Register DMI-Plugins with NCMP for CM Handle registrations.
234 * Update, Create and Remove CM Handles.
235 * Add support for retrieving and writing CM Handle data through NCMP datastores.
236 * Automatic retrieval and caching of model information for CM Handles within NCMP.
241 Software Deliverables
244 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
247 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
252 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
253 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
254 - `CPS-336 <https://jira.onap.org/browse/CPS-336>`_ Ends-with functionality in cpsPath does not conform with standard xPath behavior
255 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
256 - `CPS-357 <https://jira.onap.org/browse/CPS-357>`_ cps-review-verification-maven-master Jenkins job is failing when running csit test
257 - `CPS-367 <https://jira.onap.org/browse/CPS-367>`_ Get descendent does not support xpaths that end in list values
258 - `CPS-377 <https://jira.onap.org/browse/CPS-377>`_ Init ran model validation is failing error details are not provided
259 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
260 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
261 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
262 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
263 - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ Request to update node leaves (patch) responds with json parsing failure
264 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
265 - `CPS-479 <https://jira.onap.org/browse/CPS-479>`_ Get Nodes API does not always return the object from the root
266 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
267 - `CPS-501 <https://jira.onap.org/browse/CPS-501>`_ Put DataNode API has missing transaction and error handling for concurrency issues
268 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
269 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
270 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
271 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
272 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
273 - `CPS-591 <https://jira.onap.org/browse/CPS-591>`_ CPS-Core Leaf stored as integer is being returned from DB as float
274 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
275 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
276 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
277 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
279 This document provides the release notes for Istanbul release.
284 Following CPS components are available with default ONAP/CPS installation.
287 * Platform components
297 * Additional resources that CPS utilizes deployed using ONAP common charts
302 Below service components (mS) are available to be deployed on-demand.
306 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
308 Known Limitations, Issues and Workarounds
309 -----------------------------------------
313 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
315 *Known Vulnerabilities*
317 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
318 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
319 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
323 Add recursive method to save list node data to loop through all corresponding child nodes.
328 *Fixed Security Issues*
330 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
332 *Known Security Issues*
334 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
338 * `Integration tests`
340 .. ========================
341 .. * * * HONOLULU * * *
342 .. ========================
350 +--------------------------------------+--------------------------------------------------------+
351 | **CPS Project** | |
353 +--------------------------------------+--------------------------------------------------------+
354 | **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
356 +--------------------------------------+--------------------------------------------------------+
357 | **Release designation** | 1.0.1 Honolulu |
359 +--------------------------------------+--------------------------------------------------------+
360 | **Release date** | 2021-04-09 |
362 +--------------------------------------+--------------------------------------------------------+
367 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
368 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
369 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
370 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
371 - `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
372 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
373 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
374 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
379 *Fixed Security Issues*
381 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
383 *Known Security Issues*
385 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
394 This document provides the release notes for Honolulu release.
399 Following CPS components are available with default ONAP/CPS installation.
402 * Platform components
410 * Additional resources that CPS utilizes deployed using ONAP common charts
415 Below service components (mS) are available to be deployed on-demand.
419 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
425 +--------------------------------------+--------------------------------------------------------+
426 | **CPS Project** | |
428 +--------------------------------------+--------------------------------------------------------+
429 | **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
431 +--------------------------------------+--------------------------------------------------------+
432 | **Release designation** | 1.0.0 Honolulu |
434 +--------------------------------------+--------------------------------------------------------+
435 | **Release date** | 2021-03-11 |
437 +--------------------------------------+--------------------------------------------------------+
442 Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
443 CPS has been driven by the needs of the E2E Networking Slicing use case.
444 It currently supports basic (rw) persistence and simple queries.
445 It also provides MVP support for network data access using simulated data.
447 .. _honolulu_deliverable:
452 Software Deliverables
455 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
458 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
461 Known Limitations, Issues and Workarounds
462 -----------------------------------------
464 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
465 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
466 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
467 - `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.
473 *Known Vulnerabilities*
479 Documented under corresponding jira if applicable.
484 *Fixed Security Issues*
486 * `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
487 - Upgrade org.onap.oparent to 3.2.0
488 - Upgrade spring.boot to 2.3.8.RELEASE
489 - Upgrade yangtools to 5.0.7
491 *Known Security Issues*
493 * Weak Crytography using md5
494 * Risk seen in Zip file expansion
496 *Known Vulnerabilities in Used Modules*
500 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.
504 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
509 For more information on the ONAP Honolulu release, please see:
512 #. `ONAP Documentation`_
513 #. `ONAP Release Downloads`_
517 .. _`ONAP Home Page`: https://www.onap.org
518 .. _`ONAP Wiki Page`: https://wiki.onap.org
519 .. _`ONAP Documentation`: https://docs.onap.org
520 .. _`ONAP Release Downloads`: https://git.onap.org
524 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
525 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_