JIRA:IPVSIX-29

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

10 files changed, 67 insertions, 32 deletions

diff --git a/docs/setupservicevm/0-ipv6-configguide-prep-infra.rst b/docs/setupservicevm/0-ipv6-configguide-prep-infra.rst
index 9703991..997e12e 100644
--- a/docs/setupservicevm/0-ipv6-configguide-prep-infra.rst
+++ b/docs/setupservicevm/0-ipv6-configguide-prep-infra.rst
@@ -2,11 +2,17 @@
 Infrastructure Setup
 ====================
 
-In order to set up the service VM as an IPv6 vRouter, we need to
-prepare 3 hosts, each of which has minimum 8GB RAM and 40GB storage. One host is used as OpenStack Controller
+In order to set up the service VM as an IPv6 vRouter, we need to prepare 3 hosts,
+each of which has minimum 8GB RAM and 40GB storage. One host is used as OpenStack Controller
 Node. The second host is used as Open Daylight Controller Node. And the third one is used as
 OpenStack Compute Node.
 
+Please **NOTE** that in case of HA (High Availability) deployment model where multiple controller
+nodes are used, the setup procedure is the same. When ``ipv6-router`` is created in step **SETUP-SVM-11**,
+it could be created in any of the controller node. Thus you need to identify in which controller node
+``ipv6-router`` is created in order to manually spawn ``radvd`` daemon inside the ``ipv6-router`` namespace
+in steps **SETUP-SVM-24** through **SETUP-SVM-30**.
+
 For exemplary purpose, we assume:
 
 * The hostname of OpenStack Controller+Network+Compute Node is ``opnfv-os-controller``, and the host IP address
diff --git a/docs/setupservicevm/4-ipv6-configguide-servicevm.rst b/docs/setupservicevm/4-ipv6-configguide-servicevm.rst
index fb9f450..8212c1e 100644
--- a/docs/setupservicevm/4-ipv6-configguide-servicevm.rst
+++ b/docs/setupservicevm/4-ipv6-configguide-servicevm.rst
@@ -266,6 +266,12 @@ Spawn ``RADVD`` in ``ipv6-router``
 Let us manually spawn a ``radvd`` daemon inside ``ipv6-router`` namespace to simulate an external router.
 First of all, we will have to identify the ``ipv6-router`` namespace and move to the namespace.
 
+Please **NOTE** that in case of HA (High Availability) deployment model where multiple controller
+nodes are used, ``ipv6-router`` created in step **SETUP-SVM-11** could be in any of the controller
+node. Thus you need to identify in which controller node ``ipv6-router`` is created in order to manually
+spawn ``radvd`` daemon inside the ``ipv6-router`` namespace in steps **SETUP-SVM-24** through
+**SETUP-SVM-30**.
+
 **SETUP-SVM-24**: identify the ``ipv6-router`` namespace and move to the namespace
 
 .. code-block:: bash
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 1a303cc..d222c63 100644
--- a/docs/setupservicevm/5-ipv6-configguide-scenario-1-native-os.rst
+++ b/docs/setupservicevm/5-ipv6-configguide-scenario-1-native-os.rst
@@ -22,11 +22,15 @@ For exemplary purpose, we assume:
 
    Underlay Network Topology - Scenario 1
 
-**Please note that the IP address shown in** :numref:`s1-figure1`
-**are for exemplary purpose. You need to configure your public IP
-address connecting to Internet according to your actual network
-infrastructure. And you need to make sure the private IP address are
-not conflicting with other subnets**.
+**Please note that:**
+
+* **the IP address shown in** :numref:`s1-figure1` **are for exemplary purpose.
+  You need to configure your public IP address connecting to Internet according
+  to your actual network infrastructure. And you need to make sure the private IP address are
+  not conflicting with other subnets**.
+* **Although the deployment model of single controller node is assumed, in case of HA (High Availability)
+  deployment model where multiple controller nodes are used, there is no impact and the setup procedure
+  is the same.**
 
 ************
 Prerequisite
diff --git a/docs/setupservicevm/architecture-design.rst b/docs/setupservicevm/architecture-design.rst
index 61b9ad5..e2546ca 100644
--- a/docs/setupservicevm/architecture-design.rst
+++ b/docs/setupservicevm/architecture-design.rst
@@ -11,3 +11,6 @@ shown as follows in :numref:`arch-figure1`:
 
    Architectural Design of Using a VM as an IPv6 vRouter
 
