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