| | 1 | [[PageOutline]] |
| | 2 | = GENI portal = |
| | 3 | |
| | 4 | == Preparation for utilizing the GENI environment == |
| | 5 | |
| | 6 | Make sure that before starting you have setup the correct topology and have the proper setup of SSH keys. The following videos will walk you through these steps. |
| | 7 | |
| | 8 | * Part 1: [http://www.youtube.com/watch?v=H61s9sRP8Qk Understanding the GENI Portal] |
| | 9 | |
| | 10 | * Part 2: [http://www.youtube.com/watch?v=3gssCqOvR-Q Setting up your SSH Keys] |
| | 11 | |
| | 12 | * Part 3: [http://www.youtube.com/watch?v=1tFhi5ypCgg Reserving Resources] |
| | 13 | |
| | 14 | |
| | 15 | == Step 1: Get Ready: == |
| | 16 | |
| | 17 | The first thing we need to do is login to the portal. |
| | 18 | Go to [portal.geni.net Geni Portal] press the Use GENI button |
| | 19 | and from the Drop Down menu select your institution. If you got an account through the GENI Identity Provider, please select GENI Project Office. |
| | 20 | Tip: Start typing the name of your institution and see the list become smaller. |
| | 21 | You will be transferred to the Login Page of your institution. Fill in your username and password. |
| | 22 | |
| | 23 | == Step 2: Launch your experiment: == |
| | 24 | |
| | 25 | * At the portal home page press the create slice from your project. |
| | 26 | |
| | 27 | Tip: If you are not a member of any project and you don't know how to procede, email us |
| | 28 | |
| | 29 | * Name your slice something like xxxhello (where xxx are your initials) |
| | 30 | |
| | 31 | * When the slice page loads up, press the Slice Jacks (beta) button. |
| | 32 | |
| | 33 | * Once the Jacks window loads, click the Add Resources button placed at the top left part of the screen. |
| | 34 | |
| | 35 | NOTE: If you get a warning about not having uploaded ssh keys just follow the instructions on providing an ssh key before you proceed. |
| | 36 | |
| | 37 | * In the Choose RSpec section, choose the Hello GENI choice, which should contain: [http://www.gpolab.bbn.com/exp/HelloGENI/hellogeni.rspec.] |
| | 38 | |
| | 39 | * You will need to choose an aggregate where you want this topology to be instantiated. Click on the Site 0 box and a panel on the left side of the canvas will appear. |
| | 40 | |
| | 41 | * Click on the Reserve Resources button on them bottom left part of the screen. |
| | 42 | |
| | 43 | * Wait while your resources are being reserved. This will take several minutes so be patient. The nodes will turn green to signify that your resources are ready. |
| | 44 | |
| | 45 | * Now, as a professor, you will be the admin of the project. You will have permission to accept the requests of the students to join your project. You can make TA as the project lead who will also have permission to accept the requests of students. |
| | 46 | |
| | 47 | *NOTE: |
| | 48 | |
| | 49 | *Slice has an expiration date. You will have an option to renew the resources before expiration. You will also get a mail notification before 24 hours of expiry. But, projects do not have an expiry date. |
| | 50 | |
| | 51 | == Step 3: View Results: == |
| | 52 | |
| | 53 | See the Labwiki instructions section. |
| | 54 | |
| | 55 | == Step 4: Cleanup experiment: == |
| | 56 | |
| | 57 | After you are done with your experiment, you should always release your resources so that other experimenters can use the resources. In order to cleanup your slice : |
| | 58 | |
| | 59 | *Press the Delete button in the bottom of your Jacks canvas. |
| | 60 | |
| | 61 | Wait and after a few moments all the resources will have been released and you will have an empty canvas again. Notice that your slice is still there. There is no way to delete a slice, it will be removed automatically after its expiration date, but remember that a slice is just an empty container so it doesn't take up any resources. |
| | 62 | |
| | 63 | == Useful links == |
| | 64 | * [Geni Introduction](http://groups.geni.net/geni/wiki/GeniNewcomersWelcome) |
| | 65 | * [Key concepts in Geni](http://groups.geni.net/geni/wiki/GENIConcepts) |
| | 66 | * ["How To" pages] (http://groups.geni.net/geni/wiki/HowTo) |
| | 67 | * [FAQs](http://groups.geni.net/geni/wiki/GENIFAQ) |
| | 68 | |
| | 69 | |
| | 70 | = LABWIKI = |
| | 71 | |
| | 72 | == Introduction == |
| | 73 | LabWiki is a web-based tool developed at Nicta. It is used to design, describe and run experiments on GENI test bed and perform active measurements. |
| | 74 | |
| | 75 | == OEDL == |
| | 76 | OEDL is a domain-specific language for the description of an experiment's execution. OEDL is based on the Ruby language, but provides its own set of experiment-oriented commands and statements. |
| | 77 | |
| | 78 | For further details, visit |
| | 79 | |
| | 80 | * [http://mytestbed.net/projects/omf6/wiki/OEDLOMF6](http://mytestbed.net/projects/omf6/wiki/OEDLOMF6) |
| | 81 | |
| | 82 | == Logging in LabWiki == |
| | 83 | |
| | 84 | LabWiki webpage is available at [http://labwiki.casa.umass.edu:4000/labwiki] . Click on the "Login with GENI ID" |
| | 85 | |
| | 86 | * If you have already logged in to the GENI Portal, you will be automatically logged in to LabWiki |
| | 87 | |
| | 88 | * Use your GENI Portal username and password to login |
| | 89 | |
| | 90 | * You will be asked to agree on sending your GENI Portal information to LabWiki. LabWiki will only use your GENI ID to log you in, so please click on "Send my information" |
| | 91 | |
| | 92 | Note: |
| | 93 | If you are logged in to Geni portal, you are logged in to LabWiki as well. It is recommended to use chrome browser to access LabWiki. In other browsers, the graphs in LabWiki may not be displayed properly due to some issues in JavaScript used in LabWiki. |
| | 94 | |
| | 95 | == Structure of LabWiki == |
| | 96 | LabWiki consists of three panels namely: Plan, Prepare and Execute. |
| | 97 | |
| | 98 | == Plan: == |
| | 99 | This panel is used to view Markdown scripts. This column is usually used to provide some instructions on the experiment. This is also the place where you describe for example, the goals of the experiment, the hypotheses that it tests, its design, any background information to help understand it. When the experiment is finished, the graphs can be dragged and dropped in to this panel to take a look. To open a document, start typing its name in the search box below the column's title. You can choose the required one from the drop down list that shows the matching documents. |
| | 100 | |
| | 101 | == Prepare == |
| | 102 | This column can be used to create and edit two type of documents: |
| | 103 | |
| | 104 | * Markdown scripts that can be viewed on the plan column |
| | 105 | |
| | 106 | * OEDL documents that have the experiment scripts written in Ruby. |
| | 107 | |
| | 108 | A new document can be created by clicking on the "+" button below the column's title. You will have the option of choosing either the "wiki" option or "oedl" option. "wiki" option should be chosen for markdown scripts. Also, a document opened in the plan column can be dragged and dropped in to this column for editing. Click save icon to save the document. |
| | 109 | |
| | 110 | To edit a document, start typing in the search box below the column's title. A drop down list consisting of matching results will be displayed. The experiment scripts will have either .oedl or .rb file extension whereas the markdown scripts will have .md extension. |
| | 111 | |
| | 112 | == Execute == |
| | 113 | This panel is used to start a new instance of an experiment, monitor the execution, view the logs and graphs. |
| | 114 | |
| | 115 | * To start a new instance of an experiment, select and load the experiment in the Prepare column as described above. If required you may want to edit and save that experiment |
| | 116 | |
| | 117 | * Then drag the icon next to the experiment's name from the Prepare column, and drop it in the Execute column. You should now see in the Execute column some information about this new experiment instance. |
| | 118 | |
| | 119 | * In addition to standard experiment parameters (e.g. Name, Slice, Scripts), all configurable experiment properties are displayed in the Execute column , where you can change their default values. |
| | 120 | |
| | 121 | * You may want to give a name to this experiment instance in the Name field within the Execute column, or leave that field blank to let LabWiki pick a unique name for you. |
| | 122 | |
| | 123 | * You can start this new experiment instance by clicking on the "Start Experiment" button. |
| | 124 | |
| | 125 | * Once you start this new experiment instance, the Execute column will show information about the running experiment, such as detailed logs and any defined graphs (you may have to scroll down to the bottom of the Execute column to see these graphs) |
| | 126 | |
| | 127 | * When the experiment instance has finished running, you may copy a plotted graph from the Execute column back to the Plan column, in order to include it to your report or written records. To do so, drag the icon located below the graph (next to its title) and drop it just after the line of text of your choice in the Plan column |
| | 128 | |
| | 129 | = Key Features of LabWiki = |
| | 130 | LabWiki can be used to run experiments which: |
| | 131 | |
| | 132 | * dynamically react to changes in the resources being used- |
| | 133 | It allows user to define events which will trigger based on measurements produced by resources involved in the experiment. In other words, if one or more collected measurements reach a specific condition, then the event will trigger and some user-defined tasks will be executed. For further details, check http://groups.geni.net/geni/wiki/GEC21Agenda/OEDL/Experiment1 |
| | 134 | |
| | 135 | * dynamically react to collected measurements- |
| | 136 | It allows user to define events which will trigger based on measurements produced by resources involved in the experiment. In other words, if one or more collected measurements reach a specific condition, then the event will trigger and some user-defined tasks will be executed. For further details, check http://groups.geni.net/geni/wiki/GEC21Agenda/OEDL/Experiment2 |
| | 137 | |
| | 138 | |
| | 139 | |
| | 140 | == Gitolite- coming soon == |
| | 141 | Labwiki now provides SSH Access to LabWiki Managed Git Repository with the help of Gitolite. By integrating with Gitolite, LabWiki now allows end users to access and update git repositories via standard git command. They could now use their favorite text editor to create and modify experiment scripts; use normal git work flow to synchronize changes. Gitolite need not be installed on the same server as Geni. |
| | 142 | |
| | 143 | == Instructions to grade an experiment- coming soon == |
| | 144 | Labwiki can now be used to automatically grade the students' experiments. There is a configuration file with global permissions. It will have the details of whether people are professors or students. There will be three repositories serving each purpose. |
| | 145 | |
| | 146 | * The system repository is the global repository which will have the files created by the instructor. This the repository shared between Professors and the students. Professor will have write permissions for files in this repository whereas students will have Read-only access. |
| | 147 | |
| | 148 | * The students will have their own repositories will have files pertaining to each student. They can create their own files. |
| | 149 | |
| | 150 | * There will be a submission repository which will have all the submission files of the students. |
| | 151 | |
| | 152 | * The first step for the professor is to create Mark down file providing instructions and reading materials required to run an experiment for the students. |
| | 153 | |
| | 154 | * The second step is to create OEDL scripts to run the experiment.To know more about OEDL, check [http://mytestbed.net/projects/omf6/wiki/OEDLOMF6](http://mytestbed.net/projects/omf6/wiki/OEDLOMF6) |
| | 155 | |
| | 156 | * The students can login to LabWiki and view the files loaded by the Professor. They will not be able to edit the original files. |
| | 157 | |
| | 158 | * Student has to create his/her own OEDL file, copy the content from original file, make modifications if necessary and run the experiment. |
| | 159 | |
| | 160 | * Once the experiment is complete, students have to create a new mark down file for submission. They can drag the graphs of the experiment into the file and and include necessary details about the experiment.. When they are ready to submit the file, they can click "share page" icon in the plan panel of Labwiki. |
| | 161 | |
| | 162 | * The shared files from the students will be loaded into the submission repository |
| | 163 | |
| | 164 | * Currently, there is a separate markdown file which will have the links to all the student submissions. This file will can be accessed only the Professor. |
| | 165 | |
| | 166 | * Professors can write a user-defined event such that it gets triggered only if the experiment has run successfully. They can define the events that need to start upon triggering. For an example, check http://groups.geni.net/geni/wiki/GEC22Agenda/LabWiki/ModuleA |
