From 3d1579cb8cfe7fe924181bc3e02c570dca6ae081 Mon Sep 17 00:00:00 2001 From: shivasubedi Date: Mon, 13 Sep 2021 16:43:20 +0100 Subject: Create preliminary documentation for ONAP DMI-Plugin Create Preliminary documentation for Istanbul release of the DMI Plugin. Added new plugins in POM to generate swagger doc for design page. Added icons from Cps-Core, along with latest conf.py file from http://gerrit.onap.org/r/doc Issue-ID: CPS-625 Change-Id: I30582de9b07e93c1c2ecc18003ee6882994690d8 Signed-off-by: DylanB95EST Signed-off-by: shivasubedi --- docs/release-notes.rst | 129 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 129 insertions(+) create mode 100644 docs/release-notes.rst (limited to 'docs/release-notes.rst') diff --git a/docs/release-notes.rst b/docs/release-notes.rst new file mode 100644 index 00000000..8e9a91a7 --- /dev/null +++ b/docs/release-notes.rst @@ -0,0 +1,129 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +.. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING +.. _release_notes: + + + +======================== +DMI Plugin Release Notes +======================== + +.. warning:: draft + +.. contents:: + :depth: 2 +.. + +.. ======================== +.. * * * ISTANBUL * * * +.. ======================== + +Version: 1.0.0 +============== + +Abstract +-------- + +This document provides the release notes for Istanbul release. + +Release Data +------------ + ++--------------------------------------+--------------------------------------------------------+ +| **CPS Project** | | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Docker images** | placeholder | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release designation** | 1.0.0 Istanbul | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release date** | 2021-14-10 | +| | | ++--------------------------------------+--------------------------------------------------------+ + +Features +-------- +* Implement plugin registration. +* Retrieve data from cmHandles using ncmp-datastores passthorugh. +* Retrieve Yang Resources from one or more modules of a CM Handle. + +.. _istanbul_deliverable: + +Deliverables +------------ + +Software Deliverables + +.. csv-table:: + :header: "Repository", "SubModules", "Version & Docker Image (if applicable)" + :widths: auto + + "cps/ncmp-dmi-plugin", "", "placeholder" + +Bug Fixes +--------- + +This document provides the release notes for Istanbul release. + +Summary +------- + +Following DMI plugin components are available with default ONAP/DMI-plugin installation. + + + * Platform components + + * Service components + + * Additional resources that CPS utilizes deployed using ONAP common charts + +Below service components (mS) are available to be deployed on-demand. + +Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster. + +Known Limitations, Issues and Workarounds +----------------------------------------- + +*System Limitations* + +*Known Vulnerabilities* + +None + +*Workarounds* + +Security Notes +-------------- + +*Fixed Security Issues* + +*Known Security Issues* + +Test Results +------------ + * `Integration tests` + +References +---------- + +For more information on the ONAP Honolulu release, please see: + +#. `ONAP Home Page`_ +#. `ONAP Documentation`_ +#. `ONAP Release Downloads`_ +#. `ONAP Wiki Page`_ + + +.. _`ONAP Home Page`: https://www.onap.org +.. _`ONAP Wiki Page`: https://wiki.onap.org +.. _`ONAP Documentation`: https://docs.onap.org +.. _`ONAP Release Downloads`: https://git.onap.org + +Quick Links: + + - `Dmi Plugin implementation page `_ + - `Passing Badge information for CPS `_ -- cgit 1.2.3-korg