Updating release notes and documentation

Issue-Id: AIMLFW-50

Change-Id: I1d754b7dc024d191a6002de3173ca421e1565776
Signed-off-by: josephthaliath <jo.thaliath@samsung.com>

diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst
index 2a00c60..382bd3a 100755 (executable)
--- a/docs/installation-guide.rst
+++ b/docs/installation-guide.rst
@@ -19,20 +19,19 @@ This document describes how to install AIMLFW, demo scenarios, it's dependencies
 
 Version history
 
-+--------------------+--------------------+--------------------+--------------------+
-| **Date**           | **Ver.**           | **Author**         | **Comment**        |
-|                    |                    |                    |                    |
-+--------------------+--------------------+--------------------+--------------------+
-| 2022-11-30         | 0.1.0              |                   | First draft        |
-|                    |                    |                    |                    |
-+--------------------+--------------------+--------------------+--------------------+
-| 2023-06-06         | 1.0.0              | Joseph Thaliath    |  H Release         |
-|                    |                    |                    |                    |
-+--------------------+--------------------+--------------------+--------------------+
-|                    |                    |                    |                    |
-|                    |                    |                    |                    |
-|                    |                    |                    |                    |
-+--------------------+--------------------+--------------------+--------------------+
++--------------------+--------------------+--------------------+-----------------------+
+| **Date**           | **Ver.**           | **Author**         | **Comment**           |
+|                    |                    |                    |                       |
++--------------------+--------------------+--------------------+-----------------------+
+| 2022-11-30         | 0.1.0              |                   | First draft           |
+|                    |                    |                    |                       |
++--------------------+--------------------+--------------------+-----------------------+
+| 2023-06-06         | 1.0.0              | Joseph Thaliath    |  H Release            |
+|                    |                    |                    |                       |
++--------------------+--------------------+--------------------+-----------------------+
+| 2023-08-10         | 1.0.1              | Joseph Thaliath    | H Maintenance release |
+|                    |                    |                    |                       |
++--------------------+--------------------+--------------------+-----------------------+
 
 
 Introduction
@@ -386,7 +385,7 @@ Example of updating the RECIPE file is shown below
             host: <IP of RANPM setup>
             port: 31812
             orgname: est
-            bucket: pm-bucket
+            bucket: pm-logg-bucket
             token:  <Token shown when ./get_access_tokens.sh is executed>
 
 Execute the below script
@@ -415,14 +414,14 @@ Steps to check if data is upload correctly
 .. code:: bash
 
         kubectl exec -it influxdb2-0 -n nonrtric -- bash
-        influx query 'from(bucket: "pm-bucket") |> range(start: -1000000000000000000d)' |grep pdcpBytesDl
+        influx query 'from(bucket: "pm-logg-bucket") |> range(start: -1000000000000000000d)' |grep pdcpBytesDl
 
 Steps to clear the data in InfluxDB
 
 .. code:: bash
 
         kubectl exec -it influxdb2-0 -n nonrtric -- bash
-        influx delete --bucket pm-bucket --start 1801-01-27T05:00:22.305309038Z   --stop 2023-11-14T00:00:00Z
+        influx delete --bucket pm-logg-bucket --start 1801-01-27T05:00:22.305309038Z   --stop 2023-11-14T00:00:00Z
 
 
 Training job creation with DME as data source
@@ -435,48 +434,48 @@ Training job creation with DME as data source
 
 NOTE: Below are some example values to be used for the QoE usecase training job creation 
 
