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