Update release-notes for new Honolulu's K8splugin

[multicloud/framework.git] / docs / release-notes.rst

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 41c83c5..ab79eaf 100644 (file)
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -11,14 +11,13 @@ MultiCloud Release Notes
 Abstract
 ========
 
-This document provides the release notes for the ``guilin`` release.
+This document provides the release notes for the ``honolulu`` maintenance release.
 
 Summary
 =======
 
-MultiCloud Project enhances artifactbroker to support CNF orchestration with
-artifact format of helm charts (without wrapping in a dummy heat template)
-
+This release introduces new features into k8s plugin that enhance Day 2 configuration support for k8s resources and brings features for monitoring of CNF health.
+Maintenance Release provided additional changes compared to Honolulu release in k8splugin (see Bug fixes and Docker images sections).
 
 Release Data
 ============
@@ -33,10 +32,9 @@ Release Data
 |                           | onap/multicloud-openstack-windriver:1.5.5       |
 |                           | onap/multicloud-openstack-fcaps:1.5.5           |
 |                           | onap/multicloud-openstack-pike:1.5.5            |
-|                           | onap/multicloud-azure:1.2.4                     |
-|                           | onap/multicloud-k8s:0.7.0                       |
-+--------------------------------------+--------------------------------------+
-| **Release designation**   | Guilin 7.0.0                                    |
+|                           | **onap/multicloud-k8s:0.8.2**                   |
++---------------------------+-------------------------------------------------+
+| **Release designation**   | honolulu 8.1.0                                  |
 |                           |                                                 |
 +---------------------------+-------------------------------------------------+
 
@@ -44,21 +42,31 @@ Release Data
 New features
 ------------
 
-Enables CNF orchestration with artifact format of helm charts
+New features in k8s Plugin:
+- Refined Configuration API allows for flexible modification of the CNF configuration. Configuration API allows to create, modify and delete k8s resource templates and it allows their parameterization base on dedicated or inherited from the CNF instance input parameters.
+
+- Query API allows for the gathering of the filtered out the status of CNF what can be helpful to get precise information for particular resources belonging to the CNF. Query API produces results in the same format as Status API that offers the full set of information about CNF status.
+
+- HealthCheck API allows for the execution of dedicated healthcheck jobs (similar to helm test operation) that can verify on demand the current status of the CNF. The API can be used also to retrieved the results of healthcheck job execution, which can be extended with Status/Query API
+
+All new the features of k8splugin are explained and showcased as a part of `vFW CNF Use Case <https://docs.onap.org/projects/onap-integration/en/honolulu/docs_vFW_CNF_CDS.html>` and in the k8s API documentation.
 
 **Bug fixes**
 
-- `MULTICLOUD-1195 <https://jira.onap.org/browse/MULTICLOUD-1195>`_
-  Multicloud used wrong MSB URL
-  
+- `MULTICLOUD-1295 <https://jira.onap.org/browse/MULTICLOUD-1295>`_
+  MultiCloud k8s: Bug in Multicloud K8S Plugin Detemplating
+
+- `MULTICLOUD-1338 <https://jira.onap.org/browse/MULTICLOUD-1338>`_
+  MultiCloud k8s: Foreground delete policy prevents deletion of the pods
+
+- `MULTICLOUD-1348 <https://jira.onap.org/browse/MULTICLOUD-1348>`_
+  MultiCloud k8s: Regression in Multicloud-k8s
+
 **Known Issues**
 
 - `MULTICLOUD-359 <https://jira.onap.org/browse/MULTICLOUD-359>`_
   MultiCloud OpenStack: image creating API cannot handle large image file
 
-- `MULTICLOUD-389 <https://jira.onap.org/browse/MULTICLOUD-389>`_
-  MultiCloud OpenStack: keypair cannot be passed for nova instance creation
-
 - `MULTICLOUD-421 <https://jira.onap.org/browse/MULTICLOUD-421>`_
   MultiCloud OpenStack: API request to multicloud with authorization header will be rejected
 
@@ -68,6 +76,20 @@ Enables CNF orchestration with artifact format of helm charts
 - `MULTICLOUD-661 <https://jira.onap.org/browse/MULTICLOUD-661>`_
   MultiCloud k8s: OVN Installation issues
 
+- `MULTICLOUD-1269 <https://jira.onap.org/browse/MULTICLOUD-1269>`_
+  MultiCloud k8s: K8s Plugins keeps failed RB Instance
+
+- `MULTICLOUD-1312 <https://jira.onap.org/browse/MULTICLOUD-1312>`_
+  MultiCloud k8s: Query API returns 500 instead of 404
+
+- `MULTICLOUD-1329 <https://jira.onap.org/browse/MULTICLOUD-1329>`_
+  MultiCloud k8s: Redundant data in MongoDB created
+
+- `MULTICLOUD-1330 <https://jira.onap.org/browse/MULTICLOUD-1330>`_
+  MultiCloud k8s: Consul operation interface problems
+
+- `MULTICLOUD-1331 <https://jira.onap.org/browse/MULTICLOUD-1331>`_
+  MultiCloud k8s: Instance status update failure
 
 Deliverables
 ------------
@@ -88,11 +110,9 @@ System Limitations
 
 N/A
 
-
 Known Vulnerabilities
 ---------------------
 
-
 MULTICLOUD 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.
@@ -102,13 +122,11 @@ assessment have been documented as part of the
 `project
 <https://wiki.onap.org/pages/viewpage.action?pageId=68541501>`_.
 
-
 Workarounds
 -----------
 
 N/A
 
-
 Security Notes
 --------------