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