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