-+--------------------+--------------------------------------------------------------+
-| **Parameter**      | **Value**                                                    |
-|                    |                                                              |
-+--------------------+--------------------------------------------------------------+
-| Training Job Name  | qoetest                                                      |
-|                    |                                                              |
-+--------------------+--------------------------------------------------------------+
-| Training Function  | qoe_pipeline_h_release                                       |
-|                    |                                                              |
-+--------------------+--------------------------------------------------------------+
-| Experiment Name    | Default                                                      |
-|                    |                                                              |
-|                    |                                                              |
-+--------------------+--------------------------------------------------------------+
-| Datalake Source    | Influx DB                                                    |
-|                    |                                                              |
-|                    |                                                              |
-+--------------------+--------------------------------------------------------------+
-| _measurement       | ManagedElement=nodedntest,GNBDUFunction=1004,NRCellDU=c4_B2  |
-|                    |                                                              |
-|                    |                                                              |
-+--------------------+--------------------------------------------------------------+
-| bucket             | pm-bucket                                                    |
-|                    |                                                              |
-|                    |                                                              |
-+--------------------+--------------------------------------------------------------+
-| Feature Name       | \*                                                           |
-|                    |                                                              |
-|                    |                                                              |
-+--------------------+--------------------------------------------------------------+
-| Feature Filter     |                                                              |
-|                    |                                                              |
-|                    |                                                              |
-+--------------------+--------------------------------------------------------------+
-| Hyper Parameters   | epochs:1                                                     |
-|                    |                                                              |
-|                    |                                                              |
-+--------------------+--------------------------------------------------------------+
-| Description        | test                                                         |
-|                    |                                                              |
-|                    |                                                              |
-+--------------------+--------------------------------------------------------------+
++--------------------+-------------------------------------------------------------------+
+| **Parameter**      | **Value**                                                         |
+|                    |                                                                   |
++--------------------+-------------------------------------------------------------------+
+| Training Job Name  | qoetest                                                           |
+|                    |                                                                   |
++--------------------+-------------------------------------------------------------------+
+| Training Function  | qoe_pipeline_h_release                                            |
+|                    |                                                                   |
++--------------------+-------------------------------------------------------------------+
+| Experiment Name    | Default                                                           |
+|                    |                                                                   |
+|                    |                                                                   |
++--------------------+-------------------------------------------------------------------+
+| Datalake Source    | Influx DB                                                         |
+|                    |                                                                   |
+|                    |                                                                   |
++--------------------+-------------------------------------------------------------------+
+| _measurement       | test,ManagedElement=nodedntest,GNBDUFunction=1004,NRCellDU=c4_B2  |
+|                    |                                                                   |
+|                    |                                                                   |
++--------------------+-------------------------------------------------------------------+
+| bucket             | pm-logg-bucket                                                    |
+|                    |                                                                   |
+|                    |                                                                   |
++--------------------+-------------------------------------------------------------------+
+| Feature Name       | \*                                                                |
+|                    |                                                                   |
+|                    |                                                                   |
++--------------------+-------------------------------------------------------------------+
+| Feature Filter     |                                                                   |
+|                    |                                                                   |
+|                    |                                                                   |
++--------------------+-------------------------------------------------------------------+
+| Hyper Parameters   | epochs:1                                                          |
+|                    |                                                                   |
+|                    |                                                                   |
++--------------------+-------------------------------------------------------------------+
+| Description        | test                                                              |
+|                    |                                                                   |
+|                    |                                                                   |
++--------------------+-------------------------------------------------------------------+
 
 
 Training job creation with standalone Influx DB as data source

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index c220680..6311dc9 100644 (file)
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -17,16 +17,19 @@ This document provides the release notes for the release of AIMLFW Installation
 Version history
 ===============
 
-+--------------------+--------------------+--------------------+--------------------+
-| **Date**           | **Ver.**           | **Author**         | **Comment**        |
-|                    |                    |                    |                    |
-+--------------------+--------------------+--------------------+--------------------+
-| 2022-12-08         | 1.0.0              | Joseph Thaliath    | G release          |
-|                    |                    |                    |                    |
-+--------------------+--------------------+--------------------+--------------------+
-| 2023-06-07         | 1.1.0              | Joseph Thaliath    | H release          |
-|                    |                    |                    |                    |
-+--------------------+--------------------+--------------------+--------------------+
++--------------------+--------------------+--------------------+-----------------------+
+| **Date**           | **Ver.**           | **Author**         | **Comment**           |
+|                    |                    |                    |                       |
++--------------------+--------------------+--------------------+-----------------------+
+| 2022-12-08         | 1.0.0              | Joseph Thaliath    | G release             |
+|                    |                    |                    |                       |
++--------------------+--------------------+--------------------+-----------------------+
+| 2023-06-07         | 1.1.0              | Joseph Thaliath    | H release             |
+|                    |                    |                    |                       |
++--------------------+--------------------+--------------------+-----------------------+
+| 2023-08-10         | 1.1.1              | Joseph Thaliath    | H Maintenance release |
+|                    |                    |                    |                       |
++--------------------+--------------------+--------------------+-----------------------+
 
 
 Summary
@@ -38,6 +41,27 @@ The H release of AIMLFW provides required installation scripts for deployment of
 Release Data
 ============
 
+H Maintenance Release
+---------------------
+
++--------------------------------------+------------------------------------------------+
+| **Project**                          | AIMLFW Installation and Deployment             |
+|                                      |                                                |
++--------------------------------------+------------------------------------------------+
+| **Repo/commit-ID**                   | aiml-fw/aimlfw-dep                             |
+|                                      | /ae0529d608bc914df622547a7bf01e0f140ec87a      |
++--------------------------------------+------------------------------------------------+
+| **Release designation**              | H  Maintenance release                         |
+|                                      |                                                |
++--------------------------------------+------------------------------------------------+
+| **Release date**                     | 2023-08-10                                     |
+|                                      |                                                |
++--------------------------------------+------------------------------------------------+
+| **Purpose of the delivery**          | Align to changes in NON-RT RIC DME APIs        |
++--------------------------------------+------------------------------------------------+
+
+
+
 H Release
 ---------