summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorToineSiebelink <toine.siebelink@est.tech>2021-02-26 12:05:30 +0000
committerToineSiebelink <toine.siebelink@est.tech>2021-02-26 15:45:18 +0000
commitb87f3238bd57a866f7682055c5357bc232c391f2 (patch)
treeaf59392bedc309acea3dbbde4a1c0a74c70dcba1
parentd3609db46635b9bdb0a49a7d0e18ebe144bb7f29 (diff)
adding a placeholder release notes rst file
Issue-ID: CPS-179 Signed-off-by: ToineSiebelink <toine.siebelink@est.tech> Change-Id: I0b001f14bcc9302bc2a0d64a2de02408688e84b0
-rwxr-xr-xdocs/index.rst3
-rw-r--r--docs/release-notes.rst146
2 files changed, 149 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 81c485fb0f..a7c1b93df6 100755
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -11,4 +11,7 @@ CPS Documentation Repository
.. toctree::
:maxdepth: 1
+ architecure.rst
offeredapis.rst
+ release-notes.rst
+
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
new file mode 100644
index 0000000000..ad8b745735
--- /dev/null
+++ b/docs/release-notes.rst
@@ -0,0 +1,146 @@
+.. 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:
+
+
+
+=================
+CPS Release Notes
+=================
+
+.. contents::
+ :depth: 2
+..
+
+
+
+.. =========================
+.. * * * HONOULULU * * *
+.. =========================
+
+
+Version: 0.0.3
+==============
+
+
+Abstract
+--------
+
+This document provides the release notes for Honolulu release.
+
+Summary
+-------
+
+Following CPS components are available with default ONAP/CPS installation.
+
+
+ - Service components
+
+ -
+
+ - Additional resources that CPS utilizes deployed using ONAP common charts:
+
+ - Postgres Database
+
+
+
+Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
+
+
+Release Data
+------------
+
++--------------------------------------+--------------------------------------------------------+
+| **CPS Project** | |
+| | |
++--------------------------------------+--------------------------------------------------------+
+| **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
+| | |
++--------------------------------------+--------------------------------------------------------+
+| **Release designation** | 0.0.3 Honolulu |
+| | |
++--------------------------------------+--------------------------------------------------------+
+| **Release date** | 2021-03-01 |
+| | |
++--------------------------------------+--------------------------------------------------------+
+
+
+Features
+--------
+
+
+.. _honolulu_deliverable:
+
+Deliverables
+------------
+
+Software Deliverables
+
+.. csv-table::
+ :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
+ :widths: auto
+
+ "tbc", "tbc", "tbc"
+
+
+Known Limitations, Issues and Workarounds
+-----------------------------------------
+
+ * TBC
+
+
+*System Limitations*
+
+None
+
+*Known Vulnerabilities*
+
+None
+
+*Workarounds*
+
+Documented under corresponding jira if applicable.
+
+Security Notes
+--------------
+
+*Fixed Security Issues*
+ Listed above
+
+*Known Security Issues*
+
+ None
+
+
+*Known Vulnerabilities in Used Modules*
+
+ None
+
+CPS code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive.
+
+Test Results
+------------
+
+
+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:
+
+ - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
+ - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_