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