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