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-636 <https://jira.onap.org/browse/CPS-636>`_ Update operation for datastore pass through running
30 - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_ Delete operation for datastore pass through running
31 - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
36 - `CPS-762 <https://jira.onap.org/browse/CPS-762>`_ Query cm handles for module names returns incorrect cm handle identifiers
37 - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
38 - `CPS-783 <https://jira.onap.org/browse/CPS-783>`_ Remove cm handle does not completely remove all cm handle information
40 Known Limitations, Issues and Workarounds
41 -----------------------------------------
47 *Known Vulnerabilities*
58 *Fixed Security Issues*
62 *Known Security Issues*
66 .. ========================
67 .. * * * ISTANBUL * * *
68 .. ========================
76 +--------------------------------------+--------------------------------------------------------+
79 +--------------------------------------+--------------------------------------------------------+
80 | **Docker images** | onap/cps-and-ncmp:2.0.1 |
82 +--------------------------------------+--------------------------------------------------------+
83 | **Release designation** | 2.0.1 Istanbul |
85 +--------------------------------------+--------------------------------------------------------+
86 | **Release date** | 2021-14-10 |
88 +--------------------------------------+--------------------------------------------------------+
93 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
94 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
95 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
96 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
98 Known Limitations, Issues and Workarounds
99 -----------------------------------------
103 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
105 *Known Vulnerabilities*
107 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
111 Add recursive method to save list node data to loop through all corresponding child nodes.
116 *Fixed Security Issues*
118 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
120 *Known Security Issues*
130 This document provides the release notes for Istanbul release.
135 +--------------------------------------+--------------------------------------------------------+
136 | **CPS Project** | |
138 +--------------------------------------+--------------------------------------------------------+
139 | **Docker images** | onap/cps-and-ncmp:2.0.0 |
141 +--------------------------------------+--------------------------------------------------------+
142 | **Release designation** | 2.0.0 Istanbul |
144 +--------------------------------------+--------------------------------------------------------+
145 | **Release date** | 2021-14-09 |
147 +--------------------------------------+--------------------------------------------------------+
151 * Register DMI-Plugins with NCMP for CM Handle registrations.
152 * Update, Create and Remove CM Handles.
153 * Add support for retrieving and writing CM Handle data through NCMP datastores.
154 * Automatic retrieval and caching of model information for CM Handles within NCMP.
159 Software Deliverables
162 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
165 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
170 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
171 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
172 - `CPS-336 <https://jira.onap.org/browse/CPS-336>`_ Ends-with functionality in cpsPath does not conform with standard xPath behavior
173 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
174 - `CPS-357 <https://jira.onap.org/browse/CPS-357>`_ cps-review-verification-maven-master Jenkins job is failing when running csit test
175 - `CPS-367 <https://jira.onap.org/browse/CPS-367>`_ Get descendent does not support xpaths that end in list values
176 - `CPS-377 <https://jira.onap.org/browse/CPS-377>`_ Init ran model validation is failing error details are not provided
177 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
178 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
179 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
180 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
181 - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ Request to update node leaves (patch) responds with json parsing failure
182 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
183 - `CPS-479 <https://jira.onap.org/browse/CPS-479>`_ Get Nodes API does not always return the object from the root
184 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
185 - `CPS-501 <https://jira.onap.org/browse/CPS-501>`_ Put DataNode API has missing transaction and error handling for concurrency issues
186 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
187 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
188 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
189 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
190 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
191 - `CPS-591 <https://jira.onap.org/browse/CPS-591>`_ CPS-Core Leaf stored as integer is being returned from DB as float
192 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
193 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
194 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
195 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
197 This document provides the release notes for Istanbul release.
202 Following CPS components are available with default ONAP/CPS installation.
205 * Platform components
215 * Additional resources that CPS utilizes deployed using ONAP common charts
220 Below service components (mS) are available to be deployed on-demand.
224 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
226 Known Limitations, Issues and Workarounds
227 -----------------------------------------
231 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
233 *Known Vulnerabilities*
235 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
236 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
237 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
241 Add recursive method to save list node data to loop through all corresponding child nodes.
246 *Fixed Security Issues*
248 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
250 *Known Security Issues*
252 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
256 * `Integration tests`
258 .. ========================
259 .. * * * HONOLULU * * *
260 .. ========================
268 +--------------------------------------+--------------------------------------------------------+
269 | **CPS Project** | |
271 +--------------------------------------+--------------------------------------------------------+
272 | **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
274 +--------------------------------------+--------------------------------------------------------+
275 | **Release designation** | 1.0.1 Honolulu |
277 +--------------------------------------+--------------------------------------------------------+
278 | **Release date** | 2021-04-09 |
280 +--------------------------------------+--------------------------------------------------------+
285 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
286 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
287 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
288 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
289 - `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
290 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
291 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
292 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
297 *Fixed Security Issues*
299 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
301 *Known Security Issues*
303 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
312 This document provides the release notes for Honolulu release.
317 Following CPS components are available with default ONAP/CPS installation.
320 * Platform components
328 * Additional resources that CPS utilizes deployed using ONAP common charts
333 Below service components (mS) are available to be deployed on-demand.
337 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
343 +--------------------------------------+--------------------------------------------------------+
344 | **CPS Project** | |
346 +--------------------------------------+--------------------------------------------------------+
347 | **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
349 +--------------------------------------+--------------------------------------------------------+
350 | **Release designation** | 1.0.0 Honolulu |
352 +--------------------------------------+--------------------------------------------------------+
353 | **Release date** | 2021-03-11 |
355 +--------------------------------------+--------------------------------------------------------+
360 Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
361 CPS has been driven by the needs of the E2E Networking Slicing use case.
362 It currently supports basic (rw) persistence and simple queries.
363 It also provides MVP support for network data access using simulated data.
365 .. _honolulu_deliverable:
370 Software Deliverables
373 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
376 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
379 Known Limitations, Issues and Workarounds
380 -----------------------------------------
382 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
383 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
384 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
385 - `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.
391 *Known Vulnerabilities*
397 Documented under corresponding jira if applicable.
402 *Fixed Security Issues*
404 * `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
405 - Upgrade org.onap.oparent to 3.2.0
406 - Upgrade spring.boot to 2.3.8.RELEASE
407 - Upgrade yangtools to 5.0.7
409 *Known Security Issues*
411 * Weak Crytography using md5
412 * Risk seen in Zip file expansion
414 *Known Vulnerabilities in Used Modules*
418 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.
422 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
427 For more information on the ONAP Honolulu release, please see:
430 #. `ONAP Documentation`_
431 #. `ONAP Release Downloads`_
435 .. _`ONAP Home Page`: https://www.onap.org
436 .. _`ONAP Wiki Page`: https://wiki.onap.org
437 .. _`ONAP Documentation`: https://docs.onap.org
438 .. _`ONAP Release Downloads`: https://git.onap.org
442 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
443 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_