| | 1 | = INSTOOLS, Instrumentize = |
| | 2 | |
| | 3 | INSTOOLS can now be added to your slice using [http://protogeni.net/flack.html FLACK] and a single button press. See [wiki:INSTOOLSSummary INSTOOLS Summary] for details. For documentation purposes and project history, the following describes the former script method. |
| | 4 | |
| | 5 | == What is it? == |
| | 6 | |
| | 7 | Instrumentize is the INSTOOLS process of creating and deploying a set of measurement tools onto a slice. |
| | 8 | [[br]] |
| | 9 | For more information about the Instrumentation Tools see [wiki:INSTOOLSSummary INSTOOLS Summary] |
| | 10 | For more information about the INSTOOLS project, see [wiki:InstrumentationTools InstrumentationTools]. |
| | 11 | [[br]] |
| | 12 | See the online [http://www.netlab.uky.edu/p/instools/home GEC9 Tutorial] for details about setting up INSTOOLS. |
| | 13 | [[br]] |
| | 14 | See below for a quick overview of how to start using INSTOOLS. |
| | 15 | |
| | 16 | == Quick Start == |
| | 17 | |
| | 18 | * Download the [http://www.uky.emulab.net/downloads/INSTOOLSv3_3.tgz python INSTOOLS scripts and docs] |
| | 19 | * See the /docs/README file for more details on using INSTOOLS. |
| | 20 | * You should already have the appropriate accounts and certificates setup. See [http://www.protogeni.net/trac/protogeni/wiki/Tutorial How to use ProtoGen] and-or docs/INSTOOLS-SETUP. |
| | 21 | * Make sure that you create a file named ''.protogeni-config.py'' in your home |
| | 22 | directory with the following contents (example is for Kentucky aggregate). |
| | 23 | {{{ |
| | 24 | XMLRPC_SERVER = { "default" : "www.uky.emulab.net", "ch" : "www.emulab.net" } |
| | 25 | }}} |
| | 26 | * Create your slice as usual or use the script createExp.py |
| | 27 | {{{ |
| | 28 | ./createExp.py -n slicename rspecfilename |
| | 29 | }}} |
| | 30 | Note that there are sample rspecs in the rspecs directory. |
| | 31 | * Once the experiment has been setup, run the instrumentize.py script with the appropriate slicename. |
| | 32 | {{{ |
| | 33 | ./instrumentize.py -n slicename |
| | 34 | }}} |
| | 35 | If you are not using ssh agent, you may need to provide the file name of your private key to instrumentize your experiment. |
| | 36 | {{{ |
| | 37 | ./instrumentize.py -n slicename -k private_key_filename |
| | 38 | }}} |
| | 39 | where ''private_key_filename'' is the name of the file storing the private key generated by ssh-keygen. |
| | 40 | |
| | 41 | * The time needed for the script to run will vary on the number of nodes used and the current server loads. |
| | 42 | * Towards the end, you will be prompted for a password. This will be used for the [wiki:INSTOOLSInterface INSTOOLS Live View] pages and the INSTOOLS Portal page. |
| | 43 | * Once the scripts are complete, go to the [http://portal.uky.emulab.net/ Portal ]. For Portal help, see [wiki:SlicePortal INSTOOLS Portal Wiki]. |