+This design applies to deployment model of single controller node as well as HA (High Availability)
+deployment model of multiple controller nodes.
+
diff --git a/docs/setupservicevm/images/ipv6-topology-scenario-3.png b/docs/setupservicevm/images/ipv6-topology-scenario-3.png
new file mode 100644
index 0000000..5cc16bd
--- /dev/null
+++ b/docs/setupservicevm/images/ipv6-topology-scenario-3.png
diff --git a/docs/setupservicevm/index.rst b/docs/setupservicevm/index.rst
index 292cffe..f498138 100644
--- a/docs/setupservicevm/index.rst
+++ b/docs/setupservicevm/index.rst
@@ -23,6 +23,16 @@ environment. There are three scenarios.
   controller which is built from the latest stable/Lithium branch which includes the fix.
   In this scenario, we can fully automate the setup similar to Scenario 1.
 
+Please **NOTE** that the instructions in this document assume the deployment model of single
+controller node. In case of HA (High Availability) deployment model where multiple controller
+nodes are used, the setup procedure is the same. In particular:
+
+* There is **No Impact** on Scenario 1 and Scenario 3.
+* For Scenario 2, when ``ipv6-router`` is created in step **SETUP-SVM-11**, it could be
+  created in any of the controller node. Thus you need to identify in which controller node
+  ``ipv6-router`` is created in order to manually spawn ``radvd`` daemon inside the
+  ``ipv6-router`` namespace in steps **SETUP-SVM-24** through **SETUP-SVM-30**.
+
 .. toctree::
    :numbered:
    :maxdepth: 4
diff --git a/docs/setupservicevm/scenario-3-0-ipv6-configguide-prep-infra.rst b/docs/setupservicevm/scenario-3-0-ipv6-configguide-prep-infra.rst
index 9703991..a407c27 100644
--- a/docs/setupservicevm/scenario-3-0-ipv6-configguide-prep-infra.rst
+++ b/docs/setupservicevm/scenario-3-0-ipv6-configguide-prep-infra.rst
@@ -2,11 +2,15 @@
 Infrastructure Setup
 ====================
 
-In order to set up the service VM as an IPv6 vRouter, we need to
-prepare 3 hosts, each of which has minimum 8GB RAM and 40GB storage. One host is used as OpenStack Controller
+In order to set up the service VM as an IPv6 vRouter, we need to prepare 3 hosts,
+each of which has minimum 8GB RAM and 40GB storage. One host is used as OpenStack Controller
 Node. The second host is used as Open Daylight Controller Node. And the third one is used as
 OpenStack Compute Node.
 
+** Please NOTE that Although the deployment model of single controller node is assumed, in case of HA
+(High Availability) deployment model where multiple controller nodes are used, there is no impact and the
+setup procedure is the same.**
+
 For exemplary purpose, we assume:
 
 * The hostname of OpenStack Controller+Network+Compute Node is ``opnfv-os-controller``, and the host IP address
@@ -17,15 +21,15 @@ For exemplary purpose, we assume:
 * We use ``opnfv`` as username to login.
 * We use ``devstack`` to install OpenStack Kilo. Please note that OpenStack Liberty can be used as well.
 
-The underlay network topology of those 3 hosts are shown as follows in :numref:`s2-figure1`:
+The underlay network topology of those 3 hosts are shown as follows in :numref:`s3-figure1`:
 
-.. figure:: images/ipv6-topology-scenario-2.png
-   :name: s2-figure1
+.. figure:: images/ipv6-topology-scenario-3.png
+   :name: s3-figure1
    :width: 100%
 
-   Underlay Network Topology - Scenario 2
+   Underlay Network Topology - Scenario 3
 
-**Please note that the IP address shown in** :numref:`s2-figure1`
+**Please note that the IP address shown in** :numref:`s3-figure1`
 **are for exemplary purpose. You need to configure your public IP
 address connecting to Internet according to your actual network
 infrastructure. And you need to make sure the private IP address are
diff --git a/docs/setupservicevm/scenario-3-1-ipv6-configguide-odl-setup.rst b/docs/setupservicevm/scenario-3-1-ipv6-configguide-odl-setup.rst
index 89152d5..3a068e0 100644
--- a/docs/setupservicevm/scenario-3-1-ipv6-configguide-odl-setup.rst
+++ b/docs/setupservicevm/scenario-3-1-ipv6-configguide-odl-setup.rst
@@ -10,26 +10,22 @@ For exemplary purpose, we assume:
 * We use ``opnfv`` as username to login.
 * Java 7 is installed in directory ``/usr/lib/jvm/java-1.7.0-openjdk-1.7.0.85-2.6.1.2.el7_1.x86_64/``
 
