Changes between Initial Version and Version 1 of GENIExperimenter/Tutorials/SystematicExprCaseStudy/SmallTopo/DesignSetup

Timestamp:

08/13/14 09:55:32 (10 years ago)

Author:

xliu@bbn.com

Comment:

--

GENIExperimenter/Tutorials/SystematicExprCaseStudy/SmallTopo/DesignSetup

@@ +1 @@
+[[PageOutline]]
+
+'''[http://groups.geni.net/syseng/wiki/XuanSandbox#ATutorialonSystematicExperimentalDesign A Tutorial on Systematic Experimental Design]'''
+
+'''[http://groups.geni.net/syseng/wiki/XuanSandbox/InstallSoftware Step I: Single Node]'''
+
+'''[http://groups.geni.net/syseng/wiki/XuanSandbox/SmallTopo Step II: Small Topology]'''
+
+ 
+{{{
+#!html
+
+<div style="text-align:center; width:495px; margin-left:auto; margin-right:auto;">
+<img id="Image-Maps_5201305222028436" src="http://groups.geni.net/geni/attachment/wiki/GENIExperimenter/Tutorials/Graphics/Setup.jpg?format=raw" usemap="#Image-Maps_5201305222028436" border="0" width="495" height="138" alt="" />
+<map id="_Image-Maps_5201305222028436" name="Image-Maps_5201305222028436">
+<area shape="rect" coords="18,18,135,110" href="http://groups.geni.net/syseng/wiki/XuanSandbox/SmallTopo/DesignSetup" alt="" title=""    />
+<area shape="rect" coords="180,18,297,111" href="http://groups.geni.net/syseng/wiki/XuanSandbox/SmallTopo/Execute" alt="" title=""    />
+<area shape="rect" coords="344,17,460,110" href="http://groups.geni.net/syseng/wiki/XuanSandbox/SmallTopo/Finish" alt="" title=""    />
+<area shape="rect" coords="493,136,495,138" href="http://www.image-maps.com/index.php?aff=mapped_users_5201305222028436" alt="Image Map" title="Image Map" />
+</map>
+<!-- Image map text links - End - -->
+
+</div>
+}}}
+
+
+
+= 1. Software Configuration =
+
+Once we have installed the software on the VM, we may need to configure the software, and automate the configuration process for every node used in an experiment. For this tutorial, since we are setting a virtual routing environment, we will need to configure the routing protocol (e.g., OSPF protocol) for `XORP`. Again, let's start with the smallest reasonable topology, which is a four-router virtual topology as shown below. The reason that we chose the four-router topology is that we need at least one pair of routers that are not directly connected to each other and each router must have at least two virtual interfaces. 
+
+[[Image(XuanSandbox/SmallTopo/DesignSetup:4node-config.png)]]
+
+
+== a. Create Virtual Network ==
+
+As we have mentioned, a four-router topology is the smallest topology to configure and verify the `OSPF` routing. In this part, we illustrate how to create a virtual network with four virtual routers. 
+
+=== i. Create VMs and Virtual Links ===
+
+Create four VMs from the same InstaGENI aggregate and add the links. Modify each VM's name and load the custom image by following [http://groups.geni.net/syseng/wiki/XuanSandbox/InstallSoftware#a4.LoadInstaGENICustomImage Load Custom Image].
+
+[[Image(XuanSandbox/SmallTopo/DesignSetup:4node-topo.png)]]
+
+=== ii. Configure Virtual Interfaces ===
+
+Configure the virtual interfaces' IP addresses of each link by clicking [[Image(XuanSandbox/SmallTopo/DesignSetup:info.jpg)]] at the link icon.
+
+[[Image(XuanSandbox/SmallTopo/DesignSetup:lan-config.png, 50%, nolink)]]
+
+
+After configuring all the links, submit the request at the bottom of your canvas.
+
+=== iii. Save the Current RSpec and Submit the Request ===
+
+For version control purpose, It is important to save (or export) the user request RSpec at each step. Thus, when all VMs are ready for login, we save a copy of current RSpec as `4node-v1.rspec`. 
+We can do so by clicking the '''View'''  and choosing '''Preview requested document(s)''' from the pull-down list. You will see the RSpec generated by Flack looks like the following:
+
+{{{
+<rspec type="request" generated_by="Flack" generated="2014-08-07T22:23:33Z" xsi:schemaLocation="http://www.geni.net/resources/rspec/3 http://www.geni.net/resources/rspec/3/request.xsd " xmlns:flack="http://www.protogeni.net/resources/rspec/ext/flack/1" xmlns:client="http://www.protogeni.net/resources/rspec/ext/client/1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.geni.net/resources/rspec/3">
+  <node client_id="router-2" component_manager_id="urn:publicid:IDN+instageni.stanford.edu+authority+cm" exclusive="false" xmlns:rs="http://www.protogeni.net/resources/rspec/ext/emulab/1">
+    <rs:vnode name="pcvm3-13" xmlns="http://www.protogeni.net/resources/rspec/ext/emulab/1"/>
+    <sliver_type name="emulab-xen">
+      <disk_image url="https://www.instageni.clemson.edu/image_metadata.php?uuid=21a48773-f7cc-11e3-aa57-000000000000"/>
+    </sliver_type>
+    <interface client_id="xen:if0">
+      <ip address="192.168.1.2" netmask="255.255.255.0" type="ipv4"/>
+      <flack:interface_info addressBound="false" bound="false"/>
+    </interface>
+    <interface client_id="xen:if1">
+      <ip address="192.168.2.1" netmask="255.255.255.0" type="ipv4"/>
+      <flack:interface_info addressBound="false" bound="false"/>
+    </interface>
+    <interface client_id="xen:if2">
+      <ip address="192.168.5.1" netmask="255.255.255.0" type="ipv4"/>
+      <flack:interface_info addressBound="false" bound="false"/>
+    </interface>
+    <flack:node_info x="422" y="170" unbound="true"/>
+  </node>
+}}}
+
+
+Choose '''Save to file''' to export the RSpec. In this tutorial, we assume the file is saved to `4node-v1.rspec`, but you can choose any name as you like.
+
+[[Image(XuanSandbox/SmallTopo/DesignSetup:export-to-file.jpg)]]
+
+
+
+
+== b. Manually Configure OSPF for XORP ==
+
+In this tutorial, we configure each VM as an virtual router running `OSPF` routing protocol.  Examples of `XORP` configurations can be found at [http://www.xorp.org/getting_started.html XORPExamples]. For each VM runs as a software router, the `OSPF` configuration file is named as `ospfd.conf` and stored at `/etc/xorp/`. 
+
+We first configure `OSPF` on `router-1`. The configuration file can be downloaded from [http://groups.geni.net/syseng/attachment/wiki/XuanSandbox/DesignSetup/r1-ospf.conf here]. 
+
+There are several key information we observed by manually creating the `OSPF` configuration file for `router-1`. 
+
+ * Interface Information
+{{{
+interface eth1 {
+    description: "virtual interface-eth1"
+    disable: false
+    discard: false
+    vif eth1 {
+        disable: false
+        address 192.168.4.2 {
+                 prefix-length: 24
+                 disable: false
+        }
+    }
+  }
+interface eth2 {
+......
+}
+}}} 
+
+ * `OSPF` Metrics
+{{{
+protocols {
+    ospf4 {
+        router-id: 192.168.1.1
+        area 0.0.0.0 {
+            area-type:"normal"
+            interface eth1 {
+                vif eth1 {
+                  address 192.168.4.2 {
+                    interface-cost 10
+                    hello-interval 5
+                    router-dead-interval 10
+                    disable: false
+                  }
+                }
+            }
+            interface eth2 {
+            ......
+            }
+      }
+   }
+}
+}}}
+
+
+To simplify the configuration process, we assume the `interface-cost` is 10 and the `hello-interval` for every virtual interface. So the main information we need from each node is the virtual interface's `address` and its `prefix-length`, as well as the router's `router-id` that is required for the `protocol` section in the configuration file. 
+
+Similarly, we manually create `ospfd.conf` under `/etc/xorp/` for the other three virtual routers (see [http://groups.geni.net/syseng/attachment/wiki/XuanSandbox/SmallTopo/DesignSetup/r2-ospf.conf `router-2`],  [http://groups.geni.net/syseng/attachment/wiki/XuanSandbox/SmallTopo/DesignSetup/r3-ospf.conf `router-3`], and  [http://groups.geni.net/syseng/attachment/wiki/XuanSandbox/SmallTopo/DesignSetup/r4-ospf.conf `router-4`]). 
+
+
+
+== c. Start `XORP` and Verify the Routing ==
+
+=== i. Start `XORP` Process ===
+
+Start `XORP` by specifying the routing protocol configuration file. 
+
+{{{
+xuanliu@router-1:~$ cd /usr/local/xorp/sbin/
+xuanliu@router-1:/usr/local/xorp/sbin$
+xuanliu@router-1:/usr/local/xorp/sbin$sudo ./xorp_rtrmgr -b /etc/xorp/ospfd.conf -l /tmp/xorp_rtrmgr_log -d
+}}}
+
+Verify the `XORP` process is running
+{{{
+xuanliu@router-1:/usr/local/xorp/sbin$ ps -ef | grep xorp
+root      1972     1  0 13:30 ?        00:00:02 xorp_fea
+root      1973     1  0 13:30 ?        00:00:00 xorp_rib
+root      1974     1  0 13:30 ?        00:00:00 xorp_policy
+root      1975     1  0 13:30 ?        00:00:01 xorp_ospfv2
+root      1976     1  0 13:30 ?        00:00:00 ./xorp_rtrmgr -b /etc/xorp/ospfd.conf -l /tmp/xorp_rtrmgr_log -d
+}}}
+
+Note that there is no one-key method to stop `XORP` process, so we have to kill every `XORP`-related process. We can use the command like the one below to kill all `XORP` process at one time.
+
+{{{
+ps -ef | grep xorp_ | /usr/bin/awk '{ if ( $1 == "root" ) {print "sudo kill -9 " $2}}' | sh
+}}}
+
+=== ii. Verify the Routing ===
+
+Login to `router-1` and view the `OSPF` routing table:
+
+{{{
+xuanliu@router-1:/usr/local/xorp/sbin$ sudo ./xorpsh
+Welcome to XORP v1.8.5 on router-1.xuan-wiki-prep.ch-geni-net.instageni.stanford.edu
+Version tag: 00000000  Build Date: 2014-06-05 17:11 64-bit
+root@router-1.xuan-wiki-prep.ch-geni-net.instageni.stanford.edu> show route table ipv4 unicast ospf
+192.168.2.0/24  [ospf(110)/20]
+                > to 192.168.1.2 via eth2/eth2
+192.168.3.0/24  [ospf(110)/20]
+                > to 192.168.4.1 via eth1/eth1
+192.168.5.0/24  [ospf(110)/20]
+                > to 192.168.1.2 via eth2/eth2
+}}}
+
+
+Login to `router-3` and view the `OSPF` routing table:
+{{{
+xuanliu@router-3:/usr/local/xorp/sbin$ sudo ./xorpsh
+Welcome to XORP v1.8.5 on router-3.xuan-wiki-prep.ch-geni-net.instageni.stanford.edu
+Version tag: 00000000  Build Date: 2014-06-05 17:11 64-bit
+root@router-3.xuan-wiki-prep.ch-geni-net.instageni.stanford.edu> show route table ipv4 unicast ospf
+192.168.1.0/24  [ospf(110)/20]
+                > to 192.168.2.1 via eth2/eth2
+192.168.4.0/24  [ospf(110)/20]
+                > to 192.168.3.1 via eth1/eth1
+192.168.5.0/24  [ospf(110)/20]
+                > to 192.168.2.1 via eth2/eth2
+root@router-3.xuan-wiki-prep.ch-geni-net.instageni.stanford.edu>
+}}}
+
+Since `router-1` and `router-3` are not directly connected, by `OSPF` routing, we should be able to run `ping` and `traceroute` between them. 
+
+{{{
+xuanliu@router-3:/usr/local/xorp/sbin$ ping 192.168.1.1
+PING 192.168.1.1 (192.168.1.1) 56(84) bytes of data.
+64 bytes from 192.168.1.1: icmp_req=1 ttl=63 time=2.15 ms
+64 bytes from 192.168.1.1: icmp_req=2 ttl=63 time=1.45 ms
+64 bytes from 192.168.1.1: icmp_req=3 ttl=63 time=1.41 ms
+^C
+--- 192.168.1.1 ping statistics ---
+3 packets transmitted, 3 received, 0% packet loss, time 2003ms
+rtt min/avg/max/mdev = 1.411/1.673/2.152/0.342 ms
+xuanliu@router-3:/usr/local/xorp/sbin$ traceroute 192.168.1.1
+traceroute to 192.168.1.1 (192.168.1.1), 30 hops max, 60 byte packets
+ 1  router-2-lan1 (192.168.2.1)  0.652 ms  0.595 ms  0.563 ms
+ 2  router-1-lan0 (192.168.1.1)  1.146 ms  1.106 ms  1.076 ms
+xuanliu@router-3:/usr/local/xorp/sbin$
+}}}
+
+== d. Automate `OSPF` Configuration ==
+
+By understanding the syntax of the `OSPF` configuration file for `XORP`, we are able to automate the `OSPF` configuration for every virtual router in a topology, assuming these virtual routers are identical. You can download the automation scripts from [http://geni-myvini.umkc.gpeni.net/resources/experiments/xorp_autostart.tar.gz XORPAutoStart]. 
+
+=== i. Test the Automation ===
+
+To test it, you will need to login to each router (e.g., `router-3`) and run the `start-xorp.sh`. You will see the output similar to the following:
+
+{{{
+dhcp89-69-127:~ xliu$ ssh -p 30781  -i /Users/xliu/.ssh/id_rsa xuanliu@pc3.instageni.stanford.edu
+Welcome to Ubuntu 12.04 LTS (GNU/Linux 3.2.0-56-generic x86_64)
+
+ * Documentation:  https://help.ubuntu.com/
+Last login: Mon Jun 30 14:56:51 2014 from 128.89.69.127
+xuanliu@router-3:~$ cd /local
+xuanliu@router-3:/local$ wget http://geni-myvini.umkc.gpeni.net/resources/experiments/xorp_autostart.tar.gz
+xuanliu@router-3:/local$ tar -zxvf xorp_autostart.tar.gz
+xuanliu@router-3:/local/xorp_autostart$ /bin/bash start-xorp.sh
+router-3.xuan-wiki-prep.ch-geni-net.instageni.stanford.edu
+2014-07-01 06:56:28 AM
+XORP dir exist
+xorp is already added to the group
+xorp is running, stop it first
+XORP is starting ......
+Not doing pidfile...
+}}}
+
+The key procedure is to obtain the virtual interface's `address` and its `prefix` of the subnet information. 
+
+In the install script `start-xorp.sh`, the Following components are the key parts to generate `ospfd.conf`. 
+
+ * Get Hostname and virtual interface information, and store it into a file (`vm_info.txt`)
+{{{
+hostname | sudo tee vm_info.txt > /dev/null
+/sbin/ifconfig | egrep 'eth|inet addr' | sudo tee -a vm_info.txt > /dev/null
+}}}  
+  A sample `vm_info.txt` is available at [http://groups.geni.net/syseng/attachment/wiki/XuanSandbox/DesignSetup/vm_info.txt.example SampleVMInfo]
+
+ * Create `ospfd.conf` by running an `awk` script, available from [http://groups.geni.net/syseng/attachment/wiki/XuanSandbox/SmallTopo/DesignSetup/ospfd-conf-gen.awk here]
+{{{
+sudo /usr/bin/awk -f $ABS_PATH/ospfd-conf-gen.awk $vm_info_file "$timestamp" 24 | sudo tee $ABS_PATH/ospfd.conf > /dev/null
+}}}
+  A sample `ospfd.conf` is available at [http://groups.geni.net/syseng/attachment/wiki/XuanSandbox/DesignSetup/ospfd.conf.example SampleOSPFConf]
+ 
+ * Start `XORP` Process
+{{{
+$sudo ./xorp_rtrmgr -b /etc/xorp/ospfd.conf -l /tmp/xorp_rtrmgr_log -d
+}}}
+ 
+The complete shell script to wrap up the above procedures is available at [http://groups.geni.net/syseng/attachment/wiki/XuanSandbox/DesignSetup/start-xorp.sh StartXORP]
+
+
+{{{
+#!html
+<table id="Table_01" border="0" cellpadding="5" cellspacing="0">
+        <tr>
+                <td>
+                        <img src="http://trac.gpolab.bbn.com/gcf/raw-attachment/wiki/Graphics/4NotesIcon_512x512.png" width="50" height="50" alt="Note">
+               </td>
+<td>
+Please go to [http://groups.geni.net/geni/wiki/HowTo/WriteInstallScript HOWTOWriteInstallScript] for details on how to write an install script.
+<br/>
+<i>
+
+</i>
+</td>
+        </tr>
+</table>
+}}}
+
+Next we are going to install the automate script as an install script at the postboot stage. 
+
+{{{
+#!html
+<table border="0" cellpadding="0" cellspacing="0"><tr><td><img src="http://groups.geni.net/geni/attachment/wiki/GENIExperimenter/Tutorials/Graphics/warning-icon-hi.png?format=raw" width='50' height='50'/></td><td>If you plan to use the same slice to do the next step, please delete your existing resources in your slice at this time, otherwise you can create a new slice to continue.</td></tr></table>
+  </li>
+</ol>
+</td>
+</tr>
+</table>
+}}}
+
+== e. Install Script ==
+
+Launch Flack for your slice, and import the RSpec `4node-v1.rspec` we just saved.
+
+Click '''Import''' and select '''Import from file''' from the pull-down list, then select `4node-v1.rspec` from the location where you have just saved to, and confirm it. You will see the four-node topology on your canvas, and each node has been configured to have the custom image. 
+
+[[Image(XuanSandbox/SmallTopo/DesignSetup:import-rspec-from-file.png)]]
+
+Now, we are ready to add an install script by editing the node property. For each node, click [[Image(XuanSandbox/SmallTopo/DesignSetup:info.jpg)]] to see the node information. By clicking [[Image(XuanSandbox/SmallTopo/DesignSetup:add-service-btn.png)]], we are able to add a service that usually refers to an install script. In this tutorial, we will enter the link ''http://geni-myvini.umkc.gpeni.net/resources/experiments/xorp_autostart.tar.gz'', and the install path is set as ''/local''. By clicking [[Image(XuanSandbox/SmallTopo/DesignSetup:add-exe-serv-btn.png)]], we can add the commend that execute the install script. 
+
+[[Image(XuanSandbox/SmallTopo/DesignSetup:node-install-service.png)]]
+
+Once we added the service and the execute service in Flack, apply the changes and submit the VM reservation request, the OSPF configuration file will be automatically created and the XORP will be started at each virtual router once it is initialized. Setting up the install script will automate installation or configuration process at every node's postboot stage, and we do not need to login to every node to run `start-xorp.sh` manually. 
+
+= 2. Impact to Request RSpec =
+
+Whenever we make a change to node information or link information in Flack, the user request RSpec is modified accordingly. In other words, we can rely on Flack to easily modify the request RSpec.
+
+Now let's take a look at how the steps [http://groups.geni.net/syseng/wiki/XuanSandbox/InstallSoftware#a4.LoadInstaGENICustomImage Load a Custom Image] and [http://groups.geni.net/syseng/wiki/XuanSandbox/SmallTopo/DesignSetup#e.PostbootScript Adding Install Scripts] will modify the request RSpec. For instance, before adding the custom image and install scripts, the RSpec describing `router-1` was like:
+
+{{{
+<node client_id="router-1" component_manager_id="urn:publicid:IDN+instageni.stanford.edu+authority+cm" component_id="urn:publicid:IDN+instageni.stanford.edu+node+pc3" component_name="pc3" exclusive="false">
+    <vnode name="pcvm3-3" xmlns="http://www.protogeni.net/resources/rspec/ext/emulab/1"/>
+    <location latitude="37.43" longitude="-122.17" country="US"/>
+    <interface client_id="xen-0:if0">
+      <ip address="192.168.1.1" netmask="255.255.255.0" type="ipv4"/>
+      <flack:interface_info addressBound="true" bound="false"/>
+    </interface>
+    <interface client_id="xen-0:if1">
+      <ip address="192.168.4.2" netmask="255.255.255.0" type="ipv4"/>
+      <flack:interface_info addressBound="true" bound="false"/>
+    </interface>
+    <flack:node_info x="150" y="407" unbound="true"/>
+  </node>
+}}}
+
+First, when we added the custom image (see [http://groups.geni.net/syseng/wiki/XuanSandbox/InstallSoftware#a4.LoadInstaGENICustomImage Load a Custom Image]), a new tag `<sliver>` will be added to `router-1`'s RSpec, which is 
+
+{{{
+  <sliver_type name="emulab-xen">
+      <disk_image url="https://www.instageni.clemson.edu/image_metadata.php?uuid=21a48773-f7cc-11e3-aa57-00000000000"/>
+  </sliver_type>
+}}}
+
+
+Secondly, when we added the install scripts (see [http://groups.geni.net/syseng/wiki/XuanSandbox/SmallTopo/DesignSetup#e.PostbootScript Adding Install Scripts]), a new tag `<service>` will be added to `router-1`'s RSpec, which is
+{{{
+   <services>
+      <execute command="/bin/bash /local/xorp_autostart/start-xorp.sh" shell="sh"/>
+      <install install_path="/local" url="http://geni-myvini.umkc.gpeni.net/resources/experiments/xorp_autostart.tar.gz"/>
+   </services>
+}}}
+
+This indicates that we can add custom image and postboot scripts by directly modifying the request RSpec, this is helpful when we have a larger topology.
+
+'''Save''' the RSpec as `4node-v2.rspec` at this stage, we will load this RSpec in the next step to get the same setup. 
+
+
+= 3. Script to Capture Routing Table Periodically =
+
+
+In this tutorial, one metric we would like to evaluate is how often the routing table will be updated when there is a link/node failure. To emulate a link failure, we can disable the virtual interfaces, and to emulate a virtual router failure, we can stop the XORP process at the virtual router. A short script (downloaded from [http://geni-myvini.umkc.gpeni.net/resources/experiments/xorp_run.tar.gz here] is available to be loaded as an install script. 
+
+Delete any existing resources or create a new slice, '''LOAD''' the RSpec `4node-v2.rspec`, and add a new install service to every node in Flack. Now, the service portion for each node becomes to 
+{{{
+    <services>
+      <execute command="/bin/bash /local/xorp_autostart/start-xorp.sh" shell="sh"/>
+      <install install_path="/local" url="http://geni-myvini.umkc.gpeni.net/resources/experiments/xorp_autostart.tar.gz"/>
+      <install install_path="/local" url="http://geni-myvini.umkc.gpeni.net/resources/experiments/xorp_run.tar.gz"/>
+    </services>
+}}}
+
+After adding the new install script to every node, send the resource reservation request. When all nodes are ready to login,  we save the new modified RSpec as `4node-v3.rspec`.
+
+In the next step, we will add two end hosts to current four-node topology, so now we can delete existing resources from the current slice. 
+
+= 4. Add End Hosts and Install `iperf` =
+
+
+
+Once we have verified the routing functions for the virtual router, we add end hosts to validate the end-to-end communication.  As the figure shows below, we create the same four-node topology by loading `4node-v3.rspec` in Flack, and create two more VMs as a client and a server, and add two virtual links.  For client and server,  we select regular `Ubuntu 12.04` OS in the node information, so we need to install `iperf` separately. We can also write a script to install `iperf` to the client and server, and the script can be loaded as an install script. 
+
+The install scripts for client and server can be downloaded from [http://geni-myvini.umkc.gpeni.net/resources/experiments/install_script/ here]. 
+
+[[Image(XuanSandbox/SmallTopo/DesignSetup:4node-add-endhosts.png)]]
+
+'''SAVE''' the new RSpec to `4node-v4.rspec`. 
+
+
+
+'''[http://groups.geni.net/syseng/wiki/XuanSandbox/SmallTopo Small Topology: Introduction]'''
+
+'''[http://groups.geni.net/syseng/wiki/XuanSandbox/SmallTopo/Execute Small Topology: Execute]'''