Add slice-analysis-ms documents

Application configurations and troubleshooting steps added
Removed references to PNDA

Issue-ID: DCAEGEN2-2515
Signed-off-by: Reshmasree <reshmasree.chamarthi2@wipro.com>
Signed-off-by: Ahila P <ahila.pandaram@wipro.com>
Change-Id: I941420b459b60e0e8f4c63463b16d7f6602cbfeb

5 files changed, 237 insertions, 0 deletions

diff --git a/docs/sections/services/slice-analysis-ms/index.rst b/docs/sections/services/slice-analysis-ms/index.rst
new file mode 100644
index 00000000..252a2f34
--- /dev/null
+++ b/docs/sections/services/slice-analysis-ms/index.rst
@@ -0,0 +1,51 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.

+.. http://creativecommons.org/licenses/by/4.0

+

+

+Slice Analysis MS

+=================

+

+.. Add or remove sections below as appropriate for the platform component.

+

+

+**Slice Analysis MS** is introduced in ONAP for:

+(a) Analyzing the FM/PM data (reported from the xNFs) and KPI data (computed from PM data) related to various slice instances (NSIs), slice sub-net instances (NSSIs) and services catered to by the slices (S-NSSAIs).

+(b) Determining and triggering appropriate Control Loop actions based on the analysis above

+(c) Receiving recommendations for closed loop actions from ML or Analytics engines, performing validity checks, etc. to determine if the actions can be carried out, and then triggering the appropriate Control Loop

+

+In Guilin, this MS:

+- Performs simple Closed Loop control action for the RAN slice sub-net instances based on simple analysis of a set of RAN PM data

+- Initiates simple control loop actions in the RAN based on recommendation from an ML engine for RAN slice sub-net instance re-configuration

+

+For the Control loops, SO, VES Collector, Policy, DMaaP and CCSDK/SDN-R, AAI, PM-mapper and DFC are involved apart from this MS.

+

+Flow diagrams are available at:

+https://wiki.onap.org/display/DW/Closed+Loop

+https://wiki.onap.org/display/DW/Intelligent+Slicing+flow

+

+

+Slice Analysis MS overview and functions

+----------------------------------------

+

+.. toctree::

+    :maxdepth: 1

+

+    ./slice_analysis_ms_overview.rst

+

+

+Slice Analysis MS Installation Steps

+------------------------------------

+

+.. toctree::

+    :maxdepth: 1

+

+    ./installation.rst

+

+

+Slice Analysis MS Troubleshooting Steps

+---------------------------------------

+

+.. toctree::

+    :maxdepth: 1

+

+    ./slice_analysis_ms_troubleshooting.rst
\ No newline at end of file
diff --git a/docs/sections/services/slice-analysis-ms/installation.rst b/docs/sections/services/slice-analysis-ms/installation.rst
new file mode 100644
index 00000000..ebe2b782
--- /dev/null
+++ b/docs/sections/services/slice-analysis-ms/installation.rst
@@ -0,0 +1,75 @@
+Installation

+============

+

+Slice Analysis MS can be deployed using cloudify blueprint using bootstrap container of an existing DCAE deployment.

+

+Deployment Pre-requisites

+~~~~~~~~~~~~~~~~~~~~~~~~~

+- DCAE and DMaaP pods should be up and running. 

+

+- DMaaP Bus Controller PostInstalls job should have completed successfully (executed as part of an OOM install).

+

+- PM mapper service should be running.

+

+- Config DB service should be running.

+

+- Make sure that cfy is installed and configured to work with the Cloudify deployment.

+

+

+Deployment steps

+~~~~~~~~~~~~~~~~

+1. Execute bash on the bootstrap Kubernetes pod. 

+   

+   kubectl -n onap exec -it <dcaegen2-dcae-bootstrap> bash

+

+2. Go to the /blueprints directory.

+

+  Check that the tag_version in the slice-analysis-ms blueprint is correct for the release

+  of ONAP that it is being installed on see Nexus link below for slice-analysis-ms for tag_versions.

+  Nexus link: https://nexus3.onap.org/#browse/browse:docker.public:v2%2Fonap%2Forg.onap.dcaegen2.services.components.slice-analysis-ms%2Ftags

+

+3. Create an input file.

+

+4. Run the Cloudify install command to install the slice-analysis-ms with the blueprint and the newly    created input file k8s-slice-input.yaml.

+

