Use python rstcheck to validate syntax

[multicloud/framework.git] / docs / MultiCloud-Heat-Deployment-Guide.rst

diff --git a/docs/MultiCloud-Heat-Deployment-Guide.rst b/docs/MultiCloud-Heat-Deployment-Guide.rst
index f736f26..b2049bc 100644 (file)
--- a/docs/MultiCloud-Heat-Deployment-Guide.rst
+++ b/docs/MultiCloud-Heat-Deployment-Guide.rst
@@ -26,29 +26,33 @@ we'll need to create a file call admin.rc with following content
 
 keystone version 2.0 Example:
 
-export OS_AUTH_URL=https://identity.api.opentack.com/v2.0/
-export OS_USERNAME=UserName
-export OS_TENANT_ID=TenantID
-export OS_REGION_NAME=RegionID
-export OS_PASSWORD=Password
-export OS_IDENTITY_API_VERSION=2
+.. code-block:: console
+
+    export OS_AUTH_URL=https://identity.api.opentack.com/v2.0/
+    export OS_USERNAME=UserName
+    export OS_TENANT_ID=TenantID
+    export OS_REGION_NAME=RegionID
+    export OS_PASSWORD=Password
+    export OS_IDENTITY_API_VERSION=2
 
 keystone version 3.0 Example:
 
-export OS_AUTH_URL=https://identiy.api.openstack.com/v3/
-export OS_PROJECT_ID=ProjectID
-export OS_PROJECT_NAME=ProjectName
-export OS_USER_DOMAIN_NAME=DomainName
-export OS_USERNAME=UserName
-export OS_PASSWORD=Password
-if [ -z "$OS_USER_DOMAIN_NAME" ]; then unset OS_USER_DOMAIN_NAME; fi
+.. code-block:: console
+
+    export OS_AUTH_URL=https://identiy.api.openstack.com/v3/
+    export OS_PROJECT_ID=ProjectID
+    export OS_PROJECT_NAME=ProjectName
+    export OS_USER_DOMAIN_NAME=DomainName
+    export OS_USERNAME=UserName
+    export OS_PASSWORD=Password
+    if [ -z "$OS_USER_DOMAIN_NAME" ]; then unset OS_USER_DOMAIN_NAME; fi
 
-# unset v2.0 items in case set
-unset OS_TENANT_ID
-unset OS_TENANT_NAME
+    # unset v2.0 items in case set
+    unset OS_TENANT_ID
+    unset OS_TENANT_NAME
 
 
-export OS_IDENTITY_API_VERSION=3
+    export OS_IDENTITY_API_VERSION=3
 
 
 
@@ -58,7 +62,10 @@ Get VIO  pem
 
 Get a copy of vio.pem in load balancer vms(/etc/ssl/vio.pem) in local
 host, then add the following line to your  admin.rc file:
-export OS_CACERT=/your/path/vio.pem
+
+.. code-block:: console
+
+    export OS_CACERT=/your/path/vio.pem
 
 
 
@@ -66,22 +73,27 @@ export OS_CACERT=/your/path/vio.pem
 Deploy the ONAP
 ~~~~~~~~~~~~~~~~
 
-get onap heat files from git repo:
-git clone http://<your-account>@gerrit.onap.org/r/a/demo
+get onap heat files from git repo::
 
-we will use onap_opentack_float.yaml and onap_openstack_float.env  heat templates
-at ./demo/heat/ONAP/ dirctory.
+    git clone http://<your-account>@gerrit.onap.org/r/a/demo
+
+we will use onap_opentack_float.yaml and onap_openstack_float.env  heat
+templates at ./demo/heat/ONAP/ dirctory.
 
 Set env options in onap_openstack_float.env according to  VIO platform env,
 Finally, heat enviroment contains correct parameters.
 
 Next source the  admin.rc file to create shell environment variables we nedd.
 
-source  admin.rc
+.. code-block:: console
+
+    source  admin.rc
 
 Then create heat stack
 
-openstack stack create -t onap_openstack_float.yaml -e onap_openstack_float.env  ONAP
+.. code-block:: console
+
+    openstack stack create -t onap_openstack_float.yaml -e onap_openstack_float.env  ONAP
 
 This process will take several minutes to spin up