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