Merge "Create preliminary documentation for ONAP DMI-Plugin"
[cps/ncmp-dmi-plugin.git] / 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 .. warning:: draft
14
15 .. contents::
16     :depth: 2
17 ..
18
19 ..      ========================
20 ..      * * *   ISTANBUL   * * *
21 ..      ========================
22
23 Version: 1.0.0
24 ==============
25
26 Abstract
27 --------
28
29 This document provides the release notes for Istanbul release.
30
31 Release Data
32 ------------
33
34 +--------------------------------------+--------------------------------------------------------+
35 | **CPS Project**                      |                                                        |
36 |                                      |                                                        |
37 +--------------------------------------+--------------------------------------------------------+
38 | **Docker images**                    |  placeholder                                           |
39 |                                      |                                                        |
40 +--------------------------------------+--------------------------------------------------------+
41 | **Release designation**              | 1.0.0 Istanbul                                         |
42 |                                      |                                                        |
43 +--------------------------------------+--------------------------------------------------------+
44 | **Release date**                     | 2021-14-10                                             |
45 |                                      |                                                        |
46 +--------------------------------------+--------------------------------------------------------+
47
48 Features
49 --------
50 * Implement plugin registration.
51 * Retrieve data from cmHandles using ncmp-datastores passthorugh.
52 * Retrieve Yang Resources from one or more modules of a  CM Handle.
53
54 .. _istanbul_deliverable:
55
56 Deliverables
57 ------------
58
59 Software Deliverables
60
61 .. csv-table::
62    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
63    :widths: auto
64
65    "cps/ncmp-dmi-plugin", "", "placeholder"
66
67 Bug Fixes
68 ---------
69
70 This document provides the release notes for Istanbul release.
71
72 Summary
73 -------
74
75 Following DMI plugin components are available with default ONAP/DMI-plugin installation.
76
77
78     * Platform components
79
80     * Service components
81
82     * Additional resources that CPS utilizes deployed using ONAP common charts
83
84 Below service components (mS) are available to be deployed on-demand.
85
86 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
87
88 Known Limitations, Issues and Workarounds
89 -----------------------------------------
90
91 *System Limitations*
92
93 *Known Vulnerabilities*
94
95 None
96
97 *Workarounds*
98
99 Security Notes
100 --------------
101
102 *Fixed Security Issues*
103
104 *Known Security Issues*
105
106 Test Results
107 ------------
108     * `Integration tests`
109
110 References
111 ----------
112
113 For more information on the ONAP Honolulu release, please see:
114
115 #. `ONAP Home Page`_
116 #. `ONAP Documentation`_
117 #. `ONAP Release Downloads`_
118 #. `ONAP Wiki Page`_
119
120
121 .. _`ONAP Home Page`: https://www.onap.org
122 .. _`ONAP Wiki Page`: https://wiki.onap.org
123 .. _`ONAP Documentation`: https://docs.onap.org
124 .. _`ONAP Release Downloads`: https://git.onap.org
125
126 Quick Links:
127
128         - `Dmi Plugin implementation page <https://wiki.onap.org/display/DW/CPS-390+Spike%3A+Define+and+Agree+DMI+Plugin+REST+Interface>`_
129         - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_