JIRA: IPVSIX-29

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

2 files changed, 164 insertions, 17 deletions

diff --git a/docs/how-to-use-docs/documentation-example.rst b/docs/how-to-use-docs/documentation-example.rst
index 5f75db5..3c57738 100644
--- a/docs/how-to-use-docs/documentation-example.rst
+++ b/docs/how-to-use-docs/documentation-example.rst
@@ -5,9 +5,8 @@
   :alt: OPNFV
   :align: left
 .. these two pipes are to seperate the logo from the first title
-|
-
-|
+  |
+  |
 
 How to create documentation for your OPNFV project
 ==================================================
diff --git a/docs/setupservicevm/ipv6-configguide.rst b/docs/setupservicevm/ipv6-configguide.rst
index 3add5c6..0d32a03 100644
--- a/docs/setupservicevm/ipv6-configguide.rst
+++ b/docs/setupservicevm/ipv6-configguide.rst
@@ -2,28 +2,30 @@
 Setting Up a Service VM as an IPv6 vRouter
 ==========================================
 
-After OPNFV Brahmaputra Release base platform has been successfully installed through previous chapters, there are 10
+After OPNFV Brahmaputra Release base platform has been successfully installed through previous chapters, there are 11
 steps to set up a service VM as an IPv6 vRouter:
 
 - Step 0: `Disable odl-l3 and Enable neutron-l3-agent`_
 
 - Step 1: `Start Open Daylight`_
 
-- Step 2: `Start Open Stack`_
+- Step 2: `Start Open Stack on Controller Node`_
 
-- Step 3: `Create External Network Connectivity ext-net`_
+- Step 3: `Start Open Stack on Compute Node`_
 
-- Step 4: `Create IPv4 Subnet and Router with External Connectivity`_
+- Step 4: `Create External Network Connectivity ext-net`_
 
-- Step 5: `Create IPv6 Subnet and Router with External Connectivity`_
+- Step 5: `Create IPv4 Subnet and Router with External Connectivity`_
 
-- Step 6: `Prepare Image, Metadata and Keypair for Service VM`_
+- Step 6: `Create IPv6 Subnet and Router with External Connectivity`_
 
-- Step 7: `Boot Service VM (vRouter) and other VMs in IPv6 Subnet`_
+- Step 7: `Prepare Image, Metadata and Keypair for Service VM`_
 
-- Step 8: `Spawn RADVD in vRouter`_
+- Step 8: `Boot Service VM (vRouter) and other VMs in IPv6 Subnet`_
 
-- Step 9: `Testing to Verify Setup Complete`_
+- Step 9: `Spawn RADVD in vRouter`_
+
+- Step 10: `Testing to Verify Setup Complete`_
 
 Once the setup is complete, you can go to `Next Steps`_.
 
@@ -42,13 +44,159 @@ If you have chosen to enable neutron-l3-agent during installation, please skip t
 _`Start Open Daylight`
 **********************
 
