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