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
38 Known Limitations, Issues and Workarounds
39 -----------------------------------------
45 *Known Vulnerabilities*
56 *Fixed Security Issues*
60 *Known Security Issues*
64 .. ========================
65 .. * * * ISTANBUL * * *
66 .. ========================
74 +--------------------------------------+--------------------------------------------------------+
77 +--------------------------------------+--------------------------------------------------------+
78 | **Docker images** | onap/cps-and-ncmp:2.0.1 |
80 +--------------------------------------+--------------------------------------------------------+
81 | **Release designation** | 2.0.1 Istanbul |
83 +--------------------------------------+--------------------------------------------------------+
84 | **Release date** | 2021-14-10 |
86 +--------------------------------------+--------------------------------------------------------+
91 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
92 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
93 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
94 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
96 Known Limitations, Issues and Workarounds
97 -----------------------------------------
101 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
103 *Known Vulnerabilities*
105 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
109 Add recursive method to save list node data to loop through all corresponding child nodes.
114 *Fixed Security Issues*
116 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
118 *Known Security Issues*
128 This document provides the release notes for Istanbul release.
133 +--------------------------------------+--------------------------------------------------------+
134 | **CPS Project** | |
136 +--------------------------------------+--------------------------------------------------------+
137 | **Docker images** | onap/cps-and-ncmp:2.0.0 |
139 +--------------------------------------+--------------------------------------------------------+
140 | **Release designation** | 2.0.0 Istanbul |
142 +--------------------------------------+--------------------------------------------------------+
143 | **Release date** | 2021-14-09 |
145 +--------------------------------------+--------------------------------------------------------+
149 * Register DMI-Plugins with NCMP for CM Handle registrations.
150 * Update, Create and Remove CM Handles.
151 * Add support for retrieving and writing CM Handle data through NCMP datastores.
152 * Automatic retrieval and caching of model information for CM Handles within NCMP.
157 Software Deliverables
160 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
163 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
168 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
169 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
170 - `CPS-336 <https://jira.onap.org/browse/CPS-336>`_ Ends-with functionality in cpsPath does not conform with standard xPath behavior
171 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
172 - `CPS-357 <https://jira.onap.org/browse/CPS-357>`_ cps-review-verification-maven-master Jenkins job is failing when running csit test
173 - `CPS-367 <https://jira.onap.org/browse/CPS-367>`_ Get descendent does not support xpaths that end in list values
174 - `CPS-377 <https://jira.onap.org/browse/CPS-377>`_ Init ran model validation is failing error details are not provided
175 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
176 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
177 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
178 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
179 - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ Request to update node leaves (patch) responds with json parsing failure
180 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
181 - `CPS-479 <https://jira.onap.org/browse/CPS-479>`_ Get Nodes API does not always return the object from the root
182 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
183 - `CPS-501 <https://jira.onap.org/browse/CPS-501>`_ Put DataNode API has missing transaction and error handling for concurrency issues
184 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
185 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
186 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
187 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
188 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
189 - `CPS-591 <https://jira.onap.org/browse/CPS-591>`_ CPS-Core Leaf stored as integer is being returned from DB as float
190 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
191 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
192 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
193 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
195 This document provides the release notes for Istanbul release.
200 Following CPS components are available with default ONAP/CPS installation.
203 * Platform components
213 * Additional resources that CPS utilizes deployed using ONAP common charts
218 Below service components (mS) are available to be deployed on-demand.
222 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
224 Known Limitations, Issues and Workarounds
225 -----------------------------------------
229 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
231 *Known Vulnerabilities*
233 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
234 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
235 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
239 Add recursive method to save list node data to loop through all corresponding child nodes.
244 *Fixed Security Issues*
246 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
248 *Known Security Issues*
250 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
254 * `Integration tests`
256 .. ========================
257 .. * * * HONOLULU * * *
258 .. ========================
266 +--------------------------------------+--------------------------------------------------------+
267 | **CPS Project** | |
269 +--------------------------------------+--------------------------------------------------------+
270 | **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
272 +--------------------------------------+--------------------------------------------------------+
273 | **Release designation** | 1.0.1 Honolulu |
275 +--------------------------------------+--------------------------------------------------------+
276 | **Release date** | 2021-04-09 |
278 +--------------------------------------+--------------------------------------------------------+
283 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
284 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
285 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
286 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
287 - `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
288 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
289 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
290 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
295 *Fixed Security Issues*
297 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
299 *Known Security Issues*
301 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
310 This document provides the release notes for Honolulu release.
315 Following CPS components are available with default ONAP/CPS installation.
318 * Platform components
326 * Additional resources that CPS utilizes deployed using ONAP common charts
331 Below service components (mS) are available to be deployed on-demand.
335 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
341 +--------------------------------------+--------------------------------------------------------+
342 | **CPS Project** | |
344 +--------------------------------------+--------------------------------------------------------+
345 | **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
347 +--------------------------------------+--------------------------------------------------------+
348 | **Release designation** | 1.0.0 Honolulu |
350 +--------------------------------------+--------------------------------------------------------+
351 | **Release date** | 2021-03-11 |
353 +--------------------------------------+--------------------------------------------------------+
358 Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
359 CPS has been driven by the needs of the E2E Networking Slicing use case.
360 It currently supports basic (rw) persistence and simple queries.
361 It also provides MVP support for network data access using simulated data.
363 .. _honolulu_deliverable:
368 Software Deliverables
371 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
374 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
377 Known Limitations, Issues and Workarounds
378 -----------------------------------------
380 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
381 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
382 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
383 - `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.
389 *Known Vulnerabilities*
395 Documented under corresponding jira if applicable.
400 *Fixed Security Issues*
402 * `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
403 - Upgrade org.onap.oparent to 3.2.0
404 - Upgrade spring.boot to 2.3.8.RELEASE
405 - Upgrade yangtools to 5.0.7
407 *Known Security Issues*
409 * Weak Crytography using md5
410 * Risk seen in Zip file expansion
412 *Known Vulnerabilities in Used Modules*
416 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.
420 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
425 For more information on the ONAP Honolulu release, please see:
428 #. `ONAP Documentation`_
429 #. `ONAP Release Downloads`_
433 .. _`ONAP Home Page`: https://www.onap.org
434 .. _`ONAP Wiki Page`: https://wiki.onap.org
435 .. _`ONAP Documentation`: https://docs.onap.org
436 .. _`ONAP Release Downloads`: https://git.onap.org
440 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
441 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_