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