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