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 CPS Release Notes
   9 #################
  10
  11 .. contents::
  12     :depth: 2
  13 ..
  14
  15 ..      ======================
  16 ..      * * *   LONDON   * * *
  17 ..      ======================
  18
  19 Version: 3.2.1
  20 ==============
  21
  22 Release Data
  23 ------------
  24
  25 +--------------------------------------+--------------------------------------------------------+
  26 | **CPS Project**                      |                                                        |
  27 |                                      |                                                        |
  28 +--------------------------------------+--------------------------------------------------------+
  29 | **Docker images**                    | (not yet released)                                     |
  30 |                                      |                                                        |
  31 +--------------------------------------+--------------------------------------------------------+
  32 | **Release designation**              | 3.2.1 London                                           |
  33 |                                      |                                                        |
  34 +--------------------------------------+--------------------------------------------------------+
  35 | **Release date**                     |                                                        |
  36 |                                      |                                                        |
  37 +--------------------------------------+--------------------------------------------------------+
  38 Features
  39 --------
  40 3.2.1
  41    - `CPS-1236 <https://jira.onap.org/browse/CPS-1236>`_  DMI audit support for NCMP: Filter on any properties of CM Handles
  42 3.2.0
  43    - `CPS-1185 <https://jira.onap.org/browse/CPS-1185>`_  Get all dataspaces
  44    - `CPS-1187 <https://jira.onap.org/browse/CPS-1187>`_  Get single dataspace
  45
  46 Bug Fixes
  47 ---------
  48 3.2.0
  49    - `CPS-1312 <https://jira.onap.org/browse/CPS-1312>`_  CPS(/NCMP) does not have version control
  50    - `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_  [CPS/NCMP] Add Basic Auth to CPS/NCMP OpenAPI Definitions
  51
  52 Known Limitations, Issues and Workarounds
  53 -----------------------------------------
  54
  55 *System Limitations*
  56
  57 For upgrading, CPS uses Liquibase for database upgrades. CPS/NCMP currently only supports upgrading from Liquibase changelog 11 to Liquibase changelog 16.
  58 This is from commit CPS-506: List all known modules and revision to CPS-1312: Default CMHandles to READY during upgrade or from ONAP release Honolulu to Kohn.
  59
  60 ..      ====================
  61 ..      * * *   KOHN   * * *
  62 ..      ====================
  63
  64 Version: 3.1.4
  65 ==============
  66
  67 Release Data
  68 ------------
  69
  70 +--------------------------------------+--------------------------------------------------------+
  71 | **CPS Project**                      |                                                        |
  72 |                                      |                                                        |
  73 +--------------------------------------+--------------------------------------------------------+
  74 | **Docker images**                    | onap/cps-and-ncmp:3.1.4                                |
  75 |                                      |                                                        |
  76 +--------------------------------------+--------------------------------------------------------+
  77 | **Release designation**              | 3.1.4 Kohn                                             |
  78 |                                      |                                                        |
  79 +--------------------------------------+--------------------------------------------------------+
  80 | **Release date**                     | 2022 October 5                                         |
  81 |                                      |                                                        |
  82 +--------------------------------------+--------------------------------------------------------+
  83
  84 Bug Fixes
  85 ---------
  86    - `CPS-1265 <https://jira.onap.org/browse/CPS-1265>`_  Revision field should not be required (NotNull) on cps-ri YangResourceEntity
  87    - `CPS-1294 <https://jira.onap.org/browse/CPS-1294>`_  Kafka communication fault caused cmHandle registration error
  88
  89 Version: 3.1.3
  90 ==============
  91
  92 Release Data
  93 ------------
  94
  95 +--------------------------------------+--------------------------------------------------------+
  96 | **CPS Project**                      |                                                        |
  97 |                                      |                                                        |
  98 +--------------------------------------+--------------------------------------------------------+
  99 | **Docker images**                    | onap/cps-and-ncmp:3.1.3                                |
 100 |                                      |                                                        |
 101 +--------------------------------------+--------------------------------------------------------+
 102 | **Release designation**              | 3.1.3 Kohn                                             |
 103 |                                      |                                                        |
 104 +--------------------------------------+--------------------------------------------------------+
 105 | **Release date**                     | 2022 September 29                                      |
 106 |                                      |                                                        |
 107 +--------------------------------------+--------------------------------------------------------+
 108
 109 Bug Fixes
 110 ---------
 111    - None
 112
 113 Version: 3.1.2
 114 ==============
 115
 116 Release Data
 117 ------------
 118
 119 +--------------------------------------+--------------------------------------------------------+
 120 | **CPS Project**                      |                                                        |
 121 |                                      |                                                        |
 122 +--------------------------------------+--------------------------------------------------------+
 123 | **Docker images**                    | onap/cps-and-ncmp:3.1.2                                |
 124 |                                      |                                                        |
 125 +--------------------------------------+--------------------------------------------------------+
 126 | **Release designation**              | 3.1.2 Kohn                                             |
 127 |                                      |                                                        |
 128 +--------------------------------------+--------------------------------------------------------+
 129 | **Release date**                     | 2022 September 28                                      |
 130 |                                      |                                                        |
 131 +--------------------------------------+--------------------------------------------------------+
 132
 133 Bug Fixes
 134 ---------
 135    - None
 136
 137 Version: 3.1.1
 138 ==============
 139
 140 Release Data
 141 ------------
 142
 143 +--------------------------------------+--------------------------------------------------------+
 144 | **CPS Project**                      |                                                        |
 145 |                                      |                                                        |
 146 +--------------------------------------+--------------------------------------------------------+
 147 | **Docker images**                    | onap/cps-and-ncmp:3.1.1                                |
 148 |                                      |                                                        |
 149 +--------------------------------------+--------------------------------------------------------+
 150 | **Release designation**              | 3.1.1 Kohn                                             |
 151 |                                      |                                                        |
 152 +--------------------------------------+--------------------------------------------------------+
 153 | **Release date**                     | 2022 September 28                                      |
 154 |                                      |                                                        |
 155 +--------------------------------------+--------------------------------------------------------+
 156
 157 Bug Fixes
 158 ---------
 159    - None
 160
 161 Security Notes
 162 --------------
 163
 164 *Fixed Security Issues*
 165
 166    - `CPS-1226 <https://jira.onap.org/browse/CPS-1226>`_  Security bug in the logs
 167
 168 Version: 3.1.0
 169 ==============
 170
 171 Release Data
 172 ------------
 173
 174 +--------------------------------------+--------------------------------------------------------+
 175 | **CPS Project**                      |                                                        |
 176 |                                      |                                                        |
 177 +--------------------------------------+--------------------------------------------------------+
 178 | **Docker images**                    | onap/cps-and-ncmp:3.1.0                                |
 179 |                                      |                                                        |
 180 +--------------------------------------+--------------------------------------------------------+
 181 | **Release designation**              | 3.1.0 Kohn                                             |
 182 |                                      |                                                        |
 183 +--------------------------------------+--------------------------------------------------------+
 184 | **Release date**                     | 2022 September 14                                      |
 185 |                                      |                                                        |
 186 +--------------------------------------+--------------------------------------------------------+
 187
 188 Features
 189 --------
 190    - `CPS-340 <https://jira.onap.org/browse/CPS-340>`_  Patch and update the root data node
 191    - `CPS-575 <https://jira.onap.org/browse/CPS-575>`_  Write data for cmHandle using ncmp-datastores:passthrough-running (NCMP.)
 192    - `CPS-731 <https://jira.onap.org/browse/CPS-731>`_  Query based on Public CM Properties
 193    - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_  Async: NCMP Rest impl. including Request ID generation
 194    - `CPS-829 <https://jira.onap.org/browse/CPS-829>`_  Async: Internal message topic incl. basic producer & Consumer
 195    - `CPS-830 <https://jira.onap.org/browse/CPS-830>`_  DMI-NCMP Asynchronously Publish Response Event to Client Topic
 196    - `CPS-869 <https://jira.onap.org/browse/CPS-869>`_  Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072
 197    - `CPS-870 <https://jira.onap.org/browse/CPS-870>`_  Align CPS-Core output with SDN-C output (add module name)
 198    - `CPS-875 <https://jira.onap.org/browse/CPS-875>`_  CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles
 199    - `CPS-877 <https://jira.onap.org/browse/CPS-877>`_  CM Handle State: Exclude any CM-Handles from queries/operations that are not in state 'READY'
 200    - `CPS-899 <https://jira.onap.org/browse/CPS-899>`_  Start and stop sessions on Java API
 201    - `CPS-909 <https://jira.onap.org/browse/CPS-909>`_  Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state
 202    - `CPS-917 <https://jira.onap.org/browse/CPS-917>`_  Structured Errors response for passthrough use-cases in NCMP
 203    - `CPS-953 <https://jira.onap.org/browse/CPS-953>`_  Update maven deploy plugin version
 204    - `CPS-977 <https://jira.onap.org/browse/CPS-977>`_  Query CM Handles using CpsPath
 205    - `CPS-1000 <https://jira.onap.org/browse/CPS-1000>`_  Create Data Synchronization watchdog
 206    - `CPS-1016 <https://jira.onap.org/browse/CPS-1016>`_  Merge 2 'query' end points in NCMP
 207    - `CPS-1034 <https://jira.onap.org/browse/CPS-1034>`_  Publish lifecycle events for ADVISED , READY and LOCKED state transition"
 208    - `CPS-1064 <https://jira.onap.org/browse/CPS-1064>`_  Support retrieval of YANG module sources for CM handle on the NCMP interface
 209    - `CPS-1099 <https://jira.onap.org/browse/CPS-1099>`_  Expose simplified 'external' lock reason enum state over REST interface
 210    - `CPS-1101 <https://jira.onap.org/browse/CPS-1101>`_  Introducing the DELETING and DELETED Cmhandle State
 211    - `CPS-1102 <https://jira.onap.org/browse/CPS-1102>`_  Register the Cmhandle Sends Advised State notification.
 212    - `CPS-1133 <https://jira.onap.org/browse/CPS-1133>`_  Enable/Disable Data Sync for Cm Handle
 213    - `CPS-1136 <https://jira.onap.org/browse/CPS-1136>`_  DMI Audit Support (get all CM Handles for a registered DMI)
 214
 215
 216 Bug Fixes
 217 ---------
 218    - `CPS-896 <https://jira.onap.org/browse/CPS-896>`_  CM Handle Registration Process only partially completes when exception is thrown
 219    - `CPS-957 <https://jira.onap.org/browse/CPS-957>`_  NCMP: fix getResourceDataForPassthroughOperational endpoint
 220    - `CPS-1020 <https://jira.onap.org/browse/CPS-1020>`_  DuplicatedYangResourceException error at parallel cmHandle registration
 221    - `CPS-1056 <https://jira.onap.org/browse/CPS-1056>`_  Wrong error response format in case of Dmi plugin error
 222    - `CPS-1067 <https://jira.onap.org/browse/CPS-1067>`_  NCMP returns 500 error on searches endpoint when No DMi Handles registered
 223    - `CPS-1085 <https://jira.onap.org/browse/CPS-1085>`_  Performance degradation on ncmp/v1/ch/searches endpoint
 224    - `CPS-1088 <https://jira.onap.org/browse/CPS-1088>`_  Kafka consumer can not be turned off
 225    - `CPS-1097 <https://jira.onap.org/browse/CPS-1097>`_  Unable to change state from LOCKED to ADVISED
 226    - `CPS-1126 <https://jira.onap.org/browse/CPS-1126>`_  CmHandle creation performance degradation
 227    - `CPS-1175 <https://jira.onap.org/browse/CPS-1175>`_  Incorrect response when empty body executed for cmhandle id-searches
 228    - `CPS-1179 <https://jira.onap.org/browse/CPS-1179>`_  Node API - GET method returns invalid response when identifier contains '/'
 229    - `CPS-1212 <https://jira.onap.org/browse/CPS-1212>`_  Additional Properties for CM Handles not included when send to DMI Plugin
 230    - `CPS-1217 <https://jira.onap.org/browse/CPS-1217>`_  Searches endpoint gives back empty list however there are already available cmhandles
 231    - `CPS-1218 <https://jira.onap.org/browse/CPS-1218>`_  NCMP logs are flooded with SyncUtils logs
 232
 233 Known Limitations, Issues and Workarounds
 234 -----------------------------------------
 235
 236 *System Limitations*
 237
 238 Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition.
 239 Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces']
 240
 241 *Known Vulnerabilities*
 242
 243 None
 244
 245 *Workarounds*
 246
 247 None
 248
 249 Security Notes
 250 --------------
 251
 252 *Fixed Security Issues*
 253
 254    - `CPS-963 <https://jira.onap.org/browse/CPS-963>`_  Liquibase has got serious vulnerability, upgrade required
 255
 256 *Known Security Issues*
 257
 258 None
 259
 260 ..      ========================
 261 ..      * * *   JAKARTA   * * *
 262 ..      ========================
 263
 264 Version: 3.0.1
 265 ==============
 266
 267 Release Data
 268 ------------
 269
 270 +--------------------------------------+--------------------------------------------------------+
 271 | **CPS Project**                      |                                                        |
 272 |                                      |                                                        |
 273 +--------------------------------------+--------------------------------------------------------+
 274 | **Docker images**                    | onap/cps-and-ncmp:3.0.1                                |
 275 |                                      |                                                        |
 276 +--------------------------------------+--------------------------------------------------------+
 277 | **Release designation**              | 3.0.1 Jakarta                                          |
 278 |                                      |                                                        |
 279 +--------------------------------------+--------------------------------------------------------+
 280 | **Release date**                     | 2022 April 28                                          |
 281 |                                      |                                                        |
 282 +--------------------------------------+--------------------------------------------------------+
 283
 284 Bug Fixes
 285 ---------
 286    - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_  Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
 287
 288 Version: 3.0.0
 289 ==============
 290
 291 Release Data
 292 ------------
 293
 294 +--------------------------------------+--------------------------------------------------------+
 295 | **CPS Project**                      |                                                        |
 296 |                                      |                                                        |
 297 +--------------------------------------+--------------------------------------------------------+
 298 | **Docker images**                    | onap/cps-and-ncmp:3.0.0                                |
 299 |                                      |                                                        |
 300 +--------------------------------------+--------------------------------------------------------+
 301 | **Release designation**              | 3.0.0 Jakarta                                          |
 302 |                                      |                                                        |
 303 +--------------------------------------+--------------------------------------------------------+
 304 | **Release date**                     | 2022 March 15                                          |
 305 |                                      |                                                        |
 306 +--------------------------------------+--------------------------------------------------------+
 307
 308 Features
 309 --------
 310    - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_  Define response objects (schemas) in cps-ncmp
 311    - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_  Update operation for datastore pass through running
 312    - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_  Delete operation for datastore pass through running
 313    - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_  Support 'public' Cm Handle Properties
 314    - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_  Re sync after removing cm handles
 315    - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_  Ensure all DMI operations use POST method
 316    - `CPS-780 <https://jira.onap.org/browse/CPS-780>`_  Add examples for parameters, request and response in openapi yaml for cps-core
 317    - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
 318    - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
 319    - `CPS-817 <https://jira.onap.org/browse/CPS-817>`_  Create Endpoint For Get Cm Handles (incl. public properties) By Name
 320    - `CPS-837 <https://jira.onap.org/browse/CPS-837>`_  Add Remove and Update properties (DMI and Public) as part of CM Handle Registration update
 321
 322 Bug Fixes
 323 ---------
 324
 325    - `CPS-762 <https://jira.onap.org/browse/CPS-762>`_ Query cm handles for module names returns incorrect cm handle identifiers
 326    - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
 327    - `CPS-783 <https://jira.onap.org/browse/CPS-783>`_ Remove cm handle does not completely remove all cm handle information
 328    - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM
 329    - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
 330    - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
 331    - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
 332    - `CPS-887 <https://jira.onap.org/browse/CPS-887>`_ Increase performance of cmHandle registration for large number of schema sets in DB
 333    - `CPS-892 <https://jira.onap.org/browse/CPS-892>`_ Fixed the response code during CM-Handle Registration from 201 CREATED to 204 NO_CONTENT
 334    - `CPS-893 <https://jira.onap.org/browse/CPS-893>`_ NCMP Java API depends on NCM-Rest-API (cyclic) through json properties on Java API
 335
 336 Known Limitations, Issues and Workarounds
 337 -----------------------------------------
 338
 339 *System Limitations*
 340
 341 Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
 342 `CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
 343 of cm handle registration.
 344
 345 The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
 346 for more information.
 347
 348 *Known Vulnerabilities*
 349
 350 None
 351
 352 *Workarounds*
 353
 354 Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
 355 pass an empty string as the value if you do not want to include names for these values.
 356
 357 Security Notes
 358 --------------
 359
 360 *Fixed Security Issues*
 361
 362 None
 363
 364 *Known Security Issues*
 365
 366 None
 367
 368 ..      ========================
 369 ..      * * *   ISTANBUL   * * *
 370 ..      ========================
 371
 372 Version: 2.0.4
 373 ==============
 374
 375 Release Data
 376 ------------
 377
 378 +--------------------------------------+--------------------------------------------------------+
 379 | **CPS Project**                      |                                                        |
 380 |                                      |                                                        |
 381 +--------------------------------------+--------------------------------------------------------+
 382 | **Docker images**                    | onap/cps-and-ncmp:2.0.4                                |
 383 |                                      |                                                        |
 384 +--------------------------------------+--------------------------------------------------------+
 385 | **Release designation**              | 2.0.4 Istanbul                                         |
 386 |                                      |                                                        |
 387 +--------------------------------------+--------------------------------------------------------+
 388 | **Release date**                     | 2022 Feb 09                                            |
 389 |                                      |                                                        |
 390 +--------------------------------------+--------------------------------------------------------+
 391
 392 Bug Fixes
 393 ---------
 394
 395    - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_  Fix docker compose for csit test.
 396    - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_  Fix intermittent circular dependency error when the application starts.
 397
 398 Version: 2.0.3
 399 ==============
 400
 401 Release Data
 402 ------------
 403
 404 +--------------------------------------+--------------------------------------------------------+
 405 | **CPS Project**                      |                                                        |
 406 |                                      |                                                        |
 407 +--------------------------------------+--------------------------------------------------------+
 408 | **Docker images**                    | onap/cps-and-ncmp:2.0.3                                |
 409 |                                      |                                                        |
 410 +--------------------------------------+--------------------------------------------------------+
 411 | **Release designation**              | 2.0.3 Istanbul                                         |
 412 |                                      |                                                        |
 413 +--------------------------------------+--------------------------------------------------------+
 414 | **Release date**                     | 2022-07-01                                             |
 415 |                                      |                                                        |
 416 +--------------------------------------+--------------------------------------------------------+
 417
 418 Bug Fixes
 419 ---------
 420
 421    - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_  Update log4j version to 2.17.1 due to security vulnerability
 422
 423 Version: 2.0.2
 424 ==============
 425
 426 Release Data
 427 ------------
 428
 429 +--------------------------------------+--------------------------------------------------------+
 430 | **CPS Project**                      |                                                        |
 431 |                                      |                                                        |
 432 +--------------------------------------+--------------------------------------------------------+
 433 | **Docker images**                    | onap/cps-and-ncmp:2.0.2                                |
 434 |                                      |                                                        |
 435 +--------------------------------------+--------------------------------------------------------+
 436 | **Release designation**              | 2.0.2 Istanbul                                         |
 437 |                                      |                                                        |
 438 +--------------------------------------+--------------------------------------------------------+
 439 | **Release date**                     | 2021-16-12                                             |
 440 |                                      |                                                        |
 441 +--------------------------------------+--------------------------------------------------------+
 442
 443 Bug Fixes
 444 ---------
 445
 446    - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_  Update log4j version due to security vulnerability
 447
 448 Version: 2.0.1
 449 ==============
 450
 451 Release Data
 452 ------------
 453
 454 +--------------------------------------+--------------------------------------------------------+
 455 | **CPS Project**                      |                                                        |
 456 |                                      |                                                        |
 457 +--------------------------------------+--------------------------------------------------------+
 458 | **Docker images**                    | onap/cps-and-ncmp:2.0.1                                |
 459 |                                      |                                                        |
 460 +--------------------------------------+--------------------------------------------------------+
 461 | **Release designation**              | 2.0.1 Istanbul                                         |
 462 |                                      |                                                        |
 463 +--------------------------------------+--------------------------------------------------------+
 464 | **Release date**                     | 2021-14-10                                             |
 465 |                                      |                                                        |
 466 +--------------------------------------+--------------------------------------------------------+
 467
 468 Bug Fixes
 469 ---------
 470
 471    - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
 472    - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
 473    - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
 474    - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
 475
 476 Known Limitations, Issues and Workarounds
 477 -----------------------------------------
 478
 479 *System Limitations*
 480
 481 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
 482
 483 *Known Vulnerabilities*
 484
 485    - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
 486
 487 *Workarounds*
 488
 489 Add recursive method to save list node data to loop through all corresponding child nodes.
 490
 491 Security Notes
 492 --------------
 493
 494 *Fixed Security Issues*
 495
 496    - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
 497
 498 *Known Security Issues*
 499
 500 None
 501
 502 Version: 2.0.0
 503 ==============
 504
 505 Abstract
 506 --------
 507
 508 This document provides the release notes for Istanbul release.
 509
 510 Release Data
 511 ------------
 512
 513 +--------------------------------------+--------------------------------------------------------+
 514 | **CPS Project**                      |                                                        |
 515 |                                      |                                                        |
 516 +--------------------------------------+--------------------------------------------------------+
 517 | **Docker images**                    | onap/cps-and-ncmp:2.0.0                                |
 518 |                                      |                                                        |
 519 +--------------------------------------+--------------------------------------------------------+
 520 | **Release designation**              | 2.0.0 Istanbul                                         |
 521 |                                      |                                                        |
 522 +--------------------------------------+--------------------------------------------------------+
 523 | **Release date**                     | 2021-14-09                                             |
 524 |                                      |                                                        |
 525 +--------------------------------------+--------------------------------------------------------+
 526
 527 Features
 528 --------
 529 * Register DMI-Plugins with NCMP for CM Handle registrations.
 530 * Update, Create and Remove CM Handles.
 531 * Add support for retrieving and writing CM Handle data through NCMP datastores.
 532 * Automatic retrieval and caching of model information for CM Handles within NCMP.
 533
 534 Deliverables
 535 ------------
 536
 537 Software Deliverables
 538
 539 .. csv-table::
 540    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
 541    :widths: auto
 542
 543    "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
 544
 545 Bug Fixes
 546 ---------
 547
 548    - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
 549    - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
 550    - `CPS-336 <https://jira.onap.org/browse/CPS-336>`_ Ends-with functionality in cpsPath does not conform with standard xPath behavior
 551    - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
 552    - `CPS-357 <https://jira.onap.org/browse/CPS-357>`_ cps-review-verification-maven-master Jenkins job is failing when running csit test
 553    - `CPS-367 <https://jira.onap.org/browse/CPS-367>`_ Get descendent does not support xpaths that end in list values
 554    - `CPS-377 <https://jira.onap.org/browse/CPS-377>`_ Init ran model validation is failing error details are not provided
 555    - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
 556    - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
 557    - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
 558    - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
 559    - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ Request to update node leaves (patch) responds with json parsing failure
 560    - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
 561    - `CPS-479 <https://jira.onap.org/browse/CPS-479>`_ Get Nodes API does not always return the object from the root
 562    - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
 563    - `CPS-501 <https://jira.onap.org/browse/CPS-501>`_ Put DataNode API has missing transaction and error handling for concurrency issues
 564    - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
 565    - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
 566    - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
 567    - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
 568    - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
 569    - `CPS-591 <https://jira.onap.org/browse/CPS-591>`_ CPS-Core Leaf stored as integer is being returned from DB as float
 570    - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
 571    - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
 572    - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
 573    - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
 574
 575 This document provides the release notes for Istanbul release.
 576
 577 Summary
 578 -------
 579
 580 Following CPS components are available with default ONAP/CPS installation.
 581
 582
 583     * Platform components
 584
 585         - CPS (Helm charts)
 586
 587     * Service components
 588
 589         - CPS-NCMP
 590         - CPS-Temporal
 591         - DMI-Plugin
 592
 593     * Additional resources that CPS utilizes deployed using ONAP common charts
 594
 595         - Postgres Database
 596
 597
 598 Below service components (mS) are available to be deployed on-demand.
 599     - CPS-TBDMT
 600
 601
 602 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
 603
 604 Known Limitations, Issues and Workarounds
 605 -----------------------------------------
 606
 607 *System Limitations*
 608
 609 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
 610
 611 *Known Vulnerabilities*
 612
 613    - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
 614    - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
 615    - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
 616
 617 *Workarounds*
 618
 619 Add recursive method to save list node data to loop through all corresponding child nodes.
 620
 621 Security Notes
 622 --------------
 623
 624 *Fixed Security Issues*
 625
 626    - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
 627
 628 *Known Security Issues*
 629
 630    - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
 631
 632 Test Results
 633 ------------
 634     * `Integration tests`
 635
 636 ..      ========================
 637 ..      * * *   HONOLULU   * * *
 638 ..      ========================
 639
 640 Version: 1.0.1
 641 ==============
 642
 643 Release Data
 644 ------------
 645
 646 +--------------------------------------+--------------------------------------------------------+
 647 | **CPS Project**                      |                                                        |
 648 |                                      |                                                        |
 649 +--------------------------------------+--------------------------------------------------------+
 650 | **Docker images**                    | onap/cps-and-nf-proxy:1.0.1                            |
 651 |                                      |                                                        |
 652 +--------------------------------------+--------------------------------------------------------+
 653 | **Release designation**              | 1.0.1 Honolulu                                         |
 654 |                                      |                                                        |
 655 +--------------------------------------+--------------------------------------------------------+
 656 | **Release date**                     | 2021-04-09                                             |
 657 |                                      |                                                        |
 658 +--------------------------------------+--------------------------------------------------------+
 659
 660 Bug Fixes
 661 ---------
 662
 663    - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
 664    - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
 665    - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
 666    - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
 667    - `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
 668    - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
 669    - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
 670    - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
 671
 672 Security Notes
 673 --------------
 674
 675 *Fixed Security Issues*
 676
 677    - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
 678
 679 *Known Security Issues*
 680
 681    - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
 682
 683 Version: 1.0.0
 684 ==============
 685
 686
 687 Abstract
 688 --------
 689
 690 This document provides the release notes for Honolulu release.
 691
 692 Summary
 693 -------
 694
 695 Following CPS components are available with default ONAP/CPS installation.
 696
 697
 698     * Platform components
 699
 700         - CPS (Helm charts)
 701
 702     * Service components
 703
 704         - CPS Core
 705
 706     * Additional resources that CPS utilizes deployed using ONAP common charts
 707
 708         - Postgres Database
 709
 710
 711 Below service components (mS) are available to be deployed on-demand.
 712     - CPS-TBDMT
 713
 714
 715 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
 716
 717
 718 Release Data
 719 ------------
 720
 721 +--------------------------------------+--------------------------------------------------------+
 722 | **CPS Project**                      |                                                        |
 723 |                                      |                                                        |
 724 +--------------------------------------+--------------------------------------------------------+
 725 | **Docker images**                    | Refer :any:`Deliverable <honolulu_deliverable>`        |
 726 |                                      |                                                        |
 727 +--------------------------------------+--------------------------------------------------------+
 728 | **Release designation**              | 1.0.0 Honolulu                                         |
 729 |                                      |                                                        |
 730 +--------------------------------------+--------------------------------------------------------+
 731 | **Release date**                     | 2021-03-11                                             |
 732 |                                      |                                                        |
 733 +--------------------------------------+--------------------------------------------------------+
 734
 735
 736 Features
 737 --------
 738 Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
 739 CPS has been driven by the needs of the E2E Networking Slicing use case.
 740 It currently supports basic (rw) persistence and simple queries.
 741 It also provides MVP support for network data access using simulated data.
 742
 743 .. _honolulu_deliverable:
 744
 745 Deliverables
 746 ------------
 747
 748 Software Deliverables
 749
 750 .. csv-table::
 751    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
 752    :widths: auto
 753
 754    "cps", "", "onap/cps-and-nf-proxy:1.0.0"
 755
 756
 757 Known Limitations, Issues and Workarounds
 758 -----------------------------------------
 759
 760    - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
 761    - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
 762    - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
 763    - `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.
 764
 765 *System Limitations*
 766
 767 None
 768
 769 *Known Vulnerabilities*
 770
 771 None
 772
 773 *Workarounds*
 774
 775 Documented under corresponding jira if applicable.
 776
 777 Security Notes
 778 --------------
 779
 780 *Fixed Security Issues*
 781
 782 * `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
 783     - Upgrade org.onap.oparent to 3.2.0
 784     - Upgrade spring.boot to 2.3.8.RELEASE
 785     - Upgrade yangtools to 5.0.7
 786
 787 *Known Security Issues*
 788
 789     * Weak Crytography using md5
 790     * Risk seen in Zip file expansion
 791
 792 *Known Vulnerabilities in Used Modules*
 793
 794     None
 795
 796 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.
 797
 798 Test Results
 799 ------------
 800     * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
 801
 802 References
 803 ----------
 804
 805 For more information on the ONAP Honolulu release, please see:
 806
 807 #. `ONAP Home Page`_
 808 #. `ONAP Documentation`_
 809 #. `ONAP Release Downloads`_
 810 #. `ONAP Wiki Page`_
 811
 812
 813 .. _`ONAP Home Page`: https://www.onap.org
 814 .. _`ONAP Wiki Page`: https://wiki.onap.org
 815 .. _`ONAP Documentation`: https://docs.onap.org
 816 .. _`ONAP Release Downloads`: https://git.onap.org
 817
 818 Quick Links:
 819
 820         - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
 821         - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_