netspec contains the slit Rspec
[sfa.git] / sfa / plc / slices.py
1 ### $Id$
2 ### $URL$
3
4 import datetime
5 import time
6 import traceback
7 import sys
8
9 from types import StringTypes
10 from sfa.util.misc import *
11 from sfa.util.rspec import *
12 from sfa.util.specdict import *
13 from sfa.util.faults import *
14 from sfa.util.storage import *
15 from sfa.util.policy import Policy
16 from sfa.util.debug import log
17 from sfa.server.aggregate import Aggregates
18 from sfa.server.registry import Registries
19
20 class Slices(SimpleStorage):
21
22     def __init__(self, api, ttl = .5, caller_cred=None):
23         self.api = api
24         self.ttl = ttl
25         self.threshold = None
26         path = self.api.config.SFA_BASE_DIR
27         filename = ".".join([self.api.interface, self.api.hrn, "slices"])
28         filepath = path + os.sep + filename
29         self.slices_file = filepath
30         SimpleStorage.__init__(self, self.slices_file)
31         self.policy = Policy(self.api)    
32         self.load()
33         self.caller_cred=caller_cred
34
35
36     def get_peer(self, hrn):
37         # Becaues of myplc federation,  we first need to determine if this
38         # slice belongs to out local plc or a myplc peer. We will assume it 
39         # is a local site, unless we find out otherwise  
40         peer = None
41
42         # get this slice's authority (site)
43         slice_authority = get_authority(hrn)
44
45         # get this site's authority (sfa root authority or sub authority)
46         site_authority = get_authority(slice_authority).lower()
47
48         # check if we are already peered with this site_authority, if so
49         peers = self.api.plshell.GetPeers(self.api.plauth, {}, ['peer_id', 'peername', 'shortname', 'hrn_root'])
50         for peer_record in peers:
51             names = [name.lower() for name in peer_record.values() if isinstance(name, StringTypes)]
52             if site_authority in names:
53                 peer = peer_record['shortname']
54
55         return peer
56
57     def refresh(self):
58         """
59         Update the cached list of slices
60         """
61         # Reload components list
62         now = datetime.datetime.now()
63         if not self.has_key('threshold') or not self.has_key('timestamp') or \
64            now > datetime.datetime.fromtimestamp(time.mktime(time.strptime(self['threshold'], self.api.time_format))):
65             if self.api.interface in ['aggregate']:
66                 self.refresh_slices_aggregate()
67             elif self.api.interface in ['slicemgr']:
68                 self.refresh_slices_smgr()
69
70     def refresh_slices_aggregate(self):
71         slices = self.api.plshell.GetSlices(self.api.plauth, {'peer_id': None}, ['name'])
72         slice_hrns = [slicename_to_hrn(self.api.hrn, slice['name']) for slice in slices]
73
74          # update timestamp and threshold
75         timestamp = datetime.datetime.now()
76         hr_timestamp = timestamp.strftime(self.api.time_format)
77         delta = datetime.timedelta(hours=self.ttl)
78         threshold = timestamp + delta
79         hr_threshold = threshold.strftime(self.api.time_format)
80         
81         slice_details = {'hrn': slice_hrns,
82                          'timestamp': hr_timestamp,
83                          'threshold': hr_threshold
84                         }
85         self.update(slice_details)
86         self.write()     
87         
88
89     def refresh_slices_smgr(self):
90         slice_hrns = []
91         aggregates = Aggregates(self.api)
92         credential = self.api.getCredential()
93         for aggregate in aggregates:
94             try:
95                 slices = aggregates[aggregate].get_slices(credential)
96                 slice_hrns.extend(slices)
97             except:
98                 print >> log, "Error calling slices at aggregate %(aggregate)s" % locals()
99          # update timestamp and threshold
100         timestamp = datetime.datetime.now()
101         hr_timestamp = timestamp.strftime(self.api.time_format)
102         delta = datetime.timedelta(hours=self.ttl)
103         threshold = timestamp + delta
104         hr_threshold = threshold.strftime(self.api.time_format)
105
106         slice_details = {'hrn': slice_hrns,
107                          'timestamp': hr_timestamp,
108                          'threshold': hr_threshold
109                         }
110         self.update(slice_details)
111         self.write()
112
113
114     def delete_slice(self, hrn):
115         if self.api.interface in ['aggregate']:
116             self.delete_slice_aggregate(hrn)
117         elif self.api.interface in ['slicemgr']:
118             self.delete_slice_smgr(hrn)
119         
120     def delete_slice_aggregate(self, hrn):
121
122         slicename = hrn_to_pl_slicename(hrn)
123         slices = self.api.plshell.GetSlices(self.api.plauth, {'name': slicename})
124         if not slices:
125             return 1        
126         slice = slices[0]
127
128         # determine if this is a peer slice
129         peer = self.get_peer(hrn)
130         if peer:
131             self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'slice', slice['slice_id'], peer)
132         self.api.plshell.DeleteSliceFromNodes(self.api.plauth, slicename, slice['node_ids'])
133         if peer:
134             self.api.plshell.BindObjectToPeer(self.api.plauth, 'slice', slice['slice_id'], peer, slice['peer_slice_id'])
135         return 1
136
137     def delete_slice_smgr(self, hrn):
138         credential = self.api.getCredential()
139         aggregates = Aggregates(self.api)
140         for aggregate in aggregates:
141             try:
142                 aggregates[aggregate].delete_slice(credential, hrn, caller_cred=self.caller_cred)
143             except:
144                 print >> log, "Error calling list nodes at aggregate %s" % aggregate
145                 traceback.print_exc(log)
146                 exc_type, exc_value, exc_traceback = sys.exc_info()
147                 print exc_type, exc_value, exc_traceback
148
149     def create_slice(self, hrn, rspec):
150         
151         # check our slice policy before we procede
152         whitelist = self.policy['slice_whitelist']     
153         blacklist = self.policy['slice_blacklist']
154        
155         if whitelist and hrn not in whitelist or \
156            blacklist and hrn in blacklist:
157             policy_file = self.policy.policy_file
158             print >> log, "Slice %(hrn)s not allowed by policy %(policy_file)s" % locals()
159             return 1
160
161         if self.api.interface in ['aggregate']:     
162             self.create_slice_aggregate(hrn, rspec)
163         elif self.api.interface in ['slicemgr']:
164             self.create_slice_smgr(hrn, rspec)
165
166     def create_slice_aggregate(self, hrn, rspec):
167
168         # Determine if this is a peer slice
169         peer = self.get_peer(hrn)
170
171         spec = Rspec(rspec)
172         # Get the slice record from sfa
173         slice = {}
174         slice_record = None
175         registries = Registries(self.api)
176         registry = registries[self.api.hrn]
177         credential = self.api.getCredential()
178         slice_records = registry.resolve(credential, hrn)
179         for record in slice_records:
180             if record.get_type() in ['slice']:
181                 slice_record = record.as_dict()
182         if not slice_record:
183             raise RecordNotFound(hrn)  
184
185         # Get the slice's site record
186         authority = get_authority(hrn)
187         site_records = registry.resolve(credential, authority)
188         site = {}
189         for site_record in site_records:
190             if site_record.get_type() in ['authority']:
191                 site = site_record.as_dict()
192         if not site:
193             raise RecordNotFound(authority)
194         remote_site_id = site.pop('site_id')
195             
196         # Make sure slice exists at plc, if it doesnt add it
197         slicename = hrn_to_pl_slicename(hrn)
198         slices = self.api.plshell.GetSlices(self.api.plauth, [slicename], ['slice_id', 'node_ids', 'site_id'] )
199         parts = slicename.split("_")
200         login_base = parts[0]
201         # if site doesnt exist add it
202         sites = self.api.plshell.GetSites(self.api.plauth, [login_base])
203         if not slices:
204             if not sites:
205                 # add the site
206                 site_id = self.api.plshell.AddSite(self.api.plauth, site)
207                 # this belongs to a peer 
208                 if peer:
209                     self.api.plshell.BindObjectToPeer(self.api.plauth, 'site', site_id, peer, remote_site_id)
210             else:
211                 site_id = sites[0]['site_id']
212                 remote_site_id = sites[0]['peer_site_id']
213             
214             # create slice object
215             slice_fields = {}
216             slice_keys = ['name', 'url', 'description']
217             for key in slice_keys:
218                 if key in slice_record and slice_record[key]:
219                     slice_fields[key] = slice_record[key]
220
221             # add the slice  
222             slice_id = self.api.plshell.AddSlice(self.api.plauth, slice_fields)
223             slice = slice_fields
224             
225             #this belongs to a peer
226             if peer:
227                 self.api.plshell.BindObjectToPeer(self.api.plauth, 'slice', slice_id, peer, slice_record['pointer'])
228             slice['node_ids'] = []
229         else:
230             slice = slices[0]
231             slice_id = slice['slice_id']
232             site_id = slice['site_id']    
233             remote_site_id = sites[0]['peer_site_id']
234         # get the list of valid slice users from the registry and make 
235         # they are added to the slice 
236         researchers = record.get('researcher', [])
237         for researcher in researchers:
238             person_record = {}
239             person_records = registry.resolve(credential, researcher)
240             for record in person_records:
241                 if record.get_type() in ['user']:
242                     person_record = record
243             if not person_record:
244                 pass
245             person_dict = person_record.as_dict()
246             persons = self.api.plshell.GetPersons(self.api.plauth, [person_dict['email']], ['person_id', 'key_ids'])
247
248             # Create the person record 
249             if not persons:
250                 person_id=self.api.plshell.AddPerson(self.api.plauth, person_dict)
251
252                 # The line below enables the user account on the remote 
253                 # aggregate soon after it is created. without this the 
254                 # user key is not transfered to the slice (as GetSlivers 
255                 # returns key of only enabled users), which prevents the 
256                 # user from login to the slice. We may do additional checks 
257                 # before enabling the user.
258
259                 self.api.plshell.UpdatePerson(self.api.plauth, person_id, {'enabled' : True})
260                 if peer:
261                     self.api.plshell.BindObjectToPeer(self.api.plauth, 'person', person_id, peer, person_dict['pointer'])
262                 key_ids = []
263             else:
264                 person_id = persons[0]['person_id'] 
265                 key_ids = persons[0]['key_ids']
266
267             # if this is a peer person, we must unbind them from the peer or PLCAPI will throw
268             # an error
269             if peer:
270                 self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'person', person_id, peer)
271                 self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'site', site_id,  peer)
272
273             self.api.plshell.AddPersonToSlice(self.api.plauth, person_dict['email'], slicename)
274             self.api.plshell.AddPersonToSite(self.api.plauth, person_dict['email'], site_id)   
275             if peer:
276                 self.api.plshell.BindObjectToPeer(self.api.plauth, 'person', person_id, peer, person_dict['pointer'])
277                 self.api.plshell.BindObjectToPeer(self.api.plauth, 'site', site_id, peer, remote_site_id) 
278
279             # Get this users local keys
280             keylist = self.api.plshell.GetKeys(self.api.plauth, key_ids, ['key'])
281             keys = [key['key'] for key in keylist]
282
283             # add keys that arent already there 
284             key_ids=person_dict['key_ids']
285             for personkey in person_dict['keys']:
286                 if personkey not in keys:
287                     key = {'key_type': 'ssh', 'key': personkey}
288                     if peer:
289                         self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'person', person_id, peer)
290                     key_id=self.api.plshell.AddPersonKey(self.api.plauth, person_dict['email'], key)
291                     if peer:
292                         self.api.plshell.BindObjectToPeer(self.api.plauth, 'person', person_id, peer, person_dict['pointer'])
293                         # BindObjectToPeer may faill if type is key and it's already bound to the peer
294                         # so lets just put a try/except here
295                         try: self.api.plshell.BindObjectToPeer(self.api.plauth, 'key', key_id, peer, key_ids.pop(0))
296                         except: pass
297
298         # find out where this slice is currently running
299         nodelist = self.api.plshell.GetNodes(self.api.plauth, slice['node_ids'], ['hostname'])
300         hostnames = [node['hostname'] for node in nodelist]
301
302         # get netspec details
303         nodespecs = spec.getDictsByTagName('NodeSpec')
304         nodes = []
305         for nodespec in nodespecs:
306             if isinstance(nodespec['name'], list):
307                 nodes.extend(nodespec['name'])
308             elif isinstance(nodespec['name'], StringTypes):
309                 nodes.append(nodespec['name'])
310
311         # remove nodes not in rspec
312         deleted_nodes = list(set(hostnames).difference(nodes))
313         # add nodes from rspec
314         added_nodes = list(set(nodes).difference(hostnames))
315
316         if peer:
317             self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'slice', slice_id, peer)
318         self.api.plshell.AddSliceToNodes(self.api.plauth, slicename, added_nodes) 
319         self.api.plshell.DeleteSliceFromNodes(self.api.plauth, slicename, deleted_nodes)
320         if peer:
321             self.api.plshell.BindObjectToPeer(self.api.plauth, 'slice', slice_id, peer, slice_record['pointer'])
322
323         return 1
324
325     def create_slice_smgr(self, hrn, rspec):
326         spec = Rspec()
327         tempspec = Rspec()
328         spec.parseString(rspec)
329         slicename = hrn_to_pl_slicename(hrn)
330         specDict = spec.toDict()
331         if specDict.has_key('Rspec'): specDict = specDict['Rspec']
332         if specDict.has_key('start_time'): start_time = specDict['start_time']
333         else: start_time = 0
334         if specDict.has_key('end_time'): end_time = specDict['end_time']
335         else: end_time = 0
336
337         rspecs = {}
338         aggregates = Aggregates(self.api)
339         credential = self.api.getCredential()
340
341         # split the netspecs into individual rspecs
342         netspecs = spec.getDictsByTagName('NetSpec')
343         for netspec in netspecs:
344             net_hrn = netspec['name']
345             resources = {'start_time': start_time, 'end_time': end_time, 'networks': netspec}
346             resourceDict = {'Rspec': resources}
347             tempspec.parseDict(resourceDict)
348             rspecs[net_hrn] = tempspec.toxml()
349
350         # send each rspec to the appropriate aggregate/sm 
351         for net_hrn in rspecs:
352             try:
353                 # if we are directly connected to the aggregate then we can just send them the rspec
354                 # if not, then we may be connected to an sm thats connected to the aggregate  
355                 if net_hrn in aggregates:
356                     # send the whloe rspec to the local aggregate
357                     if net_hrn in [self.api.hrn]:
358                         aggregates[net_hrn].create_slice(credential, hrn, rspec, caller_cred=self.caller_cred)
359                     else:
360                         aggregates[net_hrn].create_slice(credential, hrn, rspecs[net_hrn], caller_cred=self.caller_cred)
361                 else:
362                     # lets forward this rspec to a sm that knows about the network    
363                     for aggregate in aggregates:
364                         network_found = aggregates[aggregate].get_aggregates(credential, net_hrn)
365                         if network_networks:
366                             aggregates[aggregate].create_slice(credential, hrn, rspecs[net_hrn], caller_cred=self.caller_cred)
367                      
368             except:
369                 print >> log, "Error creating slice %(hrn)s at aggregate %(net_hrn)s" % locals()
370                 traceback.print_exc()
371         return 1
372
373
374     def start_slice(self, hrn):
375         if self.api.interface in ['aggregate']:
376             self.start_slice_aggregate(hrn)
377         elif self.api.interface in ['slicemgr']:
378             self.start_slice_smgr(hrn)
379
380     def start_slice_aggregate(self, hrn):
381         slicename = hrn_to_pl_slicename(hrn)
382         slices = self.api.plshell.GetSlices(self.api.plauth, {'name': slicename}, ['slice_id'])
383         if not slices:
384             raise RecordNotFound(hrn)
385         slice_id = slices[0]
386         attributes = self.api.plshell.GetSliceAttributes(self.api.plauth, {'slice_id': slice_id, 'name': 'enabled'}, ['slice_attribute_id'])
387         attribute_id = attreibutes[0]['slice_attribute_id']
388         self.api.plshell.UpdateSliceAttribute(self.api.plauth, attribute_id, "1" )
389         return 1
390
391     def start_slice_smgr(self, hrn):
392         credential = self.api.getCredential()
393         aggregates = Aggregates(self.api)
394         for aggregate in aggregates:
395             aggregates[aggregate].start_slice(credential, hrn)
396         return 1
397
398
399     def stop_slice(self, hrn):
400         if self.api.interface in ['aggregate']:
401             self.stop_slice_aggregate(hrn)
402         elif self.api.interface in ['slicemgr']:
403             self.stop_slice_smgr(hrn)
404
405     def stop_slice_aggregate(self, hrn):
406         slicename = hrn_to_pl_slicename(hrn)
407         slices = self.api.plshell.GetSlices(self.api.plauth, {'name': slicename}, ['slice_id'])
408         if not slices:
409             raise RecordNotFound(hrn)
410         slice_id = slices[0]['slice_id']
411         attributes = self.api.plshell.GetSliceAttributes(self.api.plauth, {'slice_id': slice_id, 'name': 'enabled'}, ['slice_attribute_id'])
412         attribute_id = attributes[0]['slice_attribute_id']
413         self.api.plshell.UpdateSliceAttribute(self.api.plauth, attribute_id, "0")
414         return 1
415
416     def stop_slice_smgr(self, hrn):
417         credential = self.api.getCredential()
418         aggregates = Aggregates(self.api)
419         for aggregate in aggregates:
420             aggregates[aggregate].stop_slice(credential, hrn)  
421