+   $ cfy install k8s-slice-analysis-ms.yaml -i  k8s-slice-input.yaml --blueprint-id sliceanalysisms

+

+   Details of the sample output are available at:

+   https://wiki.onap.org/pages/viewpage.action?pageId=92998809.

+

+5. To un-deploy

+

+  $ cfy uninstall sliceanalysisms

+

+

+Application configurations

+~~~~~~~~~~~~~~~~~~~~~~~~~~

++-------------------------------+------------------------------------------------+

+|Configuration                  | Description                                    |

++===============================+================================================+

+|samples                        | Minimum number of samples to be present        |

+|                               | for analysis                                   |

++-------------------------------+------------------------------------------------+

+|minimumPercentageChange        | Minimum percentage of configuration change     |

+|                               | above which control loop should be triggered   |

++-------------------------------+------------------------------------------------+

+|initialDelaySeconds            | Initial delay in milliseconds for the consumer |

+|                               | thread to start after the application startup  |

++-------------------------------+------------------------------------------------+

+|config_db                      | Host where the config DB application is running|

++-------------------------------+------------------------------------------------+

+|performance_management_topicurl| Dmaap Topic URL to which PM data are posted    |

+|                               | by network functions                           |

++-------------------------------+------------------------------------------------+

+|dcae_cl_topic_url              | Dmaap topic to which onset message to trigger  |

+|                               | the control loop are posted                    |

++-------------------------------+------------------------------------------------+

+|dcae_cl_response_topic_url     | Dmaap topic URL to which Policy posts the      |

+|                               | message after successful control loop trigger  |

++-------------------------------+------------------------------------------------+

+|intelligent_slicing_topic_url  | Dmaap topic URL to which ML MS posts the       |

+|                               | messages                                       |

++-------------------------------+------------------------------------------------+

+|dmaap_polling_interval         | Dmaap Polling interval in milliseconds         |

++-------------------------------+------------------------------------------------+

+

diff --git a/docs/sections/services/slice-analysis-ms/slice_analysis_ms_arch.jpg b/docs/sections/services/slice-analysis-ms/slice_analysis_ms_arch.jpg
new file mode 100644
index 00000000..64ead8ab
--- /dev/null
+++ b/docs/sections/services/slice-analysis-ms/slice_analysis_ms_arch.jpg
diff --git a/docs/sections/services/slice-analysis-ms/slice_analysis_ms_overview.rst b/docs/sections/services/slice-analysis-ms/slice_analysis_ms_overview.rst
new file mode 100644
index 00000000..05cb2383
--- /dev/null
+++ b/docs/sections/services/slice-analysis-ms/slice_analysis_ms_overview.rst
@@ -0,0 +1,65 @@
+.. This work is licensed under a Creative Commons Attribution 4.0

+   International License. http://creativecommons.org/licenses/by/4.0

+   

+.. _docs_slice_analysis_ms_overview:

+

+Architecture

+------------

+The internal architecture of Slice Analysis MS is shown below.

+

+.. image:: ./slice_analysis_ms_arch.jpg

+

+The Slice Analysis MS has a DMaaP interface towards towards Policy and VES-Collector, and a REST

+interface towards Config DB. It also has a DMaaP interface to receive any recommendations for

+Closed Loop updates from an ML engine, which is then used to trigger a control loop message to

+Policy.

+

+- **DMAAP Client** creates a thread pool for every DMaaP topic consumer. The thread

+  polls the DMaaP topic for every configured time interval and whenever a message is

+  received it stores that message in the Postgres DB.

+

+- **PM Thread** reads the PM event from the database and puts the PM sample in the

+  internal queue in the format which is needed for further processing.

+

+- **Consumer Thread** consumes PM samples from the internal queue and make all the

+  required Config DB calls, perform the analysis, and puts the onset message to the DMaaP topic.

+

+- **Database** is a PG DB.

+

+Detailed flow diagrams are available at:

+

+Closed Loop: https://wiki.onap.org/display/DW/Closed+Loop

+

+Intelligent Slicing: https://wiki.onap.org/display/DW/Intelligent+Slicing+flow

+

+

+Functional Description

+----------------------

+- Slice Analysis ms consumes PM messages from PERFORMANCE_MEASUREMENTS topic.

+

+- For analysis Slice Analysis MS consumes various data from Config DB including List of Network  

+  Functions which serves the S-NSSAI, List of Near-RT RICs and the corresponding cell mappings of the

+  S-NSSAI, Current Configuration of the Near-RT RICs, Slice Profile associated with the S-NSSAI and

