removed the 'append' option to Allocate in the PL driver;
[sfa.git] / sfa / methods / Allocate.py
index 22dc13b..5d0c8d2 100644 (file)
@@ -23,7 +23,26 @@ class Allocate(Method):
     @param slice_urn (string) URN of slice to allocate to
     @param credentials (dict) of credentials
     @param rspec (string) rspec to allocate
-    
+    @param options (dict)
+
+    As of 3.1.16, the PL driver implements here an important option named
+    'pltags' that affects the management of slice tags.
+
+    This option can take 3 values
+      (*) options['pltags'] == 'ignore' (default)
+          This is the recommended mode; in this mode all slice tags passed 
+          here are ignore, which correspond to the <planetlab:attribute> XML tags in 
+          the <sliver_type> areas of incoming rspec to Allocate.
+          In other words you are guaranteed to leave slice tags alone.
+      (*) options['pltags'] == 'append'
+          All incoming slice tags are added to corresponding slivers, 
+          unless an exact match can be found in the PLC db
+      (*) options['pltags'] == 'match'
+          The historical mode, that attempts to leave the PLC db in a state
+          that matches the ones specified in incoming rspec.
+
+    See also http://svn.planet-lab.org/wiki/SFASliceTags
+
     """
     interfaces = ['aggregate', 'slicemgr']
     accepts = [
@@ -45,10 +64,13 @@ class Allocate(Method):
         # the slivers should expire.
         expiration = datetime_to_string(the_credential.expiration)
         
-        # make sure request is not empty
-        slivers = RSpec(rspec).version.get_nodes_with_slivers()
-        if not slivers:
-            raise InvalidRSpec("Missing <sliver_type> or <sliver> element. Request rspec must explicitly allocate slivers")    
+        self.api.logger.debug("Allocate, received expiration from credential: %s"%expiration)
+
+# turned off, as passing an empty rspec is indeed useful for cleaning up the slice
+#        # make sure request is not empty
+#        slivers = RSpec(rspec).version.get_nodes_with_slivers()
+#        if not slivers:
+#            raise InvalidRSpec("Missing <sliver_type> or <sliver> element. Request rspec must explicitly allocate slivers")    
 
         # flter rspec through sfatables
         if self.api.interface in ['aggregate']:
@@ -59,9 +81,10 @@ class Allocate(Method):
         actual_caller_hrn = the_credential.actual_caller_hrn()
         self.api.logger.info("interface: %s\tcaller-hrn: %s\ttarget-hrn: %s\tmethod-name: %s"%(self.api.interface, actual_caller_hrn, xrn.get_hrn(), self.name)) 
         rspec = run_sfatables(chain_name, xrn.get_hrn(), actual_caller_hrn, rspec)
-        slivers = RSpec(rspec).version.get_nodes_with_slivers()
-        if not slivers:
-            raise SfatablesRejected(slice_xrn)
+# turned off, as passing an empty rspec is indeed useful for cleaning up the slice
+#        slivers = RSpec(rspec).version.get_nodes_with_slivers()
+#        if not slivers:
+#            raise SfatablesRejected(slice_xrn)
 
         # pass this to the driver code in case they need it
         options['actual_caller_hrn'] = actual_caller_hrn