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
39 Known Limitations, Issues and Workarounds
40 -----------------------------------------
46 *Known Vulnerabilities*
57 *Fixed Security Issues*
61 *Known Security Issues*
65 .. ========================
66 .. * * * ISTANBUL * * *
67 .. ========================
75 +--------------------------------------+--------------------------------------------------------+
78 +--------------------------------------+--------------------------------------------------------+
79 | **Docker images** | onap/cps-and-ncmp:2.0.1 |
81 +--------------------------------------+--------------------------------------------------------+
82 | **Release designation** | 2.0.1 Istanbul |
84 +--------------------------------------+--------------------------------------------------------+
85 | **Release date** | 2021-14-10 |
87 +--------------------------------------+--------------------------------------------------------+
92 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
93 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
94 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
95 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
97 Known Limitations, Issues and Workarounds
98 -----------------------------------------
102 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
104 *Known Vulnerabilities*
106 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
110 Add recursive method to save list node data to loop through all corresponding child nodes.
115 *Fixed Security Issues*
117 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
119 *Known Security Issues*
129 This document provides the release notes for Istanbul release.
134 +--------------------------------------+--------------------------------------------------------+
135 | **CPS Project** | |
137 +--------------------------------------+--------------------------------------------------------+
138 | **Docker images** | onap/cps-and-ncmp:2.0.0 |
140 +--------------------------------------+--------------------------------------------------------+
141 | **Release designation** | 2.0.0 Istanbul |
143 +--------------------------------------+--------------------------------------------------------+
144 | **Release date** | 2021-14-09 |
146 +--------------------------------------+--------------------------------------------------------+
150 * Register DMI-Plugins with NCMP for CM Handle registrations.
151 * Update, Create and Remove CM Handles.
152 * Add support for retrieving and writing CM Handle data through NCMP datastores.
153 * Automatic retrieval and caching of model information for CM Handles within NCMP.
158 Software Deliverables
161 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
164 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
169 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
170 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
171 - `CPS-336 <https://jira.onap.org/browse/CPS-336>`_ Ends-with functionality in cpsPath does not conform with standard xPath behavior
172 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
173 - `CPS-357 <https://jira.onap.org/browse/CPS-357>`_ cps-review-verification-maven-master Jenkins job is failing when running csit test
174 - `CPS-367 <https://jira.onap.org/browse/CPS-367>`_ Get descendent does not support xpaths that end in list values
175 - `CPS-377 <https://jira.onap.org/browse/CPS-377>`_ Init ran model validation is failing error details are not provided
176 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
177 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
178 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
179 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
180 - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ Request to update node leaves (patch) responds with json parsing failure
181 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
182 - `CPS-479 <https://jira.onap.org/browse/CPS-479>`_ Get Nodes API does not always return the object from the root
183 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
184 - `CPS-501 <https://jira.onap.org/browse/CPS-501>`_ Put DataNode API has missing transaction and error handling for concurrency issues
185 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
186 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
187 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
188 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
189 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
190 - `CPS-591 <https://jira.onap.org/browse/CPS-591>`_ CPS-Core Leaf stored as integer is being returned from DB as float
191 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
192 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
193 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
194 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
196 This document provides the release notes for Istanbul release.
201 Following CPS components are available with default ONAP/CPS installation.
204 * Platform components
214 * Additional resources that CPS utilizes deployed using ONAP common charts
219 Below service components (mS) are available to be deployed on-demand.
223 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
225 Known Limitations, Issues and Workarounds
226 -----------------------------------------
230 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
232 *Known Vulnerabilities*
234 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
235 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
236 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
240 Add recursive method to save list node data to loop through all corresponding child nodes.
245 *Fixed Security Issues*
247 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
249 *Known Security Issues*
251 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
255 * `Integration tests`
257 .. ========================
258 .. * * * HONOLULU * * *
259 .. ========================
267 +--------------------------------------+--------------------------------------------------------+
268 | **CPS Project** | |
270 +--------------------------------------+--------------------------------------------------------+
271 | **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
273 +--------------------------------------+--------------------------------------------------------+
274 | **Release designation** | 1.0.1 Honolulu |
276 +--------------------------------------+--------------------------------------------------------+
277 | **Release date** | 2021-04-09 |
279 +--------------------------------------+--------------------------------------------------------+
284 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
285 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
286 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
287 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
288 - `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
289 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
290 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
291 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
296 *Fixed Security Issues*
298 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
300 *Known Security Issues*
302 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
311 This document provides the release notes for Honolulu release.
316 Following CPS components are available with default ONAP/CPS installation.
319 * Platform components
327 * Additional resources that CPS utilizes deployed using ONAP common charts
332 Below service components (mS) are available to be deployed on-demand.
336 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
342 +--------------------------------------+--------------------------------------------------------+
343 | **CPS Project** | |
345 +--------------------------------------+--------------------------------------------------------+
346 | **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
348 +--------------------------------------+--------------------------------------------------------+
349 | **Release designation** | 1.0.0 Honolulu |
351 +--------------------------------------+--------------------------------------------------------+
352 | **Release date** | 2021-03-11 |
354 +--------------------------------------+--------------------------------------------------------+
359 Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
360 CPS has been driven by the needs of the E2E Networking Slicing use case.
361 It currently supports basic (rw) persistence and simple queries.
362 It also provides MVP support for network data access using simulated data.
364 .. _honolulu_deliverable:
369 Software Deliverables
372 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
375 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
378 Known Limitations, Issues and Workarounds
379 -----------------------------------------
381 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
382 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
383 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
384 - `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.
390 *Known Vulnerabilities*
396 Documented under corresponding jira if applicable.
401 *Fixed Security Issues*
403 * `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
404 - Upgrade org.onap.oparent to 3.2.0
405 - Upgrade spring.boot to 2.3.8.RELEASE
406 - Upgrade yangtools to 5.0.7
408 *Known Security Issues*
410 * Weak Crytography using md5
411 * Risk seen in Zip file expansion
413 *Known Vulnerabilities in Used Modules*
417 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.
421 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
426 For more information on the ONAP Honolulu release, please see:
429 #. `ONAP Documentation`_
430 #. `ONAP Release Downloads`_
434 .. _`ONAP Home Page`: https://www.onap.org
435 .. _`ONAP Wiki Page`: https://wiki.onap.org
436 .. _`ONAP Documentation`: https://docs.onap.org
437 .. _`ONAP Release Downloads`: https://git.onap.org
441 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
442 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_