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.0.1-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>`_  Update operation for datastore pass through running
  29
  30 Bug Fixes
  31 ---------
  32
  33 None
  34
  35 Known Limitations, Issues and Workarounds
  36 -----------------------------------------
  37
  38 *System Limitations*
  39
  40 None
  41
  42 *Known Vulnerabilities*
  43
  44 None
  45
  46 *Workarounds*
  47
  48 None
  49
  50 Security Notes
  51 --------------
  52
  53 *Fixed Security Issues*
  54
  55 None
  56
  57 *Known Security Issues*
  58
  59 None
  60
  61 ..      ========================
  62 ..      * * *   ISTANBUL   * * *
  63 ..      ========================
  64
  65 Version: 1.0.1
  66 ==============
  67
  68 Release Data
  69 ------------
  70
  71 +--------------------------------------+--------------------------------------------------------+
  72 | **CPS Project**                      |  DMI-Plugin                                            |
  73 |                                      |                                                        |
  74 +--------------------------------------+--------------------------------------------------------+
  75 | **Docker images**                    |  onap/ncmp-dmi-plugin:1.0.1                            |
  76 |                                      |                                                        |
  77 +--------------------------------------+--------------------------------------------------------+
  78 | **Release designation**              | 1.0.1 Istanbul                                         |
  79 |                                      |                                                        |
  80 +--------------------------------------+--------------------------------------------------------+
  81 | **Release date**                     | 2021-14-10                                             |
  82 |                                      |                                                        |
  83 +--------------------------------------+--------------------------------------------------------+
  84
  85 Bug Fixes
  86 ---------
  87
  88    - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
  89    - `CPS-659 <https://jira.onap.org/browse/CPS-659>`_ DMI does not set CREATE Response code for passthrough-running create use-case
  90    - `CPS-669 <https://jira.onap.org/browse/CPS-669>`_ Improvements in the NCMP-DMI plugin OOM charts
  91    - `CPS-678 <https://jira.onap.org/browse/CPS-678>`_ Passthrough read only supports known parameters (depth&field)
  92    - `CPS-679 <https://jira.onap.org/browse/CPS-679>`_ Passthrough does not support resourceIdentifier with / tokens
  93    - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ get moduleschema/yangresouce endpoint not working
  94
  95 Known Limitations, Issues and Workarounds
  96 -----------------------------------------
  97
  98 *System Limitations*
  99
 100   - `CPS-719 <https://jira.onap.org/browse/CPS-719>`_ Passthrough query options do not support comma (,) token in values
 101
 102 *Known Vulnerabilities*
 103
 104 None
 105
 106 *Workarounds*
 107
 108 None
 109
 110 Security Notes
 111 --------------
 112
 113 *Fixed Security Issues*
 114
 115 None
 116
 117 *Known Security Issues*
 118
 119 None
 120
 121 Version: 1.0.0
 122 ==============
 123
 124 Release Data
 125 ------------
 126
 127 +--------------------------------------+--------------------------------------------------------+
 128 | **CPS Project**                      |  DMI-Plugin                                            |
 129 |                                      |                                                        |
 130 +--------------------------------------+--------------------------------------------------------+
 131 | **Docker images**                    |  onap/ncmp-dmi-plugin:1.0.0                            |
 132 |                                      |                                                        |
 133 +--------------------------------------+--------------------------------------------------------+
 134 | **Release designation**              | 1.0.0 Istanbul                                         |
 135 |                                      |                                                        |
 136 +--------------------------------------+--------------------------------------------------------+
 137 | **Release date**                     | 2021-14-09                                             |
 138 |                                      |                                                        |
 139 +--------------------------------------+--------------------------------------------------------+
 140
 141 Features
 142 --------
 143 * Implement plugin registration.
 144 * Retrieve data from cmHandles using ncmp-datastores passthrough.
 145 * Retrieve Yang Resources from one or more modules of a  CM Handle.
 146
 147 .. _istanbul_deliverable:
 148
 149 Deliverables
 150 ------------
 151
 152 Software Deliverables
 153
 154 .. csv-table::
 155    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
 156    :widths: auto
 157
 158    "cps/ncmp-dmi-plugin", "", "onap/ncmp-dmi-plugin:1.0.0"
 159
 160 Bug Fixes
 161 ---------
 162
 163    - `CPS-504 <https://jira.onap.org/browse/CPS-504>`_ Checkstyle rules are not enforced for cps-ncmp-dmi-plugin
 164    - `CPS-589 <https://jira.onap.org/browse/CPS-589>`_ Json for Yang Resources does not contain name and revision tags
 165    - `CPS-617 <https://jira.onap.org/browse/CPS-617>`_ DMI base path does not conform to agreed API URL
 166
 167 Summary
 168 -------
 169
 170 Following DMI-Plugin components are available with default ONAP/DMI-plugin installation.
 171
 172     * Platform components
 173
 174     * Service components
 175
 176     * Additional resources that CPS utilizes deployed using ONAP common charts
 177
 178 Below service components (mS) are available to be deployed on-demand.
 179
 180 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
 181
 182 Known Limitations, Issues and Workarounds
 183 -----------------------------------------
 184
 185 *System Limitations*
 186
 187 None
 188
 189 *Known Vulnerabilities*
 190
 191    - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
 192    - `CPS-659 <https://jira.onap.org/browse/CPS-659>`_ DMI does not set CREATE Response code for passthrough-running create use-case
 193
 194 *Workarounds*
 195
 196 None
 197
 198 Security Notes
 199 --------------
 200
 201 *Fixed Security Issues*
 202
 203 None
 204
 205 *Known Security Issues*
 206
 207 None
 208
 209 References
 210 ----------
 211
 212 For more information on the ONAP Istanbul release, please see:
 213
 214 #. `ONAP Home Page`_
 215 #. `ONAP Documentation`_
 216 #. `ONAP Release Downloads`_
 217 #. `ONAP Wiki Page`_
 218
 219
 220 .. _`ONAP Home Page`: https://www.onap.org
 221 .. _`ONAP Wiki Page`: https://wiki.onap.org
 222 .. _`ONAP Documentation`: https://docs.onap.org
 223 .. _`ONAP Release Downloads`: https://git.onap.org
 224
 225 Quick Links:
 226
 227         - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
 228         - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_