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-2022 Nordix Foundation
   4
   5 .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
   6 .. _release_notes:
   7
   8
   9
  10 ========================
  11 DMI-Plugin Release Notes
  12 ========================
  13
  14 .. contents::
  15     :depth: 2
  16 ..
  17 ..      ====================
  18 ..      * * *   KOHN   * * *
  19 ..      ====================
  20
  21 Version: 1.2.2 (not yet released)
  22 =================================
  23
  24 Release Data
  25 ------------
  26
  27 +--------------------------------------+--------------------------------------------------------+
  28 | **CPS Project**                      |  DMI-Plugin                                            |
  29 |                                      |                                                        |
  30 +--------------------------------------+--------------------------------------------------------+
  31 | **Docker images**                    | onap/ncmp-dmi-plugin:1.2.2                             |
  32 |                                      |                                                        |
  33 +--------------------------------------+--------------------------------------------------------+
  34 | **Release designation**              | 1.2.2 Kohn                                             |
  35 |                                      |                                                        |
  36 +--------------------------------------+--------------------------------------------------------+
  37 | **Release date**                     | (not yet released)                                     |
  38 |                                      |                                                        |
  39 +--------------------------------------+--------------------------------------------------------+
  40
  41 Bug Fixes
  42 ---------
  43    - `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_  [CPS/NCMP] Add Basic Auth to CPS/NCMP OpenAPI Definitions
  44
  45
  46 Version: 1.2.1
  47 ==============
  48
  49 Release Data
  50 ------------
  51
  52 +--------------------------------------+--------------------------------------------------------+
  53 | **CPS Project**                      |  DMI-Plugin                                            |
  54 |                                      |                                                        |
  55 +--------------------------------------+--------------------------------------------------------+
  56 | **Docker images**                    | onap/ncmp-dmi-plugin:1.2.1                             |
  57 |                                      |                                                        |
  58 +--------------------------------------+--------------------------------------------------------+
  59 | **Release designation**              | 1.2.1 Kohn                                             |
  60 |                                      |                                                        |
  61 +--------------------------------------+--------------------------------------------------------+
  62 | **Release date**                     | 2022 October 5                                         |
  63 |                                      |                                                        |
  64 +--------------------------------------+--------------------------------------------------------+
  65
  66 Bug Fixes
  67 ---------
  68    - None
  69
  70 Version: 1.2.0
  71 ==============
  72
  73 Release Data
  74 ------------
  75
  76 +--------------------------------------+--------------------------------------------------------+
  77 | **CPS Project**                      |  DMI-Plugin                                            |
  78 |                                      |                                                        |
  79 +--------------------------------------+--------------------------------------------------------+
  80 | **Docker images**                    | onap/ncmp-dmi-plugin:1.2.0                             |
  81 |                                      |                                                        |
  82 +--------------------------------------+--------------------------------------------------------+
  83 | **Release designation**              | 1.2.0 Kohn                                             |
  84 |                                      |                                                        |
  85 +--------------------------------------+--------------------------------------------------------+
  86 | **Release date**                     | 2022 September 21                                      |
  87 |                                      |                                                        |
  88 +--------------------------------------+--------------------------------------------------------+
  89
  90 Features
  91 --------
  92    - `CPS-562 <https://jira.onap.org/browse/CPS-562>`_  Write data for cmHandle using ncmp-datastores:passthrough-running (DMI Plugin.)
  93    - `CPS-832 <https://jira.onap.org/browse/CPS-832>`_  Async: E2E Integration
  94    - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_  Async: NCMP Rest impl. including Request ID generation
  95
  96 Bug Fixes
  97 ---------
  98    - None
  99
 100 Known Limitations, Issues and Workarounds
 101 -----------------------------------------
 102
 103 *System Limitations*
 104
 105 None
 106
 107 *Known Vulnerabilities*
 108
 109 None
 110
 111 *Workarounds*
 112
 113 None
 114
 115 Security Notes
 116 --------------
 117
 118 *Fixed Security Issues*
 119
 120 None
 121
 122 *Known Security Issues*
 123
 124 None
 125
 126 ..      ========================
 127 ..      * * *   JAKARTA   * * *
 128 ..      ========================
 129
 130 Version: 1.1.0
 131 ==============
 132
 133 Release Data
 134 ------------
 135
 136 +--------------------------------------+--------------------------------------------------------+
 137 | **CPS Project**                      |  DMI-Plugin                                            |
 138 |                                      |                                                        |
 139 +--------------------------------------+--------------------------------------------------------+
 140 | **Docker images**                    |  onap/ncmp-dmi-plugin:1.1.0                            |
 141 |                                      |                                                        |
 142 +--------------------------------------+--------------------------------------------------------+
 143 | **Release designation**              | 1.1.0 Jakarta                                          |
 144 |                                      |                                                        |
 145 +--------------------------------------+--------------------------------------------------------+
 146 | **Release date**                     | 2022 March 15                                          |
 147 |                                      |                                                        |
 148 +--------------------------------------+--------------------------------------------------------+
 149
 150 Features
 151 --------
 152    - `CPS-637 <https://jira.onap.org/browse/CPS-637>`_  Support Update operation for datastore pass-through running
 153    - `CPS-639 <https://jira.onap.org/browse/CPS-639>`_  Support Delete operation for datastore pass-through running
 154    - `CPS-784 <https://jira.onap.org/browse/CPS-784>`_  Add examples to DMI-Plugin API Spec
 155
 156 Bug Fixes
 157 ---------
 158
 159    - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_  Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM
 160
 161 Known Limitations, Issues and Workarounds
 162 -----------------------------------------
 163
 164 *System Limitations*
 165
 166 None
 167
 168 *Known Vulnerabilities*
 169
 170 None
 171
 172 *Workarounds*
 173
 174 None
 175
 176 Security Notes
 177 --------------
 178
 179 *Fixed Security Issues*
 180
 181 None
 182
 183 *Known Security Issues*
 184
 185 None
 186
 187 ..      ========================
 188 ..      * * *   ISTANBUL   * * *
 189 ..      ========================
 190
 191 Version: 1.0.3
 192 ==============
 193
 194 Release Data
 195 ------------
 196
 197 +--------------------------------------+--------------------------------------------------------+
 198 | **CPS Project**                      |  DMI-Plugin                                            |
 199 |                                      |                                                        |
 200 +--------------------------------------+--------------------------------------------------------+
 201 | **Docker images**                    |  onap/ncmp-dmi-plugin:1.0.3                            |
 202 |                                      |                                                        |
 203 +--------------------------------------+--------------------------------------------------------+
 204 | **Release designation**              | 1.0.3 Istanbul                                         |
 205 |                                      |                                                        |
 206 +--------------------------------------+--------------------------------------------------------+
 207 | **Release date**                     | 2022-07-01                                             |
 208 |                                      |                                                        |
 209 +--------------------------------------+--------------------------------------------------------+
 210
 211 Bug Fixes
 212 ---------
 213
 214    - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_  Update log4j version to 2.17.1 due to security vulnerability
 215
 216 Version: 1.0.2
 217 ==============
 218
 219 Release Data
 220 ------------
 221
 222 +--------------------------------------+--------------------------------------------------------+
 223 | **CPS Project**                      |  DMI-Plugin                                            |
 224 |                                      |                                                        |
 225 +--------------------------------------+--------------------------------------------------------+
 226 | **Docker images**                    |  onap/ncmp-dmi-plugin:1.0.2                            |
 227 |                                      |                                                        |
 228 +--------------------------------------+--------------------------------------------------------+
 229 | **Release designation**              | 1.0.2 Istanbul                                         |
 230 |                                      |                                                        |
 231 +--------------------------------------+--------------------------------------------------------+
 232 | **Release date**                     | 2021-16-12                                             |
 233 |                                      |                                                        |
 234 +--------------------------------------+--------------------------------------------------------+
 235
 236 Bug Fixes
 237 ---------
 238
 239    - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_  Update log4j version due to security vulnerability
 240
 241 Version: 1.0.1
 242 ==============
 243
 244 Release Data
 245 ------------
 246
 247 +--------------------------------------+--------------------------------------------------------+
 248 | **CPS Project**                      |  DMI-Plugin                                            |
 249 |                                      |                                                        |
 250 +--------------------------------------+--------------------------------------------------------+
 251 | **Docker images**                    |  onap/ncmp-dmi-plugin:1.0.1                            |
 252 |                                      |                                                        |
 253 +--------------------------------------+--------------------------------------------------------+
 254 | **Release designation**              | 1.0.1 Istanbul                                         |
 255 |                                      |                                                        |
 256 +--------------------------------------+--------------------------------------------------------+
 257 | **Release date**                     | 2021-14-10                                             |
 258 |                                      |                                                        |
 259 +--------------------------------------+--------------------------------------------------------+
 260
 261 Bug Fixes
 262 ---------
 263
 264    - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
 265    - `CPS-659 <https://jira.onap.org/browse/CPS-659>`_ DMI does not set CREATE Response code for passthrough-running create use-case
 266    - `CPS-669 <https://jira.onap.org/browse/CPS-669>`_ Improvements in the NCMP-DMI plugin OOM charts
 267    - `CPS-678 <https://jira.onap.org/browse/CPS-678>`_ Passthrough read only supports known parameters (depth&field)
 268    - `CPS-679 <https://jira.onap.org/browse/CPS-679>`_ Passthrough does not support resourceIdentifier with / tokens
 269    - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ get moduleschema/yangresouce endpoint not working
 270
 271 Known Limitations, Issues and Workarounds
 272 -----------------------------------------
 273
 274 *System Limitations*
 275
 276   - `CPS-719 <https://jira.onap.org/browse/CPS-719>`_ Passthrough query options do not support comma (,) token in values
 277
 278 *Known Vulnerabilities*
 279
 280 None
 281
 282 *Workarounds*
 283
 284 None
 285
 286 Security Notes
 287 --------------
 288
 289 *Fixed Security Issues*
 290
 291 None
 292
 293 *Known Security Issues*
 294
 295 None
 296
 297 Version: 1.0.0
 298 ==============
 299
 300 Release Data
 301 ------------
 302
 303 +--------------------------------------+--------------------------------------------------------+
 304 | **CPS Project**                      |  DMI-Plugin                                            |
 305 |                                      |                                                        |
 306 +--------------------------------------+--------------------------------------------------------+
 307 | **Docker images**                    |  onap/ncmp-dmi-plugin:1.0.0                            |
 308 |                                      |                                                        |
 309 +--------------------------------------+--------------------------------------------------------+
 310 | **Release designation**              | 1.0.0 Istanbul                                         |
 311 |                                      |                                                        |
 312 +--------------------------------------+--------------------------------------------------------+
 313 | **Release date**                     | 2021-14-09                                             |
 314 |                                      |                                                        |
 315 +--------------------------------------+--------------------------------------------------------+
 316
 317 Features
 318 --------
 319 * Implement plugin registration.
 320 * Retrieve data from cmHandles using ncmp-datastores passthrough.
 321 * Retrieve Yang Resources from one or more modules of a  CM Handle.
 322
 323 .. _istanbul_deliverable:
 324
 325 Deliverables
 326 ------------
 327
 328 Software Deliverables
 329
 330 .. csv-table::
 331    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
 332    :widths: auto
 333
 334    "cps/ncmp-dmi-plugin", "", "onap/ncmp-dmi-plugin:1.0.0"
 335
 336 Bug Fixes
 337 ---------
 338
 339    - `CPS-504 <https://jira.onap.org/browse/CPS-504>`_ Checkstyle rules are not enforced for cps-ncmp-dmi-plugin
 340    - `CPS-589 <https://jira.onap.org/browse/CPS-589>`_ Json for Yang Resources does not contain name and revision tags
 341    - `CPS-617 <https://jira.onap.org/browse/CPS-617>`_ DMI base path does not conform to agreed API URL
 342
 343 Summary
 344 -------
 345
 346 Following DMI-Plugin components are available with default ONAP/DMI-plugin installation.
 347
 348     * Platform components
 349
 350     * Service components
 351
 352     * Additional resources that CPS utilizes deployed using ONAP common charts
 353
 354 Below service components (mS) are available to be deployed on-demand.
 355
 356 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
 357
 358 Known Limitations, Issues and Workarounds
 359 -----------------------------------------
 360
 361 *System Limitations*
 362
 363 None
 364
 365 *Known Vulnerabilities*
 366
 367    - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
 368    - `CPS-659 <https://jira.onap.org/browse/CPS-659>`_ DMI does not set CREATE Response code for passthrough-running create use-case
 369
 370 *Workarounds*
 371
 372 None
 373
 374 Security Notes
 375 --------------
 376
 377 *Fixed Security Issues*
 378
 379 None
 380
 381 *Known Security Issues*
 382
 383 None
 384
 385 References
 386 ----------
 387
 388 For more information on the ONAP Istanbul release, please see:
 389
 390 #. `ONAP Home Page`_
 391 #. `ONAP Documentation`_
 392 #. `ONAP Release Downloads`_
 393 #. `ONAP Wiki Page`_
 394
 395
 396 .. _`ONAP Home Page`: https://www.onap.org
 397 .. _`ONAP Wiki Page`: https://wiki.onap.org
 398 .. _`ONAP Documentation`: https://docs.onap.org
 399 .. _`ONAP Release Downloads`: https://git.onap.org
 400
 401 Quick Links:
 402
 403         - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
 404         - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_