docs/release-notes.rst

   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
   4
   5 .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
   6 .. _release_notes:
   7
   8
   9
  10 =================
  11 CPS Release Notes
  12 =================
  13
  14 .. contents::
  15     :depth: 2
  16 ..
  17
  18 ..      ========================
  19 ..      * * *   ISTANBUL   * * *
  20 ..      ========================
  21
  22 Version: 2.0.1
  23 ==============
  24
  25 Release Data
  26 ------------
  27
  28 +--------------------------------------+--------------------------------------------------------+
  29 | **CPS Project**                      |                                                        |
  30 |                                      |                                                        |
  31 +--------------------------------------+--------------------------------------------------------+
  32 | **Docker images**                    | onap/cps-and-ncmp:2.0.1                                |
  33 |                                      |                                                        |
  34 +--------------------------------------+--------------------------------------------------------+
  35 | **Release designation**              | 2.0.1 Istanbul                                         |
  36 |                                      |                                                        |
  37 +--------------------------------------+--------------------------------------------------------+
  38 | **Release date**                     | 2021-14-10                                             |
  39 |                                      |                                                        |
  40 +--------------------------------------+--------------------------------------------------------+
  41
  42 Bug Fixes
  43 ---------
  44
  45    - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
  46    - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
  47    - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
  48    - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
  49
  50 Known Limitations, Issues and Workarounds
  51 -----------------------------------------
  52
  53 *System Limitations*
  54
  55 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
  56
  57 *Known Vulnerabilities*
  58
  59    - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
  60
  61 *Workarounds*
  62
  63 Add recursive method to save list node data to loop through all corresponding child nodes.
  64
  65 Security Notes
  66 --------------
  67
  68 *Fixed Security Issues*
  69
  70    - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
  71
  72 *Known Security Issues*
  73
  74 None
  75
  76 Version: 2.0.0
  77 ==============
  78
  79 Abstract
  80 --------
  81
  82 This document provides the release notes for Istanbul release.
  83
  84 Release Data
  85 ------------
  86
  87 +--------------------------------------+--------------------------------------------------------+
  88 | **CPS Project**                      |                                                        |
  89 |                                      |                                                        |
  90 +--------------------------------------+--------------------------------------------------------+
  91 | **Docker images**                    | onap/cps-and-ncmp:2.0.0                                |
  92 |                                      |                                                        |
  93 +--------------------------------------+--------------------------------------------------------+
  94 | **Release designation**              | 2.0.0 Istanbul                                         |
  95 |                                      |                                                        |
  96 +--------------------------------------+--------------------------------------------------------+
  97 | **Release date**                     | 2021-14-09                                             |
  98 |                                      |                                                        |
  99 +--------------------------------------+--------------------------------------------------------+
 100
 101 Features
 102 --------
 103 * Register DMI-Plugins with NCMP for CM Handle registrations.
 104 * Update, Create and Remove CM Handles.
 105 * Add support for retrieving and writing CM Handle data through NCMP datastores.
 106 * Automatic retrieval and caching of model information for CM Handles within NCMP.
 107
 108 Deliverables
 109 ------------
 110
 111 Software Deliverables
 112
 113 .. csv-table::
 114    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
 115    :widths: auto
 116
 117    "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
 118
 119 Bug Fixes
 120 ---------
 121
 122    - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
 123    - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
 124    - `CPS-336 <https://jira.onap.org/browse/CPS-336>`_ Ends-with functionality in cpsPath does not conform with standard xPath behavior
 125    - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
 126    - `CPS-357 <https://jira.onap.org/browse/CPS-357>`_ cps-review-verification-maven-master Jenkins job is failing when running csit test
 127    - `CPS-367 <https://jira.onap.org/browse/CPS-367>`_ Get descendent does not support xpaths that end in list values
 128    - `CPS-377 <https://jira.onap.org/browse/CPS-377>`_ Init ran model validation is failing error details are not provided
 129    - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
 130    - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
 131    - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
 132    - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
 133    - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ Request to update node leaves (patch) responds with json parsing failure
 134    - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
 135    - `CPS-479 <https://jira.onap.org/browse/CPS-479>`_ Get Nodes API does not always return the object from the root
 136    - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
 137    - `CPS-501 <https://jira.onap.org/browse/CPS-501>`_ Put DataNode API has missing transaction and error handling for concurrency issues
 138    - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
 139    - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
 140    - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
 141    - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
 142    - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
 143    - `CPS-591 <https://jira.onap.org/browse/CPS-591>`_ CPS-Core Leaf stored as integer is being returned from DB as float
 144    - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
 145    - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
 146    - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
 147    - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
 148
 149 This document provides the release notes for Istanbul release.
 150
 151 Summary
 152 -------
 153
 154 Following CPS components are available with default ONAP/CPS installation.
 155
 156
 157     * Platform components
 158
 159         - CPS (Helm charts)
 160
 161     * Service components
 162
 163         - CPS-NCMP
 164         - CPS-Temporal
 165         - DMI-Plugin
 166
 167     * Additional resources that CPS utilizes deployed using ONAP common charts
 168
 169         - Postgres Database
 170
 171
 172 Below service components (mS) are available to be deployed on-demand.
 173     - CPS-TBDMT
 174
 175
 176 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
 177
 178 Known Limitations, Issues and Workarounds
 179 -----------------------------------------
 180
 181 *System Limitations*
 182
 183 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
 184
 185 *Known Vulnerabilities*
 186
 187    - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
 188    - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
 189    - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
 190
 191 *Workarounds*
 192
 193 Add recursive method to save list node data to loop through all corresponding child nodes.
 194
 195 Security Notes
 196 --------------
 197
 198 *Fixed Security Issues*
 199
 200    - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
 201
 202 *Known Security Issues*
 203
 204    - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
 205
 206 Test Results
 207 ------------
 208     * `Integration tests`
 209
 210 ..      ========================
 211 ..      * * *   HONOLULU   * * *
 212 ..      ========================
 213
 214 Version: 1.0.1
 215 ==============
 216
 217 Release Data
 218 ------------
 219
 220 +--------------------------------------+--------------------------------------------------------+
 221 | **CPS Project**                      |                                                        |
 222 |                                      |                                                        |
 223 +--------------------------------------+--------------------------------------------------------+
 224 | **Docker images**                    | onap/cps-and-nf-proxy:1.0.1                            |
 225 |                                      |                                                        |
 226 +--------------------------------------+--------------------------------------------------------+
 227 | **Release designation**              | 1.0.1 Honolulu                                         |
 228 |                                      |                                                        |
 229 +--------------------------------------+--------------------------------------------------------+
 230 | **Release date**                     | 2021-04-09                                             |
 231 |                                      |                                                        |
 232 +--------------------------------------+--------------------------------------------------------+
 233
 234 Bug Fixes
 235 ---------
 236
 237    - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
 238    - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
 239    - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
 240    - `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
 241    - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
 242    - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
 243    - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
 244
 245 Security Notes
 246 --------------
 247
 248 *Fixed Security Issues*
 249
 250    - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
 251
 252 *Known Security Issues*
 253
 254    - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
 255
 256 Version: 1.0.0
 257 ==============
 258
 259
 260 Abstract
 261 --------
 262
 263 This document provides the release notes for Honolulu release.
 264
 265 Summary
 266 -------
 267
 268 Following CPS components are available with default ONAP/CPS installation.
 269
 270
 271     * Platform components
 272
 273         - CPS (Helm charts)
 274
 275     * Service components
 276
 277         - CPS Core
 278
 279     * Additional resources that CPS utilizes deployed using ONAP common charts
 280
 281         - Postgres Database
 282
 283
 284 Below service components (mS) are available to be deployed on-demand.
 285     - CPS-TBDMT
 286
 287
 288 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
 289
 290
 291 Release Data
 292 ------------
 293
 294 +--------------------------------------+--------------------------------------------------------+
 295 | **CPS Project**                      |                                                        |
 296 |                                      |                                                        |
 297 +--------------------------------------+--------------------------------------------------------+
 298 | **Docker images**                    | Refer :any:`Deliverable <honolulu_deliverable>`        |
 299 |                                      |                                                        |
 300 +--------------------------------------+--------------------------------------------------------+
 301 | **Release designation**              | 1.0.0 Honolulu                                         |
 302 |                                      |                                                        |
 303 +--------------------------------------+--------------------------------------------------------+
 304 | **Release date**                     | 2021-03-11                                             |
 305 |                                      |                                                        |
 306 +--------------------------------------+--------------------------------------------------------+
 307
 308
 309 Features
 310 --------
 311 Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
 312 CPS has been driven by the needs of the E2E Networking Slicing use case.
 313 It currently supports basic (rw) persistence and simple queries.
 314 It also provides MVP support for network data access using simulated data.
 315
 316 .. _honolulu_deliverable:
 317
 318 Deliverables
 319 ------------
 320
 321 Software Deliverables
 322
 323 .. csv-table::
 324    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
 325    :widths: auto
 326
 327    "cps", "", "onap/cps-and-nf-proxy:1.0.0"
 328
 329
 330 Known Limitations, Issues and Workarounds
 331 -----------------------------------------
 332
 333    - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
 334    - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
 335    - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
 336    - `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.
 337
 338 *System Limitations*
 339
 340 None
 341
 342 *Known Vulnerabilities*
 343
 344 None
 345
 346 *Workarounds*
 347
 348 Documented under corresponding jira if applicable.
 349
 350 Security Notes
 351 --------------
 352
 353 *Fixed Security Issues*
 354
 355 * `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
 356     - Upgrade org.onap.oparent to 3.2.0
 357     - Upgrade spring.boot to 2.3.8.RELEASE
 358     - Upgrade yangtools to 5.0.7
 359
 360 *Known Security Issues*
 361
 362     * Weak Crytography using md5
 363     * Risk seen in Zip file expansion
 364
 365 *Known Vulnerabilities in Used Modules*
 366
 367     None
 368
 369 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.
 370
 371 Test Results
 372 ------------
 373     * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
 374
 375 References
 376 ----------
 377
 378 For more information on the ONAP Honolulu release, please see:
 379
 380 #. `ONAP Home Page`_
 381 #. `ONAP Documentation`_
 382 #. `ONAP Release Downloads`_
 383 #. `ONAP Wiki Page`_
 384
 385
 386 .. _`ONAP Home Page`: https://www.onap.org
 387 .. _`ONAP Wiki Page`: https://wiki.onap.org
 388 .. _`ONAP Documentation`: https://docs.onap.org
 389 .. _`ONAP Release Downloads`: https://git.onap.org
 390
 391 Quick Links:
 392
 393         - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
 394         - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_