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