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