Context Navigation

Tutorial

Timestamp:: 03/13/12 10:54:28 (12 years ago)
Author:: nriga@bbn.com
Comment:: --

Legend:

: Unmodified
: Added
: Removed
: Modified

GEC13Agenda/ExperimenterWorkflowTutorial/Tutorial

-                      v31
+                      v32
 Now Flack will go behind the scenes and invoke listresources in the selected AMs and populate the map. While Flack is loading the resources you can browse through your personal information by clicking to the button with your username on the left. You will see your credential, your certificate and your ssh keys.
 ===Configure Omni to use your account ===
+=== Configure Omni to use your account ===
 While Flack is loading the resources let's understand how the same functionality works with Omni. Omni is configured through a text file that is called omni_config. Go back to the terminal window and go under the directory that corresponds to your user
 {{{
 …
 Notice how you can see the slice that you created with Flack from Omni as well. If you go back to flack and click the reload button that is next to the Slice under your username on the left you will see that the Omni slice will appear there as well.
+=== Createsliver and sliverstatus with Omni ===
+== 1. Configure Omni ==
+The purpose of this first exercise is to setup
+[http://trac.gpolab.bbn.com/gcf/wiki/Omni Omni] to use your credentials and
+keys.
+=== 1a. Setup omni ===
+Omni uses as input a configuration file, where you can specify information such
+as which clearinghouse to use, where your certificate and keys are located, etc.
+Under the ''Tutorials/Omni/<username>'' directory (where <username> is your
+username on the piece of paper you were given upon entering the room), there is
+a configuration file, ''omni_config''.
+   * '''Open a terminal''' (there is a shortcut on the top bar).
+   * First lets update the files that are on the VM:
+      {{{
+cd Tutorials/Omni/
+downloadRSpecs.sh
+      }}}
+   * The rest of the tutorial assumes that you are under the
+''Tutorials/Omni/<username>'' directory :
+      {{{
+cd <username>
+      }}}
+   * '''Remove the passphrase''' from your certificate. For security best
+practices you should keep a passphrase on your certificate. To avoid typing the
+passphrase throughout the tutorial, we will temporarily remove the passphrase.
+Run
+   {{{
+   clear_cert.sh <username>
+   }}}
+   It will prompt you for the passphrase which should be included on the slip
+that was given to you.
+   *
+   * '''Look at the  omni_config'''. Open omni_config. For the tutorial you
+should use the cleartext certificate, but when running your own experiments, for
+security best practices always use your encrypted certificate.
+   For ''gpousr21'' using a cleartext certificate the omni_config file looks
+like :
+   {{{
+# This file is the omni_config for GEC 12 tutorial
+# Experimental topologies on the GENI Mesoscale network with Omni
+# General section of omni config
+[omni]
+default_cf = pgeni
+users = gpousr21
+# ---------- Users ----------
+[gpousr21]
+# Make sure the urn matches the URN of the credential
+urn = urn:publicid:IDN+pgeni.gpolab.bbn.com+user+gpousr21
+# Public key to be installed in compute resources. For multiple
+# keys use a comma separated file
+keys = ~/Tutorials/Omni/gpousr20/ssh/gpousr21_key.pub
+# If -a option is not specified the omni command will by run against all
+# the following AMs
+aggregates =  http://emulab.net/protogeni/xmlrpc/am,
+https://pgeni.gpolab.bbn.com/protogeni/xmlrpc/am,
+http://myplc.gpolab.bbn.com:12346/, http://myplc.clemson.edu:12346/,
+https://myplc.stanford.edu:12346/,
+https://wings-openflow-1.wail.wisc.edu:12346/,
+https://of.cs.washington.edu:12346/, https://plc.orbit-lab.org:12346/,
+https://myplc.grnoc.iu.edu:12346/, https://myplc.cip.gatech.edu:12346/,
+https://foam-tutorial.gpolab.bbn.com:3626/foam/gapi/1
+# ---------- Frameworks ----------
+[pgeni]
+type = pg
+ch = https://www.emulab.net:443/protogeni/xmlrpc/ch
+sa = https://www.pgeni.gpolab.bbn.com:443/protogeni/xmlrpc/sa
+# Use the following two lines if you are using
+# a certificate with a passphrase
+#cert = ~/Tutorials/Omni/gpousr21/ssh/gpousr21_cert.pem
+#key = ~/Tutorials/Omni/gpousr21/ssh/gpousr21_cert.pem
+# Use the following two lines if you are using
+# a cleartext cert.
+cert = ~/Tutorials/Omni/gpousr21/ssh/gpousr21_cert_ct.pem
+key = ~/Tutorials/Omni/gpousr21/ssh/gpousr21_cert_ct.pem
+#------AM nicknames----------------
+# Instead of typing the whole url of an AM in the -a option you can
+# specify a nickname in this section and use the nickname instead
+# Format :
+# Nickname=URN, URL
+# URN is optional
+[aggregate_nicknames]
+# ProtoGENI AMs and PlanetLab central
+pg-gpo=urn:publicid:IDN+pgeni.gpolab.bbn.com+authority+am,https://pgeni.gpolab.bbn.com/protogeni/xmlrpc/am
+pg-utah=,https://www.emulab.net/protogeni/xmlrpc/am
+pg-ky=urn:publicid:IDN+uky.emulab.net+authority+am,https://www.uky.emulab.net/protogeni/xmlrpc/am
+plc=,https://www.planet-lab.org:12346
+# Private myplc installations
+pl-gpo=,http://myplc.gpolab.bbn.com:12346/
+pl-clemson=,http://myplc.clemson.edu:12346/
+pl-stanford=,https://myplc.stanford.edu:12346/
+pl-wisconsin=,https://wings-openflow-1.wail.wisc.edu:12346/
+pl-washington=,https://of.cs.washington.edu:12346/
+pl-rutgers=,https://plc.orbit-lab.org:12346/
+pl-indiana=,https://localhost:1234/
+pl-gatech=,https://localhost:2346/
+# Tutorial OpenFlow AM
+of-tut=,https://foam-tutorial.gpolab.bbn.com:3626/foam/gapi/1
+# Other OpenFlow AMs
+of-gpo=,https://foam.gpolab.bbn.com:3626/foam/gapi/1
+   }}}
+   Note, the pgeni framework definition includes the Utah Emulab clearinghouse,
+which is the only clearinghouse for ProtoGENI aggregates. For additional
+configuration details please see the [http://trac.gpolab.bbn.com/gcf/wiki/Omni
+Omni] page for more details.  The omni_configuration parameters shown define the
+following:  [[BR]]
+   || '''Parameter'''   || ''' Use'''  ||
+   || default_cf||  Default Clearinghouse and credentials used if not specified
+on the command line.  ||
+   || users||  users setting used when reserving slices. ||
+   || urn||  The username URN ||
+   || keys|| A comma separated list of public ssh key files to be uploaded to
+the Clearinghouse and to your resources ||
+   || type||  Clearinghouse/credentials type "pg" indicates ProtoGENI, see the
+[http://trac.gpolab.bbn.com/gcf/wiki/Omni Omni] page. ||
+   || ch||  ProtoGENI Clearinghouse URL. ||
+   || sa|| Slice Authority URL. ||
+   || cert||  Location of your SSL encrypted certificate (contains both a
+certificate and a key). ||
+   || key||  Location of your SSL encrypted key (contains both a certificate and
+a key). ||
+   || <AM nickname>|| Optional URN, required URL of an Aggregate Manager. ||
+   * Verify that the user URN is correct.
+     Get the URN from your omni config
+     {{{
+     grep urn omni_config
+     }}}
+     Verify that it matches the urn in your cert (disregard the leading URI:)
+     {{{
+     openssl x509 -noout -text -in ./ssh/<username>_cert_ct.pem | grep
+'urn:publicid'
+     }}}
+     For gpousr21 the output looks like
+     {{{
+geni@geni-vm:~/omni_tutorial$ grep urn omni_config
+urn = urn:publicid:IDN+pgeni.gpolab.bbn.com+user+gpousr21
+geni@geni-vm:~/omni_tutorial$ openssl x509 -noout -text -in
+./ssh/gpousr21_cert_ct.pem | grep 'urn:publicid'
+                URI:urn:publicid:IDN+pgeni.gpolab.bbn.com+user+gpousr21,
+email:gpousr21@pgeni.gpolab.bbn.com
+     }}}
+=== 1b. Test configuration ===
+In order to test that our configuration is correct, you can issue a getversion
+command. For this step we have used !PlanetLab's AM, but you can use any
+Aggregate Manager(AM).
+{{{
+omni.py getversion -a http://www.planet-lab.org:12346
+}}}
+Or equivalently using the !PlanetLab nickname:
+{{{
+omni.py getversion -a plc
+}}}
+gpousr21 decided to use !PlanetLab central :
+{{{
+#!xml
+geni@geni-tutorial:~/Tutorials/Omni/gpousr21$ omni.py getversion -a plc
+INFO:omni:Loading config file omni_config
+INFO:omni:Using control framework pgeni
+INFO:omni:Substituting AM nickname plc with URL
+https://www.planet-lab.org:12346, URN unspecified_AM_URN
+INFO:omni:AM URN: unspecified_AM_URN (url: https://www.planet-lab.org:12346) has
+version:
+INFO:omni:{   'ad_rspec_versions': [   {   'extensions': [
+'http://www.protogeni.net/resources/rspec/ext/gre-tunnel/1',
+                                                   'http://www.protogeni.net/resources/rspec/ext/other-ext/3'],
+                                 'namespace':
+'http://www.protogeni.net/resources/rspec/2',
+                                 'schema':
+'http://www.protogeni.net/resources/rspec/2/ad.xsd',
+                                 'type': 'ProtoGENI',
+                                 'version': '2'},
+                             {   'extensions': [],
+                                 'namespace': None,
+                                 'schema': None,
+                                 'type': 'SFA',
+                                 'version': '1'}],
+    'code_tag': '1.0-35',
+    'code_url': 'git://git.onelab.eu/sfa.git@sfa-1.0-35',
+    'default_ad_rspec': {   'extensions': [],
+                            'namespace': None,
+                            'schema': None,
+                            'type': 'SFA',
+                            'version': '1'},
+    'geni_api': 1,
+    'hostname': 'www.planet-lab.org',
+    'hrn': 'plc',
+    'interface': 'aggregate',
+    'request_rspec_versions': [   {   'extensions': [
+'http://www.protogeni.net/resources/rspec/ext/gre-tunnel/1',
+                                                        'http://www.protogeni.net/resources/rspec/ext/other-ext/3'],
+                                      'namespace':
+'http://www.protogeni.net/resources/rspec/2',
+                                      'schema':
+'http://www.protogeni.net/resources/rspec/2/request.xsd',
+                                      'type': 'ProtoGENI',
+                                      'version': '2'},
+                                  {   'extensions': [],
+                                      'namespace': None,
+                                      'schema': None,
+                                      'type': 'SFA',
+                                      'version': '1'}],
+    'sfa': 1,
+    'testbed': 'myplc'}
+INFO:omni: ------------------------------------------------------------
+INFO:omni: Completed getversion:
+  Options as run:
+    aggregate: plc
+    framework: pgeni
+    native: True
+  Args: getversion
+  Result Summary:
+Got version for 1 out of 1 aggregates
+INFO:omni: ============================================================
+}}}
+== 2. Make a slice ==
+Before we continue with the rest of the tutorial, we need to create a slice that
+will contain all our slivers with the different AMs.
+Since the omni_config specifies using GPO's ProtoGENI as the Slice Authority
+(SA), your slice will be created in the pgeni.gpolab.bbn.com namespace.
+=== 2a. Createslice ===
+For this tutorial we will create a slice named ''gposlice##'' (where ## matches
+your username); you should always choose a slice name that is meaningful to you.
+To avoid confusion, avoid creating a slice with the same name as your username
+(i.e. if your username is ''alice'', don't name your slice ''alice'' too).
+{{{
+omni.py createslice gposlice##
+}}}
+=== 2b. Renew Slice ===
+Note in the above output that our new slice expires soon. Your slivers can not
+last longer then your slice, and your resources will go away when the
+reservation expires. For your experiments be sure to renew your slice for the
+duration of your experiment. For the tutorial you don't need to extend the
+lifetime, but if you wanted to, this is what it would look like:
+{{{
+omni.py renewslice gposlice## 20111105T00:00:00
+}}}
+For Alice the output would like:
+{{{
+geni@geni-tutorial:~/Tutorials/Omni/gpousr21$ omni.py renewslice gposlice21
+20111105T00:00:00
+INFO:omni:Loading config file omni_config
+INFO:omni:Using control framework pgeni
+INFO:omni.protogeni:Requesting new slice expiration '2011-11-05T00:00:00'
+INFO:omni:Slice gposlice21 now expires at 2011-11-05 00:00:00 UTC
+INFO:omni:Slice urn:publicid:IDN+pgeni.gpolab.bbn.com+slice+gposlice21 expires
+on 2011-11-05 00:00:00 UTC
+INFO:omni: ------------------------------------------------------------
+INFO:omni: Completed renewslice:
+  Options as run:
+    framework: pgeni
+    native: True
+  Args: renewslice gposlice21 20111105T00:00:00
+  Result Summary: Slice gposlice21 now expires at 2011-11-05 00:00:00 UTC
+Slice urn:publicid:IDN+pgeni.gpolab.bbn.com+slice+gposlice21 expires on
+-11-05 00:00:00 UTC
+INFO:omni: ============================================================
+}}}
+'''Note:''' You can not renew the slice expiration time to an earlier time that
+its current expiration time. Also there is no deleteslice operation. However,
+you can delete all the slivers in your slice and let the slice expire.
+=== 2c. List your Slices ===
+If you want to find out what slices you currently have, you can use an Omni
+command to {{{listmyslices}}}.
+{{{
+omni.py listmyslices <username>
+}}}
+We've pre-reserved resources in a second slice (ctrl##) in advance of the
+tutorial for each user.
+So for gpousr21 the output would look like :
+{{{
+geni@geni-tutorial:~/Tutorials/Omni/gpousr21$ omni.py listmyslices gpousr21
+INFO:omni:Loading config file omni_config
+INFO:omni:Using control framework pgeni
+INFO:omni:User 'gpousr21' has slices:
+  urn:publicid:IDN+pgeni.gpolab.bbn.com+slice+gposlice21
+  urn:publicid:IDN+pgeni.gpolab.bbn.com+slice+ctrl21
+INFO:omni: ------------------------------------------------------------
+INFO:omni: Completed listmyslices:
+  Options as run:
+    framework: pgeni
+    native: True
+  Args: listmyslices gpousr21
+  Result Summary: Found 2 slices for user 'gpousr21'.
+INFO:omni: ============================================================
+}}}
+=== Createsliver and sliverstatus  ===
+For this part we are going to go back and forth between Omni and Flack and understand how each tool manipulate slices. In Flack go back to the empty canvas on your slice. You will see on the left the AMs that you chose in the beginning .
+There are some icons next to them to correspond to nodes. You can drag and drop nodes in your canvas.
+[[Image(flack-addnodes.png, 50%)]]
+ You can press on the (i) button and look at all the information that you can set for your nodes. If you have more than one nodes in your canvas you can draw links between the nodes, and set parameters on that links.
+On the background Flack is creating the request specification documents that you will need to reserve the resources that are on your slice canvas. If you want to take a look at the RSpec created by flack you have to press at the button on the top right of your canvas that correspond to "Preview Request Rspec".
+[[Image(flack-preview.png, 50%)]]
 == 3. Make a ProtoGENI sliver ==