JIRA:IPVSIX-29

Change-Id: Ib80b22327d59453d72fb0b6cbe7d291dd1eb6176
Signed-off-by: Bin Hu <bh526r@att.com>
(cherry picked from commit c2f95a5ac3829feb2c43d1bfa019b09b52e63b71)

diff --git a/docs/configguide/featureconfig.rst b/docs/configguide/featureconfig.rst
index 78ebfc6..928e675 100644 (file)
--- a/docs/configguide/featureconfig.rst
+++ b/docs/configguide/featureconfig.rst
@@ -52,12 +52,22 @@ Install OPNFV and Preparation
 .. code-block:: bash
 
     # HA deployment in OpenStack-only environment
-    sudo deploy.sh -s os-nofeature-ha
+    sudo ./deploy.sh -s os-nofeature-ha
 
     # Non-HA deployment in OpenStack-only environment
-    sudo deploy.sh -s os-nofeature-noha
+    sudo ./deploy.sh -s os-nofeature-noha
 
-Please **NOTE** that currently only ``Fuel`` installer supports this environment.
+**Joid** Installer:
+
+.. code-block:: bash
+
+    # HA deployment in OpenStack-only environment
+    sudo ./deploy.sh -o liberty -s nosdn -t ha
+
+    # 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.
 
 **OPNFV-NATIVE-INSTALL-2**: Clone the following GitHub repository to get the
 configuration and metadata files
@@ -100,15 +110,33 @@ Set Up Service VM as IPv6 vRouter
 ---------------------------------
 
 **OPNFV-NATIVE-SETUP-1**: Now we assume that OpenStack multi-node setup is up and running.
-We have to source the tenant credentials in this step. The following command should be executed:
+We have to source the tenant credentials in this step. Please **NOTE** that the method of sourcing tenant
+credentials may vary depending on installers. For example:
+
+**Apex** installer:
+
+.. code-block:: bash
+
+    # source the tenant credentials using Apex installer of OPNFV
+    # you need to copy the file /home/stack/overcloudrc from the installer VM called "instack"
+    # to a location in controller node, for example, in the directory /opt
+    source /opt/overcloudrc
+
+**Compass** installer:
 
 .. code-block:: bash
 
-    # source the tenant credentials in OPNFV
+    # source the tenant credentials using Compass installer of OPNFV
     source /opt/admin-openrc.sh
 
-Please **NOTE** that the method of sourcing tenant credentials may vary depending on installers. For example,
-in ``devstack``, the following command should be used:
+**Joid** installer:
+
+.. code-block:: bash
+
+    # source the tenant credentials using Joid installer of OPNFV
+    source $HOME/joid_config/admin-openrc
+
+**devstack**:
 
 .. code-block:: bash
 
@@ -294,10 +322,10 @@ of OPNFV Brahmaputra Release:
 .. code-block:: bash
 
     # HA deployment in OpenStack with Open Daylight L2-only environment
-    sudo deploy.sh -s os-odl_l2-nofeature-ha
+    sudo ./deploy.sh -s os-odl_l2-nofeature-ha
 
     # Non-HA deployment in OpenStack with Open Daylight L2-only environment
-    sudo deploy.sh -s os-odl_l2-nofeature-noha
+    sudo ./deploy.sh -s os-odl_l2-nofeature-noha
 
 Please **NOTE** that currently only ``Apex`` and ``Fuel`` installer support this environment.
 
@@ -315,16 +343,33 @@ Source the Credentials in OpenStack Controller Node
 **SETUP-SVM-1**: Login in OpenStack Controller Node. Start a new terminal,
 and change directory to where OpenStack is installed.
 
-**SETUP-SVM-2**: We have to source the tenant credentials in this step.
-The following command should be executed:
+**SETUP-SVM-2**: We have to source the tenant credentials in this step. Please **NOTE**
+that the method of sourcing tenant credentials may vary depending on installers. For example:
+
+**Apex** installer:
 
 .. code-block:: bash
 
