Merge "CPS-401 Update Open API YAML with data types and example for output (cpsData)"
[cps.git] / docs / release-notes.rst
old mode 100644 (file)
new mode 100755 (executable)
index e87a102..f213c7e
@@ -16,12 +16,53 @@ CPS Release Notes
 
 
 
-..      =========================
-..      * * *   HONOULULU   * * *
-..      =========================
+..      ========================
+..      * * *   HONOLULU   * * *
+..      ========================
 
+Version: 1.0.1
+==============
+
+Release Data
+------------
+
++--------------------------------------+--------------------------------------------------------+
+| **CPS Project**                      |                                                        |
+|                                      |                                                        |
++--------------------------------------+--------------------------------------------------------+
+| **Docker images**                    | onap/cps-and-nf-proxy:1.0.1                            |
+|                                      |                                                        |
++--------------------------------------+--------------------------------------------------------+
+| **Release designation**              | 1.0.1 Honolulu                                         |
+|                                      |                                                        |
++--------------------------------------+--------------------------------------------------------+
+| **Release date**                     | 2021-04-09                                             |
+|                                      |                                                        |
++--------------------------------------+--------------------------------------------------------+
+
+Bug Fixes
+---------
+
+   - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
+   - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
+   - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
+   - `CPS-292 <https://jira.onap.org/browse/CPS-292>`_ Detailed information is missing to explain why data is not compliant with the specified YANG model
+   - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
+   - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
+   - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
 
-Version: 0.0.3
+Security Notes
+--------------
+
+*Fixed Security Issues*
+
+   - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
+
+*Known Security Issues*
+
+   - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
+
+Version: 1.0.0
 ==============
 
 
@@ -36,15 +77,22 @@ Summary
 Following CPS components are available with default ONAP/CPS installation.
 
 
-    - Service components
+    * Platform components
+
+        - CPS (Helm charts)
 
-        -
+    * Service components
 
-    - Additional resources that CPS utilizes deployed using ONAP common charts:
+        - CPS Core
+
+    * Additional resources that CPS utilizes deployed using ONAP common charts
 
         - Postgres Database
 
 
+Below service components (mS) are available to be deployed on-demand.
+    - CPS-TBDMT
+
 
 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
 
@@ -59,17 +107,20 @@ Release Data
 | **Docker images**                    | Refer :any:`Deliverable <honolulu_deliverable>`        |
 |                                      |                                                        |
 +--------------------------------------+--------------------------------------------------------+
-| **Release designation**              | 0.0.3 Honolulu                                         |
+| **Release designation**              | 1.0.0 Honolulu                                         |
 |                                      |                                                        |
 +--------------------------------------+--------------------------------------------------------+
-| **Release date**                     | 2021-03-01                                             |
+| **Release date**                     | 2021-03-11                                             |
 |                                      |                                                        |
 +--------------------------------------+--------------------------------------------------------+
 
 
 Features
 --------
-
+Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
+CPS has been driven by the needs of the E2E Networking Slicing use case.
+It currently supports basic (rw) persistence and simple queries.
+It also provides MVP support for network data access using simulated data.
 
 .. _honolulu_deliverable:
 
@@ -82,14 +133,16 @@ Software Deliverables
    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
    :widths: auto
 
-   "tbc", "tbc", "tbc"
+   "cps", "", "onap/cps-and-nf-proxy:1.0.0"
 
 
 Known Limitations, Issues and Workarounds
 -----------------------------------------
 
-    * TBC
-
+   - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
+   - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
+   - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
+   - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ & `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Update data node leaves API does not support updating a list element with compound keys.
 
 *System Limitations*
 
@@ -109,24 +162,24 @@ Security Notes
 *Fixed Security Issues*
 
 * `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
-    - Update org.onap.oparent to 3.2.0
+    - Upgrade org.onap.oparent to 3.2.0
     - Upgrade spring.boot to 2.3.8.RELEASE
-    - Upgrade yangtool to 5.0.7
+    - Upgrade yangtools to 5.0.7
 
 *Known Security Issues*
 
-       None
-
+    * Weak Crytography using md5
+    * Risk seen in Zip file expansion
 
 *Known Vulnerabilities in Used Modules*
 
-       None
+    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. 
+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
 ------------
-
+    * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
 
 References
 ----------