1 from __future__ import with_statement
2 from sfa.util.faults import *
3 from sfa.util.namespace import *
4 from sfa.util.rspec import RSpec
5 from sfa.server.registry import Registries
6 from sfa.plc.nodes import *
9 from boto.ec2.regioninfo import RegionInfo
10 from boto.exception import EC2ResponseError
11 from ConfigParser import ConfigParser
12 from xmlbuilder import XMLBuilder
13 from lxml import etree as ET
14 from sqlobject import *
20 # The data structure used to represent a cloud.
21 # It contains the cloud name, its ip address, image information,
22 # key pairs, and clusters information.
27 # The location of the RelaxNG schema.
29 EUCALYPTUS_RSPEC_SCHEMA='/etc/sfa/eucalyptus.rng'
32 # A representation of an Eucalyptus instance. This is a support class
33 # for instance <-> slice mapping.
35 class EucaInstance(SQLObject):
36 instance_id = StringCol(unique=True, default=None)
37 kernel_id = StringCol()
38 image_id = StringCol()
39 ramdisk_id = StringCol()
40 inst_type = StringCol()
41 key_pair = StringCol()
42 slice = ForeignKey('Slice')
45 # Contacts Eucalyptus and tries to reserve this instance.
47 # @param botoConn A connection to Eucalyptus.
49 def reserveInstance(self, botoConn):
50 print >>sys.stderr, 'Reserving an instance: image: %s, kernel: ' \
51 '%s, ramdisk: %s, type: %s, key: %s' % \
52 (self.image_id, self.kernel_id, self.ramdisk_id,
53 self.inst_type, self.key_pair)
55 # XXX The return statement is for testing. REMOVE in production
59 reservation = botoConn.run_instances(self.image_id,
60 kernel_id = self.kernel_id,
61 ramdisk_id = self.ramdisk_id,
62 instance_type = self.inst_type,
63 key_name = self.key_pair)
64 for instance in reservation.instances:
65 self.instance_id = instance.id
67 # If there is an error, destroy itself.
68 except EC2ResponseError, ec2RespErr:
69 errTree = ET.fromstring(ec2RespErr.body)
70 msg = errTree.find('.//Message')
71 print >>sys.stderr, msg.text
75 # A representation of a PlanetLab slice. This is a support class
76 # for instance <-> slice mapping.
78 class Slice(SQLObject):
79 slice_hrn = StringCol()
80 #slice_index = DatabaseIndex('slice_hrn')
81 instances = MultipleJoin('EucaInstance')
84 # Initialize the aggregate manager by reading a configuration file.
87 configParser = ConfigParser()
88 configParser.read(['/etc/sfa/eucalyptus_aggregate.conf', 'eucalyptus_aggregate.conf'])
89 if len(configParser.sections()) < 1:
90 print >>sys.stderr, 'No cloud defined in the config file'
91 raise Exception('Cannot find cloud definition in configuration file.')
93 # Only read the first section.
94 cloudSec = configParser.sections()[0]
95 cloud['name'] = cloudSec
96 cloud['access_key'] = configParser.get(cloudSec, 'access_key')
97 cloud['secret_key'] = configParser.get(cloudSec, 'secret_key')
98 cloud['cloud_url'] = configParser.get(cloudSec, 'cloud_url')
99 cloudURL = cloud['cloud_url']
100 if cloudURL.find('https://') >= 0:
101 cloudURL = cloudURL.replace('https://', '')
102 elif cloudURL.find('http://') >= 0:
103 cloudURL = cloudURL.replace('http://', '')
104 (cloud['ip'], parts) = cloudURL.split(':')
106 # Initialize sqlite3 database.
107 dbPath = '/etc/sfa/db'
108 dbName = 'euca_aggregate.db'
110 if not os.path.isdir(dbPath):
111 print >>sys.stderr, '%s not found. Creating directory ...' % dbPath
114 conn = connectionForURI('sqlite://%s/%s' % (dbPath, dbName))
115 sqlhub.processConnection = conn
116 Slice.createTable(ifNotExists=True)
117 EucaInstance.createTable(ifNotExists=True)
119 # Make sure the schema exists.
120 if not os.path.exists(EUCALYPTUS_RSPEC_SCHEMA):
121 err = 'Cannot location schema at %s' % EUCALYPTUS_RSPEC_SCHEMA
122 print >>sys.stderr, err
126 # Creates a connection to Eucalytpus. This function is inspired by
127 # the make_connection() in Euca2ools.
129 # @return A connection object or None
131 def getEucaConnection():
133 accessKey = cloud['access_key']
134 secretKey = cloud['secret_key']
135 eucaURL = cloud['cloud_url']
140 if not accessKey or not secretKey or not eucaURL:
141 print >>sys.stderr, 'Please set ALL of the required environment ' \
142 'variables by sourcing the eucarc file.'
145 # Split the url into parts
146 if eucaURL.find('https://') >= 0:
148 eucaURL = eucaURL.replace('https://', '')
149 elif eucaURL.find('http://') >= 0:
151 eucaURL = eucaURL.replace('http://', '')
152 (eucaHost, parts) = eucaURL.split(':')
154 parts = parts.split('/')
155 eucaPort = int(parts[0])
157 srvPath = '/'.join(parts)
159 return boto.connect_ec2(aws_access_key_id=accessKey,
160 aws_secret_access_key=secretKey,
162 region=RegionInfo(None, 'eucalyptus', eucaHost),
167 # A class that builds the RSpec for Eucalyptus.
169 class EucaRSpecBuilder(object):
171 # Initizes a RSpec builder
173 # @param cloud A dictionary containing data about a
174 # cloud (ex. clusters, ip)
175 def __init__(self, cloud):
176 self.eucaRSpec = XMLBuilder(format = True, tab_step = " ")
177 self.cloudInfo = cloud
180 # Creates a request stanza.
182 # @param num The number of instances to create.
183 # @param image The disk image id.
184 # @param kernel The kernel image id.
185 # @param keypair Key pair to embed.
186 # @param ramdisk Ramdisk id (optional).
188 def __requestXML(self, num, image, kernel, keypair, ramdisk = ''):
193 with xml.kernel_image(id=kernel):
199 with xml.ramdisk(id=ramdisk):
201 with xml.disk_image(id=image):
207 # Creates the cluster stanza.
209 # @param clusters Clusters information.
211 def __clustersXML(self, clusters):
212 cloud = self.cloudInfo
215 for cluster in clusters:
216 instances = cluster['instances']
217 with xml.cluster(id=cluster['name']):
221 for inst in instances:
222 with xml.vm_type(name=inst[0]):
225 with xml.max_instances:
229 with xml.memory(unit='MB'):
231 with xml.disk_space(unit='GB'):
233 if inst[0] == 'm1.small':
234 self.__requestXML(1, 'emi-88760F45', 'eki-F26610C6', 'cortex')
235 if 'instances' in cloud and inst[0] in cloud['instances']:
236 existingEucaInstances = cloud['instances'][inst[0]]
237 with xml.euca_instances:
238 for eucaInst in existingEucaInstances:
239 with xml.euca_instance(id=eucaInst['id']):
241 xml << eucaInst['state']
243 xml << eucaInst['public_dns']
245 xml << eucaInst['key']
248 # Creates the Images stanza.
250 # @param images A list of images in Eucalyptus.
252 def __imagesXML(self, images):
256 with xml.image(id=image.id):
260 xml << image.architecture
264 xml << image.location
267 # Creates the KeyPairs stanza.
269 # @param keypairs A list of key pairs in Eucalyptus.
271 def __keyPairsXML(self, keypairs):
279 # Generates the RSpec.
282 if not self.cloudInfo:
283 print >>sys.stderr, 'No cloud information'
287 cloud = self.cloudInfo
288 with xml.RSpec(type='eucalyptus'):
289 with xml.cloud(id=cloud['name']):
292 self.__keyPairsXML(cloud['keypairs'])
293 self.__imagesXML(cloud['images'])
294 self.__clustersXML(cloud['clusters'])
298 # A parser to parse the output of availability-zones.
300 # Note: Only one cluster is supported. If more than one, this will
303 class ZoneResultParser(object):
304 def __init__(self, zones):
308 if len(self.zones) < 3:
314 cluster['name'] = self.zones[0].name
315 cluster['ip'] = self.zones[0].state
317 for i in range(2, len(self.zones)):
318 currZone = self.zones[i]
319 instType = currZone.name.split()[1]
321 stateString = currZone.state.split('/')
322 rscString = stateString[1].split()
324 instFree = int(stateString[0])
325 instMax = int(rscString[0])
326 instNumCpu = int(rscString[1])
327 instRam = int(rscString[2])
328 instDiskSpace = int(rscString[3])
330 instTuple = (instType, instFree, instMax, instNumCpu, instRam, instDiskSpace)
331 instList.append(instTuple)
332 cluster['instances'] = instList
333 clusterList.append(cluster)
337 def get_rspec(api, xrn, origin_hrn):
339 hrn = urn_to_hrn(xrn)[0]
340 conn = getEucaConnection()
343 print >>sys.stderr, 'Error: Cannot create a connection to Eucalyptus'
344 return 'Cannot create a connection to Eucalyptus'
348 zones = conn.get_all_zones(['verbose'])
349 p = ZoneResultParser(zones)
351 cloud['clusters'] = clusters
354 images = conn.get_all_images()
355 cloud['images'] = images
358 keyPairs = conn.get_all_key_pairs()
359 cloud['keypairs'] = keyPairs
365 # Get the instances that belong to the given slice from sqlite3
366 # XXX use getOne() in production because the slice's hrn is supposed
367 # to be unique. For testing, uniqueness is turned off in the db.
368 # If the slice isn't found in the database, create a record for the
370 matchedSlices = list(Slice.select(Slice.q.slice_hrn == hrn))
372 theSlice = matchedSlices[-1]
374 theSlice = Slice(slice_hrn = hrn)
375 for instance in theSlice.instances:
376 instanceId.append(instance.instance_id)
378 # Get the information about those instances using their ids.
379 if len(instanceId) > 0:
380 reservations = conn.get_all_instances(instanceId)
383 for reservation in reservations:
384 for instance in reservation.instances:
385 instances.append(instance)
387 # Construct a dictory for the EucaRSpecBuilder
389 for instance in instances:
390 instList = instancesDict.setdefault(instance.instance_type, [])
393 instInfoDict['id'] = instance.id
394 instInfoDict['public_dns'] = instance.public_dns_name
395 instInfoDict['state'] = instance.state
396 instInfoDict['key'] = instance.key_name
398 instList.append(instInfoDict)
399 cloud['instances'] = instancesDict
401 except EC2ResponseError, ec2RespErr:
402 errTree = ET.fromstring(ec2RespErr.body)
403 errMsgE = errTree.find('.//Message')
404 print >>sys.stderr, errMsgE.text
406 rspec = EucaRSpecBuilder(cloud).toXML()
408 # Remove the instances records so next time they won't
410 if 'instances' in cloud:
411 del cloud['instances']
416 Hook called via 'sfi.py create'
418 def create_slice(api, xrn, xml):
420 hrn = urn_to_hrn(xrn)[0]
422 conn = getEucaConnection()
424 print >>sys.stderr, 'Error: Cannot create a connection to Eucalyptus'
428 schemaXML = ET.parse(EUCALYPTUS_RSPEC_SCHEMA)
429 rspecValidator = ET.RelaxNG(schemaXML)
430 rspecXML = ET.XML(xml)
431 if not rspecValidator(rspecXML):
432 error = rspecValidator.error_log.last_error
433 message = '%s (line %s)' % (error.message, error.line)
434 # XXX: InvalidRSpec is new. Currently, I am not working with Trunk code.
435 #raise InvalidRSpec(message)
436 raise Exception(message)
438 # Get the slice from db or create one.
439 s = Slice.select(Slice.q.slice_hrn == hrn).getOne(None)
441 s = Slice(slice_hrn = hrn)
443 # Process any changes in existing instance allocation
445 for sliceInst in s.instances:
446 pendingRmInst.append(sliceInst.instance_id)
447 existingInstGroup = rspecXML.findall('.//euca_instances')
448 for instGroup in existingInstGroup:
449 for existingInst in instGroup:
450 if existingInst.get('id') in pendingRmInst:
451 pendingRmInst.remove(existingInst.get('id'))
452 for inst in pendingRmInst:
453 print >>sys.stderr, 'Instance %s will be terminated' % inst
454 dbInst = EucaInstance.select(EucaInstance.q.instance_id == inst).getOne(None)
456 conn.terminate_instances(pendingRmInst)
458 # Process new instance requests
459 requests = rspecXML.findall('.//request')
461 vmTypeElement = req.getparent()
462 instType = vmTypeElement.get('name')
463 numInst = int(req.find('instances').text)
464 instKernel = req.find('kernel_image').get('id')
465 instDiskImg = req.find('disk_image').get('id')
466 instKey = req.find('keypair').text
468 ramDiskElement = req.find('ramdisk')
469 ramDiskAttr = ramDiskElement.attrib
470 if 'id' in ramDiskAttr:
471 instRamDisk = ramDiskAttr['id']
475 # Create the instances
476 for i in range(0, numInst):
477 eucaInst = EucaInstance(slice = s,
478 kernel_id = instKernel,
479 image_id = instDiskImg,
480 ramdisk_id = instRamDisk,
482 inst_type = instType)
483 eucaInst.reserveInstance(conn)
491 with open(sys.argv[1]) as xml:
492 theRSpec = xml.read()
493 create_slice(None, 'planetcloud.pc.test', theRSpec)
495 #rspec = get_rspec('euca', 'planetcloud.pc.test', 'planetcloud.pc.marcoy')
498 if __name__ == "__main__":