JIRA:IPVSIX-29

Change-Id: I948b3187326537c611e8c9fe6390936fa1e6061d
Signed-off-by: Bin Hu <bh526r@att.com>

1 files changed, 31 insertions, 3 deletions

diff --git a/docs/reldoc/index.rst b/docs/reldoc/index.rst
index 80acf38..ec74509 100644
--- a/docs/reldoc/index.rst
+++ b/docs/reldoc/index.rst
@@ -47,6 +47,20 @@ Install OPNFV and Preparation
 
 **OPNFV-NATIVE-INSTALL-1**: To install OpenStack-only environment of OPNFV Brahmaputra Release:
 
+**Compass** Installer:
+
+.. code-block:: bash
+
+    # HA deployment in OpenStack-only environment
+    export ISO_URL=file://$BUILD_DIRECTORY/compass.iso
+    export OS_VERSION=${{COMPASS_OS_VERSION}}
+    export OPENSTACK_VERSION=${{COMPASS_OPENSTACK_VERSION}}
+    export CONFDIR=$WORKSPACE/deploy/conf/vm_environment
+    sudo ./deploy.sh --dha $CONFDIR/os-nosdn-nofeature-ha.yml --network $CONFDIR/$NODE_NAME/network.yml
+
+    # Non-HA deployment in OpenStack-only environment
+    # Non-HA deployment is currently not supported by Compass installer
+
 **Fuel** Installer:
 
 .. code-block:: bash
@@ -67,7 +81,7 @@ Install OPNFV and Preparation
     # Non-HA deployment in OpenStack-only environment
     sudo ./deploy.sh -o liberty -s nosdn -t noha
 
-Please **NOTE** that currently only ``Fuel`` and ``Joid`` installers support this environment.
+Please **NOTE** that currently only ``Compass``, ``Fuel`` and ``Joid`` installers support this environment.
 
 **OPNFV-NATIVE-INSTALL-2**: Clone the following GitHub repository to get the
 configuration and metadata files
@@ -320,7 +334,21 @@ of OPNFV Brahmaputra Release:
     sudo opnfv-deploy -d /etc/opnfv/os-odl_l2-nofeature-ha.yaml
 
     # Non-HA deployment in OpenStack with Open Daylight L2-only environment
-    # Currently it is not supported by Apex installer.
+    # Non-HA deployment is currently not supported by Apex installer.
+
+**Compass** Installer:
+
+.. code-block:: bash
+
+    # HA deployment in OpenStack with Open Daylight L2-only environment
+    export ISO_URL=file://$BUILD_DIRECTORY/compass.iso
+    export OS_VERSION=${{COMPASS_OS_VERSION}}
+    export OPENSTACK_VERSION=${{COMPASS_OPENSTACK_VERSION}}
+    export CONFDIR=$WORKSPACE/deploy/conf/vm_environment
+    sudo ./deploy.sh --dha $CONFDIR/os-odl_l2-nofeature-ha.yml --network $CONFDIR/$NODE_NAME/network.yml
+
+    # Non-HA deployment in OpenStack with Open Daylight L2-only environment
+    # Non-HA deployment is currently not supported by Compass installer
 
 **Fuel** Installer:
 
@@ -332,7 +360,7 @@ of OPNFV Brahmaputra Release:
     # Non-HA deployment in OpenStack with Open Daylight L2-only environment
     sudo ./deploy.sh -s os-odl_l2-nofeature-noha
 
-Please **NOTE** that currently only ``Apex`` and ``Fuel`` installer support this environment.
+Please **NOTE** that currently only ``Apex``, ``Compass`` and ``Fuel`` installer support this environment.
 
 **OPNFV-INSTALL-2**: Clone the following GitHub repository to get the
 configuration and metadata files