clean up some sphinx warnings
[dcaegen2.git] / docs / sections / services / heartbeat-ms / build_setup.rst
index 5df4723..e1465dc 100644 (file)
@@ -25,7 +25,7 @@ Docker build procedure
 Clone the code using below command\r
 \r
 ::\r
-      git clone --depth 1 https://gerrit.onap.org/r/dcaegen2/services/heartbeat \r
+      git clone --depth 1 https://gerrit.onap.org/r/dcaegen2/services/heartbeat\r
 \r
 give executable permission to mvn-phase-script.sh if not there\r
 already\r
@@ -54,10 +54,10 @@ CBS polling. The following environment variables are to be set.**
           consumerID=1\r
 \r
    If the postgres parameters are not there in environment setting file,\r
-   then it takes the values from    miss_htbt_service/config/hbproperties.yaml \r
-   file. Make sure that postgres running in the machine where pg_ipAddress \r
-   parameter is mentioned. \r
-   \r
+   then it takes the values from    miss_htbt_service/config/hbproperties.yaml\r
+   file. Make sure that postgres running in the machine where pg_ipAddress\r
+   parameter is mentioned.\r
+\r
    Run below netstat command to check postgres port number and IP address are fine.\r
 \r
 ::\r
@@ -75,7 +75,7 @@ CBS polling. The following environment variables are to be set.**
    are as follows\r
 \r
 ::\r
-       \r
+\r
           pg_ipAddress: 10.0.4.1\r
           pg_portNum: 5432\r
           pg_userName: postgres\r
@@ -89,25 +89,25 @@ CBS polling. The following environment variables are to be set.**
    correctly. Usually groupID remains the same for all instance of HB\r
    where as consumerID would be changed for each instance of HB Micro\r
    service. If groupID and consumerID is not provided, then it takes\r
-   “DefaultGroup” and “1” respectively.\r
+   "DefaultGroup" and "1" respectively.\r
 \r
 **Setting CBS configuration parameters using the consule KV URL.**\r
 \r
    The sample consul KV is as below.\r
    ::\r
-   \r
+\r
      http://10.12.6.50:8500/ui/#/dc1/kv/mvp-dcaegen2-heartbeat-static\r
 \r
    Go to the above link and click on KEY/VALUE tab\r
 \r
    Click on mvp-dcaegen2-heartbeat-static\r
 \r
-   Copy the configuration in the box provided and click on update. \r
-   \r
+   Copy the configuration in the box provided and click on update.\r
+\r
    The sample configuration is as below\r
-   \r
+\r
    .. code-block:: json\r
-   \r
+\r
                {\r
                        "heartbeat_config": {\r
                                "vnfs": [{\r
@@ -177,7 +177,7 @@ mentioned in the above section.**
       heartbeat.test1:latest\r
 \r
  To check the logs, run below command\r
\r
+\r
 ::\r
 \r
       sudo Docker logs -f hb1\r
@@ -191,17 +191,17 @@ mentioned in the above section.**
        sudo Docker ps -a \| grep heartbeat.test1\r
 \r
    Run below commands to stop the Docker run\r
-   \r
+\r
 ::\r
-   \r
+\r
        sudo Docker stop <Docker container ID)\r
        sudo Docker rm -f hb1\r
 \r
 **Initiate the maven build**\r
 \r
    To run the maven build, execute any one of them.\r
-   \r
-:: \r
+\r
+::\r
 \r
       sudo mvn -s settings.xml deploy\r
       OR\r
@@ -211,5 +211,5 @@ mentioned in the above section.**
    libxml-xpath as below. If the issue is something else, follow the\r
    link given as part of the build failure.\r
 \r
-:: \r
+::\r
       sudo apt install libxml-xpath-perl\r