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