Merge branch 'master' into senslab2
[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, InvalidRSpec
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.rspecs.elements.fw_rule import FWRule
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.server.threadmanager import ThreadManager
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 instance_to_sliver(instance, slice_xrn=None):
40     sliver_id = None
41     sliver = Sliver({'name': instance.name,
42                      'type': instance.name,
43                      'cpus': str(instance.vcpus),
44                      'memory': str(instance.ram),
45                      'storage':  str(instance.disk)})
46     return sliver
47
48 def image_to_rspec_disk_image(image):
49     img = DiskImage()
50     img['name'] = image['name']
51     img['description'] = image['name']
52     img['os'] = image['name']
53     img['version'] = image['name']    
54     return img
55     
56 class OSAggregate:
57
58     def __init__(self, driver):
59         self.driver = driver
60
61     def get_rspec(self, slice_xrn=None, version=None, options={}):
62         version_manager = VersionManager()
63         version = version_manager.get_version(version)
64         if not slice_xrn:
65             rspec_version = version_manager._get_version(version.type, version.version, 'ad')
66             nodes = self.get_aggregate_nodes()
67         else:
68             rspec_version = version_manager._get_version(version.type, version.version, 'manifest')
69             nodes = self.get_slice_nodes(slice_xrn)
70         rspec = RSpec(version=rspec_version, user_options=options)
71         rspec.version.add_nodes(nodes)
72         return rspec.toxml()
73
74     def get_availability_zones(self):
75         # essex release
76         zones = self.driver.shell.nova_manager.dns_domains.domains()
77
78         if not zones:
79             zones = ['cloud']
80         else:
81             zones = [zone.name for zone in zones]
82         return zones
83
84     def get_slice_nodes(self, slice_xrn):
85         # update nova connection
86         tenant_name = OSXrn(xrn=slice_xrn, type='slice').get_tenant_name()
87         self.driver.shell.nova_manager.connect(tenant=tenant_name)    
88         
89         zones = self.get_availability_zones()
90         name = hrn_to_os_slicename(slice_xrn)
91         instances = self.driver.shell.nova_manager.servers.findall(name=name)
92         rspec_nodes = []
93         for instance in instances:
94             # determine node urn
95             node_xrn = instance.metadata.get('component_id')
96             if not node_xrn:
97                 node_xrn = OSXrn('cloud', type='node')
98             else:
99                 node_xrn = OSXrn(xrn=node_xrn, type='node')
100
101             rspec_node = Node()
102             rspec_node['component_id'] = node_xrn.urn
103             rspec_node['component_name'] = node_xrn.name
104             rspec_node['component_manager_id'] = Xrn(self.driver.hrn, 'authority+cm').get_urn()
105             if instance.metadata.get('client_id'):
106                 rspec_node['client_id'] = instance.metadata.get('client_id')
107            
108             # get sliver details 
109             sliver_xrn = OSXrn(xrn=slice_xrn, type='slice', id=instance.id)
110             rspec_node['sliver_id'] = sliver_xrn.get_urn() 
111             flavor = self.driver.shell.nova_manager.flavors.find(id=instance.flavor['id'])
112             sliver = instance_to_sliver(flavor)
113             # get firewall rules
114             fw_rules = []
115             group_name = instance.metadata.get('security_groups')
116             if group_name:
117                 group = self.driver.shell.nova_manager.security_groups.find(name=group_name)
118                 for rule in group.rules:
119                     port_range ="%s:%s" % (rule['from_port'], rule['to_port'])
120                     fw_rule = FWRule({'protocol': rule['ip_protocol'],
121                                       'port_range': port_range,
122                                       'cidr_ip': rule['ip_range']['cidr']})
123                     fw_rules.append(fw_rule)
124             sliver['fw_rules'] = fw_rules 
125             rspec_node['slivers']= [sliver]
126             # get disk image
127             image = self.driver.shell.image_manager.get_images(id=instance.image['id'])
128             if isinstance(image, list) and len(image) > 0:
129                 image = image[0]
130             disk_image = image_to_rspec_disk_image(image)
131             sliver['disk_image'] = [disk_image]
132
133             # get interfaces            
134             rspec_node['services'] = []
135             rspec_node['interfaces'] = []
136             addresses = instance.addresses
137             # HACK: public ips are stored in the list of private, but 
138             # this seems wrong. Assume pub ip is the last in the list of 
139             # private ips until openstack bug is fixed.      
140             if addresses.get('private'):
141                 login = Login({'authentication': 'ssh-keys',
142                                'hostname': addresses.get('private')[-1]['addr'],
143                                'port':'22', 'username': 'root'})
144                 service = Services({'login': login})
145                 rspec_node['services'].append(service)    
146             
147             for private_ip in addresses.get('private', []):
148                 if_xrn = PlXrn(auth=self.driver.hrn, 
149                                interface='node%s' % (instance.hostId)) 
150                 if_client_id = Xrn(if_xrn.urn, type='interface', id="eth%s" %if_index).urn
151                 if_sliver_id = Xrn(rspec_node['sliver_id'], type='slice', id="eth%s" %if_index).urn
152                 interface = Interface({'component_id': if_xrn.urn,
153                                        'client_id': if_client_id,
154                                        'sliver_id': if_sliver_id})
155                 interface['ips'] =  [{'address': private_ip['addr'],
156                                      #'netmask': private_ip['network'],
157                                      'type': 'ipv%s' % str(private_ip['version'])}]
158                 rspec_node['interfaces'].append(interface) 
159             
160             # slivers always provide the ssh service
161             for public_ip in addresses.get('public', []):
162                 login = Login({'authentication': 'ssh-keys', 
163                                'hostname': public_ip['addr'], 
164                                'port':'22', 'username': 'root'})
165                 service = Services({'login': login})
166                 rspec_node['services'].append(service)
167
168             rspec_nodes.append(rspec_node)
169         return rspec_nodes
170
171     def get_aggregate_nodes(self):
172         zones = self.get_availability_zones()
173         # available sliver/instance/vm types
174         instances = self.driver.shell.nova_manager.flavors.list()
175         if isinstance(instances, dict):
176             instances = instances.values()
177         # available images
178         images = self.driver.shell.image_manager.get_images_detailed()
179         disk_images  = [image_to_rspec_disk_image(img) for img in images if img['container_format'] in ['ami', 'ovf']]
180         rspec_nodes = []
181         for zone in zones:
182             rspec_node = Node()
183             xrn = OSXrn(zone, type='node')
184             rspec_node['component_id'] = xrn.urn
185             rspec_node['component_name'] = xrn.name
186             rspec_node['component_manager_id'] = Xrn(self.driver.hrn, 'authority+cm').get_urn()
187             rspec_node['exclusive'] = 'false'
188             rspec_node['hardware_types'] = [HardwareType({'name': 'plos-pc'}),
189                                                 HardwareType({'name': 'pc'})]
190             slivers = []
191             for instance in instances:
192                 sliver = instance_to_sliver(instance)
193                 sliver['disk_image'] = disk_images
194                 slivers.append(sliver)
195         
196             rspec_node['slivers'] = slivers
197             rspec_nodes.append(rspec_node) 
198
199         return rspec_nodes 
200
201
202     def create_tenant(self, tenant_name):
203         tenants = self.driver.shell.auth_manager.tenants.findall(name=tenant_name)
204         if not tenants:
205             self.driver.shell.auth_manager.tenants.create(tenant_name, tenant_name)
206             tenant = self.driver.shell.auth_manager.tenants.find(name=tenant_name)
207         else:
208             tenant = tenants[0]
209         return tenant
210             
211
212     def create_instance_key(self, slice_hrn, user):
213         slice_name = Xrn(slice_hrn).leaf
214         user_name = Xrn(user['urn']).leaf
215         key_name = "%s_%s" % (slice_name, user_name)
216         pubkey = user['keys'][0]
217         key_found = False
218         existing_keys = self.driver.shell.nova_manager.keypairs.findall(name=key_name)
219         for existing_key in existing_keys:
220             if existing_key.public_key != pubkey:
221                 self.driver.shell.nova_manager.keypairs.delete(existing_key)
222             elif existing_key.public_key == pubkey:
223                 key_found = True
224
225         if not key_found:
226             self.driver.shell.nova_manager.keypairs.create(key_name, pubkey)
227         return key_name       
228         
229
230     def create_security_group(self, slicename, fw_rules=[]):
231         # use default group by default
232         group_name = 'default' 
233         if isinstance(fw_rules, list) and fw_rules:
234             # Each sliver get's its own security group.
235             # Keep security group names unique by appending some random
236             # characters on end.
237             random_name = "".join([random.choice(string.letters+string.digits)
238                                            for i in xrange(6)])
239             group_name = slicename + random_name 
240             security_group = SecurityGroup(self.driver)
241             security_group.create_security_group(group_name)
242             for rule in fw_rules:
243                 security_group.add_rule_to_group(group_name, 
244                                              protocol = rule.get('protocol'), 
245                                              cidr_ip = rule.get('cidr_ip'), 
246                                              port_range = rule.get('port_range'), 
247                                              icmp_type_code = rule.get('icmp_type_code'))
248             # Open ICMP by default
249             security_group.add_rule_to_group(group_name,
250                                              protocol = "icmp",
251                                              cidr_ip = "0.0.0.0/0",
252                                              icmp_type_code = "-1:-1")
253         return group_name
254
255     def add_rule_to_security_group(self, group_name, **kwds):
256         security_group = SecurityGroup(self.driver)
257         security_group.add_rule_to_group(group_name=group_name, 
258                                          protocol=kwds.get('protocol'), 
259                                          cidr_ip =kwds.get('cidr_ip'), 
260                                          icmp_type_code = kwds.get('icmp_type_code'))
261
262  
263
264     def run_instances(self, instance_name, tenant_name, rspec, key_name, pubkeys):
265         #logger.debug('Reserving an instance: image: %s, flavor: ' \
266         #            '%s, key: %s, name: %s' % \
267         #            (image_id, flavor_id, key_name, slicename))
268
269         # make sure a tenant exists for this slice
270         tenant = self.create_tenant(tenant_name)  
271
272         # add the sfa admin user to this tenant and update our nova client connection
273         # to use these credentials for the rest of this session. This emsures that the instances
274         # we create will be assigned to the correct tenant.
275         sfa_admin_user = self.driver.shell.auth_manager.users.find(name=self.driver.shell.auth_manager.opts['OS_USERNAME'])
276         user_role = self.driver.shell.auth_manager.roles.find(name='user')
277         admin_role = self.driver.shell.auth_manager.roles.find(name='admin')
278         self.driver.shell.auth_manager.roles.add_user_role(sfa_admin_user, admin_role, tenant)
279         self.driver.shell.auth_manager.roles.add_user_role(sfa_admin_user, user_role, tenant)
280         self.driver.shell.nova_manager.connect(tenant=tenant.name)  
281
282         authorized_keys = "\n".join(pubkeys)
283         files = {'/root/.ssh/authorized_keys': authorized_keys}
284         rspec = RSpec(rspec)
285         requested_instances = defaultdict(list)
286         # iterate over clouds/zones/nodes
287         for node in rspec.version.get_nodes_with_slivers():
288             instances = node.get('slivers', [])
289             if not instances:
290                 continue
291             for instance in instances:
292                 try: 
293                     metadata = {}
294                     flavor_id = self.driver.shell.nova_manager.flavors.find(name=instance['name'])
295                     image = instance.get('disk_image')
296                     if image and isinstance(image, list):
297                         image = image[0]
298                     else:
299                         raise InvalidRSpec("Must specify a disk_image for each VM")
300                     image_id = self.driver.shell.nova_manager.images.find(name=image['name'])
301                     fw_rules = instance.get('fw_rules', [])
302                     group_name = self.create_security_group(instance_name, fw_rules)
303                     metadata['security_groups'] = group_name
304                     if node.get('component_id'):
305                         metadata['component_id'] = node['component_id']
306                     if node.get('client_id'):
307                         metadata['client_id'] = node['client_id']
308                     self.driver.shell.nova_manager.servers.create(flavor=flavor_id,
309                                                             image=image_id,
310                                                             key_name = key_name,
311                                                             security_groups = [group_name],
312                                                             files=files,
313                                                             meta=metadata, 
314                                                             name=instance_name)
315                 except Exception, err:    
316                     logger.log_exc(err)                                
317                            
318
319
320     def delete_instances(self, instance_name, tenant_name):
321
322         def _delete_security_group(instance):
323             security_group = instance.metadata.get('security_groups', '')
324             if security_group:
325                 manager = SecurityGroup(self.driver)
326                 timeout = 10.0 # wait a maximum of 10 seconds before forcing the security group delete
327                 start_time = time.time()
328                 instance_deleted = False
329                 while instance_deleted == False and (time.time() - start_time) < timeout:
330                     inst = self.driver.shell.nova_manager.servers.findall(id=instance.id)
331                     if not inst:
332                         instance_deleted = True
333                     time.sleep(.5)
334                 manager.delete_security_group(security_group)
335
336         thread_manager = ThreadManager()
337         self.driver.shell.nova_manager.connect(tenant=tenant_name)
338         instances = self.driver.shell.nova_manager.servers.findall(name=instance_name)
339         for instance in instances:
340             # destroy instance
341             self.driver.shell.nova_manager.servers.delete(instance)
342             # deleate this instance's security groups
343             thread_manager.run(_delete_security_group, instance)
344         return True
345
346
347     def stop_instances(self, instance_name, tenant_name):
348         self.driver.shell.nova_manager.connect(tenant=tenant_name)
349         instances = self.driver.shell.nova_manager.servers.findall(name=instance_name)
350         for instance in instances:
351             self.driver.shell.nova_manager.servers.pause(instance)
352         return 1
353
354     def update_instances(self, project_name):
355         pass