Merge "Add request IDs in command-executor log"
[ccsdk/cds.git] / docs / microservices / bluePrintsProcessorMS.rst
index 911f999..292f99e 100644 (file)
@@ -14,7 +14,7 @@ Micro service to Manage Controller Blueprint Models, such as Resource Dictionary
 This microservice is used to deploy Controller Blueprint Archive file in Run time database. This also helps to test the Valid Blueprint.
 
 Architecture:
-==============
+-------------
 
 |image0|
 
@@ -23,7 +23,7 @@ Architecture:
    :width: 800px
    
 Running Blueprints Processor Microservice Locally:
-==================================================
+--------------------------------------------------
 
 The purpose of this page is to show how to run the Blueprints Processor microservice locally, using the docker-compose.yaml file provided in the project.
 
@@ -34,7 +34,9 @@ Check out the latest code from Gerrit: https://gerrit.onap.org/r/#/admin/project
 Build CDS locally:
 In the checked out directory, type
 
-    mvn clean install -DskipTests=true -Dmaven.test.skip=true -Dmaven.javadoc.skip=true -Dadditionalparam=-Xdoclint:none
+.. code-block:: none
+   
+   mvn clean install -DskipTests=true -Dmaven.test.skip=true -Dmaven.javadoc.skip=true -Dadditionalparam=-Xdoclint:none
        
 Create the needed Docker images:
 
@@ -42,32 +44,44 @@ The Blueprints Processor microservice project has a module, called distribution,
 
 The first step is to create any custom image needed, by building the distribution module.  From the CDS home directory (where the code was checked out), navigate to the module:
 
-    cd ms/blueprintsprocessor/distribution/
+.. code-block:: none
+
+   cd ms/blueprintsprocessor/distribution/
+   
 Build it using the Maven profile called Docker:
 
-    mvn clean install -Pdocker
+.. code-block:: none
+
+   mvn clean install -Pdocker
        
 Start Docker containers using docker-composer:
-==============================================
+----------------------------------------------
 
 Navigate to the docker-compose file in the distribution module:
 
-    cd src/main/dc/
+.. code-block:: none
+    
+   cd src/main/dc/
        
 From there, start the containers:
 
-    docker-compose up -d
+.. code-block:: none
+
+   docker-compose up -d
+   
 This will spin the Docker containers declared inside the docker-compose.yaml file in the background.
 
 
 To verify the logs generated by docker-composer, type:
 
-    docker-compose logs -f
+.. code-block:: none
+
+   docker-compose logs -f
        
        
 Testing the environment:
-========================
+------------------------
 
 Point your browser to http://localhost:8000/api/v1/execution-service/ping (please note that the port is 8000, not 8080)
 
-To authenticate, use ccsdkapps / ccsdkapps as login / password.
\ No newline at end of file
+To authenticate, use login user id and password.
\ No newline at end of file