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