+  Subscriber details of the S-NSSAI (for sending the onset message to policy).

+

+- Based on the collected PM data, Slice Analysis MS computes the DLThptPerSlice and ULThptPerSlice

+  for the Near-RT RICs relevant for the S-NSSAI, and the computed value is compared with the current

+  configuration of the Near-RT RICs. If the change in configuration exceeds the minimum percentage

+  value which is kept as a configuration parameter, then the closed-loop will be triggered by posting

+  the onset message to DMaaP.

+

+- Upon reception of recommendation to update the configuration of RAN from e.g., an ML MS, the Slice

+  Analysis MS prepares and sends a control loop onset message.

+

+

+Deployment aspects

+------------------

+The SON-Handler MS will be deployed on DCAE as an on-demand component. Details of the installation

+steps are available at ./installation.rst. Further details can be obtained from:

+https://wiki.onap.org/pages/viewpage.action?pageId=92998809

+

+

+Known Issues and Resolutions

+----------------------------

+The assumptions of functionality in Guilin release is documented in:

+https://wiki.onap.org/display/DW/Assumptions+for+Guilin+release

diff --git a/docs/sections/services/slice-analysis-ms/slice_analysis_ms_troubleshooting.rst b/docs/sections/services/slice-analysis-ms/slice_analysis_ms_troubleshooting.rst
new file mode 100644
index 00000000..66dee8c2
--- /dev/null
+++ b/docs/sections/services/slice-analysis-ms/slice_analysis_ms_troubleshooting.rst
@@ -0,0 +1,46 @@
+Trouble shooting steps
+----------------------
+1. **Microservice stops and restarts during startup**
+
+    Possible reason & Solution: Microservice is not registered with the consul 
+     - Check the consul if the microservice is registered with it and the MS is able to fetch the app config from the CBS. Check if CBS and consul are   deployed properly and try to redeploy the MS
+        The below logs will be seen if CBS is not reachable by the MS
+
+       15:14:13.861 [main] WARN  org.postgresql.Driver - JDBC URL port: 0 not valid (1:65535) 
+       15:14:13.862 [main] WARN  o.s.b.w.s.c.AnnotationConfigServletWebServerApplicationContext -
+       Exception encountered during context initialization - cancelling refresh attempt: 
+       org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name
+       'org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaConfiguration': Unsatisfied
+       dependency expressed through constructor parameter 0; nested exception is
+       org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'dataSource'
+       defined in org.onap.dcaegen2.services. sliceanalysisms.Application: Initialization of bean failed;
+       nested exception is org.springframework.beans.factory.BeanCreationException: Error creating bean with name
+       'org.springframework.boot.autoconfigure.jdbc.DataSourceInitializerInvoker': Invocation of init method failed; nested exception is
+       org.springframework.jdbc.datasource.init.UncategorizedScriptException: Failed to execute database script; nested exception is
+       java.lang.RuntimeException: Driver org.postgresql.Driver claims to not accept jdbcUrl, jdbc:postgresql://null:0/sliceanalysisms
+       15:14:13.865 [main] INFO  o.a.catalina.core.StandardService - Stopping service [Tomcat]
+       15:14:13.877 [main] INFO  o.s.b.a.l.ConditionEvaluationReportLoggingListener - Error starting ApplicationContext.
+       To display the conditions report re-run      your application with 'debug' enabled.
+       15:14:13.880 [main] ERROR o.s.boot.SpringApplication - Application run failed
+
+2. **No PostgreSQL clusters have been deployed on this manager**
+
+   Solution:
+   
+    kubectl exec -ti -n onap dev-dcaemod-db-primary-56ff585cf7-dxkkx bash
+    psql
+    ALTER ROLE "postgres" WITH PASSWORD 'onapdemodb';
+    \q
+
+    kubectl exec -ti -n onap dev-dcae-bootstrap-b47854569-dnrqf bash
+    cfy blueprints upload -b pgaas_initdb /blueprints/k8s-pgaas-initdb.yaml
+    cfy deployments create -b pgaas_initdb -i k8s-pgaas-initdb-inputs.yaml pgaas_initdb
+    cfy executions start -d pgaas_initdb install
+
+
+Logging
+-------
+Since the Slice Analysis MS is deployed as a pod in the kubernetes, we can check the logs by
+using the following command:
+
+ $ kubectl logs <pod-name> –namespace onap
\ No newline at end of file