-    # source the tenant credentials in OPNFV
+    # source the tenant credentials using Apex installer of OPNFV
+    # you need to copy the file /home/stack/overcloudrc from the installer VM called "instack"
+    # to a location in controller node, for example, in the directory /opt
+    source /opt/overcloudrc
+
+**Compass** installer:
+
+.. code-block:: bash
+
+    # source the tenant credentials using Compass installer of OPNFV
     source /opt/admin-openrc.sh
 
-Please **NOTE** that the method of sourcing tenant credentials may vary depending on installers. For example,
-in ``devstack``, the following command should be used:
+**Joid** installer:
+
+.. code-block:: bash
+
+    # source the tenant credentials using Joid installer of OPNFV
+    source $HOME/joid_config/admin-openrc
+
+**devstack**:
 
 .. code-block:: bash
 
@@ -639,4 +684,3 @@ to reach external ``ipv6-router``.
 
     exit
 
-

diff --git a/docs/reldoc/index.rst b/docs/reldoc/index.rst
index f9c7a46..1e4f9af 100644 (file)
--- a/docs/reldoc/index.rst
+++ b/docs/reldoc/index.rst
@@ -52,12 +52,22 @@ Install OPNFV and Preparation
 .. code-block:: bash
 
     # HA deployment in OpenStack-only environment
-    sudo deploy.sh -s os-nofeature-ha
+    sudo ./deploy.sh -s os-nofeature-ha
 
     # Non-HA deployment in OpenStack-only environment
-    sudo deploy.sh -s os-nofeature-noha
+    sudo ./deploy.sh -s os-nofeature-noha
 
-Please **NOTE** that currently only ``Fuel`` installer supports this environment.
+**Joid** Installer:
+
+.. code-block:: bash
+
+    # HA deployment in OpenStack-only environment
+    sudo ./deploy.sh -o liberty -s nosdn -t ha
+
+    # 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.
 
 **OPNFV-NATIVE-INSTALL-2**: Clone the following GitHub repository to get the
 configuration and metadata files
@@ -100,15 +110,33 @@ Set Up Service VM as IPv6 vRouter
 ---------------------------------
 
 **OPNFV-NATIVE-SETUP-1**: Now we assume that OpenStack multi-node setup is up and running.
-We have to source the tenant credentials in this step. The following command should be executed:
+We have to source the tenant credentials in this step. Please **NOTE** that the method of sourcing tenant
+credentials may vary depending on installers. For example:
+
+**Apex** installer:
+
+.. code-block:: bash
+
+    # source the tenant credentials using Apex installer of OPNFV
+    # you need to copy the file /home/stack/overcloudrc from the installer VM called "instack"
+    # to a location in controller node, for example, in the directory /opt
+    source /opt/overcloudrc
+
+**Compass** installer:
 
 .. code-block:: bash
 
-    # source the tenant credentials in OPNFV
+    # source the tenant credentials using Compass installer of OPNFV
     source /opt/admin-openrc.sh
 
-Please **NOTE** that the method of sourcing tenant credentials may vary depending on installers. For example,
-in ``devstack``, the following command should be used:
+**Joid** installer:
+
+.. code-block:: bash
+
+    # source the tenant credentials using Joid installer of OPNFV
+    source $HOME/joid_config/admin-openrc
+
+**devstack**:
 
 .. code-block:: bash
 
@@ -294,10 +322,10 @@ of OPNFV Brahmaputra Release:
 .. code-block:: bash
 
     # HA deployment in OpenStack with Open Daylight L2-only environment
-    sudo deploy.sh -s os-odl_l2-nofeature-ha
+    sudo ./deploy.sh -s os-odl_l2-nofeature-ha
 
     # Non-HA deployment in OpenStack with Open Daylight L2-only environment
-    sudo deploy.sh -s os-odl_l2-nofeature-noha
+    sudo ./deploy.sh -s os-odl_l2-nofeature-noha
 
 Please **NOTE** that currently only ``Apex`` and ``Fuel`` installer support this environment.
 
