X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=sfa%2Fmethods%2FAllocate.py;h=c2ecfc553fb7e3f1e1406a8ba77cd18eeb14363e;hb=3e6097e2d50ff322b45f53fcb22d07fc16adbdb6;hp=e386b3085e1d2acf8e48791c26a38a111837fb68;hpb=3017dd2038fc11a41c8b886eb7c565c486c3e922;p=sfa.git

diff --git a/sfa/methods/Allocate.py b/sfa/methods/Allocate.py
index e386b308..c2ecfc55 100644
--- a/sfa/methods/Allocate.py
+++ b/sfa/methods/Allocate.py
@@ -1,5 +1,5 @@
 from sfa.util.faults import SfaInvalidArgument, InvalidRSpec, SfatablesRejected
-from sfa.util.sfatime import datetime_to_string 
+from sfa.util.sfatime import datetime_to_string
 from sfa.util.xrn import Xrn, urn_to_hrn
 from sfa.util.method import Method
 from sfa.util.sfatablesRuntime import run_sfatables
@@ -8,6 +8,7 @@ from sfa.storage.parameter import Parameter, Mixed
 from sfa.rspecs.rspec import RSpec
 from sfa.util.sfalogging import logger
 
+
 class Allocate(Method):
     """
     Allocate resources as described in a request RSpec argument 
@@ -23,7 +24,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'] == 'sync'
+          The historical mode, that attempts to leave the PLC db in a state
+          in sync with the ones specified in incoming rspec.
+
+    See also http://svn.planet-lab.org/wiki/SFASliceTags
+
     """
     interfaces = ['aggregate', 'slicemgr']
     accepts = [
@@ -31,37 +51,41 @@ class Allocate(Method):
         Parameter(type([dict]), "List of credentials"),
         Parameter(str, "RSpec"),
         Parameter(dict, "options"),
-        ]
+    ]
     returns = Parameter(str, "Allocated RSpec")
 
     def call(self, xrn, creds, rspec, options):
         xrn = Xrn(xrn, type='slice')
 
         # Find the valid credentials
-        valid_creds = self.api.auth.checkCredentialsSpeaksFor(creds, 'createsliver', xrn.get_hrn(), options=options)
+        valid_creds = self.api.auth.checkCredentialsSpeaksFor(
+            creds, 'createsliver', xrn.get_hrn(), options=options)
         the_credential = Credential(cred=valid_creds[0])
 
-        # use the expiration from the first valid credential to determine when 
+        # use the expiration from the first valid credential to determine when
         # the slivers should expire.
         expiration = datetime_to_string(the_credential.expiration)
-        
-        self.api.logger.debug("Allocate, received expiration from credential: %s"%expiration)
+
+        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")    
+#            raise InvalidRSpec("Missing <sliver_type> or <sliver> element. Request rspec must explicitly allocate slivers")
 
         # flter rspec through sfatables
         if self.api.interface in ['aggregate']:
             chain_name = 'INCOMING'
         elif self.api.interface in ['slicemgr']:
             chain_name = 'FORWARD-INCOMING'
-        self.api.logger.debug("Allocate: sfatables on chain %s"%chain_name)
+        self.api.logger.debug("Allocate: sfatables on chain %s" % chain_name)
         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)
+        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)
 # 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:
@@ -69,5 +93,6 @@ class Allocate(Method):
 
         # pass this to the driver code in case they need it
         options['actual_caller_hrn'] = actual_caller_hrn
-        result = self.api.manager.Allocate(self.api, xrn.get_urn(), creds, rspec, expiration, options)
+        result = self.api.manager.Allocate(
+            self.api, xrn.get_urn(), creds, rspec, expiration, options)
         return result