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: 2.1.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.1 |
88 +--------------------------------------+--------------------------------------------------------+
89 | **Release designation** | 2.0.1 Istanbul |
91 +--------------------------------------+--------------------------------------------------------+
92 | **Release date** | 2021-14-10 |
94 +--------------------------------------+--------------------------------------------------------+
99 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
100 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
101 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
102 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
104 Known Limitations, Issues and Workarounds
105 -----------------------------------------
109 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
111 *Known Vulnerabilities*
113 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
117 Add recursive method to save list node data to loop through all corresponding child nodes.
122 *Fixed Security Issues*
124 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
126 *Known Security Issues*
136 This document provides the release notes for Istanbul release.
141 +--------------------------------------+--------------------------------------------------------+
142 | **CPS Project** | |
144 +--------------------------------------+--------------------------------------------------------+
145 | **Docker images** | onap/cps-and-ncmp:2.0.0 |
147 +--------------------------------------+--------------------------------------------------------+
148 | **Release designation** | 2.0.0 Istanbul |
150 +--------------------------------------+--------------------------------------------------------+
151 | **Release date** | 2021-14-09 |
153 +--------------------------------------+--------------------------------------------------------+
157 * Register DMI-Plugins with NCMP for CM Handle registrations.
158 * Update, Create and Remove CM Handles.
159 * Add support for retrieving and writing CM Handle data through NCMP datastores.
160 * Automatic retrieval and caching of model information for CM Handles within NCMP.
165 Software Deliverables
168 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
171 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
176 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
177 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
178 - `CPS-336 <https://jira.onap.org/browse/CPS-336>`_ Ends-with functionality in cpsPath does not conform with standard xPath behavior
179 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
180 - `CPS-357 <https://jira.onap.org/browse/CPS-357>`_ cps-review-verification-maven-master Jenkins job is failing when running csit test
181 - `CPS-367 <https://jira.onap.org/browse/CPS-367>`_ Get descendent does not support xpaths that end in list values
182 - `CPS-377 <https://jira.onap.org/browse/CPS-377>`_ Init ran model validation is failing error details are not provided
183 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
184 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
185 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
186 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
187 - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ Request to update node leaves (patch) responds with json parsing failure
188 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
189 - `CPS-479 <https://jira.onap.org/browse/CPS-479>`_ Get Nodes API does not always return the object from the root
190 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
191 - `CPS-501 <https://jira.onap.org/browse/CPS-501>`_ Put DataNode API has missing transaction and error handling for concurrency issues
192 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
193 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
194 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
195 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
196 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
197 - `CPS-591 <https://jira.onap.org/browse/CPS-591>`_ CPS-Core Leaf stored as integer is being returned from DB as float
198 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
199 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
200 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
201 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
203 This document provides the release notes for Istanbul release.
208 Following CPS components are available with default ONAP/CPS installation.
211 * Platform components
221 * Additional resources that CPS utilizes deployed using ONAP common charts
226 Below service components (mS) are available to be deployed on-demand.
230 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
232 Known Limitations, Issues and Workarounds
233 -----------------------------------------
237 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
239 *Known Vulnerabilities*
241 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
242 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
243 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
247 Add recursive method to save list node data to loop through all corresponding child nodes.
252 *Fixed Security Issues*
254 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
256 *Known Security Issues*
258 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
262 * `Integration tests`
264 .. ========================
265 .. * * * HONOLULU * * *
266 .. ========================
274 +--------------------------------------+--------------------------------------------------------+
275 | **CPS Project** | |
277 +--------------------------------------+--------------------------------------------------------+
278 | **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
280 +--------------------------------------+--------------------------------------------------------+
281 | **Release designation** | 1.0.1 Honolulu |
283 +--------------------------------------+--------------------------------------------------------+
284 | **Release date** | 2021-04-09 |
286 +--------------------------------------+--------------------------------------------------------+
291 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
292 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
293 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
294 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
295 - `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
296 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
297 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
298 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
303 *Fixed Security Issues*
305 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
307 *Known Security Issues*
309 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
318 This document provides the release notes for Honolulu release.
323 Following CPS components are available with default ONAP/CPS installation.
326 * Platform components
334 * Additional resources that CPS utilizes deployed using ONAP common charts
339 Below service components (mS) are available to be deployed on-demand.
343 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
349 +--------------------------------------+--------------------------------------------------------+
350 | **CPS Project** | |
352 +--------------------------------------+--------------------------------------------------------+
353 | **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
355 +--------------------------------------+--------------------------------------------------------+
356 | **Release designation** | 1.0.0 Honolulu |
358 +--------------------------------------+--------------------------------------------------------+
359 | **Release date** | 2021-03-11 |
361 +--------------------------------------+--------------------------------------------------------+
366 Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
367 CPS has been driven by the needs of the E2E Networking Slicing use case.
368 It currently supports basic (rw) persistence and simple queries.
369 It also provides MVP support for network data access using simulated data.
371 .. _honolulu_deliverable:
376 Software Deliverables
379 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
382 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
385 Known Limitations, Issues and Workarounds
386 -----------------------------------------
388 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
389 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
390 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
391 - `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.
397 *Known Vulnerabilities*
403 Documented under corresponding jira if applicable.
408 *Fixed Security Issues*
410 * `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
411 - Upgrade org.onap.oparent to 3.2.0
412 - Upgrade spring.boot to 2.3.8.RELEASE
413 - Upgrade yangtools to 5.0.7
415 *Known Security Issues*
417 * Weak Crytography using md5
418 * Risk seen in Zip file expansion
420 *Known Vulnerabilities in Used Modules*
424 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.
428 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
433 For more information on the ONAP Honolulu release, please see:
436 #. `ONAP Documentation`_
437 #. `ONAP Release Downloads`_
441 .. _`ONAP Home Page`: https://www.onap.org
442 .. _`ONAP Wiki Page`: https://wiki.onap.org
443 .. _`ONAP Documentation`: https://docs.onap.org
444 .. _`ONAP Release Downloads`: https://git.onap.org
448 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
449 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_