Merge branch 'master' into senslab2
[sfa.git] / sfa / openstack / osaggregate.py
1 from nova.exception import ImageNotFound
2 from nova.api.ec2.cloud import CloudController
3 from sfa.util.faults import SfaAPIError
4 from sfa.rspecs.rspec import RSpec
5 from sfa.rspecs.elements.hardware_type import HardwareType
6 from sfa.rspecs.elements.node import Node
7 from sfa.rspecs.elements.sliver import Sliver
8 from sfa.rspecs.elements.login import Login
9 from sfa.rspecs.elements.disk_image import DiskImage
10 from sfa.rspecs.elements.services import Services
11 from sfa.util.xrn import Xrn
12 from sfa.util.osxrn import OSXrn
13 from sfa.rspecs.version_manager import VersionManager
14
15
16 def disk_image_to_rspec_object(image):
17     img = DiskImage()
18     img['name'] = image['ami']['name']
19     img['description'] = image['ami']['name']
20     img['os'] = image['ami']['name']
21     img['version'] = image['ami']['name']
22     return img
23     
24
25 def instance_to_sliver(instance, slice_xrn=None):
26     # should include?
27     # * instance.image_ref
28     # * instance.kernel_id
29     # * instance.ramdisk_id
30     import nova.db.sqlalchemy.models
31     name=None
32     type=None
33     sliver_id = None
34     if isinstance(instance, dict):
35         # this is an isntance type dict
36         name = instance['name']
37         type = instance['name']
38     elif isinstance(instance, nova.db.sqlalchemy.models.Instance):
39         # this is an object that describes a running instance
40         name = instance.display_name
41         type = instance.instance_type.name
42     else:
43         raise SfaAPIError("instnace must be an instance_type dict or" + \
44                            " a nova.db.sqlalchemy.models.Instance object")
45     if slice_xrn:
46         xrn = Xrn(slice_xrn, 'slice')
47         sliver_id = xrn.get_sliver_id(instance.project_id, instance.hostname, instance.id)
48
49     sliver = Sliver({'slice_id': sliver_id,
50                      'name': name,
51                      'type': 'plos-' + type,
52                      'tags': []})
53     return sliver
54             
55
56 class OSAggregate:
57
58     def __init__(self, driver):
59         self.driver = driver
60
61     def get_machine_image_details(self, image):
62         """
63         Returns a dict that contains the ami, aki and ari details for the specified
64         ami image. 
65         """
66         disk_image = {}
67         if image['container_format'] == 'ami':
68             kernel_id = image['properties']['kernel_id']
69             ramdisk_id = image['properties']['ramdisk_id']
70             disk_image['ami'] = image
71             disk_image['aki'] = self.driver.shell.image_manager.show(kernel_id)
72             disk_image['ari'] = self.driver.shell.image_manager.show(ramdisk_id)
73         return disk_image
74         
75     def get_disk_image(self, id=None, name=None):
76         """
77         Look up a image bundle using the specifeid id or name  
78         """
79         disk_image = None    
80         try:
81             if id:
82                 image = self.driver.shell.image_manager.show(image_id)
83             elif name:
84                 image = self.driver.shell.image_manager.show_by_name(image_name)
85             if image['container_format'] == 'ami':
86                 disk_image = self.get_machine_image_details(image)
87         except ImageNotFound:
88                 pass
89         return disk_image
90
91     def get_available_disk_images(self):
92         # get image records
93         disk_images = []
94         for image in self.driver.shell.image_manager.detail():
95             if image['container_format'] == 'ami':
96                 disk_images.append(self.get_machine_image_details(image))
97         return disk_images 
98
99     def get_rspec(self, slice_xrn=None, version=None, options={}):
100         version_manager = VersionManager()
101         version = version_manager.get_version(version)
102         if not slice_xrn:
103             rspec_version = version_manager._get_version(version.type, version.version, 'ad')
104             nodes = self.get_aggregate_nodes()
105         else:
106             rspec_version = version_manager._get_version(version.type, version.version, 'manifest')
107             nodes = self.get_slice_nodes(slice_xrn)
108         rspec = RSpec(version=rspec_version, user_options=options)
109         rspec.version.add_nodes(nodes)
110         return rspec.toxml()
111
112     def get_slice_nodes(self, slice_xrn):
113         name = OSXrn(xrn = slice_xrn).name
114         instances = self.driver.shell.db.instance_get_all_by_project(name)
115         rspec_nodes = []
116         for instance in instances:
117             rspec_node = Node()
118             xrn = OSXrn(instance.hostname, 'node')
119             rspec_node['component_id'] = xrn.urn
120             rspec_node['component_name'] = xrn.name
121             rspec_node['component_manager_id'] = Xrn(self.driver.hrn, 'authority+cm').get_urn()   
122             sliver = instance_to_sliver(instance)
123             disk_image = self.get_disk_image(instance.image_ref)
124             sliver['disk_images'] = [disk_image_to_rspec_object(disk_image)]
125             rspec_node['slivers'] = [sliver]
126             rspec_nodes.append(rspec_node)
127         return rspec_nodes
128
129     def get_aggregate_nodes(self):
130                 
131         zones = self.driver.shell.db.zone_get_all()
132         if not zones:
133             zones = ['cloud']
134         else:
135             zones = [zone.name for zone in zones]
136
137         # available sliver/instance/vm types
138         instances = self.driver.shell.db.instance_type_get_all().values()
139         # available images
140         disk_images = self.get_available_disk_images()
141         disk_image_objects = [disk_image_to_rspec_object(image) \
142                                for image in disk_images]  
143         rspec_nodes = []
144         for zone in zones:
145             rspec_node = Node()
146             xrn = OSXrn(zone, 'node')
147             rspec_node['component_id'] = xrn.urn
148             rspec_node['component_name'] = xrn.name
149             rspec_node['component_manager_id'] = Xrn(self.driver.hrn, 'authority+cm').get_urn()
150             rspec_node['exclusive'] = 'false'
151             rspec_node['hardware_types'] = [HardwareType({'name': 'plos-pc'}),
152                                                 HardwareType({'name': 'pc'})]
153             slivers = []
154             for instance in instances:
155                 sliver = instance_to_sliver(instance)
156                 sliver['disk_images'] = disk_image_objects
157                 slivers.append(sliver)
158         
159             rspec_node['slivers'] = slivers
160             rspec_nodes.append(rspec_node) 
161
162         return rspec_nodes 
163
164
165     def create_project(self, slicename, users, options={}):
166         """
167         Create the slice if it doesn't alredy exist  
168         """
169         import nova.exception.ProjectNotFound
170         try:
171             slice = self.driver.shell.auth_manager.get_project(slicename)
172         except nova.exception.ProjectNotFound:
173             # convert urns to user names
174             usernames = [Xrn(user['urn']).get_leaf() for user in users]
175             # assume that the first user is the project manager
176             proj_manager = usernames[0] 
177             self.driver.shell.auth_manager.create_project(slicename, proj_manager)
178
179     def create_project_users(self, slicename, users, options={}):
180         """
181         Add requested users to the specified slice.  
182         """
183         
184         # There doesn't seem to be an effcient way to 
185         # look up all the users of a project, so lets not  
186         # attempt to remove stale users . For now lets just
187         # ensure that the specified users exist     
188         for user in users:
189             username = Xrn(user['urn']).get_leaf()
190             try:
191                 self.driver.shell.auth_manager.get_user(username)
192             except nova.exception.UserNotFound:
193                 self.driver.shell.auth_manager.create_user(username)
194             self.verify_user_keys(username, user['keys'], options)
195         
196
197     def verify_user_keys(self, username, keys, options={}):
198         """
199         Add requested keys.
200         """
201         append = options.get('append', True)    
202         existing_keys = self.driver.shell.db.key_pair_get_all_by_user(username)
203         existing_pub_keys = [key.public_key for key in existing_keys]
204         removed_pub_keys = set(existing_pub_keys).difference(keys)
205         added_pub_keys = set(keys).difference(existing_pub_keys)
206         pubkeys = []
207         # add new keys
208         for public_key in added_pub_keys:
209             key = {}
210             key['user_id'] = username
211             key['name'] =  username
212             key['public'] = public_key
213             self.driver.shell.db.key_pair_create(key)
214
215         # remove old keys
216         if not append:
217             for key in existing_keys:
218                 if key.public_key in removed_pub_keys:
219                     self.driver.shell.db.key_pair_destroy(username, key.name)
220     
221     def reserve_instance(self, image_id, kernel_id, ramdisk_id, \
222                          instance_type, key_name, user_data):
223         conn  = self.driver.euca_shell
224         logger.info('Reserving an instance: image: %s, kernel: ' \
225                     '%s, ramdisk: %s, type: %s, key: %s' % \
226                     (image_id, kernel_id, ramdisk_id,
227                     instance_type, key_name))
228         try:
229             reservation = conn.run_instances(image_id=image_id,
230                                              kernel_id=kernel_id,
231                                              ramdisk_id=ramdisk_id,
232                                              instance_type=instance_type,
233                                              key_name=key_name,
234                                              user_data = user_data)
235         except EC2ResponseError, ec2RespError:
236             logger.log_exc(ec2RespError)
237                
238     def run_instances(self, slicename, rspec, keyname, pubkeys):
239         """
240         Create the instances thats requested in the rspec 
241         """
242         # the default image to use for instnaces that dont
243         # explicitly request an image.
244         # Just choose the first available image for now.
245         available_images = self.get_available_disk_images()
246         default_image = self.get_disk_images()[0]    
247         default_ami_id = CloudController.image_ec2_id(default_image['ami']['id'])  
248         default_aki_id = CloudController.image_ec2_id(default_image['aki']['id'])  
249         default_ari_id = CloudController.image_ec2_id(default_image['ari']['id'])
250
251         # get requested slivers
252         rspec = RSpec(rspec)
253         requested_instances = defaultdict(list)
254         # iterate over clouds/zones/nodes
255         for node in rspec.version.get_nodes_with_slivers():
256             instance_types = node.get('slivers', [])
257             if isinstance(instance_types, list):
258                 # iterate over sliver/instance types
259                 for instance_type in instance_types:
260                     ami_id = default_ami_id
261                     aki_id = default_aki_id
262                     ari_id = default_ari_id
263                     req_image = instance_type.get('disk_images')
264                     if req_image and isinstance(req_image, list):
265                         req_image_name = req_image[0]['name']
266                         disk_image = self.get_disk_image(name=req_image_name)
267                         if disk_image:
268                             ami_id = CloudController.image_ec2_id(disk_image['ami']['id'])
269                             aki_id = CloudController.image_ec2_id(disk_image['aki']['id'])
270                             ari_id = CloudController.image_ec2_id(disk_image['ari']['id'])
271                     # start the instance
272                     self.reserve_instance(ami_id, aki_id, ari_id, \
273                                           instance_type['name'], keyname, pubkeys)