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