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