geni/aggregate.py

   1 import os
   2 import sys
   3 import datetime
   4 import time
   5 import xmlrpclib
   6
   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
  18
  19 class Aggregate(GeniServer):
  20
  21     hrn = None
  22     nodes_ttl = None
  23     nodes = None
  24     slices = None
  25     policy = None
  26     timestamp = None
  27     threshold = None
  28     shell = None
  29     registry = None
  30     key_file = None
  31     cert_file = None
  32     credential = None
  33
  34     ##
  35     # Create a new aggregate object.
  36     #
  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)
  41
  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
  50
  51         nodes_file = os.sep.join([self.server_basedir, 'agg.' + self.hrn + '.components'])
  52         self.nodes = SimpleStorage(nodes_file)
  53         self.nodes.load()
  54
  55         slices_file = os.sep.join([self.server_basedir, 'agg.' + self.hrn + '.slices'])
  56         self.slices = SimpleStorage(slices_file)
  57         self.slices.load()
  58
  59         policy_file = os.sep.join([self.server_basedir, 'agg.' + self.hrn + '.policy'])
  60         self.policy = SimpleStorage(policy_file, {'whitelist': [], 'blacklist': []})
  61         self.policy.load()
  62
  63         timestamp_file = os.sep.join([self.server_basedir, 'agg.' + self.hrn + '.timestamp'])
  64         self.timestamp = SimpleStorage(timestamp_file)
  65
  66         # How long before we refresh nodes cache
  67         self.nodes_ttl = 1
  68
  69         self.connectPLC()
  70         #self.connectRegistry()
  71         #self.loadCredential()
  72
  73     def connectRegistry(self):
  74         """
  75         Connect to the registry
  76         """
  77         # connect to registry using GeniClient
  78         address = self.config.GENI_REGISTRY_HOSTNAME
  79         port = self.config.GENI_REGISTRY_PORT
  80         url = 'https://%(address)s:%(port)s' % locals()
  81         self.registry = GeniClient(url, self.key_file, self.cert_file)
  82
  83
  84     def connectPLC(self):
  85         """
  86         Connect to the plc api interface. First attempt to impor thte shell, if that fails
  87         try to connect to the xmlrpc server.
  88         """
  89         self.auth = {'Username': self.config.GENI_PLC_USER,
  90                      'AuthMethod': 'password',
  91                      'AuthString': self.config.GENI_PLC_PASSWORD}
  92
  93         try:
  94            # try to import PLC.Shell directly
  95             sys.path.append(self.config.GENI_PLC_SHELL_PATH)
  96             import PLC.Shell
  97             self.shell = PLC.Shell.Shell(globals())
  98             self.shell.AuthCheck()
  99         except ImportError:
 100             # connect to plc api via xmlrpc
 101             plc_host = self.config.GENI_PLC_HOST
 102             plc_port = self.config.GENI_PLC_PORT
 103             plc_api_path = self.config.GENI_PLC_API_PATH
 104             url = "https://%(plc_host)s:%(plc_port)s/%(plc_api_path)s/" % locals()
 105             self.auth = {'Username': self.config.GENI_PLC_USER,
 106                  'AuthMethod': 'password',
 107                  'AuthString': self.config.GENI_PLC_PASSWORD}
 108
 109             self.shell = xmlrpclib.Server(url, verbose = 0, allow_none = True)
 110             self.shell.AuthCheck(self.auth)
 111
 112     def loadCredential(self):
 113         """
 114         Attempt to load credential from file if it exists. If it doesnt get
 115         credential from registry.
 116         """
 117
 118         self_cred_filename = self.server_basedir + os.sep + "agg." + self.hrn + ".cred"
 119         ma_cred_filename = self.server_basedir + os.sep + "agg." + self.hrn + ".ma.cred"
 120
 121         # see if this file exists
 122         try:
 123             cred = Credential(filename = ma_cred_filename, subject=self.hrn)
 124             self.credential = cred.save_to_string()
 125         except IOError:
 126             # get self credential
 127             self_cred = self.registry.get_credential(None, 'ma', self.hrn)
 128             self_credential = Credential(string = self_cred)
 129             self_credential.save_to_file(self_cred_filename)
 130
 131             # get ma credential
 132             ma_cred = self.registry.get_credential(self_cred)
 133             ma_credential = Credential(string = ma_cred)
 134             ma_credential.save_to_file(ma_cred_filename)
 135             self.credential = ma_cred
 136
 137     def hostname_to_hrn(self, login_base, hostname):
 138         """
 139         Convert hrn to plantelab name.
 140         """
 141         genihostname = "_".join(hostname.split("."))
 142         return ".".join([self.hrn, login_base, genihostname])
 143
 144     def slicename_to_hrn(self, slicename):
 145         """
 146         Convert hrn to planetlab name.
 147         """
 148         slicename = slicename.replace("_", ".")
 149         return ".".join([self.hrn, slicename])
 150
 151     def refresh_components(self):
 152         """
 153         Update the cached list of nodes and save in 4 differnt formats
 154         (rspec, dns, ip)
 155         """
 156
 157         # get node list in rspec format
 158         rspec = Rspec()
 159         rspec.parseString(self.get_rspec(self.hrn, 'aggregate'))
 160
 161         # filter nodes according to policy
 162         rspec.filter('NodeSpec', 'name', blacklist=self.policy['blacklist'], whitelist=self.policy['whitelist'])
 163
 164         # extract ifspecs from rspec to get ip's
 165         ips = []
 166         ifspecs = rspec.getDictsByTagName('IfSpec')
 167         for ifspec in ifspecs:
 168             if ifspec.has_key('addr') and ifspec['addr']:
 169                 ips.append(ifspec['addr'])
 170
 171         # extract nodespecs from rspec to get dns names
 172         hostnames = []
 173         nodespecs = rspec.getDictsByTagName('NodeSpec')
 174         for nodespec in nodespecs:
 175             if nodespec.has_key('name') and nodespec['name']:
 176                 hostnames.append(nodespec['name'])
 177
 178
 179         node_details = {}
 180         node_details['rspec'] = rspec.toxml()
 181         node_details['ip'] = ips
 182         node_details['dns'] = hostnames
 183         # save state
 184         self.nodes = SimpleStorage(self.nodes.db_filename, node_details)
 185         self.nodes.write()
 186
 187
 188         # update timestamp and threshold
 189         self.timestamp['timestamp'] =  datetime.datetime.now()
 190         delta = datetime.timedelta(hours=self.nodes_ttl)
 191         self.threshold = self.timestamp['timestamp'] + delta
 192         self.timestamp.write()
 193
 194     def load_components(self):
 195         """
 196         Read cached list of nodes.
 197         """
 198         # Read component list from cached file
 199         self.nodes.load()
 200         self.timestamp.load()
 201         time_format = "%Y-%m-%d %H:%M:%S"
 202         timestamp = self.timestamp['timestamp']
 203         self.timestamp['timestamp'] = datetime.datetime.fromtimestamp(time.mktime(time.strptime(timestamp, time_format)))
 204         delta = datetime.timedelta(hours=self.nodes_ttl)
 205         self.threshold = self.timestamp['timestamp'] + delta
 206
 207     def load_policy(self):
 208         """
 209         Read the list of blacklisted and whitelisted nodes.
 210         """
 211         self.policy.load()
 212
 213
 214     def getNodes(self, format = 'rspec'):
 215         """
 216         Return a list of components at this aggregate.
 217         """
 218         valid_formats = ['rspec', 'hrn', 'dns', 'ip']
 219         if not format:
 220             format = 'rspec'
 221         if format not in valid_formats:
 222             raise Exception, "Invalid format specified, must be one of the following: %s" \
 223                              % ", ".join(valid_formats)
 224
 225         # Reload components list
 226         now = datetime.datetime.now()
 227         #self.load_components()
 228         if not self.threshold or not self.timestamp['timestamp'] or now > self.threshold:
 229             self.refresh_components()
 230         elif now < self.threshold and not self.nodes.keys():
 231             self.load_components()
 232         return self.nodes[format]
 233
 234     def getSlices(self):
 235         """
 236         Return a list of instnatiated managed by this slice manager.
 237         """
 238
 239         slices = self.shell.GetSlices(self.auth, {}, ['name'])
 240         slice_hrns = [self.slicename_to_hrn(slice['name']) for slice in slices]
 241
 242         return slice_hrns
 243
 244     def get_rspec(self, hrn, type):
 245         """
 246         Get resource information from PLC
 247         """
 248
 249         # Get the required nodes
 250         if type in ['aggregate']:
 251             nodes = self.shell.GetNodes(self.auth)
 252         elif type in ['slice']:
 253             slicename = hrn_to_pl_slicename(hrn)
 254             slices = self.shell.GetSlices(self.auth, [slicename])
 255             node_ids = slices[0]['node_ids']
 256             nodes = self.shell.GetNodes(self.auth, node_ids)
 257
 258         # Filter out whitelisted nodes
 259         public_nodes = lambda n: n.has_key('slice_ids_whitelist') and not n['slice_ids_whitelist']
 260         nodes = filter(public_nodes, nodes)
 261
 262         # Get all network interfaces
 263         interface_ids = []
 264         for node in nodes:
 265             interface_ids.extend(node['nodenetwork_ids'])
 266         interfaces = self.shell.GetNodeNetworks(self.auth, interface_ids)
 267         interface_dict = {}
 268         for interface in interfaces:
 269             interface_dict[interface['nodenetwork_id']] = interface
 270
 271         # join nodes with thier interfaces
 272         for node in nodes:
 273             node['interfaces'] = []
 274             for nodenetwork_id in node['nodenetwork_ids']:
 275                 node['interfaces'].append(interface_dict[nodenetwork_id])
 276
 277         # convert and threshold to ints
 278         if self.timestamp.has_key('timestamp') and self.timestamp['timestamp']:
 279             timestamp = self.timestamp['timestamp']
 280             threshold = self.threshold
 281         else:
 282             timestamp = datetime.datetime.now()
 283             delta = datetime.timedelta(hours=self.nodes_ttl)
 284             threshold = timestamp + delta
 285
 286
 287         start_time = int(timestamp.strftime("%s"))
 288         end_time = int(threshold.strftime("%s"))
 289         duration = end_time - start_time
 290
 291         # create the plc dict
 292         networks = [{'nodes': nodes, 'name': self.hrn, 'start_time': start_time, 'duration': duration}]
 293         resources = {'networks': networks, 'start_time': start_time, 'duration': duration}
 294
 295         # convert the plc dict to an rspec dict
 296         resourceDict = RspecDict(resources)
 297         # convert the rspec dict to xml
 298         rspec = Rspec()
 299         rspec.parseDict(resourceDict)
 300         return rspec.toxml()
 301
 302     def getResources(self, slice_hrn):
 303         """
 304         Return the current rspec for the specified slice.
 305         """
 306         rspec = self.get_rspec(slice_hrn, 'slice')
 307
 308         return rspec
 309
 310
 311     def getTicket(self, hrn, rspec):
 312         """
 313         Retrieve a ticket. This operation is currently implemented on PLC
 314         only (see SFA, engineering decisions); it is not implemented on
 315         components.
 316
 317         @param name name of the slice to retrieve a ticket for
 318         @param rspec resource specification dictionary
 319         @return the string representation of a ticket object
 320         """
 321         #self.registry.get_ticket(name, rspec)
 322
 323         return
 324
 325
 326     def createSlice(self, slice_hrn, rspec, attributes = []):
 327         """
 328         Instantiate the specified slice according to whats defined in the rspec.
 329         """
 330
 331         spec = Rspec(rspec)
 332         # save slice state locally
 333         # we can assume that spec object has been validated so its safer to
 334         # save this instead of the unvalidated rspec the user gave us
 335         self.slices[slice_hrn] = spec.toxml()
 336         self.slices.write()
 337
 338         # Get slice info
 339         slicename = hrn_to_pl_slicename(slice_hrn)
 340         slices = self.shell.GetSlices(self.auth, [slicename], ['node_ids'])
 341         if not slices:
 342             raise RecordNotFound(slice_hrn)
 343         slice = slices[0]
 344
 345         # find out where this slice is currently running
 346         nodes = self.shell.GetNodes(self.auth, slice['node_ids'], ['hostname'])
 347         hostnames = [node['hostname'] for node in nodes]
 348
 349         # get netspec details
 350         nodespecs = spec.getDictsByTagName('NodeSpec')
 351         nodes = [nodespec['name'] for nodespec in nodespecs]
 352
 353         # save slice state locally
 354         # we can assume that spec object has been validated so its safer to
 355         # save this instead of the unvalidated rspec the user gave us
 356         self.slices[slice_hrn] = spec.toxml()
 357         self.slices.write()
 358
 359         # remove nodes not in rspec
 360         deleted_nodes = list(set(hostnames).difference(nodes))
 361         # add nodes from rspec
 362         added_nodes = list(set(nodes).difference(hostnames))
 363
 364         self.shell.AddSliceToNodes(self.auth, slicename, added_nodes)
 365         self.shell.DeleteSliceFromNodes(self.auth, slicename, deleted_nodes)
 366
 367         for attribute in attributes:
 368             type, value, node, nodegroup = attribute['type'], attribute['value'], attribute['node'], attribute['nodegroup']
 369             self.shell.AddSliceAttribute(self.auth, slicename, type, value, node, nodegroup)
 370
 371         # contact registry to get slice users and add them to the slice
 372         #slice_record = self.registry.resolve(self.credential, slice_hrn)
 373         # persons = slice_record['users']
 374
 375         #for person in persons:
 376         #    shell.AddPersonToSlice(person['email'], slice_name)
 377         return 1
 378
 379     def updateSlice(self, slice_hrn, rspec, attributes = []):
 380         return self.create_slice(slice_hrn, rspec, attributes)
 381
 382     def deleteSlice(self, slice_hrn):
 383         """
 384         Remove this slice from all components it was previouly associated with and
 385         free up the resources it was using.
 386         """
 387         if self.slices.has_key(slice_hrn):
 388             self.slices.pop(slice_hrn)
 389             self.slices.write()
 390
 391         slicename = hrn_to_pl_slicename(slice_hrn)
 392         slices = self.shell.GetSlices(self.auth, [slicename])
 393         if not slices:
 394             return 1
 395         slice = slices[0]
 396
 397         self.shell.DeleteSliceFromNodes(self.auth, slicename, slice['node_ids'])
 398         return 1
 399
 400     def startSlice(self, slice_hrn):
 401         """
 402         Stop the slice at plc.
 403         """
 404         slicename = hrn_to_pl_slicename(slice_hrn)
 405         slices = self.shell.GetSlices(self.auth, {'name': slicename}, ['slice_id'])
 406         if not slices:
 407             #raise RecordNotFound(slice_hrn)
 408             return 1
 409         slice_id = slices[0]
 410         atrribtes = self.shell.GetSliceAttributes({'slice_id': slice_id, 'name': 'enabled'}, ['slice_attribute_id'])
 411         attribute_id = attreibutes[0]
 412         self.shell.UpdateSliceAttribute(self.auth, attribute_id, "1" )
 413         return 1
 414
 415     def stopSlice(self, slice_hrn):
 416         """
 417         Stop the slice at plc
 418         """
 419         slicename = hrn_to_pl_slicename(slice_hrn)
 420         slices = self.shell.GetSlices(self.auth, {'name': slicename}, ['slice_id'])
 421         if not slices:
 422             #raise RecordNotFound(slice_hrn)
 423             return 1
 424         slice_id = slices[0]
 425         atrribtes = self.shell.GetSliceAttributes({'slice_id': slice_id, 'name': 'enabled'}, ['slice_attribute_id'])
 426         attribute_id = attreibutes[0]
 427         self.shell.UpdateSliceAttribute(self.auth, attribute_id, "0")
 428         return 1
 429
 430
 431     def resetSlice(self, slice_hrn):
 432         """
 433         Reset the slice
 434         """
 435         # XX not yet implemented
 436         return 1
 437
 438     def getPolicy(self):
 439         """
 440         Return this aggregates policy.
 441         """
 442
 443         return self.policy
 444
 445
 446
 447 ##############################
 448 ## Server methods here for now
 449 ##############################
 450
 451
 452     # XX fix rights, should be function name defined in
 453     # privilege_table (from util/rights.py)
 454     def list_nodes(self, cred):
 455         self.decode_authentication(cred, 'listnodes')
 456         return self.getNodes()
 457
 458     def list_slices(self, cred):
 459         self.decode_authentication(cred, 'listslices')
 460         return self.getSlices()
 461
 462     def get_resources(self, cred, hrn):
 463         self.decode_authentication(cred, 'listnodes')
 464         return self.getResources(hrn)
 465
 466     def get_ticket(self, cred, hrn, rspec):
 467         self.decode_authentication(cred, 'getticket')
 468         return self.getTicket(hrn, rspec)
 469
 470     def get_policy(self, cred):
 471         self.decode_authentication(cred, 'getpolicy')
 472         return self.getPolicy()
 473
 474     def create_slice(self, cred, hrn, rspec):
 475         self.decode_authentication(cred, 'createslice')
 476         return self.createSlice(hrn, rspec)
 477
 478     def update_slice(self, cred, hrn, rspec):
 479         self.decode_authentication(cred, 'updateslice')
 480         return self.updateSlice(hrn)
 481
 482     def delete_slice(self, cred, hrn):
 483         self.decode_authentication(cred, 'deleteslice')
 484         return self.deleteSlice(hrn)
 485
 486     def start_slice(self, cred, hrn):
 487         self.decode_authentication(cred, 'startslice')
 488         return self.startSlice(hrn)
 489
 490     def stop_slice(self, cred, hrn):
 491         self.decode_authentication(cred, 'stopslice')
 492         return self.stopSlice(hrn)
 493
 494     def reset_slice(self, cred, hrn):
 495         self.decode_authentication(cred, 'resetslice')
 496         return self.resetSlice(hrn)
 497
 498     def register_functions(self):
 499         GeniServer.register_functions(self)
 500
 501         # Aggregate interface methods
 502         self.server.register_function(self.list_nodes)
 503         self.server.register_function(self.list_slices)
 504         self.server.register_function(self.get_resources)
 505         self.server.register_function(self.get_policy)
 506         self.server.register_function(self.create_slice)
 507         self.server.register_function(self.update_slice)
 508         self.server.register_function(self.delete_slice)
 509         self.server.register_function(self.start_slice)
 510         self.server.register_function(self.stop_slice)
 511         self.server.register_function(self.reset_slice)
 512