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