JIRA: IPVSIX-29

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

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 5567a01..266acb1 100644 (file)
--- a/docs/setupservicevm/5-ipv6-configguide-scenario-1-native-os.rst
+++ b/docs/setupservicevm/5-ipv6-configguide-scenario-1-native-os.rst
@@ -237,7 +237,8 @@ We are adding some static routes to the ``ipv6-router``. For whatever reason, if
 or dissociate the ``ipv6-router`` from ``ipv6-int-subnet2``, ``Neutron`` will not allow this operation because
 the static route requires the ``ipv6-int-subnet2`` subnet.
 
-In order to work around this issue, and to clear the static routes associated to the ``ipv6-router``, you may execute the following:
+In order to work around this issue, and to clear the static routes associated to the ``ipv6-router``,
+you may execute the following:
 
 .. code-block:: bash
 

diff --git a/docs/setupservicevm/index.rst b/docs/setupservicevm/index.rst
index 1983adc..d116c5f 100644 (file)
--- a/docs/setupservicevm/index.rst
+++ b/docs/setupservicevm/index.rst
@@ -7,14 +7,19 @@ Setting Up a Service VM as an IPv6 vRouter
 :Authors: Bin Hu (AT&T), Sridhar Gaddam (RedHat)
 
 :Abstract: This document provides the users with installation guidelines to create a Service VM as
-           an IPv6 vRouter in OPNFV environment, i.e. integrated OpenStack with Open Daylight environment.
-           The complete set of instructions walk you through every step of preparing the infrastructure,
-           setting up Open Daylight and OpenStack, creating service VM and IPv6 subnet, and testing and
-           validating the setup.
+           an IPv6 vRouter in OPNFV environment, i.e. integrated OpenStack with Open Daylight
+           environment. There are three scenarios. Scenario 1 is pre-OPNFV environment, i.e. a native
+           OpenStack environment without Open Daylight Controller. Scenario 2 is an OPNFV environment
+           where OpenStack is integrated with Open Daylight Official Lithium Release which not only
+           does not support IPv6 L3 Routing but also has a bug in net-virt provider implementation
+           that throws Java exception. Scenario 3 is similar to Scenario 2. However, Open Daylight
+           Lithium is patched with a fix of Java exception. The complete set of instructions walk
+           you through every step of preparing the infrastructure, setting up Open Daylight and
+           OpenStack, creating service VM and IPv6 subnet, and testing and validating the setup.
 
 .. toctree::
    :numbered:
    :maxdepth: 4
 
    5-ipv6-configguide-scenario-1-native-os.rst
-   scenario-3.rst
+   scenario-2.rst

diff --git a/docs/setupservicevm/scenario-2.rst b/docs/setupservicevm/scenario-2.rst
new file mode 100644 (file)
index 0000000..ff30973
--- /dev/null
+++ b/docs/setupservicevm/scenario-2.rst
@@ -0,0 +1,18 @@
+===============================================================
+Scenario 2 - OpenStack + Open Daylight Lithium Official Release
+===============================================================
+
+Scenario 2 is the environment of OpenStack + Open Daylight Lithium Official Release. Because Lithium Official
+Release does not support IPv6 L3 Routing, we need to enable Neutron L3 Agent instead of Open Daylight L3
+function, while we still use Open Daylight for L2 switching. Because there is a bug in net-virt provider
+implementation, we need to use manual configuration to work around this bug / Java exception.
+
+.. toctree::
+   :numbered:
+   :maxdepth: 4
+
+   0-ipv6-configguide-prep-infra.rst
+   1-ipv6-configguide-odl-setup.rst
+   2-ipv6-configguide-os-controller.rst
+   3-ipv6-configguide-os-compute.rst
+   4-ipv6-configguide-servicevm.rst