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):
17 self.config = Config(config)
19 self.config = Config()
21 self.admin_client = OpenStackClient()
22 self.admin_user = self.admin_client.keystone.users.find(name=self.admin_client.keystone.username)
27 self.shell = OpenStackClient()
29 self.enabled = manager_enabled
30 self.has_openstack = has_openstack
32 def client_driver(self, caller=None, tenant=None):
34 auth = {'username': caller.email,
35 'password': hashlib.md5(caller.password).hexdigest()[:6],
37 client = OpenStackClient(**auth)
39 client = OpenStackClient(tenant=tenant)
40 driver = OpenStackDriver(client=client)
43 def admin_driver(self, tenant=None):
44 client = OpenStackClient(tenant=tenant)
45 driver = OpenStackDriver(client=client)
47 def create_role(self, name):
48 roles = self.shell.keystone.roles.findall(name=name)
50 role = self.shell.keystone.roles.create(name)
55 def delete_role(self, filter):
56 roles = self.shell.keystone.roles.findall(**filter)
58 self.shell.keystone.roles.delete(role)
61 def create_tenant(self, tenant_name, enabled, description):
62 """Create keystone tenant. Suggested fields: name, description, enabled"""
63 tenants = self.shell.keystone.tenants.findall(name=tenant_name)
65 fields = {'tenant_name': tenant_name, 'enabled': enabled,
66 'description': description}
67 tenant = self.shell.keystone.tenants.create(**fields)
71 # always give the admin user the admin role to any tenant created
73 self.add_user_role(self.admin_user.id, tenant.id, 'admin')
76 def update_tenant(self, id, **kwds):
77 return self.shell.keystone.tenants.update(id, **kwds)
79 def delete_tenant(self, id):
80 ctx = self.shell.nova_db.ctx
81 tenants = self.shell.keystone.tenants.findall(id=id)
82 for tenant in tenants:
83 # nova does not automatically delete the tenant's instances
84 # so we manually delete instances before deleteing the tenant
85 instances = self.shell.nova_db.instance_get_all_by_filters(ctx,
86 {'project_id': tenant.id}, 'id', 'asc')
87 client = OpenStackClient(tenant=tenant.name)
88 driver = OpenStackDriver(client=client)
89 for instance in instances:
90 driver.destroy_instance(instance.id)
91 self.shell.keystone.tenants.delete(tenant)
94 def create_user(self, name, email, password, enabled):
95 users = self.shell.keystone.users.findall(email=email)
97 fields = {'name': name, 'email': email, 'password': password,
99 user = self.shell.keystone.users.create(**fields)
104 def delete_user(self, id):
105 users = self.shell.keystone.users.findall(id=id)
108 keys = self.shell.nova.keypairs.findall()
110 self.shell.nova.keypairs.delete(key)
111 self.shell.keystone.users.delete(user)
114 def add_user_role(self, kuser_id, tenant_id, role_name):
115 user = self.shell.keystone.users.find(id=kuser_id)
116 tenant = self.shell.keystone.tenants.find(id=tenant_id)
117 role = self.shell.keystone.roles.find(name=role_name)
120 user_roles = user.list_roles(tenant.id)
121 for user_role in user_roles:
122 if user_role.name == role.name:
125 tenant.add_user(user, role)
129 def delete_user_role(self, kuser_id, tenant_id, role_name):
130 user = self.shell.keystone.users.find(id=kuser_id)
131 tenant = self.shell.keystone.tenants.find(id=tenant_id)
132 role = self.shell.keystone.roles.find(name=role_name)
135 user_roles = user.list_roles(tenant.id)
136 for user_role in user_roles:
137 if user_role.name == role.name:
140 tenant.remove_user(user, role)
144 def update_user(self, id, fields):
145 if 'password' in fields:
146 self.shell.keystone.users.update_password(id, fields['password'])
147 if 'enabled' in fields:
148 self.shell.keystone.users.update_enabled(id, fields['enabled'])
151 def create_router(self, name, set_gateway=True):
152 routers = self.shell.quantum.list_routers(name=name)['routers']
156 router = self.shell.quantum.create_router({'router': {'name': name}})['router']
157 # add router to external network
159 nets = self.shell.quantum.list_networks()['networks']
161 if net['router:external'] == True:
162 self.shell.quantum.add_gateway_router(router['id'],
163 {'network_id': net['id']})
167 def delete_router(self, id):
168 routers = self.shell.quantum.list_routers(id=id)['routers']
169 for router in routers:
170 self.shell.quantum.delete_router(router['id'])
171 # remove router form external network
172 #nets = self.shell.quantum.list_networks()['networks']
174 # if net['router:external'] == True:
175 # self.shell.quantum.remove_gateway_router(router['id'])
177 def add_router_interface(self, router_id, subnet_id):
178 router = self.shell.quantum.show_router(router_id)['router']
179 subnet = self.shell.quantum.show_subnet(subnet_id)['subnet']
180 if router and subnet:
181 self.shell.quantum.add_interface_router(router_id, {'subnet_id': subnet_id})
183 def delete_router_interface(self, router_id, subnet_id):
184 router = self.shell.quantum.show_router(router_id)
185 subnet = self.shell.quantum.show_subnet(subnet_id)
186 if router and subnet:
187 self.shell.quantum.remove_interface_router(router_id, {'subnet_id': subnet_id})
189 def create_network(self, name, shared=False):
190 nets = self.shell.quantum.list_networks(name=name)['networks']
194 net = self.shell.quantum.create_network({'network': {'name': name, 'shared': shared}})['network']
197 def delete_network(self, id):
198 nets = self.shell.quantum.list_networks()['networks']
202 self.delete_network_ports(net['id'])
203 # delete all subnets:
204 for subnet_id in net['subnets']:
205 self.delete_subnet(subnet_id)
206 self.shell.quantum.delete_network(net['id'])
209 def delete_network_ports(self, network_id):
210 ports = self.shell.quantum.list_ports()['ports']
212 if port['network_id'] == network_id:
213 self.shell.quantum.delete_port(port['id'])
216 def delete_subnet_ports(self, subnet_id):
217 ports = self.shell.quantum.list_ports()['ports']
220 for fixed_ip in port['fixed_ips']:
221 if fixed_ip['subnet_id'] == subnet_id:
225 self.shell.quantum.delete_port(port['id'])
228 def create_subnet(self, name, network_id, cidr_ip, ip_version, start, end):
229 #nets = self.shell.quantum.list_networks(name=network_name)['networks']
231 # raise Exception, "No such network: %s" % network_name
235 subnets = self.shell.quantum.list_subnets()['subnets']
237 if snet['cidr'] == cidr_ip and snet['network_id'] == network_id:
241 allocation_pools = [{'start': start, 'end': end}]
242 subnet = {'subnet': {'name': name,
243 'network_id': network_id,
244 'ip_version': ip_version,
246 'dns_nameservers': ['8.8.8.8', '8.8.4.4'],
247 'allocation_pools': allocation_pools}}
248 subnet = self.shell.quantum.create_subnet(subnet)['subnet']
249 self.add_external_route(subnet)
250 # TODO: Add route to external network
251 # e.g. # route add -net 10.0.3.0/24 dev br-ex gw 10.100.0.5
254 def update_subnet(self, id, fields):
255 return self.shell.quantum.update_subnet(id, fields)
257 def delete_subnet(self, id):
258 #return self.shell.quantum.delete_subnet(id=id)
259 # inefficient but fault tolerant
260 subnets = self.shell.quantum.list_subnets()['subnets']
261 for subnet in subnets:
262 if subnet['id'] == id:
263 self.delete_subnet_ports(subnet['id'])
264 self.shell.quantum.delete_subnet(id)
265 self.delete_external_route(subnet)
268 def get_external_routes(self):
269 status, output = commands.getstatusoutput('route')
270 routes = output.split('\n')[3:]
273 def add_external_route(self, subnet, routes=[]):
275 routes = self.get_external_routes()
277 ports = self.shell.quantum.list_ports()['ports']
279 gw_ip = subnet['gateway_ip']
280 subnet_id = subnet['id']
282 # 1. Find the port associated with the subnet's gateway
283 # 2. Find the router associated with that port
284 # 3. Find the port associated with this router and on the external net
285 # 4. Set up route to the subnet through the port from step 3
288 for fixed_ip in port['fixed_ips']:
289 if fixed_ip['subnet_id'] == subnet_id and fixed_ip['ip_address'] == gw_ip:
291 router_id = gw_port['device_id']
292 router = self.shell.quantum.show_router(router_id)['router']
293 if router and router.get('external_gateway_info'):
294 ext_net = router['external_gateway_info']['network_id']
296 if port['device_id'] == router_id and port['network_id'] == ext_net:
297 ip_address = port['fixed_ips'][0]['ip_address']
300 # check if external route already exists
304 if subnet['cidr'] in route and ip_address in route:
307 cmd = "route add -net %s dev br-ex gw %s" % (subnet['cidr'], ip_address)
308 s, o = commands.getstatusoutput(cmd)
309 #print cmd, "\n", s, o
313 def delete_external_route(self, subnet):
314 ports = self.shell.quantum.list_ports()['ports']
316 gw_ip = subnet['gateway_ip']
317 subnet_id = subnet['id']
319 # 1. Find the port associated with the subnet's gateway
320 # 2. Find the router associated with that port
321 # 3. Find the port associated with this router and on the external net
322 # 4. Set up route to the subnet through the port from step 3
325 for fixed_ip in port['fixed_ips']:
326 if fixed_ip['subnet_id'] == subnet_id and fixed_ip['ip_address'] == gw_ip:
328 router_id = gw_port['device_id']
329 router = self.shell.quantum.show_router(router_id)['router']
330 ext_net = router['external_gateway_info']['network_id']
332 if port['device_id'] == router_id and port['network_id'] == ext_net:
333 ip_address = port['fixed_ips'][0]['ip_address']
336 cmd = "route delete -net %s" % (subnet['cidr'])
337 commands.getstatusoutput(cmd)
341 def create_keypair(self, name, public_key):
342 keys = self.shell.nova.keypairs.findall(name=name)
346 if key.public_key != public_key:
347 self.delete_keypair(key.id)
348 key = self.shell.nova.keypairs.create(name=name, public_key=public_key)
350 key = self.shell.nova.keypairs.create(name=name, public_key=public_key)
353 def delete_keypair(self, id):
354 keys = self.shell.nova.keypairs.findall(id=id)
356 self.shell.nova.keypairs.delete(key)
359 def get_private_networks(self, tenant=None):
361 tenant = self.shell.nova.tenant
362 tenant = self.shell.keystone.tenants.find(name=tenant)
363 search_opts = {"tenant_id": tenant.id, "shared": False}
364 private_networks = self.shell.quantum.list_networks(**search_opts)
365 return private_networks
367 def get_shared_networks(self):
368 search_opts = {"shared": True}
369 shared_networks = self.shell.quantum.list_networks(**search_opts)
370 return shared_networks
372 def get_network_subnet(self, network_id):
376 os_networks = self.shell.quantum.list_networks(id=network_id)["networks"]
378 os_network = os_networks[0]
379 if os_network['subnets']:
380 subnet_id = os_network['subnets'][0]
381 os_subnets = self.shell.quantum.list_subnets(id=subnet_id)['subnets']
383 subnet = os_subnets[0]['cidr']
385 return (subnet_id, subnet)
387 def spawn_instance(self, name, key_name=None, hostname=None, image_id=None, security_group=None, pubkeys=[], nics=None, metadata=None):
388 flavor_name = self.config.nova_default_flavor
389 flavor = self.shell.nova.flavors.find(name=flavor_name)
391 # image = self.config.nova_default_imave
392 if not security_group:
393 security_group = self.config.nova_default_security_group
397 files['/root/.ssh/authorized_keys'] = "\n".join(pubkeys)
400 availability_zone = None
402 availability_zone = 'nova:%s' % hostname
403 server = self.shell.nova.servers.create(
408 security_group = security_group,
410 scheduler_hints=hints,
411 availability_zone=availability_zone,
416 def destroy_instance(self, id):
417 if (self.shell.nova.tenant=="admin"):
418 # findall() is implemented as a list() followed by a python search of the
419 # list. Since findall() doesn't accept "all_tenants", we do this using
420 # list() ourselves. This allows us to delete an instance as admin.
421 servers = self.shell.nova.servers.list(search_opts={"all_tenants": True})
423 servers = self.shell.nova.servers.list()
424 for server in servers:
426 result=self.shell.nova.servers.delete(server)
428 def update_instance_metadata(self, id, metadata):
429 servers = self.shell.nova.servers.findall(id=id)
430 for server in servers:
431 self.shell.nova.servers.set_meta(server, metadata)
432 # note: set_meta() returns a broken Server() object. Don't try to
433 # print it in the shell or it will fail in __repr__.
435 def delete_instance_metadata(self, id, metadata):
436 # note: metadata is a dict. Only the keys matter, not the values.
437 servers = self.shell.nova.servers.findall(id=id)
438 for server in servers:
439 self.shell.nova.servers.delete_meta(server, metadata)