Heartbeat Microservice User Documentation

User Documentation for heartbeat Microservice
Issue-ID: DCAEGEN2-280

Change-Id: I1fd627b5026fa850c866a364440ff316db409b5a
Signed-off-by: PrakashH <pbhandar@techmahindra.com>

diff --git a/docs/sections/services/heartbeat-ms/architecture.rst b/docs/sections/services/heartbeat-ms/architecture.rst
index f97fa24..af96af3 100644 (file)
--- a/docs/sections/services/heartbeat-ms/architecture.rst
+++ b/docs/sections/services/heartbeat-ms/architecture.rst
@@ -1,12 +1,10 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.\r
 .. http://creativecommons.org/licenses/by/4.0\r
 \r
-.. _architecture:\r
-\r
 High-level architecture of Heartbeat Microservice\r
 =================================================\r
 \r
-**Heartbeat Microservice**’s startup script (misshtbtd.py) gets the\r
+**Heartbeat Microservice** startup script (misshtbtd.py) gets the\r
 configuration from CBS and parses these entries and saves them in the\r
 postgres database having table name **vnf_table_1**. Each entry in the\r
 configuration is for a particular eventName. Each entry has missed\r
@@ -40,7 +38,7 @@ function/method to download the CBS configuration.
 \r
 The heartbeat microservice has 2 states\r
 \r
-**Reconfiguration state**– Download configuration from CBS and update\r
+**Reconfiguration state** – Download configuration from CBS and update\r
 the vnf_table_1 is in progress.\r
 \r
 **Running state** – Normal working that comprises of receiving of HB\r

diff --git a/docs/sections/services/heartbeat-ms/build_setup.rst b/docs/sections/services/heartbeat-ms/build_setup.rst
index f2943cc..6ab6a17 100644 (file)
--- a/docs/sections/services/heartbeat-ms/build_setup.rst
+++ b/docs/sections/services/heartbeat-ms/build_setup.rst
@@ -1,9 +1,6 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.\r
 .. http://creativecommons.org/licenses/by/4.0\r
 \r
-.. _build_setup:\r
-\r
-\r
 Build and Setup procedure\r
 =========================\r
 \r
@@ -26,13 +23,14 @@ Docker build procedure
 ----------------------\r
 \r
 Clone the code using below command\r
-   .. code-block:: bash\r
+\r
+::\r
       git clone https://gerrit.onap.org/r/dcaegen2/services/heartbeat \r
 \r
 give executable permission to mvn-phase-script.sh if not there\r
 already\r
-   .. code-block:: bash\r
 \r
+::\r
       chmod +x mvn-phase-script.sh\r
 \r
 **Setting up the postgres DB, group/consumer IDs, CBS download and\r
@@ -62,7 +60,8 @@ CBS polling. The following environment variables are to be set.**
    \r
    Run below netstat command to check postgres port number and IP address are fine.\r
 \r
-   .. code-block:: bash\r
+::\r
+\r
       netstat -ant\r
 \r
    If CBS parameters are not there in the environment setting file, then\r
@@ -74,7 +73,8 @@ CBS polling. The following environment variables are to be set.**
 \r
    The sample values in miss_htbt_service/config/hbproperties.yaml file\r
    are as follows\r
-    .. code-block:: YAML\r
+\r
+::\r
        \r
           pg_ipAddress: 10.0.4.1\r
           pg_portNum: 5432\r
@@ -156,39 +156,39 @@ CBS polling. The following environment variables are to be set.**
 \r
 **Build the Docker using below command with a image name**\r
 \r
-   .. code-block:: bash\r
+::\r
 \r
      sudo Docker build --no-cache --network=host -f ./Dockerfile -t\r
      heartbeat.test1:latest .\r
 \r
  To check whether image is built or not, run below command\r
 \r
-   .. code-block:: bash\r
+::\r
       sudo Docker images |grep heartbeat.test1\r
 \r
 **Run the Docker using below command which uses the environment file\r
 mentioned in the above section.**\r
 \r
-   .. code-block:: bash\r
+::\r
       sudo Docker run -d --name hb1 --env-file env.list\r
       heartbeat.test1:latest\r
 \r
  To check the logs, run below command\r
  \r
-   .. code-block:: bash\r
+::\r
       sudo Docker logs -f hb1\r
 \r
 **To stop the Docker run**\r
 \r
    Get the Docker container ID from below command\r
 \r
-   .. code-block:: bash\r
+::\r
 \r
        sudo Docker ps -a \| grep heartbeat.test1\r
 \r
    Run below commands to stop the Docker run\r
    \r
-   .. code-block:: bash\r
+::\r
    \r
        sudo Docker stop <Docker container ID)\r
        sudo Docker rm -f hb1\r
@@ -197,7 +197,7 @@ mentioned in the above section.**
 \r
    To run the maven build, execute any one of them.\r
    \r
-   .. code-block:: bash\r
+:: \r
       sudo mvn -s settings.xml deploy\r
       OR\r
       sudo mvn -s settings.xml -X deploy\r
@@ -205,6 +205,6 @@ mentioned in the above section.**
    If there is a libxml-xpath related issue, then install the\r
    libxml-xpath as below. If the issue is something else, follow the\r
    link given as part of the build failure.\r
-  \r
-   .. code-block:: bash\r
+\r
+:: \r
       sudo apt install libxml-xpath-perl\r

diff --git a/docs/sections/services/heartbeat-ms/design.rst b/docs/sections/services/heartbeat-ms/design.rst
index fa4490f..837b8fc 100644 (file)
--- a/docs/sections/services/heartbeat-ms/design.rst
+++ b/docs/sections/services/heartbeat-ms/design.rst
@@ -1,8 +1,6 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.\r
 .. http://creativecommons.org/licenses/by/4.0\r
 \r
-.. _design:\r
-\r
 Design\r
 ======\r
 \r

diff --git a/docs/sections/services/heartbeat-ms/index.rst b/docs/sections/services/heartbeat-ms/index.rst
index 4b67e98..148b8da 100644 (file)
--- a/docs/sections/services/heartbeat-ms/index.rst
+++ b/docs/sections/services/heartbeat-ms/index.rst
@@ -13,12 +13,9 @@ Heartbeat Microservice overview and functions
 ---------------------------------------------\r
 \r
 .. toctree::\r
-    :maxdepth: 1\r
+   :maxdepth: 1\r
        \r
-       architecture\r
-       design\r
-       build_setup\r
-       testprocedure\r
-       \r
-\r
- \r
+   ./architecture.rst\r
+   ./design.rst\r
+   ./build_setup.rst\r
+   ./testprocedure.rst\r

diff --git a/docs/sections/services/heartbeat-ms/testprocedure.rst b/docs/sections/services/heartbeat-ms/testprocedure.rst
index 6f80fc4..03bcbab 100644 (file)
--- a/docs/sections/services/heartbeat-ms/testprocedure.rst
+++ b/docs/sections/services/heartbeat-ms/testprocedure.rst
@@ -1,8 +1,6 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.\r
 .. http://creativecommons.org/licenses/by/4.0\r
 \r
-.. _testprocedure:\r
-\r
 Test procedures and Postgres Database access\r
 ============================================\r
 \r
@@ -16,7 +14,7 @@ Run below commands to login into postgres DB and connect to HB Micro service DB.
 ::\r
      sudo su postgres\r
      psql\r
-        \l hb_vnf\r
+     \l hb_vnf\r
 \r
 Sample output is as below\r
 \r