Context Navigation

← Previous Change
Wiki History
Next Change →

Changes between Initial Version and Version 1 of GENIExperimenter/ExperimentExample-OF-FOAM

Timestamp:: 04/02/12 11:14:43 (12 years ago)
Author:: lnevers@bbn.com
Comment:: --

Legend:

: Unmodified
: Added
: Removed
: Modified

GENIExperimenter/ExperimentExample-OF-FOAM

                       v1
+[[PageOutline]]
+= GENI !OpenFlow Experiment Example 2 =
+This page illustrates an operational !OpenFlow (OF) example for the [wiki:HowToUseOmni Omni How-to] page. [http://www.openflow.org/ OpenFlow] is used for control of many of the network resources in the GENI backbone and at meso-scale campus locations.  Many experimenters can use these GENI resources without learning !OpenFlow.  The GENI [mailto:help@geni.net] can help arrange connectivity across your GENI slice, including IP connectivity and/or layer 2 VLANs.
+For experimenters who desire control over the network switching fabric in their slices, !OpenFlow provides increased flexibility.  Your experiment will incorporate an !OpenFlow controller.  If you have never written a controller, don't panic.  Many experiments can use existing controller code as-is, or with relatively simple modifications.  The GPO is available to help design your controller and plan your experiment configuration.  Feel free to contact us at [mailto:help@geni.net].
+The example captured in this page uses credentials from pgeni.gpolab.bbn.com, the GPO ProtoGENI Clearinghouse, to set up an experiment that includes 3 fictional sites (1 PG and 2 MyPLC nodes). This example assumes that an !OpenFlow Controller, such as NOX, is running on a slice resource, and is available and is accessible to the !FlowVisor instances. In this scenario, two sites are Web Servers and 3 are clients, as shown in the diagram below:
+[[Image(OF-Experiment-example.jpg)]]
+Omni tools can be used to reserve OF resources in each of the site's !OpenFlow Aggregate Manager (OF AM). Steps that are to take place include:
+    * Configure Omni tools
+    * Define !OpenFlow RSPEC
+    * Request flowspace resources
+    * Opt-in Manager Administrative approval
+    * Run the experiment
+Note: Open Flow Aggregate Manager sites must be federated in order to trust a Clearinghouse. This is an OF administrator task that must take place before any of the user OF operations can take place.
+== Authentication and Omni tools configuration ==
+This example assumes that GENI credentials have been set up as detailed in the [wiki:HowToUseOmni#a1.GetGENICredentials GENI Credentials] section of the [wiki:HowToUseOmni Omni how-to] page.
+The settings as defined in the [wiki:GENIExperimenter/ExperimentExample#OmniConfiguration Omni Configuration] section of the non-OF Omni how-to example will work for this OF setup.  The credentials from the GPO Clearinghouse will allow access to the GPO OF aggregate manager.  A list of Aggregate managers is being compiled in the [http://groups.geni.net/geni/wiki/GeniAggregate GENI Aggregate] page, if your site is not listed on this page you should contact your site administrator, or help@geni.net.
+== Determine Resources ==
+An !OpenFlow RSPEC must be defined for each of the 3 site OF AM in order to get access to the OF resources.  The content of the OF RSPEC depends on the type OF AM resource that you may need.  You may need to define an RSPEC using any of the following:
+  * IP Addresses
+  * MAC Address
+  * Data Path Identifier (DPID).
+To find out what OF resources are available from each of the OF Aggregate Manager, you may use Omni tools to get a list of available resources. For a list of available aggregates see the [wiki:GeniAggregate GENI Aggregates] page. Here is an example of listing resources advertised by the OF Aggregate Manager for Site 1 in native RSPEC format.
+NOTE: This example uses Omni V1.3 and later syntax (native is the default, and the {{{-o}}} option allows you to save the output to a file). For earlier versions of omni, you should (a) include the {{{-n}}} argument, (b) re-direct output to a file (''>'') instead of the -o option, and (c) use PG V0.2 RSpecs at Emulab and SFA format RSpecs at PlanetLab.
+{{{
+$ ./src/omni.py -a https://ofam1.site1.com:1443/openflow/gapi/ -o listresources
+INFO:omni:Loading config file omni_config
+INFO:omni:Using control framework pgeni
+INFO:omni:Saving output to a file.
+INFO:omni:Listed resources on 1 out of 1 possible aggregates.
+INFO:omni:Writing to 'rspec-ofam1-site1-com-1443.xml'
+INFO:omni: ------------------------------------------------------------
+INFO:omni: Completed listresources:
+  Options as run:
+                aggregate: https://ofam1.site1.com:1443/openflow/gapi/
+                configfile: omni_config
+                framework: pgeni
+                native: True
+                output: True
+  Args: listresources
+  Result Summary: Retrieved resources from 1 aggregates.
+Wrote rspecs from 1 aggregates to 1 files.
+INFO:omni: ============================================================
+}}}
+The resulting Advertisement RSpec looks like this:
+{{{
+#!xml
+<?xml version="1.0" ?>
+<!-- Resources at AM:
+        URN: unspecified_AM_URN
+        URL: https://ofam1.site1.com:1443/openflow/gapi/
+ -->
+<rspec type="openflow">
+  <network location="Somewhere USA " name="local-oim ">
+    <switches>
+      <switch urn="urn:publicid:IDN+ofam1.site1.com:expedient:openflow+switch
+:06:bb:00:24:88:cc:bb:00">
+        <port urn="urn:publicid:IDN+ofam1.site1.com:expedient:openflow+switch:044:d0:02:6f:13:f3:b0:0+port:26"/>
+      </switch>
+    </switches>
+    <links/>
+  </network>
+</rspec>
+}}}
+The above provides the switch and the port URN information to be used in making the OF flowspace reservation.  The above results will give you some insight into what is available, but it is recommended that you coordinate with the site contact to ensure RSpec accuracy for each of the OF Aggregate Managers.
+== Request Resources ==
+The OF RSpecs are used to request resources at each site's !OpenFlow Aggregate Manager.  This will result in your resource request being imported into the Opt-In manager, where an Administrator must approve your request for resources. Currently requesting OF resources for the sites in the experiment does not require OF setup for the Network Core path; the default handling will allow OF traffic.  This is expected to change.
+The OF RSpec defines a flowspace for each OF rule for your traffic sliver.  Following are example OF RSpecs that could be used to reserve the flowspaces needed for each of the generic 3 node scenario in this page. The scenario uses 3 OF Aggregate Managers (one per site) and one OF Controller at Site 1 for all sites.  The example RSpecs are for each of the 3 OF AM and assume that the flowspace is based on traffic type and port (TCP port 9080 and 9082).
+'''RSpec Example for Site 1 !OpenFlow Aggregate Manager'''
+{{{
+#!xml
+<resv_rspec type="openflow">
+  <user affiliation="GPO" email="help@geni.net" firstname="GPO" lastname="Ops" password="xxxxxxx"/>
+  <project description="Project description" name=" Project name"/>
+  <slice controller_url="tcp:controller.site1.com:9933" description="description" name="name"/>
+<flowspace>
+    <switch urn="urn:publicid:IDN+ofam1.site1.com:expedient:openflow+switch:044:d0:02:6f:13:f3:b0:0"/>
+    <tp_dst from="9080" to="9082"/>
+  </flowspace>
+  <flowspace>
+    <switch urn="urn:publicid:IDN+ofam1.site1.com:expedient:openflow+switch:044:d0:02:6f:13:f3:b0:0"/>
+    <tp_src from="9080" to="9082"/>
+  </flowspace>
+</resv_rspec>
+}}}
+'''RSpec Example for Site 2 !OpenFlow Aggregate Manager'''
+{{{
+#!xml
+<resv_rspec type="openflow">
+  <user affiliation="GPO" email="help@geni.net" firstname="GPO" lastname="Ops" password="xxxxxxx"/>
+  <project description="Project description" name=" Project name"/>
+  <slice controller_url="tcp:controller.site1.com:9933" description="description" name="name"/>
+<flowspace>
+    <switch urn="urn:publicid:IDN+ofam2.site2.com:expedient:openflow+switch:00:00:00:13:65:f4:21:4f"/>
+    <tp_dst from="9080" to="9082"/>
+  </flowspace>
+  <flowspace>
+    <switch urn="urn:publicid:IDN+ofam2.site2.com:expedient:openflow+switch:00:00:00:13:65:f4:21:4f"/>
+    <tp_src from="9080" to="9082"/>
+  </flowspace>
+</resv_rspec>
+}}}
+'''RSpec Example for Site 3 !OpenFlow Aggregate Manager'''
+{{{
+#!xml
+<resv_rspec type="openflow">
+  <user affiliation="GPO" email="help@geni.net" firstname="GPO" lastname="Ops" password="xxxxxxx"/>
+  <project description="Project description" name=" Project name"/>
+  <slice controller_url="tcp:controller.site1.com:9933" description="description" name="name"/>
+<flowspace>
+    <switch urn="urn:publicid:IDN+ofam3.site3.com:expedient:openflow+switch:00:00:00:21:6f:b8:f3:d0"/>
+    <tp_dst from="9080" to="9082"/>
+  </flowspace>
+  <flowspace>
+    <switch urn="urn:publicid:IDN+ofam3.site3.com:expedient:openflow+switch:00:00:00:21:6f:b8:f3:d0"/>
+    <tp_src from="9080" to="9082"/>
+  </flowspace>
+</resv_rspec>
+}}}
+'''Create Slice and Request Resources'''
+Using the RSpec that defines the required OF flowspace, you can now request OF resources with Omni. First create a slice using your GPO Clearinghouse credentials as defined in the omni_config. Note that the slice name should be meaningful to you:
+{{{
+$ ./src/omni.py createslice ln_OF_slice
+INFO:omni:Loading config file omni_config
+INFO:omni:Using control framework pgeni
+INFO:omni:Created slice with Name ln_OF_slice, URN urn:publicid:IDN+pgeni.gpolab.bbn.com+slice+ln_OF_slice, Expiration 2011-06-16 19:46:49
+INFO:omni: ------------------------------------------------------------
+INFO:omni: Completed createslice:
+  Options as run:
+                configfile: omni_config
+                framework: pgeni
+                native: True
+  Args: createslice ln_OF_slice
+  Result Summary: Created slice with Name ln_OF_slice, URN urn:publicid:IDN+pgeni.gpolab.bbn.com+slice+ln_OF_slice, Expiration 2011-06-16 19:46:49
+INFO:omni: ============================================================
+}}}
+Then create a sliver for each resource aggregate.  In this example there are 3 OF aggregates (one per site) and 3 compute resource aggregates (1 PG & 2 MyPLC), which maps to creating 6 slivers, and the following commands are executed:
+{{{
+ $ ./src/omni.py -a https://ofam1.site1.com:1443/openflow/gapi/ -o createsliver ln_OF_slice OF-site1.txt.rspec
+ $ ./src/omni.py -a https://ofam2.site2.com:1443/openflow/gapi/ -o createsliver ln_OF_slice OF-site2.rspec
+ $ ./src/omni.py -a https://ofam3.site3.com:1443/openflow/gapi/ -o createsliver ln_OF_slice OF-site3.rspec
+ $ ./src/omni.py -a https://www.emulab.net/protogeni/xmlrpc/am -o createsliver ln_OF_slice emulab-site2.rspec
+ $ ./src/omni.py -a http://myplc.site1.com:12346 -o createsliver ln_OF_slice myplc-site1.rspec
+ $ ./src/omni.py -a http://myplc.site3.com:12346 -o createsliver ln_OF_slice myplc-site3.rspec
+}}}
+^^ Note: Examples that detailed rspec creation examples for the PG and MyPLC resource aggregates can be found in the other non-OF [wiki:GENIExperimenter/ExperimentExample experiment] example. ^^
+== Opt-in Manager Administrative Approval ==
+The OF Aggregate Administrator has to allow traffic from various nodes to be routed as decided by your !OpenFlow controller. In this case, you are asking the administrator to route traffic on the PG and PL nodes you have just reserved. So you will need to give the site OF Aggregate Administrator:
+  - your name
+  - slice name and clearinghouse
+  - PI name
+  - duration of your experiment
+  - IP address and names of the nodes whose traffic you need opted in (see the result of {{{listresources}}} and/or {{{sliverstatus}}})
+  - your flowspace request in plain text - what were you looking for
+The OF Aggregate Administrator that opts-in your flows is responsible for resolving any conflicts between the traffic flows that you are requesting and the traffic flows requested by other experiments. If your flows are too generic (ex. all port 80 traffic) then they may overlap with other experiments; the administrator will have control over whether the conflict is resolved in your favor or someone else's.
+Once the OF Aggregate  Administrator has opted-in your traffic, you may start using the OF resources.
+== Run Experiment ==
+Once your flowspace has been opted in you should be able to exchange traffic over the approved flows between the hosts that have been allocated to your experiment.  Simply SSH into one of the hosts and ping any of the other hosts to verify connectivity. If you have connectivity between the allocated hosts, you may start your experiment, if you do not have connectivity, contact [mailto:help@geni.net].
+Remember to check the expiration time for the flowspace and for each aggregate with the Omni ''sliverstatus'' and to ''renewslice'' and ''renewsliver'' to expand the duration of the resource allocation to match your experiment needs.  For an example on how to check ''sliverstatus'' and ''renewslice'' see the [wiki:GENIExperimenter/ExperimentExample#Checkingsliverresourcestatus checking status] section of the other non-OF experiment.
+== Release Resources ==
+When the experiment is completed you should release the resources by deleting the sliver for each of the Resource Aggregates used in the Experiment. In the example experiment used in this page, the following commands should be issued to release resources:
+{{{
+ $ ./src/omni.py -a https://ofam1.site1.com:1443/openflow/gapi/ deletesliver ln_OF_slice
+ $ ./src/omni.py -a https://ofam2.site2.com:1443/openflow/gapi/ deletesliver ln_OF_slice
+ $ ./src/omni.py -a https://ofam3.site3.com:1443/openflow/gapi/ deletesliver ln_OF_slice
+ $ ./src/omni.py -a https://www.emulab.net/protogeni/xmlrpc/am deletesliver ln_OF_slice
+ $ ./src/omni.py -a http://myplc.site1.com:12346 deletesliver ln_OF_slice
+ $ ./src/omni.py -a http://myplc.site3.com:12346 deletesliver ln_OF_slice
+}}}
+----
+{{{
+#!html
+<a href="mailto:luisa.nevers@bbn.com">Email us</a> with any questions and feedback on this page!
+}}}