JIRA:IPVSIX-29

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

2 files changed, 84 insertions, 0 deletions

diff --git a/docs/configguide/featureconfig.rst b/docs/configguide/featureconfig.rst
index 7a16150..073d05f 100644
--- a/docs/configguide/featureconfig.rst
+++ b/docs/configguide/featureconfig.rst
@@ -189,9 +189,25 @@ which need to provide external connectivity.
 **OPNFV-NATIVE-SETUP-6**: Create an external network/subnet ``ext-net`` using
 the appropriate values based on the data-center physical network setup.
 
+Please **NOTE** that you may only need to create the subnet of ``ext-net`` because OPNFV installers
+should have created an external network during installation. You must use the same name of external
+network that installer creates when you create the subnet. For example:
+
+* **Apex** installer: ``external``
+* **Compass** installer: ``ext-net``
+* **Fuel** installer: ``net04_ext``
+* **Joid** installer: ``ext-net``
+
+**Please refer to the documentation of installers if there is any issue**
+
 .. code-block:: bash
 
+    # This is needed only if installer does not create an external work
+    # Otherwise, skip this command "net-create"
     neutron net-create --router:external ext-net
+
+    # Note that the name "ext-net" may work for some installers such as Compass and Joid
+    # Change the name "ext-net" to match the name of external network that an installer creates
     neutron subnet-create --disable-dhcp --allocation-pool start=198.59.156.251,end=198.59.156.254 --gateway 198.59.156.1 ext-net 198.59.156.0/24
 
 **OPNFV-NATIVE-SETUP-7**: Create Neutron networks ``ipv4-int-network1`` and
@@ -215,6 +231,8 @@ and ``ipv6-router``.
 
 .. code-block:: bash
 
+    # Note that the name "ext-net" may work for some installers such as Compass and Joid
+    # Change the name "ext-net" to match the name of external network that an installer creates
     neutron router-gateway-set ipv4-router ext-net
     neutron router-gateway-set ipv6-router ext-net
 
@@ -283,6 +301,8 @@ would be as shown as follows:
 .. code-block:: bash
 
     # 1. Create a floatingip and associate it with VM1, VM2 and vRouter (to the port id that is passed).
