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