docs/release-notes.rst

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