Declare the correct schmea (ad/manifest/request) for ProtoGENI rspecs
[sfa.git] / sfa / managers / aggregate_manager_pl.py
1
2
3 import datetime
4 import time
5 import traceback
6 import sys
7 import re
8 from types import StringTypes
9
10 from sfa.util.faults import *
11 from sfa.util.xrn import get_authority, hrn_to_urn, urn_to_hrn, Xrn, urn_to_sliver_id
12 from sfa.util.plxrn import slicename_to_hrn, hrn_to_pl_slicename, hostname_to_urn
13 from sfa.util.rspec import *
14 from sfa.util.specdict import *
15 from sfa.util.record import SfaRecord
16 from sfa.util.policy import Policy
17 from sfa.util.record import *
18 from sfa.util.sfaticket import SfaTicket
19 from sfa.plc.slices import Slices
20 from sfa.trust.credential import Credential
21 import sfa.plc.peers as peers
22 from sfa.plc.network import *
23 from sfa.plc.api import SfaAPI
24 from sfa.plc.aggregate import Aggregate
25 from sfa.plc.slices import *
26 from sfa.util.version import version_core
27 from sfa.rspecs.version_manager import VersionManager
28 from sfa.rspecs.rspec import RSpec
29 from sfa.util.sfatime import utcparse
30 from sfa.util.callids import Callids
31
32 def GetVersion(api):
33
34     version_manager = VersionManager()
35     ad_rspec_versions = []
36     request_rspec_versions = []
37     for rspec_version in version_manager.versions:
38         if rspec_version in ['*', 'ad']:
39             request_rspec_versions.append(rspec_version.to_dict())
40         if rspec_version in ['*', 'request']:
41             request_rspec_version.append(rspec_version.to_dict()) 
42     default_rspec_version = version_manager.get_version("sfa 1").to_dict()
43     xrn=Xrn(api.hrn)
44     version_more = {'interface':'aggregate',
45                     'testbed':'myplc',
46                     'hrn':xrn.get_hrn(),
47                     'request_rspec_versions': request_rspec_versions,
48                     'ad_rspec_versions': ad_rspec_versions,
49                     'default_ad_rspec': default_rspec_version
50                     }
51     return version_core(version_more)
52
53 def __get_registry_objects(slice_xrn, creds, users):
54     """
55
56     """
57     hrn, type = urn_to_hrn(slice_xrn)
58
59     hrn_auth = get_authority(hrn)
60
61     # Build up objects that an SFA registry would return if SFA
62     # could contact the slice's registry directly
63     reg_objects = None
64
65     if users:
66         # dont allow special characters in the site login base
67         #only_alphanumeric = re.compile('[^a-zA-Z0-9]+')
68         #login_base = only_alphanumeric.sub('', hrn_auth[:20]).lower()
69         slicename = hrn_to_pl_slicename(hrn)
70         login_base = slicename.split('_')[0]
71         reg_objects = {}
72         site = {}
73         site['site_id'] = 0
74         site['name'] = 'geni.%s' % login_base 
75         site['enabled'] = True
76         site['max_slices'] = 100
77
78         # Note:
79         # Is it okay if this login base is the same as one already at this myplc site?
80         # Do we need uniqueness?  Should use hrn_auth instead of just the leaf perhaps?
81         site['login_base'] = login_base
82         site['abbreviated_name'] = login_base
83         site['max_slivers'] = 1000
84         reg_objects['site'] = site
85
86         slice = {}
87         
88         # get_expiration always returns a normalized datetime - no need to utcparse
89         extime = Credential(string=creds[0]).get_expiration()
90         # If the expiration time is > 60 days from now, set the expiration time to 60 days from now
91         if extime > datetime.datetime.utcnow() + datetime.timedelta(days=60):
92             extime = datetime.datetime.utcnow() + datetime.timedelta(days=60)
93         slice['expires'] = int(time.mktime(extime.timetuple()))
94         slice['hrn'] = hrn
95         slice['name'] = hrn_to_pl_slicename(hrn)
96         slice['url'] = hrn
97         slice['description'] = hrn
98         slice['pointer'] = 0
99         reg_objects['slice_record'] = slice
100
101         reg_objects['users'] = {}
102         for user in users:
103             user['key_ids'] = []
104             hrn, _ = urn_to_hrn(user['urn'])
105             user['email'] = hrn_to_pl_slicename(hrn) + "@geni.net"
106             user['first_name'] = hrn
107             user['last_name'] = hrn
108             reg_objects['users'][user['email']] = user
109
110         return reg_objects
111
112 def __get_hostnames(nodes):
113     hostnames = []
114     for node in nodes:
115         hostnames.append(node.hostname)
116     return hostnames
117
118 def SliverStatus(api, slice_xrn, creds, call_id):
119     if Callids().already_handled(call_id): return {}
120
121     (hrn, type) = urn_to_hrn(slice_xrn)
122     # find out where this slice is currently running
123     slicename = hrn_to_pl_slicename(hrn)
124     
125     slices = api.plshell.GetSlices(api.plauth, [slicename], ['slice_id', 'node_ids','person_ids','name','expires'])
126     if len(slices) == 0:        
127         raise Exception("Slice %s not found (used %s as slicename internally)" % (slice_xrn, slicename))
128     slice = slices[0]
129     
130     # report about the local nodes only
131     nodes = api.plshell.GetNodes(api.plauth, {'node_id':slice['node_ids'],'peer_id':None},
132                                  ['node_id', 'hostname', 'site_id', 'boot_state', 'last_contact'])
133     site_ids = [node['site_id'] for node in nodes]
134     sites = api.plshell.GetSites(api.plauth, site_ids, ['site_id', 'login_base'])
135     sites_dict = dict ( [ (site['site_id'],site['login_base'] ) for site in sites ] )
136
137     result = {}
138     top_level_status = 'unknown'
139     if nodes:
140         top_level_status = 'ready'
141     slice_urn = Xrn(slice_xrn, 'slice').get_urn()
142     result['geni_urn'] = slice_urn
143     result['pl_login'] = slice['name']
144     result['pl_expires'] = datetime.datetime.fromtimestamp(slice['expires']).ctime()
145     
146     resources = []
147     for node in nodes:
148         res = {}
149         res['pl_hostname'] = node['hostname']
150         res['pl_boot_state'] = node['boot_state']
151         res['pl_last_contact'] = node['last_contact']
152         if node['last_contact'] is not None:
153             res['pl_last_contact'] = datetime.datetime.fromtimestamp(node['last_contact']).ctime()
154         sliver_id = urn_to_sliver_id(slice_urn, slice['slice_id'], node['node_id']) 
155         res['geni_urn'] = sliver_id
156         if node['boot_state'] == 'boot':
157             res['geni_status'] = 'ready'
158         else:
159             res['geni_status'] = 'failed'
160             top_level_staus = 'failed' 
161             
162         res['geni_error'] = ''
163
164         resources.append(res)
165         
166     result['geni_status'] = top_level_status
167     result['geni_resources'] = resources
168     return result
169
170 def CreateSliver(api, slice_xrn, creds, rspec_string, users, call_id):
171     """
172     Create the sliver[s] (slice) at this aggregate.    
173     Verify HRN and initialize the slice record in PLC if necessary.
174     """
175     if Callids().already_handled(call_id): return ""
176
177     aggregate = Aggregate(api)
178     slices = Slices(api)
179     (hrn, type) = urn_to_hrn(slice_xrn)
180     peer = slices.get_peer(hrn)
181     sfa_peer = slices.get_sfa_peer(hrn)
182     slice_record=None    
183     if users:
184         slice_record = users[0].get('slice_record', {})
185
186     # parse rspec
187     rspec = RSpec(rspec_string)
188     requested_attributes = rspec.version.get_slice_attributes()
189     
190     # ensure site record exists
191     site = slices.verify_site(hrn, slice_record, peer, sfa_peer)
192     # ensure slice record exists
193     slice = slices.verify_slice(hrn, slice_record, peer, sfa_peer)
194     # ensure person records exists
195     persons = slices.verify_persons(hrn, slice, users, peer, sfa_peer)
196     # ensure slice attributes exists
197     slices.verify_slice_attributes(slice, requested_attributes)
198     
199     # add/remove slice from nodes
200     requested_slivers = [str(host) for host in rspec.version.get_nodes_with_slivers()]
201     slices.verify_slice_nodes(slice, requested_slivers, peer) 
202
203     # hanlde MyPLC peer association.
204     # only used by plc and ple.
205     slices.handle_peer(site, slice, persons, peer)
206     
207     return aggregate.get_rspec(slice_xrn=slice_xrn, version=rspec.version)
208
209
210 def RenewSliver(api, xrn, creds, expiration_time, call_id):
211     if Callids().already_handled(call_id): return True
212     (hrn, type) = urn_to_hrn(xrn)
213     slicename = hrn_to_pl_slicename(hrn)
214     slices = api.plshell.GetSlices(api.plauth, {'name': slicename}, ['slice_id'])
215     if not slices:
216         raise RecordNotFound(hrn)
217     slice = slices[0]
218     requested_time = utcparse(expiration_time)
219     record = {'expires': int(time.mktime(requested_time.timetuple()))}
220     try:
221         api.plshell.UpdateSlice(api.plauth, slice['slice_id'], record)
222         return True
223     except:
224         return False
225
226 def start_slice(api, xrn, creds):
227     hrn, type = urn_to_hrn(xrn)
228     slicename = hrn_to_pl_slicename(hrn)
229     slices = api.plshell.GetSlices(api.plauth, {'name': slicename}, ['slice_id'])
230     if not slices:
231         raise RecordNotFound(hrn)
232     slice_id = slices[0]['slice_id']
233     slice_tags = api.plshell.GetSliceTags(api.plauth, {'slice_id': slice_id, 'tagname': 'enabled'}, ['slice_tag_id'])
234     # just remove the tag if it exists
235     if slice_tags:
236         api.plshell.DeleteSliceTag(api.plauth, slice_tags[0]['slice_tag_id'])
237
238     return 1
239  
240 def stop_slice(api, xrn, creds):
241     hrn, type = urn_to_hrn(xrn)
242     slicename = hrn_to_pl_slicename(hrn)
243     slices = api.plshell.GetSlices(api.plauth, {'name': slicename}, ['slice_id'])
244     if not slices:
245         raise RecordNotFound(hrn)
246     slice_id = slices[0]['slice_id']
247     slice_tags = api.plshell.GetSliceTags(api.plauth, {'slice_id': slice_id, 'tagname': 'enabled'})
248     if not slice_tags:
249         api.plshell.AddSliceTag(api.plauth, slice_id, 'enabled', '0')
250     elif slice_tags[0]['value'] != "0":
251         tag_id = attributes[0]['slice_tag_id']
252         api.plshell.UpdateSliceTag(api.plauth, tag_id, '0')
253     return 1
254
255 def reset_slice(api, xrn):
256     # XX not implemented at this interface
257     return 1
258
259 def DeleteSliver(api, xrn, creds, call_id):
260     if Callids().already_handled(call_id): return ""
261     (hrn, type) = urn_to_hrn(xrn)
262     slicename = hrn_to_pl_slicename(hrn)
263     slices = api.plshell.GetSlices(api.plauth, {'name': slicename})
264     if not slices:
265         return 1
266     slice = slices[0]
267
268     # determine if this is a peer slice
269     peer = peers.get_peer(api, hrn)
270     try:
271         if peer:
272             api.plshell.UnBindObjectFromPeer(api.plauth, 'slice', slice['slice_id'], peer)
273         api.plshell.DeleteSliceFromNodes(api.plauth, slicename, slice['node_ids'])
274     finally:
275         if peer:
276             api.plshell.BindObjectToPeer(api.plauth, 'slice', slice['slice_id'], peer, slice['peer_slice_id'])
277     return 1
278
279 # xxx Thierry : caching at the aggregate level sounds wrong...
280 #caching=True
281 caching=False
282 def ListSlices(api, creds, call_id):
283     if Callids().already_handled(call_id): return []
284     # look in cache first
285     if caching and api.cache:
286         slices = api.cache.get('slices')
287         if slices:
288             return slices
289
290     # get data from db 
291     slices = api.plshell.GetSlices(api.plauth, {'peer_id': None}, ['name'])
292     slice_hrns = [slicename_to_hrn(api.hrn, slice['name']) for slice in slices]
293     slice_urns = [hrn_to_urn(slice_hrn, 'slice') for slice_hrn in slice_hrns]
294
295     # cache the result
296     if caching and api.cache:
297         api.cache.add('slices', slice_urns) 
298
299     return slice_urns
300     
301 def ListResources(api, creds, options,call_id):
302     if Callids().already_handled(call_id): return ""
303     # get slice's hrn from options
304     xrn = options.get('geni_slice_urn', None)
305     (hrn, type) = urn_to_hrn(xrn)
306
307     version_manager = VersionManager()
308     # get the rspec's return format from options
309     rspec_version = version_manager.get_version(options.get('rspec_version'))
310     version_string = "rspec_%s" % (rspec_version.to_string())
311
312     #panos adding the info option to the caching key (can be improved)
313     if options.get('info'):
314         version_string = version_string + "_"+options.get('info', 'default')
315
316     # look in cache first
317     if caching and api.cache and not xrn:
318         rspec = api.cache.get(version_string)
319         if rspec:
320             api.logger.info("aggregate.ListResources: returning cached value for hrn %s"%hrn)
321             return rspec 
322
323     #aggregate = Aggregate(api)
324     #panos: passing user-defined options
325     #print "manager options = ",options
326     aggregate = Aggregate(api, options)
327     rspec =  aggregate.get_rspec(slice_xrn=xrn, version=rspec_version)
328
329     # cache the result
330     if caching and api.cache and not xrn:
331         api.cache.add(version_string, rspec)
332
333     return rspec
334
335
336 def get_ticket(api, xrn, creds, rspec, users):
337
338     reg_objects = __get_registry_objects(xrn, creds, users)
339
340     slice_hrn, type = urn_to_hrn(xrn)
341     slices = Slices(api)
342     peer = slices.get_peer(slice_hrn)
343     sfa_peer = slices.get_sfa_peer(slice_hrn)
344
345     # get the slice record
346     registry = api.registries[api.hrn]
347     credential = api.getCredential()
348     records = registry.Resolve(xrn, credential)
349
350     # similar to CreateSliver, we must verify that the required records exist
351     # at this aggregate before we can issue a ticket
352     site_id, remote_site_id = slices.verify_site(registry, credential, slice_hrn,
353                                                  peer, sfa_peer, reg_objects)
354     slice = slices.verify_slice(registry, credential, slice_hrn, site_id,
355                                 remote_site_id, peer, sfa_peer, reg_objects)
356
357     # make sure we get a local slice record
358     record = None
359     for tmp_record in records:
360         if tmp_record['type'] == 'slice' and \
361            not tmp_record['peer_authority']:
362             record = SliceRecord(dict=tmp_record)
363     if not record:
364         raise RecordNotFound(slice_hrn)
365
366     # get sliver info
367     slivers = Slices(api).get_slivers(slice_hrn)
368     if not slivers:
369         raise SliverDoesNotExist(slice_hrn)
370
371     # get initscripts
372     initscripts = []
373     data = {
374         'timestamp': int(time.time()),
375         'initscripts': initscripts,
376         'slivers': slivers
377     }
378
379     # create the ticket
380     object_gid = record.get_gid_object()
381     new_ticket = SfaTicket(subject = object_gid.get_subject())
382     new_ticket.set_gid_caller(api.auth.client_gid)
383     new_ticket.set_gid_object(object_gid)
384     new_ticket.set_issuer(key=api.key, subject=api.hrn)
385     new_ticket.set_pubkey(object_gid.get_pubkey())
386     new_ticket.set_attributes(data)
387     new_ticket.set_rspec(rspec)
388     #new_ticket.set_parent(api.auth.hierarchy.get_auth_ticket(auth_hrn))
389     new_ticket.encode()
390     new_ticket.sign()
391
392     return new_ticket.save_to_string(save_parents=True)
393
394
395
396 def main():
397     api = SfaAPI()
398     """
399     rspec = ListResources(api, "plc.princeton.sapan", None, 'pl_test_sapan')
400     #rspec = ListResources(api, "plc.princeton.coblitz", None, 'pl_test_coblitz')
401     #rspec = ListResources(api, "plc.pl.sirius", None, 'pl_test_sirius')
402     print rspec
403     """
404     f = open(sys.argv[1])
405     xml = f.read()
406     f.close()
407     CreateSliver(api, "plc.princeton.sapan", xml, 'CreateSliver_sapan')
408
409 if __name__ == "__main__":
410     main()