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