JIRA: IPVSIX-29

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

2 files changed, 246 insertions, 0 deletions

diff --git a/docs/setupservicevm/5-ipv6-configguide-scenario-1-native-os.rst b/docs/setupservicevm/5-ipv6-configguide-scenario-1-native-os.rst
new file mode 100644
index 0000000..5567a01
--- /dev/null
+++ b/docs/setupservicevm/5-ipv6-configguide-scenario-1-native-os.rst
@@ -0,0 +1,245 @@
+=========================================
+Scenario 1 - Native OpenStack Environment
+=========================================
+
+Scenario 1 is the native OpenStack environment. Because the anti-spoofing rule of Security Group feature in OpenStack
+prevents a VM from forwarding packets, we need to work around Security Group feature in the native OpenStack
+environment.
+
+For exemplary purpose, we assume:
+
+* A two-node setup of OpenStack environment is used
+* The hostname of OpenStack Controller+Network+Compute Node is ``opnfv-os-controller``
+* The hostname of OpenStack Compute Node is ``opnfv-os-compute``
+* Ubuntu 14.04 is installed
+* We use ``opnfv`` as username to login.
+* We use ``devstack`` to install OpenStack Kilo
+
+***********************************
+Verify OpenStack is Setup Correctly
+***********************************
+
+**OS-NATIVE-1**: Show hypervisor list
+
+.. code-block:: bash
+
+    ~/devstack$ nova hypervisor-list
+    +----+------------------------------------+---------+------------+
+    | ID  | Hypervisor hostname      | State  | Status  |
+    +----+------------------------------------+---------+------------+
+    | 1   | opnfv-os-controller      | up     | enabled |
+    | 2   | opnfv-os-compute         | up     | enabled |
+    +----+------------------------------------+---------+------------+
+
+**********************************************
+Disable Security Groups in OpenStack ML2 Setup
+**********************************************
+
+**OS-NATIVE-2**: Change the settings in ``/etc/neutron/plugins/ml2/ml2_conf.ini`` as follows
+
+.. code-block:: bash
+
+    # /etc/neutron/plugins/ml2/ml2_conf.ini
+    [securitygroup]
+    enable_security_group = False
+    firewall_driver = neutron.agent.firewall.NoopFirewallDriver
+
+**OS-NATIVE-3**: Change the settings in ``/etc/nova/nova.conf`` as follows
+
+.. code-block:: bash
+
+    # /etc/nova/nova.conf
+    [DEFAULT]
+    security_group_api = nova
+    firewall_driver = nova.virt.firewall.NoopFirewallDriver
+
+***********************************************************************
+Prepare Fedora22 Image, Configuration and Metadata Files for Service VM
+***********************************************************************
+
+**OS-NATIVE-4**: Clone the following GitHub repository to get the configuration and metadata files
+
+.. code-block:: bash
+
+    git clone https://github.com/sridhargaddam/opnfv_os_ipv6_poc.git /opt/stack/opnfv_os_ipv6_poc
+
+**OS-NATIVE-5**: Download ``fedora22`` image which would be used for ``vRouter``
+
+.. code-block:: bash
+
+    wget https://download.fedoraproject.org/pub/fedora/linux/releases/22/Cloud/x86_64/Images/Fedora-Cloud-Base-22-20150521.x86_64.qcow2
+
+*********************************
+Set Up Service VM as Ipv6 vRouter
+*********************************
+
+**OS-NATIVE-5**: Now we assume that OpenStack multi-node setup is up and running. The following
+commands should be executed:
+
+.. code-block:: bash
+
+    cd ~/devstack
+    source openrc admin demo
+
+**OS-NATIVE-6**: Download ``fedora22`` image which would be used for ``vRouter``
+
+.. code-block:: bash
+
+    wget https://download.fedoraproject.org/pub/fedora/linux/releases/22/Cloud/x86_64/Images/Fedora-Cloud-Base-22-20150521.x86_64.qcow2
+
+**OS-NATIVE-7**: Import Fedora22 image to ``glance``
+
+.. code-block:: bash
+
+    glance image-create --name 'Fedora20' --disk-format qcow2 --container-format bare --file ./Fedora-Cloud-Base-22-20150521.x86_64.qcow2
+
+**OS-NATIVE-8**: Create Neutron routers ``ipv4-router`` and ``ipv6-router`` which need to provide external
+connectivity.
+
+.. code-block:: bash
+
+    neutron router-create ipv4-router
+    neutron router-create ipv6-router
+
+**OS-NATIVE-9**: Create an external network/subnet ``ext-net`` using the appropriate values based on the
+data-center physical network setup.
+
+.. code-block:: bash
+
+    neutron net-create --router:external ext-net
+
+**OS-NATIVE-10**: If your ``opnfv-os-controller`` node has two interfaces ``eth0`` and ``eth1``,
+and ``eth1`` is used for external connectivity, move the IP address of ``eth1`` to ``br-ex``.
+
+Please note that the IP address ``198.59.156.113`` and related subnet and gateway addressed in the command
+below are for exemplary purpose. **Please replace them with the IP addresses of your actual network**.
+
+.. code-block:: bash
+
+    sudo ip addr del 198.59.156.113/24 dev eth1
+    sudo ovs-vsctl add-port br-ex eth1
+    sudo ifconfig eth1 up
+    sudo ip addr add 198.59.156.113/24 dev br-ex
+    sudo ifconfig br-ex up
+    sudo ip route add default via 198.59.156.1 dev br-ex
+    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
+
+**OS-NATIVE-11**: Verify that ``br-ex`` now has the original external IP address, and that the default route is on
+``br-ex``
+
+.. code-block:: bash
+
+    opnfv@opnfv-os-controller:~/devstack$ ip a s br-ex
+    38: br-ex: <BROADCAST,UP,LOWER_UP> mtu 1430 qdisc noqueue state UNKNOWN group default
+        link/ether 00:50:56:82:42:d1 brd ff:ff:ff:ff:ff:ff
+        inet 198.59.156.113/24 brd 198.59.156.255 scope global br-ex
+           valid_lft forever preferred_lft forever
+        inet6 fe80::543e:28ff:fe70:4426/64 scope link
+           valid_lft forever preferred_lft forever
+    opnfv@opnfv-os-controller:~/devstack$
+    opnfv@opnfv-os-controller:~/devstack$ ip route
+    default via 198.59.156.1 dev br-ex
+    10.134.156.0/24 dev eth0  proto kernel  scope link  src 10.134.156.113
+    192.168.122.0/24 dev virbr0  proto kernel  scope link  src 192.168.122.1
+    198.59.156.0/24 dev br-ex  proto kernel  scope link  src 198.59.156.113
+
+**OS-NATIVE-12**: Create Neutron networks ``ipv4-int-network1`` and ``ipv6-int-network2``
+with port_security disabled
+
+.. code-block:: bash
+
+    neutron net-create --port_security_enabled=False ipv4-int-network1
+    neutron net-create --port_security_enabled=False ipv6-int-network2
+
+**OS-NATIVE-13**: Create IPv4 subnet ``ipv4-int-subnet1`` in the internal network ``ipv4-int-network1``,
+and associate it to ``ipv4-router``.
+
+.. code-block:: bash
+
+    neutron subnet-create --name ipv4-int-subnet1 --dns-nameserver 8.8.8.8 ipv4-int-network1 20.0.0.0/24
+    neutron router-interface-add ipv4-router ipv4-int-subnet1
+
+**OS-NATIVE-14**: Associate the ``ext-net`` to the Neutron routers ``ipv4-router`` and ``ipv6-router``.
+
+.. code-block:: bash
+
+    neutron router-gateway-set ipv4-router ext-net
+    neutron router-gateway-set ipv6-router ext-net
+
+**OS-NATIVE-15**: Create IPv4 subnet ``ipv4-int-subnet2`` and IPv6 subnet ``ipv6-int-subnet2`` in
+the internal network ``ipv6-int-network2``, and associate them to ``ipv6-router``
+
+.. code-block:: bash
+
+    neutron subnet-create --name ipv4-int-subnet2 --dns-nameserver 8.8.8.8 ipv6-int-network2 10.0.0.0/24
+    neutron subnet-create --name ipv6-int-subnet2 --ip-version 6 --ipv6-ra-mode slaac --ipv6-address-mode slaac ipv6-int-network2 2001:db8:0:1::/64
+    neutron router-interface-add ipv6-router ipv4-int-subnet2
+    neutron router-interface-add ipv6-router ipv6-int-subnet2
+
+**OS-NATIVE-16**: Create a keypair
+
+.. code-block:: bash
+
+    nova keypair-add vRouterKey > ~/vRouterKey
+
+**OS-NATIVE-17**: Create ports for vRouter (with some specific MAC address - basically for automation -
+to know the IPv6 addresses that would be assigned to the port).
+
+.. code-block:: bash
+
+    neutron port-create --name eth0-vRouter --mac-address fa:16:3e:11:11:11 ipv6-int-network2
+    neutron port-create --name eth1-vRouter --mac-address fa:16:3e:22:22:22 ipv4-int-network1
+
+**OS-NATIVE-18**: Create ports for VM1 and VM2.
+
+.. code-block:: bash
+
+    neutron port-create --name eth0-VM1 --mac-address fa:16:3e:33:33:33 ipv4-int-network1
+    neutron port-create --name eth0-VM2 --mac-address fa:16:3e:44:44:44 ipv4-int-network1
+
+**OS-NATIVE-19**: Update ``ipv6-router`` with routing information to subnet ``2001:db8:0:2::/64``
+
+.. code-block:: bash
+
+    neutron router-update ipv6-router --routes type=dict list=true destination=2001:db8:0:2::/64,nexthop=2001:db8:0:1:f816:3eff:fe11:1111
+
+**OS-NATIVE-20**: Boot Service VM (``vRouter``), VM1 and VM2
+
+.. code-block:: bash
+
+    nova boot --image Fedora20 --flavor m1.small --user-data /opt/stack/opnfv_os_ipv6_poc/metadata.txt --availability-zone nova:opnfv-os-compute --nic port-id=$(neutron port-list | grep -w eth0-vRouter | awk '{print $2}') --nic port-id=$(neutron port-list | grep -w eth1-vRouter | awk '{print $2}') --key-name vRouterKey vRouter
+    nova list
+    nova console-log vRouter #Please wait for some 10 to 15 minutes so that necessary packages (like radvd) are installed and vRouter is up.
+    nova boot --image cirros-0.3.4-x86_64-uec --flavor m1.tiny --nic port-id=$(neutron port-list | grep -w eth0-VM1 | awk '{print $2}') --availability-zone nova:opnfv-os-controller --key-name vRouterKey --user-data /opt/stack/opnfv_os_ipv6_poc/set_mtu.sh VM1
+    nova boot --image cirros-0.3.4-x86_64-uec --flavor m1.tiny --nic port-id=$(neutron port-list | grep -w eth0-VM2 | awk '{print $2}') --availability-zone nova:opnfv-os-compute --key-name vRouterKey --user-data /opt/stack/opnfv_os_ipv6_poc/set_mtu.sh VM2
+    nova list # Verify that all the VMs are in ACTIVE state.
+
+**OS-NATIVE-21**: If all goes well, the IPv6 addresses assigned to the VMs would be as shown as follows:
+
+.. code-block:: bash
+
+    vRouter eth0 interface would have the following IPv6 address: 2001:db8:0:1:f816:3eff:fe11:1111/64
+    vRouter eth1 interface would have the following IPv6 address: 2001:db8:0:2::1/64
+    VM1 would have the following IPv6 address: 2001:db8:0:2:f816:3eff:fe33:3333/64
+    VM2 would have the following IPv6 address: 2001:db8:0:2:f816:3eff:fe44:4444/64
+
+**OS-NATIVE-22**: To ``SSH`` to vRouter, you can execute the following command.
+
+.. code-block:: bash
+
+    sudo ip netns exec qrouter-$(neutron router-list | grep -w ipv6-router | awk '{print $2}') ssh -i ~/vRouterKey fedora@2001:db8:0:1:f816:3eff:fe11:1111
+
+*******************
+Miscellaneour Notes
+*******************
+
+We are adding some static routes to the ``ipv6-router``. For whatever reason, if we want to delete the router
+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:
+
+.. code-block:: bash
+
+    neutron router-update ipv6-router --routes action=clear
+
diff --git a/docs/setupservicevm/index.rst b/docs/setupservicevm/index.rst
index 944efa2..1983adc 100644
--- a/docs/setupservicevm/index.rst
+++ b/docs/setupservicevm/index.rst
@@ -16,4 +16,5 @@ Setting Up a Service VM as an IPv6 vRouter
    :numbered:
    :maxdepth: 4
 
+   5-ipv6-configguide-scenario-1-native-os.rst
    scenario-3.rst