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