-# Place holder for instructions of how to start Open Daylight
+ODL-1: Login to Open Daylight Controller Node. For the purpose of example, we use ''opnfv'' as username of login, and ''opnfv-odl-controller'' as hostname of the Open Daylight Controller Node.
+
+ODL-2: Start a new terminal session, and change directory to where Open Daylight is installed. Here we use ''odl'' directory name and ''Lithium SR2'' installation as an example.
+
+   cd ~/odl/distribution-karaf-0.3.2-Lithium-SR2/bin
+
+ODL-3: Run the ''karaf'' shell:
+
+   ./karaf
+
+ODL-4: You are now in the Karaf shell of Open Daylight. To explore the list of available features you can execute
+''feature:list''. In order to enable Open Daylight with Open Stack, you have to load the ''odl-ovsdb-openstack''
+feature. 
+
+   opendaylight-user@opnfv>feature:install odl-ovsdb-openstack  
+
+ODL-5: Verify that OVSDB feature is installed successfully.
+
+    opendaylight-user@opnfv>feature:list -i | grep ovsdb
+    odl-ovsdb-openstack | 1.1.1-Lithium-SR1       | x  | ovsdb-1.1.1-Lithium-SR1 | OpenDaylight :: OVSDB :: OpenStack Network Virtual
+    odl-ovsdb-southbound-api  | 1.1.1-Lithium-SR1 | x  | odl-ovsdb-southbound-1.1.1-Lithium-SR1 | OpenDaylight :: southbound :: api                 
+    odl-ovsdb-southbound-impl | 1.1.1-Lithium-SR1 | x  | odl-ovsdb-southbound-1.1.1-Lithium-SR1 | OpenDaylight :: southbound :: impl                
+    odl-ovsdb-southbound-impl-rest|1.1.1-Lithium-SR1 | x | odl-ovsdb-southbound-1.1.1-Lithium-SR1| OpenDaylight :: southbound :: impl :: REST        
+    odl-ovsdb-southbound-impl-ui  | 1.1.1-Lithium-SR1| x | odl-ovsdb-southbound-1.1.1-Lithium-SR1| OpenDaylight :: southbound :: impl :: UI          
+    opendaylight-user@opnfv>
+
+ODL-6: To view the logs, you can use the following commands (or alternately the file data/log/karaf.log).
+
+    opendaylight-user@opnfv>log:display
+    opendaylight-user@opnfv>log:tail
+
+ODL-7: To enable ODL DLUX UI, install the following features. Then you can navigate to http://localhost:8181/index.html
+for DLUX UI. The default user-name and password is admin/admin.
+
+    opendaylight-user@opnfv>feature:install odl-restconf odl-l2switch-switch odl-mdsal-apidocs odl-dlux-core
+
+ODL-8: To exit out of screen session, please use the command ''CTRL+a'' followed by ''d''
+
+''**Note: Do not kill the screen session, it will terminate the ODL controller.**''
+
+At this moment, Open Daylight has been started successfully.
+
+********************************
+_`Start Open Stack on Controller Node`
+********************************
+
+OS-N-1: Login to Open Stack Controller Node. For the purpose of example, we use ''opnfv'' as username of login, and
+''opnfv-os-controller'' as hostname of the Open Stack Controller Node.
+
+OS-N-2: Start a new terminal, and change directory to where Open Stack is installed. Here we use ''devstack'' directory
+name as an example.
+
+   cd ~/devstack
+
+OS-N-3: Create a ''local.conf'' file with the contents from the following URL.
+
+   http://fpaste.org/276949/39476214/
+
+Note 1: You need to change the value of ''BRANCH'', and all appearance of ''stable/kilo'' and related URL to point to
+the actual branch of your upstream repository.
+
+Note 2: you need to change the IP address of ''ODL_MGR_IP'' to point to your actual IP address of Open Daylight Controller.
+
+Note 3: You may have to change the value of ''ODL_PROVIDER_MAPPINGS'' and ''PUBLIC_INTERFACE'' to match your actual
+network interfaces.
+
+OS-N-4: Initiate Openstack setup by invoking ''stack.sh''
+
+   ./stack.sh
+
+OS-N-5: If the setup is successful you would see the following logs on the console. Please note that the IP addresses are
+all for the purpose of example. Your IP addresses will match the ones assigned during the installation of OPNFV B Release
+base platform in prior chapters.
+
+   This is your host ip: 198.59.156.113
+   Horizon is now available at http://198.59.156.113/
+   Keystone is serving at http://198.59.156.113:5000/
+   The default users are: admin and demo 
+   The password: password
+ 
+OS-N-6: Assuming that all goes well, you can set ''OFFLINE=True'' and ''RECLONE=no'' in ''local.conf'' to lock the codebase.
+Devstack uses these configuration parameters to determine if it has to run with the existing codebase or update to the latest copy.
+
+OS-N-7: Source the credentials.
+
+   opnfv@opnfv-os-controller:~/devstack$ source openrc admin demo
+
+OS-N-8: Verify some commands to check if setup is working fine.
+
+    opnfv@opnfv-os-controller:~/devstack$ nova flavor-list
+    +----+-----------+-----------+------+-----------+------+-------+-------------+-----------+
+    | ID | Name      | Memory_MB | Disk | Ephemeral | Swap | VCPUs | RXTX_Factor | Is_Public |
+    +----+-----------+-----------+------+-----------+------+-------+-------------+-----------+
+    | 1  | m1.tiny   | 512       | 1    | 0         |      | 1     | 1.0         | True      |
+    | 2  | m1.small  | 2048      | 20   | 0         |      | 1     | 1.0         | True      |
+    | 3  | m1.medium | 4096      | 40   | 0         |      | 2     | 1.0         | True      |
+    | 4  | m1.large  | 8192      | 80   | 0         |      | 4     | 1.0         | True      |
+    | 5  | m1.xlarge | 16384     | 160  | 0         |      | 8     | 1.0         | True      |
+    +----+-----------+-----------+------+-----------+------+-------+-------------+-----------+
+
+Now you can start the Compute node setup.
+
+*******************************
+_`Start Open Stack on Compute Node`
+*******************************
+
+OS-M-1: Login to Open Stack Compute Node. For the purpose of example, we use ''opnfv'' as username of login, and
+''opnfv-os-compute'' as hostname of the Open Stack Compute Node.
+
+OS-M-2: Start a new terminal, and change directory to where Open Stack is installed. Here we use ''devstack''
+directory name as an example.
+
+   cd ~/devstack
+
+OS-M-3: Create a ''local.conf'' file with the contents from the following URL.
+
+   http://fpaste.org/276958/44395955/
+
+Note 1: You need to change the value of ''BRANCH'', and all appearance of ''stable/kilo'' and related URL to point to
+the actual branch of your upstream repository.
+
+Note 2: you need to change the IP address of ''SERVICE_HOST'' to point to your actual IP address of Open Stack Controller.
+
+Note 3: you need to change the IP address of ''ODL_MGR_IP'' to point to your actual IP address of Open Daylight Controller.
+
+Note 4: You may have to change the value of ''ODL_PROVIDER_MAPPINGS'' and ''PUBLIC_INTERFACE'' to match your actual
+network interface.
+
+OS-M-4: Initiate Openstack setup by invoking ''stack.sh''
+
+   ./stack.sh
+
+OS-M-5: Assuming that all goes well, you can set ''OFFLINE=True'' and ''RECLONE=no'' in ''local.conf'' to lock the codebase.
+Devstack uses these configuration parameters to determine if it has to run with the existing codebase or update to the latest copy.
+
+OS-M-6: Source the credentials.
+
+   opnfv@opnfv-os-compute:~/devstack$ source openrc admin demo
+
+OS-M-7:Verify some commands to check if setup is working fine.
 