-**ODL-1**: Login to Open Daylight Controller Node with username ``opnfv``.
+Please **NOTE** that this Scenario 3 uses an Open Daylight Lithium controller which is built
+from the latest ``stable/Lithium`` branch that includes the fix of a bug, there is a **prerequisite**
+that you are able to build this Open Daylight Lithium Controller from the  the latest ``stable/Lithium``
+branch. Please refer to relevant documentation from Open Daylight.
 
-**ODL-2**: Download the ODL Lithium distribution from
-``http://www.opendaylight.org/software/downloads``
+**ODL-1**: **Prerequisite** - build Open Daylight Lithium Controller from the the latest
+``stable/Lithium`` branch, and make it available for step **ODL-3**.
 
-.. code-block:: bash
-
-    wget https://nexus.opendaylight.org/content/groups/public/org/opendaylight/integration/distribution-karaf/0.3.3-Lithium-SR3/distribution-karaf-0.3.3-Lithium-SR3.tar.gz
+**ODL-2**: Login to Open Daylight Controller Node with username ``opnfv``.
 
-**Note**: This **ODL-2** is a placeholder, and to be replaced with actual URL of a build from the latest
-``stable/Lithium`` branch which includes the fix.
-
-**ODL-3**: Extract the tar file
+**ODL-3**: Extract the tar file of your custom build of Open Daylight Lithium Controller
+from step **ODL-1**.
 
 .. code-block:: bash
 
-    tar -zxvf distribution-karaf-0.3.3-Lithium-SR3.tar.gz
-
-**Note**: This **ODL-3** is a placeholder, and to be replaced with actual tarball of a build from the latest
-``stable/Lithium`` branch which includes the fix.
+    tar -zxvf <filename-of-your-custom-build>.tar.gz
 
 **ODL-4**: Install Java7
 
diff --git a/docs/setupservicevm/scenario-3-2-ipv6-configguide-os-controller.rst b/docs/setupservicevm/scenario-3-2-ipv6-configguide-os-controller.rst
index 050be79..60af9f4 100644
--- a/docs/setupservicevm/scenario-3-2-ipv6-configguide-os-controller.rst
+++ b/docs/setupservicevm/scenario-3-2-ipv6-configguide-os-controller.rst
@@ -56,8 +56,12 @@ For **Fedora**:
 
     cp /opt/stack/opnfv_os_ipv6_poc/scenario2/local.conf.odl.controller ~/devstack/local.conf
 
-Please **note** that you need to change the IP address of ``ODL_MGR_IP`` to point to your actual IP address
-of Open Daylight Controller.
+Please **note** that:
+
+* Note 1: Because Scenario 3 and Scenario 2 are essentially the same, and their only difference
+  is using different build of Open Daylight, they share the same ``local.conf``` file of OpenStack.
+* Note 2: You need to change the IP address of ``ODL_MGR_IP`` to point to your actual IP address
+  of Open Daylight Controller.
 
 **OS-N-6**: Initiate Openstack setup by invoking ``stack.sh``
 
diff --git a/docs/setupservicevm/scenario-3-3-ipv6-configguide-os-compute.rst b/docs/setupservicevm/scenario-3-3-ipv6-configguide-os-compute.rst
index a27ae4c..88a66cd 100644
--- a/docs/setupservicevm/scenario-3-3-ipv6-configguide-os-compute.rst
+++ b/docs/setupservicevm/scenario-3-3-ipv6-configguide-os-compute.rst
@@ -58,9 +58,11 @@ For **Fedora**:
 
 Please Note:
 
-* Note 1: you need to change the IP address of ``SERVICE_HOST`` to point to your actual IP address
+* Note 1: Because Scenario 3 and Scenario 2 are essentially the same, and their only difference
+  is using different build of Open Daylight, they share the same ``local.conf``` file of OpenStack.
+* Note 2: you need to change the IP address of ``SERVICE_HOST`` to point to your actual IP address
   of OpenStack Controller.
-* Note 2: you need to change the IP address of ``ODL_MGR_IP`` to point to your actual IP address
+* Note 3: you need to change the IP address of ``ODL_MGR_IP`` to point to your actual IP address
   of Open Daylight Controller.
 
 **OS-M-6**: Initiate Openstack setup by invoking ``stack.sh``