+    #    Note that the name "ext-net" may work for some installers such as Compass and Joid
+    #    Change the name "ext-net" to match the name of external network that an installer creates
     neutron floatingip-create --port-id $(neutron port-list | grep -w eth0-VM1 | \
     awk '{print $2}') ext-net
     neutron floatingip-create --port-id $(neutron port-list | grep -w eth0-VM2 | \
@@ -475,9 +495,25 @@ Create IPv4 Subnet and Router with External Connectivity
 **SETUP-SVM-6**: Create an external network/subnet ``ext-net`` using the appropriate values based on the
 data-center physical network setup.
 
+Please **NOTE** that you may only need to create the subnet of ``ext-net`` because OPNFV installers
+should have created an external network during installation. You must use the same name of external
+network that installer creates when you create the subnet. For example:
+
+* **Apex** installer: ``external``
+* **Compass** installer: ``ext-net``
+* **Fuel** installer: ``net04_ext``
+* **Joid** installer: ``ext-net``
+
+**Please refer to the documentation of installers if there is any issue**
+
 .. code-block:: bash
 
+    # This is needed only if installer does not create an external work
+    # Otherwise, skip this command "net-create"
     neutron net-create --router:external ext-net
+
+    # Note that the name "ext-net" may work for some installers such as Compass and Joid
+    # Change the name "ext-net" to match the name of external network that an installer creates
     neutron subnet-create --disable-dhcp --allocation-pool start=198.59.156.251,end=198.59.156.254 --gateway 198.59.156.1 ext-net 198.59.156.0/24
 
 Please note that the IP addresses in the command above are for exemplary purpose. **Please replace the IP addresses of
@@ -487,6 +523,8 @@ your actual network**.
 
 .. code-block:: bash
 
+    # Note that the name "ext-net" may work for some installers such as Compass and Joid
+    # Change the name "ext-net" to match the name of external network that an installer creates
     neutron router-gateway-set ipv4-router ext-net
 
 **SETUP-SVM-8**: Create an internal/tenant IPv4 network ``ipv4-int-network1``
@@ -524,6 +562,8 @@ IPv6 router.
 
 .. code-block:: bash
 
+    # Note that the name "ext-net" may work for some installers such as Compass and Joid
+    # Change the name "ext-net" to match the name of external network that an installer creates
     neutron router-gateway-set ipv6-router ext-net
 
 **SETUP-SVM-13**: Create a second internal/tenant IPv4 network ``ipv4-int-network2``
@@ -733,6 +773,8 @@ We use ``floatingip`` mechanism to achieve ``SSH``.
 .. code-block:: bash
 
     # 1. Create a floatingip and associate it with VM1, VM2 and vRouter (to the port id that is passed).
+    #    Note that the name "ext-net" may work for some installers such as Compass and Joid
+    #    Change the name "ext-net" to match the name of external network that an installer creates
     neutron floatingip-create --port-id $(neutron port-list | grep -w eth0-VM1 | \
     awk '{print $2}') ext-net
     neutron floatingip-create --port-id $(neutron port-list | grep -w eth0-VM2 | \
diff --git a/docs/reldoc/index.rst b/docs/reldoc/index.rst
index ec74509..df5a5ed 100644
--- a/docs/reldoc/index.rst
+++ b/docs/reldoc/index.rst
@@ -189,9 +189,25 @@ which need to provide external connectivity.
 **OPNFV-NATIVE-SETUP-6**: Create an external network/subnet ``ext-net`` using
 the appropriate values based on the data-center physical network setup.
 
+Please **NOTE** that you may only need to create the subnet of ``ext-net`` because OPNFV installers
+should have created an external network during installation. You must use the same name of external
+network that installer creates when you create the subnet. For example:
+
+* **Apex** installer: ``external``
+* **Compass** installer: ``ext-net``
+* **Fuel** installer: ``net04_ext``
+* **Joid** installer: ``ext-net``
+
+**Please refer to the documentation of installers if there is any issue**
+
 .. code-block:: bash
 
+    # This is needed only if installer does not create an external work
+    # Otherwise, skip this command "net-create"
     neutron net-create --router:external ext-net
+
+    # Note that the name "ext-net" may work for some installers such as Compass and Joid
+    # Change the name "ext-net" to match the name of external network that an installer creates
     neutron subnet-create --disable-dhcp --allocation-pool start=198.59.156.251,end=198.59.156.254 --gateway 198.59.156.1 ext-net 198.59.156.0/24
 
 **OPNFV-NATIVE-SETUP-7**: Create Neutron networks ``ipv4-int-network1`` and
@@ -215,6 +231,8 @@ and ``ipv6-router``.
 
 .. code-block:: bash
 
+    # Note that the name "ext-net" may work for some installers such as Compass and Joid
+    # Change the name "ext-net" to match the name of external network that an installer creates
     neutron router-gateway-set ipv4-router ext-net
     neutron router-gateway-set ipv6-router ext-net
 
@@ -283,6 +301,8 @@ would be as shown as follows:
 .. code-block:: bash
 
     # 1. Create a floatingip and associate it with VM1, VM2 and vRouter (to the port id that is passed).
+    #    Note that the name "ext-net" may work for some installers such as Compass and Joid
+    #    Change the name "ext-net" to match the name of external network that an installer creates
     neutron floatingip-create --port-id $(neutron port-list | grep -w eth0-VM1 | \
     awk '{print $2}') ext-net
     neutron floatingip-create --port-id $(neutron port-list | grep -w eth0-VM2 | \
@@ -475,9 +495,25 @@ Create IPv4 Subnet and Router with External Connectivity
 **SETUP-SVM-6**: Create an external network/subnet ``ext-net`` using the appropriate values based on the
 data-center physical network setup.
 
+Please **NOTE** that you may only need to create the subnet of ``ext-net`` because OPNFV installers
+should have created an external network during installation. You must use the same name of external
+network that installer creates when you create the subnet. For example:
+
+* **Apex** installer: ``external``
+* **Compass** installer: ``ext-net``
+* **Fuel** installer: ``net04_ext``
+* **Joid** installer: ``ext-net``
+
+**Please refer to the documentation of installers if there is any issue**
+
 .. code-block:: bash
 
+    # This is needed only if installer does not create an external work
+    # Otherwise, skip this command "net-create"
     neutron net-create --router:external ext-net
+
+    # Note that the name "ext-net" may work for some installers such as Compass and Joid
+    # Change the name "ext-net" to match the name of external network that an installer creates
     neutron subnet-create --disable-dhcp --allocation-pool start=198.59.156.251,end=198.59.156.254 --gateway 198.59.156.1 ext-net 198.59.156.0/24
 
 Please note that the IP addresses in the command above are for exemplary purpose. **Please replace the IP addresses of
@@ -487,6 +523,8 @@ your actual network**.
 
 .. code-block:: bash
 
+    # Note that the name "ext-net" may work for some installers such as Compass and Joid
+    # Change the name "ext-net" to match the name of external network that an installer creates
     neutron router-gateway-set ipv4-router ext-net
 
 **SETUP-SVM-8**: Create an internal/tenant IPv4 network ``ipv4-int-network1``
@@ -524,6 +562,8 @@ IPv6 router.
 
 .. code-block:: bash
 
+    # Note that the name "ext-net" may work for some installers such as Compass and Joid
+    # Change the name "ext-net" to match the name of external network that an installer creates
     neutron router-gateway-set ipv6-router ext-net
 
 **SETUP-SVM-13**: Create a second internal/tenant IPv4 network ``ipv4-int-network2``
@@ -733,6 +773,8 @@ We use ``floatingip`` mechanism to achieve ``SSH``.
 .. code-block:: bash
 
     # 1. Create a floatingip and associate it with VM1, VM2 and vRouter (to the port id that is passed).
+    #    Note that the name "ext-net" may work for some installers such as Compass and Joid
+    #    Change the name "ext-net" to match the name of external network that an installer creates
     neutron floatingip-create --port-id $(neutron port-list | grep -w eth0-VM1 | \
     awk '{print $2}') ext-net
     neutron floatingip-create --port-id $(neutron port-list | grep -w eth0-VM2 | \