7 from geni.util.geniserver import GeniServer
8 from geni.util.geniclient import *
9 from geni.util.cert import Keypair, Certificate
10 from geni.util.credential import Credential
11 from geni.util.trustedroot import TrustedRootList
12 from geni.util.excep import *
13 from geni.util.misc import *
14 from geni.util.config import Config
15 from geni.util.rspec import Rspec
16 from geni.util.specdict import *
17 from geni.util.storage import SimpleStorage
19 class Aggregate(GeniServer):
35 # Create a new aggregate object.
37 # @param ip the ip address to listen on
38 # @param port the port to listen on
39 # @param key_file private key filename of registry
40 # @param cert_file certificate filename containing public key (could be a GID file)
42 def __init__(self, ip, port, key_file, cert_file, config = "/usr/share/geniwrapper/geni/util/geni_config"):
43 GeniServer.__init__(self, ip, port, key_file, cert_file)
44 self.key_file = key_file
45 self.cert_file = cert_file
46 self.config = Config(config)
47 self.basedir = self.config.GENI_BASE_DIR + os.sep
48 self.server_basedir = self.basedir + os.sep + "geni" + os.sep
49 self.hrn = self.config.GENI_INTERFACE_HRN
51 nodes_file = os.sep.join([self.server_basedir, 'agg.' + self.hrn + '.components'])
52 self.nodes = SimpleStorage(nodes_file)
55 slices_file = os.sep.join([self.server_basedir, 'agg.' + self.hrn + '.slices'])
56 self.slices = SimpleStorage(slices_file)
59 policy_file = os.sep.join([self.server_basedir, 'agg.' + self.hrn + '.policy'])
60 self.policy = SimpleStorage(policy_file, {'whitelist': [], 'blacklist': []})
63 timestamp_file = os.sep.join([self.server_basedir, 'agg.' + self.hrn + '.timestamp'])
64 self.timestamp = SimpleStorage(timestamp_file)
69 self.connectRegistry()
70 #self.loadCredential()
72 def connectRegistry(self):
74 Connect to the registry
76 # connect to registry using GeniClient
77 address = self.config.GENI_REGISTRY_HOSTNAME
78 port = self.config.GENI_REGISTRY_PORT
79 url = 'https://%(address)s:%(port)s' % locals()
80 self.registry = GeniClient(url, self.key_file, self.cert_file)
85 Connect to the plc api interface. First attempt to impor thte shell, if that fails
86 try to connect to the xmlrpc server.
88 self.auth = {'Username': self.config.GENI_PLC_USER,
89 'AuthMethod': 'password',
90 'AuthString': self.config.GENI_PLC_PASSWORD}
93 # try to import PLC.Shell directly
94 sys.path.append(self.config.GENI_PLC_SHELL_PATH)
96 self.shell = PLC.Shell.Shell(globals())
97 self.shell.AuthCheck()
99 # connect to plc api via xmlrpc
100 plc_host = self.config.GENI_PLC_HOST
101 plc_port = self.config.GENI_PLC_PORT
102 plc_api_path = self.config.GENI_PLC_API_PATH
103 url = "https://%(plc_host)s:%(plc_port)s/%(plc_api_path)s/" % locals()
104 self.auth = {'Username': self.config.GENI_PLC_USER,
105 'AuthMethod': 'password',
106 'AuthString': self.config.GENI_PLC_PASSWORD}
108 self.shell = xmlrpclib.Server(url, verbose = 0, allow_none = True)
109 self.shell.AuthCheck(self.auth)
111 def loadCredential(self):
113 Attempt to load credential from file if it exists. If it doesnt get
114 credential from registry.
117 self_cred_filename = self.server_basedir + os.sep + "agg." + self.hrn + ".cred"
118 ma_cred_filename = self.server_basedir + os.sep + "agg." + self.hrn + ".ma.cred"
120 # see if this file exists
122 cred = Credential(filename = ma_cred_filename, subject=self.hrn)
123 self.credential = cred.save_to_string()
125 # get self credential
126 self_cred = self.registry.get_credential(None, 'ma', self.hrn)
127 self_credential = Credential(string = self_cred)
128 self_credential.save_to_file(self_cred_filename)
131 ma_cred = self.registry.get_credential(self_cred)
132 ma_credential = Credential(string = ma_cred)
133 ma_credential.save_to_file(ma_cred_filename)
134 self.credential = ma_cred
136 def hostname_to_hrn(self, login_base, hostname):
138 Convert hrn to plantelab name.
140 genihostname = "_".join(hostname.split("."))
141 return ".".join([self.hrn, login_base, genihostname])
143 def slicename_to_hrn(self, slicename):
145 Convert hrn to planetlab name.
147 slicename = slicename.replace("_", ".")
148 return ".".join([self.hrn, slicename])
150 def refresh_components(self):
152 Update the cached list of nodes and save in 4 differnt formats
153 (rspec, dns, ip, hrn)
157 # get node list in rspec format
159 rspec.parseString(self.get_rspec(self.hrn, 'aggregate'))
160 # filter nodes according to policy
161 rspec.filter('NodeSpec', 'name', blacklist=self.policy['blacklist'], whitelist=self.policy['whitelist'])
162 # extract ifspec info to get ip's
164 ifspecs = rspec.getDictsByTagName('IfSpec')
165 for ifspec in ifspecs:
166 if ifspec.has_key('addr') and ifspec['addr']:
167 ips.append(ifspec['addr'])
169 # resolve component hostnames
170 nodes = self.shell.GetNodes(self.auth, {}, ['hostname', 'site_id', 'slice_ids_whitelist'])
172 # resolve site login_bases
173 site_ids = [node['site_id'] for node in nodes]
174 sites = self.shell.GetSites(self.auth, site_ids, ['site_id', 'login_base'])
177 site_dict[site['site_id']] = site['login_base']
179 # filter nodes according to policy policy
180 # filter nodes with whitelist
181 # convert plc names to geni hrn
184 node_hrn = self.hostname_to_hrn(site_dict[node['site_id']], node['hostname'])
185 # filter nodes with a whitelist
186 if node.has_key('slice_ids_whitelist') and node['slice_ids_whitelist']:
188 # Do not allow nodes not found in whitelist policy
189 if self.policy['whitelist'] and node_hrn not in self.polciy['whitelist']:
191 # Do not allow nodes found in blacklist policy
192 if self.policy['blacklist'] and node_hrn in self.policy['blacklist']:
194 nodedict[node_hrn] = node['hostname']
197 node_details['rspec'] = rspec.toxml()
198 node_details['hrn'] = nodedict.keys()
199 node_details['dns'] = nodedict.values()
200 node_details['ip'] = ips
202 self.nodes = SimpleStorage(self.nodes.db_filename, node_details)
206 # update timestamp and threshold
207 self.timestamp['timestamp'] = datetime.datetime.now()
208 delta = datetime.timedelta(hours=self.nodes_ttl)
209 self.threshold = self.timestamp['timestamp'] + delta
210 self.timestamp.write()
212 def load_components(self):
214 Read cached list of nodes.
216 # Read component list from cached file
218 self.timestamp.load()
219 time_format = "%Y-%m-%d %H:%M:%S"
220 timestamp = self.timestamp['timestamp']
221 self.timestamp['timestamp'] = datetime.datetime.fromtimestamp(time.mktime(time.strptime(timestamp, time_format)))
222 delta = datetime.timedelta(hours=self.nodes_ttl)
223 self.threshold = self.timestamp['timestamp'] + delta
225 def load_policy(self):
227 Read the list of blacklisted and whitelisted nodes.
232 def getNodes(self, format = 'rspec'):
234 Return a list of components at this aggregate.
236 valid_formats = ['rspec', 'hrn', 'dns', 'ip']
239 if format not in valid_formats:
240 raise Exception, "Invalid format specified, must be one of the following: %s" \
241 % ", ".join(valid_formats)
243 # Reload components list
244 now = datetime.datetime.now()
245 #self.load_components()
246 if not self.threshold or not self.timestamp['timestamp'] or now > self.threshold:
247 self.refresh_components()
248 elif now < self.threshold and not self.nodes.keys():
249 self.load_components()
250 return self.nodes[format]
252 def getSlices(self, hrn):
254 Return a list of instnatiated managed by this slice manager.
257 # XX list only the slices at the specfied hrn
258 return dict(self.slices)
260 def get_rspec(self, hrn, type):
262 Get resource information from PLC
265 # Get the required nodes
266 if type in ['aggregate']:
267 nodes = self.shell.GetNodes(self.auth)
268 elif type in ['slice']:
269 slicename = hrn_to_pl_slicename(hrn)
270 slices = self.shell.GetSlices(self.auth, [slicename])
271 node_ids = slices[0]['node_ids']
272 nodes = self.shell.GetNodes(self.auth, node_ids)
274 # Filter out whitelisted nodes
275 public_nodes = lambda n: n.has_key('slice_ids_whitelist') and not n['slice_ids_whitelist']
276 nodes = filter(public_nodes, nodes)
278 # Get all network interfaces
281 interface_ids.extend(node['nodenetwork_ids'])
282 interfaces = self.shell.GetNodeNetworks(self.auth, interface_ids)
284 for interface in interfaces:
285 interface_dict[interface['nodenetwork_id']] = interface
287 # join nodes with thier interfaces
289 node['interfaces'] = []
290 for nodenetwork_id in node['nodenetwork_ids']:
291 node['interfaces'].append(interface_dict[nodenetwork_id])
293 # convert and threshold to ints
294 if self.timestamp.has_key('timestamp') and self.timestamp['timestamp']:
295 timestamp = self.timestamp['timestamp']
296 threshold = self.threshold
298 timestamp = datetime.datetime.now()
299 delta = datetime.timedelta(hours=self.nodes_ttl)
300 threshold = timestamp + delta
303 start_time = int(timestamp.strftime("%s"))
304 end_time = int(threshold.strftime("%s"))
305 duration = end_time - start_time
307 # create the plc dict
308 networks = [{'nodes': nodes, 'name': self.hrn, 'start_time': start_time, 'duration': duration}]
309 resources = {'networks': networks, 'start_time': start_time, 'duration': duration}
311 # convert the plc dict to an rspec dict
312 resourceDict = RspecDict(resources)
313 # convert the rspec dict to xml
315 rspec.parseDict(resourceDict)
318 def getResources(self, slice_hrn):
320 Return the current rspec for the specified slice.
322 rspec = self.get_rspec(slice_hrn, 'slice')
327 def createSlice(self, slice_hrn, rspec, attributes = []):
329 Instantiate the specified slice according to whats defined in the rspec.
333 # save slice state locally
334 # we can assume that spec object has been validated so its safer to
335 # save this instead of the unvalidated rspec the user gave us
336 self.slices[slice_hrn] = spec.toxml()
340 slicename = hrn_to_pl_slicename(slice_hrn)
341 slices = self.shell.GetSlices(self.auth, [slicename], ['node_ids'])
343 raise RecordNotFound(slice_hrn)
346 # find out where this slice is currently running
347 nodes = self.shell.GetNodes(self.auth, slice['node_ids'], ['hostname'])
348 hostnames = [node['hostname'] for node in nodes]
350 # get netspec details
351 nodespecs = spec.getDictsByTagName('NodeSpec')
352 nodes = [nodespec['name'] for nodespec in nodespecs]
354 # save slice state locally
355 # we can assume that spec object has been validated so its safer to
356 # save this instead of the unvalidated rspec the user gave us
357 self.slices[slice_hrn] = spec.toxml()
360 # remove nodes not in rspec
361 deleted_nodes = list(set(hostnames).difference(nodes))
362 # add nodes from rspec
363 added_nodes = list(set(nodes).difference(hostnames))
365 self.shell.AddSliceToNodes(self.auth, slicename, added_nodes)
366 self.shell.DeleteSliceFromNodes(self.auth, slicename, deleted_nodes)
368 for attribute in attributes:
369 type, value, node, nodegroup = attribute['type'], attribute['value'], attribute['node'], attribute['nodegroup']
370 self.shell.AddSliceAttribute(self.auth, slicename, type, value, node, nodegroup)
372 # contact registry to get slice users and add them to the slice
373 #slice_record = self.registry.resolve(self.credential, slice_hrn)
374 # persons = slice_record['users']
376 #for person in persons:
377 # shell.AddPersonToSlice(person['email'], slice_name)
380 def updateSlice(self, slice_hrn, rspec, attributes = []):
381 return self.create_slice(slice_hrn, rspec, attributes)
383 def deleteSlice(self, slice_hrn):
385 Remove this slice from all components it was previouly associated with and
386 free up the resources it was using.
388 if self.slices.has_key(slice_hrn):
389 self.slices.pop(slice_hrn)
392 slicename = hrn_to_pl_slicename(slice_hrn)
393 slices = self.shell.GetSlices(self.auth, [slicename])
398 self.shell.DeleteSliceFromNodes(self.auth, slicename, slice['node_ids'])
401 def startSlice(self, slice_hrn):
403 Stop the slice at plc.
405 slicename = hrn_to_pl_slicename(slice_hrn)
406 slices = self.shell.GetSlices(self.auth, {'name': slicename}, ['slice_id'])
408 #raise RecordNotFound(slice_hrn)
411 atrribtes = self.shell.GetSliceAttributes({'slice_id': slice_id, 'name': 'enabled'}, ['slice_attribute_id'])
412 attribute_id = attreibutes[0]
413 self.shell.UpdateSliceAttribute(self.auth, attribute_id, "1" )
416 def stopSlice(self, slice_hrn):
418 Stop the slice at plc
420 slicename = hrn_to_pl_slicename(slice_hrn)
421 slices = self.shell.GetSlices(self.auth, {'name': slicename}, ['slice_id'])
423 #raise RecordNotFound(slice_hrn)
426 atrribtes = self.shell.GetSliceAttributes({'slice_id': slice_id, 'name': 'enabled'}, ['slice_attribute_id'])
427 attribute_id = attreibutes[0]
428 self.shell.UpdateSliceAttribute(self.auth, attribute_id, "0")
432 def resetSlice(self, slice_hrn):
436 # XX not yet implemented
441 Return this aggregates policy.
448 ##############################
449 ## Server methods here for now
450 ##############################
453 # XX fix rights, should be function name defined in
454 # privilege_table (from util/rights.py)
455 def list_nodes(self, cred, format):
456 self.decode_authentication(cred, 'listnodes')
457 return self.getNodes(format)
459 def list_slices(self, cred, hrn):
460 self.decode_authentication(cred, 'listslices')
461 return self.getSlices(hrn)
463 def get_resources(self, cred, hrn):
464 self.decode_authentication(cred, 'listnodes')
465 return self.getResources(hrn)
467 def get_policy(self, cred):
468 self.decode_authentication(cred, 'getpolicy')
469 return self.getPolicy()
471 def create_slice(self, cred, hrn, rspec):
472 self.decode_authentication(cred, 'createslice')
473 return self.createSlice(hrn, rspec)
475 def update_slice(self, cred, hrn, rspec):
476 self.decode_authentication(cred, 'updateslice')
477 return self.updateSlice(hrn)
479 def delete_slice(self, cred, hrn):
480 self.decode_authentication(cred, 'deleteslice')
481 return self.deleteSlice(hrn)
483 def start_slice(self, cred, hrn):
484 self.decode_authentication(cred, 'startslice')
485 return self.startSlice(hrn)
487 def stop_slice(self, cred, hrn):
488 self.decode_authentication(cred, 'stopslice')
489 return self.stopSlice(hrn)
491 def reset_slice(self, cred, hrn):
492 self.decode_authentication(cred, 'resetslice')
493 return self.resetSlice(hrn)
495 def register_functions(self):
496 GeniServer.register_functions(self)
498 # Aggregate interface methods
499 self.server.register_function(self.list_nodes)
500 self.server.register_function(self.list_slices)
501 self.server.register_function(self.get_resources)
502 self.server.register_function(self.get_policy)
503 self.server.register_function(self.create_slice)
504 self.server.register_function(self.update_slice)
505 self.server.register_function(self.delete_slice)
506 self.server.register_function(self.start_slice)
507 self.server.register_function(self.stop_slice)
508 self.server.register_function(self.reset_slice)