sfa/openstack/osaggregate.py

   1
   2 import os
   3 import socket
   4 import base64
   5 import string
   6 import random
   7 import time
   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 SfaAPIError, 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.util.sfalogging import logger
  28
  29 def pubkeys_to_user_data(pubkeys):
  30     user_data = "#!/bin/bash\n\n"
  31     for pubkey in pubkeys:
  32         pubkey = pubkey.replace('\n', '')
  33         user_data += "echo %s >> /root/.ssh/authorized_keys" % pubkey
  34         user_data += "\n"
  35         user_data += "echo >> /root/.ssh/authorized_keys"
  36         user_data += "\n"
  37     return user_data
  38
  39 def image_to_rspec_disk_image(image):
  40     img = DiskImage()
  41     img['name'] = image['name']
  42     img['description'] = image['name']
  43     img['os'] = image['name']
  44     img['version'] = image['name']
  45     return img
  46
  47 class OSAggregate:
  48
  49     def __init__(self, driver):
  50         self.driver = driver
  51
  52     def get_availability_zones(self):
  53         zones = self.driver.shell.nova_manager.dns_domains.domains()
  54         if not zones:
  55             zones = ['cloud']
  56         else:
  57             zones = [zone.name for zone in zones]
  58         return zones
  59
  60     def list_resources(self, version=None, options={}):
  61         version_manager = VersionManager()
  62         version = version_manager.get_version(version)
  63         rspec_version = version_manager._get_version(version.type, version.version, 'ad')
  64         rspec = RSpec(version=version, user_options=options)
  65         nodes = self.get_aggregate_nodes()
  66         rspec.version.add_nodes(nodes)
  67         return rspec.toxml()
  68
  69     def describe(self, urns, version=None, options={}):
  70         # update nova connection
  71         tenant_name = OSXrn(xrn=urns[0], type='slice').get_tenant_name()
  72         self.driver.shell.nova_manager.connect(tenant=tenant_name)
  73         instances = self.get_instances(urns)
  74         # lookup the sliver allocations
  75         sliver_ids = [sliver['sliver_id'] for sliver in slivers]
  76         constraint = SliverAllocation.sliver_id.in_(sliver_ids)
  77         sliver_allocations = dbsession.query(SliverAllocation).filter(constraint)
  78         sliver_allocation_dict = {}
  79         for sliver_allocation in sliver_allocations:
  80             sliver_allocation_dict[sliver_allocation.sliver_id] = sliver_allocation
  81
  82         geni_slivers = []
  83         rspec_nodes = []
  84         for instance in instances:
  85             rspec_nodes.append(self.instance_to_rspec_node(instance))
  86             geni_sliver = self.instance_to_geni_sliver(instance, sliver_sllocation_dict)
  87             geni_slivers.append(geni_sliver)
  88         version_manager = VersionManager()
  89         version = version_manager.get_version(version)
  90         rspec_version = version_manager._get_version(version.type, version.version, 'manifest')
  91         rspec = RSpec(version=rspec_version, user_options=options)
  92         rspec.version.add_nodes(rspec_nodes)
  93         result = {'geni_urn': Xrn(urns[0]).get_urn(),
  94                   'geni_rspec': rspec.toxml(),
  95                   'geni_slivers': geni_slivers}
  96
  97         return result
  98
  99     def get_instances(self, urns):
 100         # parse slice names and sliver ids
 101         names = set()
 102         ids = set()
 103         for urn in urns:
 104             xrn = OSXrn(xrn=urn)
 105             if xrn.type == 'slice':
 106                 names.add(xrn.get_slice_name())
 107             elif xrn.type == 'sliver':
 108                 ids.add(xrn.leaf)
 109
 110         # look up instances
 111         instances = []
 112         filter = {}
 113         if names:
 114             filter['name'] = names
 115         if ids:
 116             filter['id'] = ids
 117         servers = self.driver.shell.nova_manager.servers.findall(**filter)
 118         instances.extend(servers)
 119
 120         return instances
 121
 122     def instance_to_rspec_node(self, instance):
 123         # determine node urn
 124         node_xrn = instance.metadata.get('component_id')
 125         if not node_xrn:
 126             node_xrn = OSXrn('cloud', type='node')
 127         else:
 128             node_xrn = OSXrn(xrn=node_xrn, type='node')
 129
 130         rspec_node = Node()
 131         rspec_node['component_id'] = node_xrn.urn
 132         rspec_node['component_name'] = node_xrn.name
 133         rspec_node['component_manager_id'] = Xrn(self.driver.hrn, 'authority+cm').get_urn()
 134         rspec_node['sliver_id'] = OSXrn(name=instance.name, type='slice', id=instance.id).get_urn()
 135         if instance.metadata.get('client_id'):
 136             rspec_node['client_id'] = instance.metadata.get('client_id')
 137
 138         # get sliver details
 139         flavor = self.driver.shell.nova_manager.flavors.find(id=instance.flavor['id'])
 140         sliver = self.instance_to_sliver(flavor)
 141         # get firewall rules
 142         fw_rules = []
 143         group_name = instance.metadata.get('security_groups')
 144         if group_name:
 145             group = self.driver.shell.nova_manager.security_groups.find(name=group_name)
 146             for rule in group.rules:
 147                 port_range ="%s:%s" % (rule['from_port'], rule['to_port'])
 148                 fw_rule = FWRule({'protocol': rule['ip_protocol'],
 149                                   'port_range': port_range,
 150                                   'cidr_ip': rule['ip_range']['cidr']})
 151                 fw_rules.append(fw_rule)
 152         sliver['fw_rules'] = fw_rules
 153         rspec_node['slivers'] = [sliver]
 154
 155         # get disk image
 156         image = self.driver.shell.image_manager.get_images(id=instance.image['id'])
 157         if isinstance(image, list) and len(image) > 0:
 158             image = image[0]
 159         disk_image = image_to_rspec_disk_image(image)
 160         sliver['disk_image'] = [disk_image]
 161
 162         # get interfaces
 163         rspec_node['services'] = []
 164         rspec_node['interfaces'] = []
 165         addresses = instance.addresses
 166         # HACK: public ips are stored in the list of private, but
 167         # this seems wrong. Assume pub ip is the last in the list of
 168         # private ips until openstack bug is fixed.
 169         if addresses.get('private'):
 170             login = Login({'authentication': 'ssh-keys',
 171                            'hostname': addresses.get('private')[-1]['addr'],
 172                            'port':'22', 'username': 'root'})
 173             service = Services({'login': login})
 174             rspec_node['services'].append(service)
 175
 176         for private_ip in addresses.get('private', []):
 177             if_xrn = PlXrn(auth=self.driver.hrn,
 178                            interface='node%s' % (instance.hostId))
 179             if_client_id = Xrn(if_xrn.urn, type='interface', id="eth%s" %if_index).urn
 180             if_sliver_id = Xrn(rspec_node['sliver_id'], type='slice', id="eth%s" %if_index).urn
 181             interface = Interface({'component_id': if_xrn.urn,
 182                                    'client_id': if_client_id,
 183                                    'sliver_id': if_sliver_id})
 184             interface['ips'] =  [{'address': private_ip['addr'],
 185                                  #'netmask': private_ip['network'],
 186                                  'type': private_ip['version']}]
 187             rspec_node['interfaces'].append(interface)
 188
 189         # slivers always provide the ssh service
 190         for public_ip in addresses.get('public', []):
 191             login = Login({'authentication': 'ssh-keys',
 192                            'hostname': public_ip['addr'],
 193                            'port':'22', 'username': 'root'})
 194             service = Services({'login': login})
 195             rspec_node['services'].append(service)
 196         return rspec_node
 197
 198
 199     def instance_to_sliver(self, instance, xrn=None):
 200         if xrn:
 201             sliver_hrn = '%s.%s' % (self.driver.hrn, instance.id)
 202             sliver_id = Xrn(sliver_hrn, type='sliver').urn
 203
 204         sliver = Sliver({'sliver_id': sliver_id,
 205                          'name': instance.name,
 206                          'type': instance.name,
 207                          'cpus': str(instance.vcpus),
 208                          'memory': str(instance.ram),
 209                          'storage':  str(instance.disk)})
 210         return sliver
 211
 212     def instance_to_geni_sliver(self, instance, sliver_allocations = {}):
 213         sliver_hrn = '%s.%s' % (self.driver.hrn, instance.id)
 214         sliver_id = Xrn(sliver_hrn, type='sliver').urn
 215
 216         # set sliver allocation and operational status
 217         sliver_allocation = sliver_allocations[sliver_id]
 218         if sliver_allocation:
 219             allocation_status = sliver_allocation.allocation_state
 220             if allocation_status == 'geni_allocated':
 221                 op_status =  'geni_pending_allocation'
 222             elif allocation_status == 'geni_provisioned':
 223                 state = instance.state.lower()
 224                 if state == 'active':
 225                     op_status = 'geni_ready'
 226                 elif state == 'building':
 227                     op_status = 'geni_notready'
 228                 elif state == 'failed':
 229                     op_status =' geni_failed'
 230                 else:
 231                     op_status = 'geni_unknown'
 232             else:
 233                 allocation_status = 'geni_unallocated'
 234         # required fields
 235         geni_sliver = {'geni_sliver_urn': sliver_id,
 236                        'geni_expires': None,
 237                        'geni_allocation_status': allocation_status,
 238                        'geni_operational_status': op_status,
 239                        'geni_error': None,
 240                        'plos_created_at': datetime_to_string(utcparse(instance.created)),
 241                        'plos_sliver_type': self.shell.nova_manager.flavors.find(id=instance.flavor['id']).name,
 242                         }
 243
 244
 245         return geni_sliver
 246
 247     def get_aggregate_nodes(self):
 248         zones = self.get_availability_zones()
 249         # available sliver/instance/vm types
 250         instances = self.driver.shell.nova_manager.flavors.list()
 251         if isinstance(instances, dict):
 252             instances = instances.values()
 253         # available images
 254         images = self.driver.shell.image_manager.get_images_detailed()
 255         disk_images  = [image_to_rspec_disk_image(img) for img in images if img['container_format'] in ['ami', 'ovf']]
 256         rspec_nodes = []
 257         for zone in zones:
 258             rspec_node = Node()
 259             xrn = OSXrn(zone, type='node')
 260             rspec_node['component_id'] = xrn.urn
 261             rspec_node['component_name'] = xrn.name
 262             rspec_node['component_manager_id'] = Xrn(self.driver.hrn, 'authority+cm').get_urn()
 263             rspec_node['exclusive'] = 'false'
 264             rspec_node['hardware_types'] = [HardwareType({'name': 'plos-pc'}),
 265                                                 HardwareType({'name': 'pc'})]
 266             slivers = []
 267             for instance in instances:
 268                 sliver = self.instance_to_sliver(instance)
 269                 sliver['disk_image'] = disk_images
 270                 slivers.append(sliver)
 271             rspec_node['available'] = 'true'
 272             rspec_node['slivers'] = slivers
 273             rspec_nodes.append(rspec_node)
 274
 275         return rspec_nodes
 276
 277     def create_tenant(self, tenant_name):
 278         tenants = self.driver.shell.auth_manager.tenants.findall(name=tenant_name)
 279         if not tenants:
 280             self.driver.shell.auth_manager.tenants.create(tenant_name, tenant_name)
 281             tenant = self.driver.shell.auth_manager.tenants.find(name=tenant_name)
 282         else:
 283             tenant = tenants[0]
 284         return tenant
 285
 286     def create_instance_key(self, slice_hrn, user):
 287         slice_name = Xrn(slice_hrn).leaf
 288         user_name = Xrn(user['urn']).leaf
 289         key_name = "%s_%s" % (slice_name, user_name)
 290         pubkey = user['keys'][0]
 291         key_found = False
 292         existing_keys = self.driver.shell.nova_manager.keypairs.findall(name=key_name)
 293         for existing_key in existing_keys:
 294             if existing_key.public_key != pubkey:
 295                 self.driver.shell.nova_manager.keypairs.delete(existing_key)
 296             elif existing_key.public_key == pubkey:
 297                 key_found = True
 298
 299         if not key_found:
 300             self.driver.shell.nova_manager.keypairs.create(key_name, pubkey)
 301         return key_name
 302
 303
 304     def create_security_group(self, slicename, fw_rules=[]):
 305         # use default group by default
 306         group_name = 'default'
 307         if isinstance(fw_rules, list) and fw_rules:
 308             # Each sliver get's its own security group.
 309             # Keep security group names unique by appending some random
 310             # characters on end.
 311             random_name = "".join([random.choice(string.letters+string.digits)
 312                                            for i in xrange(6)])
 313             group_name = slicename + random_name
 314             security_group = SecurityGroup(self.driver)
 315             security_group.create_security_group(group_name)
 316             for rule in fw_rules:
 317                 security_group.add_rule_to_group(group_name,
 318                                              protocol = rule.get('protocol'),
 319                                              cidr_ip = rule.get('cidr_ip'),
 320                                              port_range = rule.get('port_range'),
 321                                              icmp_type_code = rule.get('icmp_type_code'))
 322         return group_name
 323
 324     def add_rule_to_security_group(self, group_name, **kwds):
 325         security_group = SecurityGroup(self.driver)
 326         security_group.add_rule_to_group(group_name=group_name,
 327                                          protocol=kwds.get('protocol'),
 328                                          cidr_ip =kwds.get('cidr_ip'),
 329                                          icmp_type_code = kwds.get('icmp_type_code'))
 330
 331
 332
 333     def run_instances(self, instance_name, tenant_name, rspec, key_name, pubkeys):
 334         #logger.debug('Reserving an instance: image: %s, flavor: ' \
 335         #            '%s, key: %s, name: %s' % \
 336         #            (image_id, flavor_id, key_name, slicename))
 337
 338         # make sure a tenant exists for this slice
 339         tenant = self.create_tenant(tenant_name)
 340
 341         # add the sfa admin user to this tenant and update our nova client connection
 342         # to use these credentials for the rest of this session. This emsures that the instances
 343         # we create will be assigned to the correct tenant.
 344         sfa_admin_user = self.driver.shell.auth_manager.users.find(name=self.driver.shell.auth_manager.opts['OS_USERNAME'])
 345         user_role = self.driver.shell.auth_manager.roles.find(name='user')
 346         admin_role = self.driver.shell.auth_manager.roles.find(name='admin')
 347         self.driver.shell.auth_manager.roles.add_user_role(sfa_admin_user, admin_role, tenant)
 348         self.driver.shell.auth_manager.roles.add_user_role(sfa_admin_user, user_role, tenant)
 349         self.driver.shell.nova_manager.connect(tenant=tenant.name)
 350
 351         authorized_keys = "\n".join(pubkeys)
 352         files = {'/root/.ssh/authorized_keys': authorized_keys}
 353         rspec = RSpec(rspec)
 354         requested_instances = defaultdict(list)
 355         # iterate over clouds/zones/nodes
 356         slivers = []
 357         for node in rspec.version.get_nodes_with_slivers():
 358             instances = node.get('slivers', [])
 359             if not instances:
 360                 continue
 361             for instance in instances:
 362                 try:
 363                     metadata = {}
 364                     flavor_id = self.driver.shell.nova_manager.flavors.find(name=instance['name'])
 365                     image = instance.get('disk_image')
 366                     if image and isinstance(image, list):
 367                         image = image[0]
 368                     image_id = self.driver.shell.nova_manager.images.find(name=image['name'])
 369                     fw_rules = instance.get('fw_rules', [])
 370                     group_name = self.create_security_group(instance_name, fw_rules)
 371                     metadata['security_groups'] = group_name
 372                     if node.get('component_id'):
 373                         metadata['component_id'] = node['component_id']
 374                     if node.get('client_id'):
 375                         metadata['client_id'] = node['client_id']
 376                     server = self.driver.shell.nova_manager.servers.create(
 377                                                             flavor=flavor_id,
 378                                                             image=image_id,
 379                                                             key_name = key_name,
 380                                                             security_groups = [group_name],
 381                                                             files=files,
 382                                                             meta=metadata,
 383                                                             name=instance_name)
 384                     slivers.append(server)
 385                 except Exception, err:
 386                     logger.log_exc(err)
 387
 388         return slivers
 389
 390     def delete_instance(self, instance):
 391
 392         def _delete_security_group(inst):
 393             security_group = inst.metadata.get('security_groups', '')
 394             if security_group:
 395                 manager = SecurityGroup(self.driver)
 396                 timeout = 10.0 # wait a maximum of 10 seconds before forcing the security group delete
 397                 start_time = time.time()
 398                 instance_deleted = False
 399                 while instance_deleted == False and (time.time() - start_time) < timeout:
 400                     tmp_inst = self.driver.shell.nova_manager.servers.findall(id=inst.id)
 401                     if not tmp_inst:
 402                         instance_deleted = True
 403                     time.sleep(.5)
 404                 manager.delete_security_group(security_group)
 405
 406         thread_manager = ThreadManager()
 407         tenant = self.driver.shell.auth_manager.tenants.find(id=instance.tenant_id)
 408         self.driver.shell.nova_manager.connect(tenant=tenant.name)
 409         args = {'name': instance.name,
 410                 'id': instance.id}
 411         instances = self.driver.shell.nova_manager.servers.findall(**args)
 412         security_group_manager = SecurityGroup(self.driver)
 413         for instance in instances:
 414             # destroy instance
 415             self.driver.shell.nova_manager.servers.delete(instance)
 416             # deleate this instance's security groups
 417             thread_manager.run(_delete_security_group, instance)
 418         return 1
 419
 420     def stop_instances(self, instance_name, tenant_name, id=None):
 421         self.driver.shell.nova_manager.connect(tenant=tenant_name)
 422         args = {'name': instance_name}
 423         if id:
 424             args['id'] = id
 425         instances = self.driver.shell.nova_manager.servers.findall(**args)
 426         for instance in instances:
 427             self.driver.shell.nova_manager.servers.pause(instance)
 428         return 1
 429
 430     def start_instances(self, instance_name, tenant_name, id=None):
 431         self.driver.shell.nova_manager.connect(tenant=tenant_name)
 432         args = {'name': instance_name}
 433         if id:
 434             args['id'] = id
 435         instances = self.driver.shell.nova_manager.servers.findall(**args)
 436         for instance in instances:
 437             self.driver.shell.nova_manager.servers.resume(instance)
 438         return 1
 439
 440     def restart_instances(self, instacne_name, tenant_name, id=None):
 441         self.stop_instances(instance_name, tenant_name, id)
 442         self.start_instances(instance_name, tenant_name, id)
 443         return 1
 444
 445     def update_instances(self, project_name):
 446         pass