-*******************
-_`Start Open Stack`
-*******************
+    opnfv@opnfv-os-compute:~/devstack$ nova flavor-list
+    +----+-----------+-----------+------+-----------+------+-------+-------------+-----------+
+    | ID | Name      | Memory_MB | Disk | Ephemeral | Swap | VCPUs | RXTX_Factor | Is_Public |
+    +----+-----------+-----------+------+-----------+------+-------+-------------+-----------+
+    | 1  | m1.tiny   | 512       | 1    | 0         |      | 1     | 1.0         | True      |
+    | 2  | m1.small  | 2048      | 20   | 0         |      | 1     | 1.0         | True      |
+    | 3  | m1.medium | 4096      | 40   | 0         |      | 2     | 1.0         | True      |
+    | 4  | m1.large  | 8192      | 80   | 0         |      | 4     | 1.0         | True      |
+    | 5  | m1.xlarge | 16384     | 160  | 0         |      | 8     | 1.0         | True      |
+    +----+-----------+-----------+------+-----------+------+-------+-------------+-----------+
 
-# Place holder for instructions of how to start Open Stack
+Now you can start to set up the service VM as an Ipv6 vRouter in the environment of Open Stack and Open Daylight.
 
 ***********************************************
 _`Create External Network Connectivity ext-net`