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