3 from planetstack.config import Config
6 from openstack.client import OpenStackClient
11 manager_enabled = Config().api_nova_enabled
13 class OpenStackDriver:
15 def __init__(self, config = None, client=None, deployment=None):
17 self.config = Config(config)
19 self.config = Config()
21 self.admin_client = OpenStackClient(deployment=deployment)
22 self.admin_user = self.admin_client.keystone.users.find(name=self.admin_client.keystone.username)
27 self.shell = OpenStackClient(deployment=deployment)
29 self.enabled = manager_enabled
30 self.has_openstack = has_openstack
32 def client_driver(self, caller=None, tenant=None, deployment=None):
34 auth = {'username': caller.email,
35 'password': hashlib.md5(caller.password).hexdigest()[:6],
37 client = OpenStackClient(deployment=deployment, **auth)
39 client = OpenStackClient(tenant=tenant, deployment=deployment)
41 driver = OpenStackDriver(client=client, deployment=deployment)
44 def admin_driver(self, tenant=None, deployment=None):
45 client = OpenStackClient(tenant=tenant, deployment=deployment)
46 driver = OpenStackDriver(client=client, deployment=deployment)
49 def create_role(self, name):
50 roles = self.shell.keystone.roles.findall(name=name)
52 role = self.shell.keystone.roles.create(name)
57 def delete_role(self, filter):
58 roles = self.shell.keystone.roles.findall(**filter)
60 self.shell.keystone.roles.delete(role)
63 def create_tenant(self, tenant_name, enabled, description):
64 """Create keystone tenant. Suggested fields: name, description, enabled"""
65 tenants = self.shell.keystone.tenants.findall(name=tenant_name)
67 fields = {'tenant_name': tenant_name, 'enabled': enabled,
68 'description': description}
69 tenant = self.shell.keystone.tenants.create(**fields)
73 # always give the admin user the admin role to any tenant created
75 self.add_user_role(self.admin_user.id, tenant.id, 'admin')
78 def update_tenant(self, id, **kwds):
79 return self.shell.keystone.tenants.update(id, **kwds)
81 def delete_tenant(self, id):
82 ctx = self.shell.nova_db.ctx
83 tenants = self.shell.keystone.tenants.findall(id=id)
84 for tenant in tenants:
85 # nova does not automatically delete the tenant's instances
86 # so we manually delete instances before deleteing the tenant
87 instances = self.shell.nova_db.instance_get_all_by_filters(ctx,
88 {'project_id': tenant.id}, 'id', 'asc')
89 client = OpenStackClient(tenant=tenant.name)
90 driver = OpenStackDriver(client=client)
91 for instance in instances:
92 driver.destroy_instance(instance.id)
93 self.shell.keystone.tenants.delete(tenant)
96 def create_user(self, name, email, password, enabled):
97 users = self.shell.keystone.users.findall(email=email)
99 fields = {'name': name, 'email': email, 'password': password,
101 user = self.shell.keystone.users.create(**fields)
106 def delete_user(self, id):
107 users = self.shell.keystone.users.findall(id=id)
110 keys = self.shell.nova.keypairs.findall()
112 self.shell.nova.keypairs.delete(key)
113 self.shell.keystone.users.delete(user)
116 def get_admin_role(self):
118 for admin_role_name in ['admin', 'Admin']:
119 roles = self.shell.keystone.roles.findall(name=admin_role_name)
125 def add_user_role(self, kuser_id, tenant_id, role_name):
126 user = self.shell.keystone.users.find(id=kuser_id)
127 tenant = self.shell.keystone.tenants.find(id=tenant_id)
128 # admin role can be lowercase or title. Look for both
130 if role_name.lower() == 'admin':
131 role = self.get_admin_role()
133 # look up non admin role or force exception when admin role isnt found
134 role = self.shell.keystone.roles.find(name=role_name)
137 user_roles = user.list_roles(tenant.id)
138 for user_role in user_roles:
139 if user_role.name == role.name:
142 tenant.add_user(user, role)
146 def delete_user_role(self, kuser_id, tenant_id, role_name):
147 user = self.shell.keystone.users.find(id=kuser_id)
148 tenant = self.shell.keystone.tenants.find(id=tenant_id)
149 # admin role can be lowercase or title. Look for both
151 if role_name.lower() == 'admin':
152 role = self.get_admin_role()
154 # look up non admin role or force exception when admin role isnt found
155 role = self.shell.keystone.roles.find(name=role_name)
158 user_roles = user.list_roles(tenant.id)
159 for user_role in user_roles:
160 if user_role.name == role.name:
163 tenant.remove_user(user, role)
167 def update_user(self, id, fields):
168 if 'password' in fields:
169 self.shell.keystone.users.update_password(id, fields['password'])
170 if 'enabled' in fields:
171 self.shell.keystone.users.update_enabled(id, fields['enabled'])
174 def create_router(self, name, set_gateway=True):
175 routers = self.shell.quantum.list_routers(name=name)['routers']
179 router = self.shell.quantum.create_router({'router': {'name': name}})['router']
180 # add router to external network
182 nets = self.shell.quantum.list_networks()['networks']
184 if net['router:external'] == True:
185 self.shell.quantum.add_gateway_router(router['id'],
186 {'network_id': net['id']})
190 def delete_router(self, id):
191 routers = self.shell.quantum.list_routers(id=id)['routers']
192 for router in routers:
193 self.shell.quantum.delete_router(router['id'])
194 # remove router form external network
195 #nets = self.shell.quantum.list_networks()['networks']
197 # if net['router:external'] == True:
198 # self.shell.quantum.remove_gateway_router(router['id'])
200 def add_router_interface(self, router_id, subnet_id):
201 router = self.shell.quantum.show_router(router_id)['router']
202 subnet = self.shell.quantum.show_subnet(subnet_id)['subnet']
203 if router and subnet:
204 self.shell.quantum.add_interface_router(router_id, {'subnet_id': subnet_id})
206 def delete_router_interface(self, router_id, subnet_id):
207 router = self.shell.quantum.show_router(router_id)
208 subnet = self.shell.quantum.show_subnet(subnet_id)
209 if router and subnet:
210 self.shell.quantum.remove_interface_router(router_id, {'subnet_id': subnet_id})
212 def create_network(self, name, shared=False):
213 nets = self.shell.quantum.list_networks(name=name)['networks']
217 net = self.shell.quantum.create_network({'network': {'name': name, 'shared': shared}})['network']
220 def delete_network(self, id):
221 nets = self.shell.quantum.list_networks()['networks']
225 self.delete_network_ports(net['id'])
226 # delete all subnets:
227 for subnet_id in net['subnets']:
228 self.delete_subnet(subnet_id)
229 self.shell.quantum.delete_network(net['id'])
232 def delete_network_ports(self, network_id):
233 ports = self.shell.quantum.list_ports()['ports']
235 if port['network_id'] == network_id:
236 self.shell.quantum.delete_port(port['id'])
239 def delete_subnet_ports(self, subnet_id):
240 ports = self.shell.quantum.list_ports()['ports']
243 for fixed_ip in port['fixed_ips']:
244 if fixed_ip['subnet_id'] == subnet_id:
248 self.shell.quantum.delete_port(port['id'])
251 def create_subnet(self, name, network_id, cidr_ip, ip_version, start, end):
252 #nets = self.shell.quantum.list_networks(name=network_name)['networks']
254 # raise Exception, "No such network: %s" % network_name
258 subnets = self.shell.quantum.list_subnets()['subnets']
260 if snet['cidr'] == cidr_ip and snet['network_id'] == network_id:
264 allocation_pools = [{'start': start, 'end': end}]
265 subnet = {'subnet': {'name': name,
266 'network_id': network_id,
267 'ip_version': ip_version,
269 'dns_nameservers': ['8.8.8.8', '8.8.4.4'],
270 'allocation_pools': allocation_pools}}
271 subnet = self.shell.quantum.create_subnet(subnet)['subnet']
272 self.add_external_route(subnet)
273 # TODO: Add route to external network
274 # e.g. # route add -net 10.0.3.0/24 dev br-ex gw 10.100.0.5
277 def update_subnet(self, id, fields):
278 return self.shell.quantum.update_subnet(id, fields)
280 def delete_subnet(self, id):
281 #return self.shell.quantum.delete_subnet(id=id)
282 # inefficient but fault tolerant
283 subnets = self.shell.quantum.list_subnets()['subnets']
284 for subnet in subnets:
285 if subnet['id'] == id:
286 self.delete_subnet_ports(subnet['id'])
287 self.shell.quantum.delete_subnet(id)
288 self.delete_external_route(subnet)
291 def get_external_routes(self):
292 status, output = commands.getstatusoutput('route')
293 routes = output.split('\n')[3:]
296 def add_external_route(self, subnet, routes=[]):
298 routes = self.get_external_routes()
300 ports = self.shell.quantum.list_ports()['ports']
302 gw_ip = subnet['gateway_ip']
303 subnet_id = subnet['id']
305 # 1. Find the port associated with the subnet's gateway
306 # 2. Find the router associated with that port
307 # 3. Find the port associated with this router and on the external net
308 # 4. Set up route to the subnet through the port from step 3
311 for fixed_ip in port['fixed_ips']:
312 if fixed_ip['subnet_id'] == subnet_id and fixed_ip['ip_address'] == gw_ip:
314 router_id = gw_port['device_id']
315 router = self.shell.quantum.show_router(router_id)['router']
316 if router and router.get('external_gateway_info'):
317 ext_net = router['external_gateway_info']['network_id']
319 if port['device_id'] == router_id and port['network_id'] == ext_net:
320 ip_address = port['fixed_ips'][0]['ip_address']
323 # check if external route already exists
327 if subnet['cidr'] in route and ip_address in route:
330 cmd = "route add -net %s dev br-ex gw %s" % (subnet['cidr'], ip_address)
331 s, o = commands.getstatusoutput(cmd)
332 #print cmd, "\n", s, o
336 def delete_external_route(self, subnet):
337 ports = self.shell.quantum.list_ports()['ports']
339 gw_ip = subnet['gateway_ip']
340 subnet_id = subnet['id']
342 # 1. Find the port associated with the subnet's gateway
343 # 2. Find the router associated with that port
344 # 3. Find the port associated with this router and on the external net
345 # 4. Set up route to the subnet through the port from step 3
348 for fixed_ip in port['fixed_ips']:
349 if fixed_ip['subnet_id'] == subnet_id and fixed_ip['ip_address'] == gw_ip:
351 router_id = gw_port['device_id']
352 router = self.shell.quantum.show_router(router_id)['router']
353 ext_net = router['external_gateway_info']['network_id']
355 if port['device_id'] == router_id and port['network_id'] == ext_net:
356 ip_address = port['fixed_ips'][0]['ip_address']
359 cmd = "route delete -net %s" % (subnet['cidr'])
360 commands.getstatusoutput(cmd)
364 def create_keypair(self, name, public_key):
365 keys = self.shell.nova.keypairs.findall(name=name)
369 if key.public_key != public_key:
370 self.delete_keypair(key.id)
371 key = self.shell.nova.keypairs.create(name=name, public_key=public_key)
373 key = self.shell.nova.keypairs.create(name=name, public_key=public_key)
376 def delete_keypair(self, id):
377 keys = self.shell.nova.keypairs.findall(id=id)
379 self.shell.nova.keypairs.delete(key)
382 def get_private_networks(self, tenant=None):
384 tenant = self.shell.nova.tenant
385 tenant = self.shell.keystone.tenants.find(name=tenant)
386 search_opts = {"tenant_id": tenant.id, "shared": False}
387 private_networks = self.shell.quantum.list_networks(**search_opts)
388 return private_networks
390 def get_shared_networks(self):
391 search_opts = {"shared": True}
392 shared_networks = self.shell.quantum.list_networks(**search_opts)
393 return shared_networks
395 def get_network_subnet(self, network_id):
399 os_networks = self.shell.quantum.list_networks(id=network_id)["networks"]
401 os_network = os_networks[0]
402 if os_network['subnets']:
403 subnet_id = os_network['subnets'][0]
404 os_subnets = self.shell.quantum.list_subnets(id=subnet_id)['subnets']
406 subnet = os_subnets[0]['cidr']
408 return (subnet_id, subnet)
410 def spawn_instance(self, name, key_name=None, hostname=None, image_id=None, security_group=None, pubkeys=[], nics=None, metadata=None):
411 flavor_name = self.config.nova_default_flavor
412 flavor = self.shell.nova.flavors.find(name=flavor_name)
414 # image = self.config.nova_default_imave
415 if not security_group:
416 security_group = self.config.nova_default_security_group
421 'path': '/root/.ssh/authorized_keys',
422 'contents':"\n".join(pubkeys),
425 availability_zone = None
427 availability_zone = 'nova:%s' % hostname.split('.')[0]
428 server = self.shell.nova.servers.create(
433 security_group = security_group,
434 personality = personality,
435 scheduler_hints=hints,
436 availability_zone=availability_zone,
442 def destroy_instance(self, id):
443 if (self.shell.nova.tenant=="admin"):
444 # findall() is implemented as a list() followed by a python search of the
445 # list. Since findall() doesn't accept "all_tenants", we do this using
446 # list() ourselves. This allows us to delete an instance as admin.
447 servers = self.shell.nova.servers.list(search_opts={"all_tenants": True})
449 servers = self.shell.nova.servers.list()
450 for server in servers:
452 result=self.shell.nova.servers.delete(server)
454 def update_instance_metadata(self, id, metadata):
455 servers = self.shell.nova.servers.findall(id=id)
456 for server in servers:
457 self.shell.nova.servers.set_meta(server, metadata)
458 # note: set_meta() returns a broken Server() object. Don't try to
459 # print it in the shell or it will fail in __repr__.
461 def delete_instance_metadata(self, id, metadata):
462 # note: metadata is a dict. Only the keys matter, not the values.
463 servers = self.shell.nova.servers.findall(id=id)
464 for server in servers:
465 self.shell.nova.servers.delete_meta(server, metadata)