8 from collections import defaultdict
9 from nova.exception import ImageNotFound
10 from nova.api.ec2.cloud import CloudController
11 from sfa.util.faults import SliverDoesNotExist
12 from sfa.util.sfatime import utcparse, datetime_to_string, datetime_to_epoch
13 from sfa.rspecs.rspec import RSpec
14 from sfa.rspecs.elements.hardware_type import HardwareType
15 from sfa.rspecs.elements.node import Node
16 from sfa.rspecs.elements.sliver import Sliver
17 from sfa.rspecs.elements.login import Login
18 from sfa.rspecs.elements.disk_image import DiskImage
19 from sfa.rspecs.elements.services import Services
20 from sfa.rspecs.elements.interface import Interface
21 from sfa.rspecs.elements.fw_rule import FWRule
22 from sfa.util.xrn import Xrn
23 from sfa.planetlab.plxrn import PlXrn
24 from sfa.openstack.osxrn import OSXrn, hrn_to_os_slicename
25 from sfa.rspecs.version_manager import VersionManager
26 from sfa.openstack.security_group import SecurityGroup
27 from sfa.client.multiclient import MultiClient
28 from sfa.util.sfalogging import logger
30 def pubkeys_to_user_data(pubkeys):
31 user_data = "#!/bin/bash\n\n"
32 for pubkey in pubkeys:
33 pubkey = pubkey.replace('\n', '')
34 user_data += "echo %s >> /root/.ssh/authorized_keys" % pubkey
36 user_data += "echo >> /root/.ssh/authorized_keys"
40 def image_to_rspec_disk_image(image):
42 img['name'] = image['name']
43 img['description'] = image['name']
44 img['os'] = image['name']
45 img['version'] = image['name']
50 def __init__(self, driver):
53 def get_availability_zones(self):
54 zones = self.driver.shell.nova_manager.dns_domains.domains()
58 zones = [zone.name for zone in zones]
61 def list_resources(self, version=None, options=None):
62 if options is None: options={}
63 version_manager = VersionManager()
64 version = version_manager.get_version(version)
65 rspec_version = version_manager._get_version(version.type, version.version, 'ad')
66 rspec = RSpec(version=version, user_options=options)
67 nodes = self.get_aggregate_nodes()
68 rspec.version.add_nodes(nodes)
71 def describe(self, urns, version=None, options=None):
72 if options is None: options={}
73 # update nova connection
74 tenant_name = OSXrn(xrn=urns[0], type='slice').get_tenant_name()
75 self.driver.shell.nova_manager.connect(tenant=tenant_name)
76 instances = self.get_instances(urns)
77 # lookup the sliver allocations
78 sliver_ids = [sliver['sliver_id'] for sliver in slivers]
79 constraint = SliverAllocation.sliver_id.in_(sliver_ids)
80 sliver_allocations = self.driver.api.dbsession().query(SliverAllocation).filter(constraint)
81 sliver_allocation_dict = {}
82 for sliver_allocation in sliver_allocations:
83 sliver_allocation_dict[sliver_allocation.sliver_id] = sliver_allocation
87 for instance in instances:
88 rspec_nodes.append(self.instance_to_rspec_node(instance))
89 geni_sliver = self.instance_to_geni_sliver(instance, sliver_sllocation_dict)
90 geni_slivers.append(geni_sliver)
91 version_manager = VersionManager()
92 version = version_manager.get_version(version)
93 rspec_version = version_manager._get_version(version.type, version.version, 'manifest')
94 rspec = RSpec(version=rspec_version, user_options=options)
95 rspec.xml.set('expires', datetime_to_string(utcparse(time.time())))
96 rspec.version.add_nodes(rspec_nodes)
97 result = {'geni_urn': Xrn(urns[0]).get_urn(),
98 'geni_rspec': rspec.toxml(),
99 'geni_slivers': geni_slivers}
103 def get_instances(self, urns):
104 # parse slice names and sliver ids
109 if xrn.type == 'slice':
110 names.add(xrn.get_slice_name())
111 elif xrn.type == 'sliver':
118 filter['name'] = names
121 servers = self.driver.shell.nova_manager.servers.findall(**filter)
122 instances.extend(servers)
126 def instance_to_rspec_node(self, instance):
128 node_xrn = instance.metadata.get('component_id')
130 node_xrn = OSXrn('cloud', type='node')
132 node_xrn = OSXrn(xrn=node_xrn, type='node')
135 rspec_node['component_id'] = node_xrn.urn
136 rspec_node['component_name'] = node_xrn.name
137 rspec_node['component_manager_id'] = Xrn(self.driver.hrn, 'authority+cm').get_urn()
138 rspec_node['sliver_id'] = OSXrn(name=instance.name, type='slice', id=instance.id).get_urn()
139 if instance.metadata.get('client_id'):
140 rspec_node['client_id'] = instance.metadata.get('client_id')
143 flavor = self.driver.shell.nova_manager.flavors.find(id=instance.flavor['id'])
144 sliver = self.instance_to_sliver(flavor)
147 group_name = instance.metadata.get('security_groups')
149 group = self.driver.shell.nova_manager.security_groups.find(name=group_name)
150 for rule in group.rules:
151 port_range ="%s:%s" % (rule['from_port'], rule['to_port'])
152 fw_rule = FWRule({'protocol': rule['ip_protocol'],
153 'port_range': port_range,
154 'cidr_ip': rule['ip_range']['cidr']})
155 fw_rules.append(fw_rule)
156 sliver['fw_rules'] = fw_rules
157 rspec_node['slivers'] = [sliver]
160 image = self.driver.shell.image_manager.get_images(id=instance.image['id'])
161 if isinstance(image, list) and len(image) > 0:
163 disk_image = image_to_rspec_disk_image(image)
164 sliver['disk_image'] = [disk_image]
167 rspec_node['services'] = []
168 rspec_node['interfaces'] = []
169 addresses = instance.addresses
170 # HACK: public ips are stored in the list of private, but
171 # this seems wrong. Assume pub ip is the last in the list of
172 # private ips until openstack bug is fixed.
173 if addresses.get('private'):
174 login = Login({'authentication': 'ssh-keys',
175 'hostname': addresses.get('private')[-1]['addr'],
176 'port':'22', 'username': 'root'})
177 service = Services({'login': login})
178 rspec_node['services'].append(service)
180 for private_ip in addresses.get('private', []):
181 if_xrn = PlXrn(auth=self.driver.hrn,
182 interface='node%s' % (instance.hostId))
183 if_client_id = Xrn(if_xrn.urn, type='interface', id="eth%s" %if_index).urn
184 if_sliver_id = Xrn(rspec_node['sliver_id'], type='slice', id="eth%s" %if_index).urn
185 interface = Interface({'component_id': if_xrn.urn,
186 'client_id': if_client_id,
187 'sliver_id': if_sliver_id})
188 interface['ips'] = [{'address': private_ip['addr'],
189 #'netmask': private_ip['network'],
190 'type': private_ip['version']}]
191 rspec_node['interfaces'].append(interface)
193 # slivers always provide the ssh service
194 for public_ip in addresses.get('public', []):
195 login = Login({'authentication': 'ssh-keys',
196 'hostname': public_ip['addr'],
197 'port':'22', 'username': 'root'})
198 service = Services({'login': login})
199 rspec_node['services'].append(service)
203 def instance_to_sliver(self, instance, xrn=None):
205 sliver_hrn = '%s.%s' % (self.driver.hrn, instance.id)
206 sliver_id = Xrn(sliver_hrn, type='sliver').urn
208 sliver = Sliver({'sliver_id': sliver_id,
209 'name': instance.name,
210 'type': instance.name,
211 'cpus': str(instance.vcpus),
212 'memory': str(instance.ram),
213 'storage': str(instance.disk)})
216 def instance_to_geni_sliver(self, instance, sliver_allocations=None):
217 if sliver_allocations is None: sliver_allocations={}
218 sliver_hrn = '%s.%s' % (self.driver.hrn, instance.id)
219 sliver_id = Xrn(sliver_hrn, type='sliver').urn
221 # set sliver allocation and operational status
222 sliver_allocation = sliver_allocations[sliver_id]
223 if sliver_allocation:
224 allocation_status = sliver_allocation.allocation_state
225 if allocation_status == 'geni_allocated':
226 op_status = 'geni_pending_allocation'
227 elif allocation_status == 'geni_provisioned':
228 state = instance.state.lower()
229 if state == 'active':
230 op_status = 'geni_ready'
231 elif state == 'building':
232 op_status = 'geni_notready'
233 elif state == 'failed':
234 op_status =' geni_failed'
236 op_status = 'geni_unknown'
238 allocation_status = 'geni_unallocated'
240 geni_sliver = {'geni_sliver_urn': sliver_id,
241 'geni_expires': None,
242 'geni_allocation_status': allocation_status,
243 'geni_operational_status': op_status,
245 'plos_created_at': datetime_to_string(utcparse(instance.created)),
246 'plos_sliver_type': self.shell.nova_manager.flavors.find(id=instance.flavor['id']).name,
251 def get_aggregate_nodes(self):
252 zones = self.get_availability_zones()
253 # available sliver/instance/vm types
254 instances = self.driver.shell.nova_manager.flavors.list()
255 if isinstance(instances, dict):
256 instances = instances.values()
258 images = self.driver.shell.image_manager.get_images_detailed()
259 disk_images = [image_to_rspec_disk_image(img) for img in images if img['container_format'] in ['ami', 'ovf']]
263 xrn = OSXrn(zone, type='node')
264 rspec_node['component_id'] = xrn.urn
265 rspec_node['component_name'] = xrn.name
266 rspec_node['component_manager_id'] = Xrn(self.driver.hrn, 'authority+cm').get_urn()
267 rspec_node['exclusive'] = 'false'
268 rspec_node['hardware_types'] = [HardwareType({'name': 'plos-pc'}),
269 HardwareType({'name': 'pc'})]
271 for instance in instances:
272 sliver = self.instance_to_sliver(instance)
273 sliver['disk_image'] = disk_images
274 slivers.append(sliver)
275 rspec_node['available'] = 'true'
276 rspec_node['slivers'] = slivers
277 rspec_nodes.append(rspec_node)
281 def create_tenant(self, tenant_name):
282 tenants = self.driver.shell.auth_manager.tenants.findall(name=tenant_name)
284 self.driver.shell.auth_manager.tenants.create(tenant_name, tenant_name)
285 tenant = self.driver.shell.auth_manager.tenants.find(name=tenant_name)
290 def create_instance_key(self, slice_hrn, user):
291 slice_name = Xrn(slice_hrn).leaf
292 user_name = Xrn(user['urn']).leaf
293 key_name = "%s_%s" % (slice_name, user_name)
294 pubkey = user['keys'][0]
296 existing_keys = self.driver.shell.nova_manager.keypairs.findall(name=key_name)
297 for existing_key in existing_keys:
298 if existing_key.public_key != pubkey:
299 self.driver.shell.nova_manager.keypairs.delete(existing_key)
300 elif existing_key.public_key == pubkey:
304 self.driver.shell.nova_manager.keypairs.create(key_name, pubkey)
308 def create_security_group(self, slicename, fw_rules=None):
309 if fw_rules is None: fw_rules=[]
310 # use default group by default
311 group_name = 'default'
312 if isinstance(fw_rules, list) and fw_rules:
313 # Each sliver get's its own security group.
314 # Keep security group names unique by appending some random
316 random_name = "".join([random.choice(string.letters+string.digits)
318 group_name = slicename + random_name
319 security_group = SecurityGroup(self.driver)
320 security_group.create_security_group(group_name)
321 for rule in fw_rules:
322 security_group.add_rule_to_group(group_name,
323 protocol = rule.get('protocol'),
324 cidr_ip = rule.get('cidr_ip'),
325 port_range = rule.get('port_range'),
326 icmp_type_code = rule.get('icmp_type_code'))
327 # Open ICMP by default
328 security_group.add_rule_to_group(group_name,
330 cidr_ip = "0.0.0.0/0",
331 icmp_type_code = "-1:-1")
334 def add_rule_to_security_group(self, group_name, **kwds):
335 security_group = SecurityGroup(self.driver)
336 security_group.add_rule_to_group(group_name=group_name,
337 protocol=kwds.get('protocol'),
338 cidr_ip =kwds.get('cidr_ip'),
339 icmp_type_code = kwds.get('icmp_type_code'))
343 def run_instances(self, instance_name, tenant_name, rspec, key_name, pubkeys):
344 #logger.debug('Reserving an instance: image: %s, flavor: ' \
345 # '%s, key: %s, name: %s' % \
346 # (image_id, flavor_id, key_name, slicename))
348 # make sure a tenant exists for this slice
349 tenant = self.create_tenant(tenant_name)
351 # add the sfa admin user to this tenant and update our nova client connection
352 # to use these credentials for the rest of this session. This emsures that the instances
353 # we create will be assigned to the correct tenant.
354 sfa_admin_user = self.driver.shell.auth_manager.users.find(name=self.driver.shell.auth_manager.opts['OS_USERNAME'])
355 user_role = self.driver.shell.auth_manager.roles.find(name='user')
356 admin_role = self.driver.shell.auth_manager.roles.find(name='admin')
357 self.driver.shell.auth_manager.roles.add_user_role(sfa_admin_user, admin_role, tenant)
358 self.driver.shell.auth_manager.roles.add_user_role(sfa_admin_user, user_role, tenant)
359 self.driver.shell.nova_manager.connect(tenant=tenant.name)
361 authorized_keys = "\n".join(pubkeys)
362 files = {'/root/.ssh/authorized_keys': authorized_keys}
364 requested_instances = defaultdict(list)
366 # iterate over clouds/zones/nodes
368 for node in rspec.version.get_nodes_with_slivers():
369 instances = node.get('slivers', [])
372 for instance in instances:
375 flavor_id = self.driver.shell.nova_manager.flavors.find(name=instance['name'])
376 image = instance.get('disk_image')
377 if image and isinstance(image, list):
380 raise InvalidRSpec("Must specify a disk_image for each VM")
381 image_id = self.driver.shell.nova_manager.images.find(name=image['name'])
382 fw_rules = instance.get('fw_rules', [])
383 group_name = self.create_security_group(instance_name, fw_rules)
384 metadata['security_groups'] = group_name
385 if node.get('component_id'):
386 metadata['component_id'] = node['component_id']
387 if node.get('client_id'):
388 metadata['client_id'] = node['client_id']
389 server = self.driver.shell.nova_manager.servers.create(
393 security_groups = [group_name],
397 slivers.append(server)
398 except Exception, err:
403 def delete_instance(self, instance):
405 def _delete_security_group(inst):
406 security_group = inst.metadata.get('security_groups', '')
408 manager = SecurityGroup(self.driver)
409 timeout = 10.0 # wait a maximum of 10 seconds before forcing the security group delete
410 start_time = time.time()
411 instance_deleted = False
412 while instance_deleted == False and (time.time() - start_time) < timeout:
413 tmp_inst = self.driver.shell.nova_manager.servers.findall(id=inst.id)
415 instance_deleted = True
417 manager.delete_security_group(security_group)
419 multiclient = MultiClient()
420 tenant = self.driver.shell.auth_manager.tenants.find(id=instance.tenant_id)
421 self.driver.shell.nova_manager.connect(tenant=tenant.name)
422 args = {'name': instance.name,
424 instances = self.driver.shell.nova_manager.servers.findall(**args)
425 security_group_manager = SecurityGroup(self.driver)
426 for instance in instances:
428 self.driver.shell.nova_manager.servers.delete(instance)
429 # deleate this instance's security groups
430 multiclient.run(_delete_security_group, instance)
433 def stop_instances(self, instance_name, tenant_name, id=None):
434 self.driver.shell.nova_manager.connect(tenant=tenant_name)
435 args = {'name': instance_name}
438 instances = self.driver.shell.nova_manager.servers.findall(**args)
439 for instance in instances:
440 self.driver.shell.nova_manager.servers.pause(instance)
443 def start_instances(self, instance_name, tenant_name, id=None):
444 self.driver.shell.nova_manager.connect(tenant=tenant_name)
445 args = {'name': instance_name}
448 instances = self.driver.shell.nova_manager.servers.findall(**args)
449 for instance in instances:
450 self.driver.shell.nova_manager.servers.resume(instance)
453 def restart_instances(self, instacne_name, tenant_name, id=None):
454 self.stop_instances(instance_name, tenant_name, id)
455 self.start_instances(instance_name, tenant_name, id)
458 def update_instances(self, project_name):