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': Xrn(urns[0]).get_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         rspec_node = Node()
136         rspec_node['component_id'] = node_xrn.urn
137         rspec_node['component_name'] = node_xrn.name
138         rspec_node['component_manager_id'] = Xrn(self.driver.hrn, 'authority+cm').get_urn()
139         flavor = self.driver.shell.nova_manager.flavors.find(id=instance.flavor['id'])
140         rspec_node['slivers'] = [self.instance_to_sliver(flavor)]
141         image = self.driver.shell.image_manager.get_images(id=instance.image['id'])
142         if isinstance(image, list) and len(image) > 0:
143             image = image[0]
144         disk_image = image_to_rspec_disk_image(image)
145         sliver['disk_image'] = [disk_image]
146
147         # build interfaces            
148         rspec_node['services'] = []
149         rspec_node['interfaces'] = []
150         addresses = instance.addresses
151         # HACK: public ips are stored in the list of private, but 
152         # this seems wrong. Assume pub ip is the last in the list of 
153         # private ips until openstack bug is fixed.      
154         if addresses.get('private'):
155             login = Login({'authentication': 'ssh-keys',
156                            'hostname': addresses.get('private')[-1]['addr'],
157                            'port':'22', 'username': 'root'})
158             service = Services({'login': login})
159             rspec_node['services'].append(service)    
160         
161         for private_ip in addresses.get('private', []):
162             if_xrn = PlXrn(auth=self.driver.hrn, 
163                            interface='node%s:eth0' % (instance.hostId)) 
164             interface = Interface({'component_id': if_xrn.urn})
165             interface['ips'] =  [{'address': private_ip['addr'],
166                                  #'netmask': private_ip['network'],
167                                  'type': private_ip['version']}]
168             rspec_node['interfaces'].append(interface) 
169         
170         # slivers always provide the ssh service
171         for public_ip in addresses.get('public', []):
172             login = Login({'authentication': 'ssh-keys', 
173                            'hostname': public_ip['addr'], 
174                            'port':'22', 'username': 'root'})
175             service = Services({'login': login})
176             rspec_node['services'].append(service)
177         return rspec_node
178
179
180     def instance_to_sliver(self, instance, xrn=None):
181         if xrn:
182             xrn = Xrn(xrn=slice_xrn, type='slice', id=instance.id).get_urn()
183
184         sliver = Sliver({'sliver_id': xrn.get_urn(),
185                          'name': instance.name,
186                          'type': instance.name,
187                          'cpus': str(instance.vcpus),
188                          'memory': str(instance.ram),
189                          'storage':  str(instance.disk)})
190         return sliver   
191
192     def instance_to_geni_sliver(self, instance):
193         op_status = "geni_unknown"
194         state = instance.state.lower()
195         if state == 'active':
196             op_status = 'geni_ready'
197         elif state == 'building': 
198             op_status = 'geni_configuring'
199         elif state == 'failed':
200             op_status =' geni_failed'
201          
202         urn = OSXrn(name=instance.name, type='slice', id=instance.id).get_urn()
203         # required fields
204         geni_sliver = {'geni_sliver_urn': urn, 
205                        'geni_expires': None,
206                        'geni_allocation_status': 'geni_provisioned',
207                        'geni_operational_status': op_status,
208                        'geni_error': None,
209                        'plos_created_at': datetime_to_string(utcparse(instance.created)),
210                        'plos_sliver_type': self.shell.nova_manager.flavors.find(id=instance.flavor['id']).name,
211                         }
212
213
214         return geni_sliver
215                         
216     def get_aggregate_nodes(self):
217         zones = self.get_availability_zones()
218         # available sliver/instance/vm types
219         instances = self.driver.shell.nova_manager.flavors.list()
220         if isinstance(instances, dict):
221             instances = instances.values()
222         # available images
223         images = self.driver.shell.image_manager.get_images_detailed()
224         disk_images  = [image_to_rspec_disk_image(img) for img in images if img['container_format'] in ['ami', 'ovf']]
225         rspec_nodes = []
226         for zone in zones:
227             rspec_node = Node()
228             xrn = OSXrn(zone, type='node')
229             rspec_node['component_id'] = xrn.urn
230             rspec_node['component_name'] = xrn.name
231             rspec_node['component_manager_id'] = Xrn(self.driver.hrn, 'authority+cm').get_urn()
232             rspec_node['exclusive'] = 'false'
233             rspec_node['hardware_types'] = [HardwareType({'name': 'plos-pc'}),
234                                                 HardwareType({'name': 'pc'})]
235             slivers = []
236             for instance in instances:
237                 sliver = self.instance_to_sliver(instance)
238                 sliver['disk_image'] = disk_images
239                 slivers.append(sliver)
240         
241             rspec_node['slivers'] = slivers
242             rspec_nodes.append(rspec_node) 
243
244         return rspec_nodes 
245
246     def create_tenant(self, tenant_name):
247         tenants = self.driver.shell.auth_manager.tenants.findall(name=tenant_name)
248         if not tenants:
249             self.driver.shell.auth_manager.tenants.create(tenant_name, tenant_name)
250             tenant = self.driver.shell.auth_manager.tenants.find(name=tenant_name)
251         else:
252             tenant = tenants[0]
253         return tenant
254             
255     def create_instance_key(self, slice_hrn, user):
256         slice_name = Xrn(slice_hrn).leaf
257         user_name = Xrn(user['urn']).leaf
258         key_name = "%s_%s" % (slice_name, user_name)
259         pubkey = user['keys'][0]
260         key_found = False
261         existing_keys = self.driver.shell.nova_manager.keypairs.findall(name=key_name)
262         for existing_key in existing_keys:
263             if existing_key.public_key != pubkey:
264                 self.driver.shell.nova_manager.keypairs.delete(existing_key)
265             elif existing_key.public_key == pubkey:
266                 key_found = True
267
268         if not key_found:
269             self.driver.shell.nova_manager.keypairs.create(key_name, pubkey)
270         return key_name       
271         
272
273     def create_security_group(self, slicename, fw_rules=[]):
274         # use default group by default
275         group_name = 'default' 
276         if isinstance(fw_rules, list) and fw_rules:
277             # Each sliver get's its own security group.
278             # Keep security group names unique by appending some random
279             # characters on end.
280             random_name = "".join([random.choice(string.letters+string.digits)
281                                            for i in xrange(6)])
282             group_name = slicename + random_name 
283             security_group = SecurityGroup(self.driver)
284             security_group.create_security_group(group_name)
285             for rule in fw_rules:
286                 security_group.add_rule_to_group(group_name, 
287                                              protocol = rule.get('protocol'), 
288                                              cidr_ip = rule.get('cidr_ip'), 
289                                              port_range = rule.get('port_range'), 
290                                              icmp_type_code = rule.get('icmp_type_code'))
291         return group_name
292
293     def add_rule_to_security_group(self, group_name, **kwds):
294         security_group = SecurityGroup(self.driver)
295         security_group.add_rule_to_group(group_name=group_name, 
296                                          protocol=kwds.get('protocol'), 
297                                          cidr_ip =kwds.get('cidr_ip'), 
298                                          icmp_type_code = kwds.get('icmp_type_code'))
299
300  
301
302     def run_instances(self, instance_name, tenant_name, rspec, key_name, pubkeys):
303         #logger.debug('Reserving an instance: image: %s, flavor: ' \
304         #            '%s, key: %s, name: %s' % \
305         #            (image_id, flavor_id, key_name, slicename))
306
307         # make sure a tenant exists for this slice
308         tenant = self.create_tenant(tenant_name)  
309
310         # add the sfa admin user to this tenant and update our nova client connection
311         # to use these credentials for the rest of this session. This emsures that the instances
312         # we create will be assigned to the correct tenant.
313         sfa_admin_user = self.driver.shell.auth_manager.users.find(name=self.driver.shell.auth_manager.opts['OS_USERNAME'])
314         user_role = self.driver.shell.auth_manager.roles.find(name='user')
315         admin_role = self.driver.shell.auth_manager.roles.find(name='admin')
316         self.driver.shell.auth_manager.roles.add_user_role(sfa_admin_user, admin_role, tenant)
317         self.driver.shell.auth_manager.roles.add_user_role(sfa_admin_user, user_role, tenant)
318         self.driver.shell.nova_manager.connect(tenant=tenant.name)  
319
320         authorized_keys = "\n".join(pubkeys)
321         files = {'/root/.ssh/authorized_keys': authorized_keys}
322         rspec = RSpec(rspec)
323         requested_instances = defaultdict(list)
324         # iterate over clouds/zones/nodes
325         for node in rspec.version.get_nodes_with_slivers():
326             instances = node.get('slivers', [])
327             if not instances:
328                 continue
329             for instance in instances:
330                 try: 
331                     metadata = {}
332                     flavor_id = self.driver.shell.nova_manager.flavors.find(name=instance['name'])
333                     image = instance.get('disk_image')
334                     if image and isinstance(image, list):
335                         image = image[0]
336                     image_id = self.driver.shell.nova_manager.images.find(name=image['name'])
337                     fw_rules = instance.get('fw_rules', [])
338                     group_name = self.create_security_group(instance_name, fw_rules)
339                     metadata['security_groups'] = group_name
340                     if node.get('component_id'):
341                         metadata['component_id'] = node['component_id']
342                     self.driver.shell.nova_manager.servers.create(flavor=flavor_id,
343                                                             image=image_id,
344                                                             key_name = key_name,
345                                                             security_groups = [group_name],
346                                                             files=files,
347                                                             meta=metadata, 
348                                                             name=instance_name)
349                 except Exception, err:    
350                     logger.log_exc(err)                                
351                            
352
353
354     def delete_instances(self, instance_name, tenant_name):
355         self.driver.shell.nova_manager.connect(tenant=tenant_name)
356         instances = self.driver.shell.nova_manager.servers.findall(name=instance_name)
357         security_group_manager = SecurityGroup(self.driver)
358         for instance in instances:
359             # deleate this instance's security groups
360             security_group = instance.metadata.get('security_groups', '')
361             if security_group:
362                 # dont delete the default security group
363                 if security_group != 'default': 
364                     security_group_manager.delete_security_group(security_group)
365             # destroy instance
366             self.driver.shell.nova_manager.servers.delete(instance)
367         return 1
368
369     def stop_instances(self, instance_name, tenant_name):
370         self.driver.shell.nova_manager.connect(tenant=tenant_name)
371         instances = self.driver.shell.nova_manager.servers.findall(name=instance_name)
372         for instance in instances:
373             self.driver.shell.nova_manager.servers.pause(instance)
374         return 1
375
376     def update_instances(self, project_name):
377         pass