@@ -315,16 +343,33 @@ Source the Credentials in OpenStack Controller Node
 **SETUP-SVM-1**: Login in OpenStack Controller Node. Start a new terminal,
 and change directory to where OpenStack is installed.
 
-**SETUP-SVM-2**: We have to source the tenant credentials in this step.
-The following command should be executed:
+**SETUP-SVM-2**: We have to source the tenant credentials in this step. Please **NOTE**
+that the method of sourcing tenant credentials may vary depending on installers. For example:
+
+**Apex** installer:
+
+.. code-block:: bash
+
+    # source the tenant credentials using Apex installer of OPNFV
+    # you need to copy the file /home/stack/overcloudrc from the installer VM called "instack"
+    # to a location in controller node, for example, in the directory /opt
+    source /opt/overcloudrc
+
+**Compass** installer:
 
 .. code-block:: bash
 
-    # source the tenant credentials in OPNFV
+    # source the tenant credentials using Compass installer of OPNFV
     source /opt/admin-openrc.sh
 
-Please **NOTE** that the method of sourcing tenant credentials may vary depending on installers. For example,
-in ``devstack``, the following command should be used:
+**Joid** installer:
+
+.. code-block:: bash
+
+    # source the tenant credentials using Joid installer of OPNFV
+    source $HOME/joid_config/admin-openrc
+
+**devstack**:
 
 .. code-block:: bash
 

diff --git a/docs/setupservicevm/4-ipv6-configguide-servicevm.rst b/docs/setupservicevm/4-ipv6-configguide-servicevm.rst
index 0868178..bf851ca 100644 (file)
--- a/docs/setupservicevm/4-ipv6-configguide-servicevm.rst
+++ b/docs/setupservicevm/4-ipv6-configguide-servicevm.rst
@@ -28,6 +28,7 @@ Start a new terminal, and change directory to where OpenStack is installed.
 
 .. code-block:: bash
 
+    # source the tenant credentials in devstack
     opnfv@opnfv-os-controller:~/devstack$ source openrc admin demo
 
 Please **NOTE** that the method of sourcing tenant credentials may vary depending on installers.

diff --git a/docs/setupservicevm/5-ipv6-configguide-scenario-1-native-os.rst b/docs/setupservicevm/5-ipv6-configguide-scenario-1-native-os.rst
index a5f8fdc..afc064c 100644 (file)
--- a/docs/setupservicevm/5-ipv6-configguide-scenario-1-native-os.rst
+++ b/docs/setupservicevm/5-ipv6-configguide-scenario-1-native-os.rst
@@ -178,14 +178,7 @@ in ``devstack``:
     cd ~/devstack
     source openrc admin demo
 
-Please **NOTE** that the method of sourcing tenant credentials may vary depending on installers. For example,
-the following command may be used for some other installers:
-
-.. code-block:: bash
-
-    # source the tenant credentials in some other installers
-    source /opt/admin-openrc.sh
-
+Please **NOTE** that the method of sourcing tenant credentials may vary depending on installers.
 **Please refer to relevant documentation of installers if you encounter any issue**.
 
 **OS-NATIVE-SETUP-2**: Download ``fedora22`` image which would be used for ``vRouter``

diff --git a/docs/setupservicevm/scenario-3-4-ipv6-configguide-servicevm.rst b/docs/setupservicevm/scenario-3-4-ipv6-configguide-servicevm.rst
index 5be5228..371a018 100644 (file)
--- a/docs/setupservicevm/scenario-3-4-ipv6-configguide-servicevm.rst
+++ b/docs/setupservicevm/scenario-3-4-ipv6-configguide-servicevm.rst
@@ -19,6 +19,8 @@ commands should be executed:
 .. code-block:: bash
 
     cd ~/devstack
+
+    # source the tenant credentials in devstack
     source openrc admin demo
 
 Please **NOTE** that the method of sourcing tenant credentials may vary depending on installers.