Changes between Version 2 and Version 3 of GEC21Agenda/OEDL/Experiment3


Ignore:
Timestamp:
10/20/14 14:45:20 (5 years ago)
Author:
thierry.rakotoarivelo@nicta.com.au
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • GEC21Agenda/OEDL/Experiment3

    v2 v3  
    66#!html
    77
     8  <div id="wrapper">
     9      <h1 id="gec21-oedltutorial3">GEC21 - OEDL Tutorial 3</h1>
     10
     11<h1 id="overview">Overview</h1>
     12
     13<p>This third part shows how to design, execute, and view the results of an experiment, which dynamically retrieves the resources available in the experimenter&#8217;s slice and select a subset to use in its execution.</p>
     14
     15<p>This experiment demonstrate OEDL&#8217;s integration with the Slice Service of the Labwiki workspace, which allows user to dynamically retrieve the list of resources available in their slice and seamlessly select and use some of these resources in their experiment.</p>
     16
     17<p>In this experiment:</p>
     18
     19<ul>
     20<li>we start by getting the list of resources provisioned for our slice</li>
     21<li>we filter that list of resources to only retain the &#8216;node&#8217; ones</li>
     22<li>then we randomly pick a few of these nodes</li>
     23<li>finally, we create a new group with these randomly picked nodes and associate a ping app to them</li>
     24</ul>
     25
     26<h1 id="step1-designsetup">Step 1 - Design/Setup</h1>
     27
     28<p>For specific help on using LabWiki, please refer to the <a href="http://groups.geni.net/geni/wiki/GEC21Agenda/OEDL/Introduction">LabWiki introduction page</a></p>
     29
     30<p><strong>The OEDL experiment description</strong></p>
     31
     32<ul>
     33<li>First, if you have not done it yet, login into LabWiki</li>
     34<li>Load the &#8216;tut_get_resource.oedl&#8217; experiment file in the &#8216;Prepare&#8217; Panel of LabWiki. This file contains the OEDL script for this 1st experiment</li>
     35<li>If you are not reading this using LabWiki, you can view this OEDL file online at: <a href="http://git.io/43sLkA">http://git.io/43sLkA</a></li>
     36</ul>
     37
     38<img src="https://raw.githubusercontent.com/mytestbed/gec_demos_tutorial/master/gec21_oedl_tutorial/wiki/tut_get_resource.fig1.png" alt="Experiment 3 OEDL Extract" />
     39
     40
     41
     42<p><strong>Walk-through the OEDL experiment description</strong></p>
     43
     44<ol>
     45<li><p>First, a reminder that all details on OEDL are available in the <a href="http://mytestbed.net/projects/omf6/wiki/OEDLOMF6">OEDL reference page</a></p></li>
     46<li><p><a href="http://mytestbed.net/projects/omf6/wiki/OEDLOMF6#loadOEDL"><strong>loadOEDL</strong></a> (line 11). This command includes in your OEDL experiment other external OEDL scripts. In this example, we are loading the definition of a ping application (instrumented with <a href="http://oml.mytestbed.net">OML</a>)</p></li>
     47<li><p><a href="http://mytestbed.net/projects/omf6/wiki/OEDLOMF6#defProperty-38-property-38-ensureProperty"><strong>defProperty</strong></a> (line 13). This command defines experiment properties (aka variables), you can set the values of these properties as parameters for each experiment trials, and access them throughout the entire experiment run. In this example, we are defining 1 property, which holds the target for the ping application.</p></li>
     48<li><p><a href="http://mytestbed.net/projects/omf6/wiki/OEDLOMF6#getResources"><strong>getResources</strong></a> (line 41) This command retrieves the list of resources which are associated with the current slice used by the experimenter. It returns an array where each element is a resource record. Such a record is a hash describing the resource. The experiment script can then filter the list of resources based on specific keys and values in such a record (e.g. only retain the resources of type &#8216;node&#8217;)</p></li>
     49<li><p><strong>Some internal variables</strong> (line 42&#8211;47). These are simple Ruby commands that select a random subset of only &#8216;node&#8217; type resources, and print some information about them. As opposed to the above defProperty variables, internal variables cannot be set at the start of each experiment trial (without having to change the content of the OEDL script itself)</p></li>
     50<li><p><a href="http://mytestbed.net/projects/omf6/wiki/OEDLOMF6#defGroup"><strong>defGroup</strong></a> (line 49&#8211;54). This command is used to define a group of resources which we will use in this experiment. A group may contain many resources or any other group, and a resource may be included in many groups. This commands may also be used to associate a set of configurations and applications to all resources in a group. In this example, we define a single group &#8216;Random_Workers&#8217; including the previously selected random resources, then we associate an instrumented ping application to them. This association is done using the <a href="http://mytestbed.net/projects/omf6/wiki/OEDLOMF6#defGroup"><strong>addApplication</strong></a>.</p></li>
     51<li><p><a href="http://mytestbed.net/projects/omf6/wiki/OEDLOMF6#onEvent"><strong>onEvent</strong></a> (line 56&#8211;62). This command declares the set of actions to perform when a specific event is triggered. In this example, the event is &#8220;APP_UP_AND_INSTALLED&#8221;, i.e. when all resources are ready to receive commands and all applications associated to them are installed. When this event triggers, we start the ping application on the resource within the &#8216;Random_Workers&#8217; group, then after 40 seconds we stop all applications and terminate the experiment trial.</p></li>
     52<li><p><a href="http://mytestbed.net/projects/omf6/wiki/OEDLOMF6#defGraph"><strong>defGraph</strong></a> (line 64&#8211;71). This commands defines the graphs that will be displayed while the experiment trial is running. In this example, we define 1 graph showing the RTT values from the ping applications against time for each resources in our experiment. This graph will be drawn using measurements enabled in the previous defGroup blocks.</p></li>
     53</ol>
     54
     55<h1 id="step2-execute">Step 2 - Execute</h1>
     56
     57<ul>
     58<li>After reviewing this OEDL experiment description, drag-and-drop it from the &#8220;Prepare&#8221; panel to the &#8220;Execute&#8221; panel, as described on the <a href="[http://groups.geni.net/geni/wiki/GEC21Agenda/OEDL/Introduction#Execute">LabWiki introduction page</a></li>
     59<li>Set the values of the &#8216;Slice&#8217; property to your own slice&#8217;s name.
     60(You can optionally decide to give a name to your experiment, if not LabWiki will assign a default unique name to it.)</li>
     61<li>Click on the &#8220;Start Experiment&#8221; button. You will soon see output messages under the &#8220;Logging&#8221; section. Some of these messages are from the OMF Experiment Controller, which interprets your OEDL experiment description and sends corresponding commands to the resources. Other messages are from the resources themselves (either the VM nodes or the applications), reporting on configuration and command results.</li>
     62</ul>
     63
     64<img src="https://raw.githubusercontent.com/mytestbed/gec_demos_tutorial/master/gec21_oedl_tutorial/wiki/tut_get_resource.fig2.png" alt="Experiment 3 Execute Screenshot" />
     65
     66
     67
     68<ul>
     69<li>If you scroll down to the start of the &#8220;Loggin&#8221; section, you should see the dynamic information about the resources in the slice and the one we randomly selected. These are the messages which corresponds to the lines 45&#8211;47 in the OEDL experiment script.</li>
     70</ul>
     71
     72<img src="https://raw.githubusercontent.com/mytestbed/gec_demos_tutorial/master/gec21_oedl_tutorial/wiki/tut_get_resource.fig3.png" alt="Experiment 3 Information Screenshot" />
     73
     74
     75
     76<ul>
     77<li>Above that &#8220;Logging&#8221; section, you should soon see the graph, which we defined in the OEDL experiment description. It is drawn dynamically as measurements are collected from the resources.</li>
     78</ul>
     79
     80<img src="https://raw.githubusercontent.com/mytestbed/gec_demos_tutorial/master/gec21_oedl_tutorial/wiki/tut_get_resource.fig4.png" alt="Experiment 3 Running Screenshot" />
     81
     82
     83
     84<h1 id="step3-finish">Step 3 - Finish</h1>
     85
     86<ul>
     87<li>A message in the &#8220;Execute&#8221; panel will appear to inform you that the experiment execution has finished. At this stage, you should have the complete graph for this experiment in that panel, which should look as follows.</li>
     88</ul>
     89
     90<img src="https://raw.githubusercontent.com/mytestbed/gec_demos_tutorial/master/gec21_oedl_tutorial/wiki/tut_get_resource.fig5.png" alt="Experiment 3 Result Screenshot" />
     91
     92
     93
     94<ul>
     95<li><p>You may interact to with the graph, e.g. hover the pointer above a graph point to display the underlying data point, drag-and-drop the graph via its icon to the &#8220;Plan&#8221; panel as described in the <a href="http://groups.geni.net/geni/wiki/GEC21Agenda/OEDL/Introduction#Execute">LabWiki introduction page</a></p></li>
     96<li><p>The complete data set holding the measurements collected from this experiment is stored in an SQL database. You can retrieve a copy of that database by clicking on the &#8216;Database Dump&#8217; buttom in the &#8216;Execute&#8217; panel. The format of that copy is depends on your LabWiki&#8217;s deployment configuration. It could be an iRODS dump, a Zipped archive of CSV files, a SQLite3 dump or a PostgreSQL dump. By default, it is a PostgreSQL dump.</p></li>
     97</ul>
     98
     99<img src="https://raw.githubusercontent.com/mytestbed/gec_demos_tutorial/master/gec21_oedl_tutorial/wiki/tut_event_state.fig6.png" alt="Database Dump" />
     100
     101
     102
     103<h1 id="helpadditionalresources">Help &amp; Additional Resources</h1>
     104
     105<ul>
     106<li><a href="http://groups.geni.net/geni/wiki/GEC21Agenda/OEDL/Introduction">LabWiki quick guide</a></li>
     107<li><a href="http://mytestbed.net/projects/omf6/wiki/OEDLOMF6">OEDL Reference Document</a></li>
     108<li><a href="http://groups.geni.net/geni/wiki/GEC21Agenda/LabWiki">GEC21 GIMI and Labwiki Tutorial</a></li>
     109<li><a href="http://mytestbed.net/projects/omf6/wiki/Wiki">OMF6 Documentation</a></li>
     110<li><a href="http://oml.mytestbed.net/projects/oml/wiki">OML Documentation</a></li>
     111</ul>
     112    </div>
    8113
    9114}}}