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