planetstack/openstack/driver.py

   1 import commands
   2 from planetstack.config import Config
   3
   4 try:
   5     from openstack.client import OpenStackClient
   6     has_openstack = True
   7 except:
   8     has_openstack = False
   9
  10 manager_enabled = Config().api_nova_enabled
  11
  12 class OpenStackDriver:
  13
  14     def __init__(self, config = None, client=None):
  15         if config:
  16             self.config = Config(config)
  17         else:
  18             self.config = Config()
  19
  20         self.admin_client = OpenStackClient()
  21         self.admin_user = self.admin_client.keystone.users.find(name=self.admin_client.keystone.username)
  22
  23         if client:
  24             self.shell = client
  25         else:
  26             self.shell = OpenStackClient()
  27
  28         self.enabled = manager_enabled
  29         self.has_openstack = has_openstack
  30
  31     def client_driver(self, caller=None, tenant=None):
  32         if caller:
  33             auth = {'username': caller.email,
  34                     'password': hashlib.md5(caller.password).hexdigest()[:6],
  35                     'tenant': tenant}
  36             client = OpenStackClient(**auth)
  37         else:
  38             client = OpenStackClient(tenant=tenant)
  39         driver = OpenStackDriver(client=client)
  40         return driver
  41
  42     def admin_driver(self, tenant=None):
  43         client = OpenStackClient(tenant=tenant)
  44         driver = OpenStackDriver(client=client)
  45
  46     def create_role(self, name):
  47         roles = self.shell.keystone.roles.findall(name=name)
  48         if not roles:
  49             role = self.shell.keystone.roles.create(name)
  50         else:
  51             role = roles[0]
  52         return role
  53
  54     def delete_role(self, filter):
  55         roles = self.shell.keystone.roles.findall(**filter)
  56         for role in roles:
  57             self.shell.keystone.roles.delete(role)
  58         return 1
  59
  60     def create_tenant(self, tenant_name, enabled, description):
  61         """Create keystone tenant. Suggested fields: name, description, enabled"""
  62         tenants = self.shell.keystone.tenants.findall(name=tenant_name)
  63         if not tenants:
  64             fields = {'tenant_name': tenant_name, 'enabled': enabled,
  65                       'description': description}
  66             tenant = self.shell.keystone.tenants.create(**fields)
  67         else:
  68             tenant = tenants[0]
  69
  70         # always give the admin user the admin role to any tenant created
  71         # by the driver.
  72         self.add_user_role(self.admin_user.id, tenant.id, 'admin')
  73         return tenant
  74
  75     def update_tenant(self, id, **kwds):
  76         return self.shell.keystone.tenants.update(id, **kwds)
  77
  78     def delete_tenant(self, id):
  79         ctx = self.shell.nova_db.ctx
  80         tenants = self.shell.keystone.tenants.findall(id=id)
  81         for tenant in tenants:
  82             # nova does not automatically delete the tenant's instances
  83             # so we manually delete instances before deleteing the tenant
  84             instances = self.shell.nova_db.instance_get_all_by_filters(ctx,
  85                        {'project_id': tenant.id}, 'id', 'asc')
  86             client = OpenStackClient(tenant=tenant.name)
  87             driver = OpenStackDriver(client=client)
  88             for instance in instances:
  89                 driver.destroy_instance(instance.id)
  90             self.shell.keystone.tenants.delete(tenant)
  91         return 1
  92
  93     def create_user(self, name, email, password, enabled):
  94         users = self.shell.keystone.users.findall(email=email)
  95         if not users:
  96             fields = {'name': name, 'email': email, 'password': password,
  97                       'enabled': enabled}
  98             user = self.shell.keystone.users.create(**fields)
  99         else:
 100             user = users[0]
 101         return user
 102
 103     def delete_user(self, id):
 104         users = self.shell.keystone.users.findall(id=id)
 105         for user in users:
 106             # delete users keys
 107             keys = self.shell.nova.keypairs.findall()
 108             for key in keys:
 109                 self.shell.nova.keypairs.delete(key)
 110             self.shell.keystone.users.delete(user)
 111         return 1
 112
 113     def add_user_role(self, kuser_id, tenant_id, role_name):
 114         user = self.shell.keystone.users.find(id=kuser_id)
 115         tenant = self.shell.keystone.tenants.find(id=tenant_id)
 116         role = self.shell.keystone.roles.find(name=role_name)
 117
 118         role_found = False
 119         user_roles = user.list_roles(tenant.id)
 120         for user_role in user_roles:
 121             if user_role.name == role.name:
 122                 role_found = True
 123         if not role_found:
 124             tenant.add_user(user, role)
 125
 126         return 1
 127
 128     def delete_user_role(self, kuser_id, tenant_id, role_name):
 129         user = self.shell.keystone.users.find(id=kuser_id)
 130         tenant = self.shell.keystone.tenants.find(id=tenant_id)
 131         role = self.shell.keystone.roles.find(name=role_name)
 132
 133         role_found = False
 134         user_roles = user.list_roles(tenant.id)
 135         for user_role in user_roles:
 136             if user_role.name == role.name:
 137                 role_found = True
 138         if role_found:
 139             tenant.remove_user(user, role)
 140
 141         return 1
 142
 143     def update_user(self, id, fields):
 144         if 'password' in fields:
 145             self.shell.keystone.users.update_password(id, fields['password'])
 146         if 'enabled' in fields:
 147             self.shell.keystone.users.update_enabled(id, fields['enabled'])
 148         return 1
 149
 150     def create_router(self, name, set_gateway=True):
 151         routers = self.shell.quantum.list_routers(name=name)['routers']
 152         if routers:
 153             router = routers[0]
 154         else:
 155             router = self.shell.quantum.create_router({'router': {'name': name}})['router']
 156         # add router to external network
 157         if set_gateway:
 158             nets = self.shell.quantum.list_networks()['networks']
 159             for net in nets:
 160                 if net['router:external'] == True:
 161                     self.shell.quantum.add_gateway_router(router['id'],
 162                                                           {'network_id': net['id']})
 163
 164         return router
 165
 166     def delete_router(self, id):
 167         routers = self.shell.quantum.list_routers(id=id)['routers']
 168         for router in routers:
 169             self.shell.quantum.delete_router(router['id'])
 170             # remove router form external network
 171             #nets = self.shell.quantum.list_networks()['networks']
 172             #for net in nets:
 173             #    if net['router:external'] == True:
 174             #        self.shell.quantum.remove_gateway_router(router['id'])
 175
 176     def add_router_interface(self, router_id, subnet_id):
 177         router = self.shell.quantum.show_router(router_id)['router']
 178         subnet = self.shell.quantum.show_subnet(subnet_id)['subnet']
 179         if router and subnet:
 180             self.shell.quantum.add_interface_router(router_id, {'subnet_id': subnet_id})
 181
 182     def delete_router_interface(self, router_id, subnet_id):
 183         router = self.shell.quantum.show_router(router_id)
 184         subnet = self.shell.quantum.show_subnet(subnet_id)
 185         if router and subnet:
 186             self.shell.quantum.remove_interface_router(router_id, {'subnet_id': subnet_id})
 187
 188     def create_network(self, name, shared=False):
 189         nets = self.shell.quantum.list_networks(name=name)['networks']
 190         if nets:
 191             net = nets[0]
 192         else:
 193             net = self.shell.quantum.create_network({'network': {'name': name, 'shared': shared}})['network']
 194         return net
 195
 196     def delete_network(self, id):
 197         nets = self.shell.quantum.list_networks()['networks']
 198         for net in nets:
 199             if net['id'] == id:
 200                 # delete_all ports
 201                 self.delete_network_ports(net['id'])
 202                 # delete all subnets:
 203                 for subnet_id in net['subnets']:
 204                     self.delete_subnet(subnet_id)
 205                 self.shell.quantum.delete_network(net['id'])
 206         return 1
 207
 208     def delete_network_ports(self, network_id):
 209         ports = self.shell.quantum.list_ports()['ports']
 210         for port in ports:
 211             if port['network_id'] == network_id:
 212                 self.shell.quantum.delete_port(port['id'])
 213         return 1
 214
 215     def delete_subnet_ports(self, subnet_id):
 216         ports = self.shell.quantum.list_ports()['ports']
 217         for port in ports:
 218             delete = False
 219             for fixed_ip in port['fixed_ips']:
 220                 if fixed_ip['subnet_id'] == subnet_id:
 221                     delete=True
 222                     break
 223             if delete:
 224                 self.shell.quantum.delete_port(port['id'])
 225         return 1
 226
 227     def create_subnet(self, name, network_id, cidr_ip, ip_version, start, end):
 228         #nets = self.shell.quantum.list_networks(name=network_name)['networks']
 229         #if not nets:
 230         #    raise Exception, "No such network: %s" % network_name
 231         #net = nets[0]
 232
 233         subnet = None
 234         subnets = self.shell.quantum.list_subnets()['subnets']
 235         for snet in subnets:
 236             if snet['cidr'] == cidr_ip and snet['network_id'] == network_id:
 237                 subnet = snet
 238
 239         if not subnet:
 240             allocation_pools = [{'start': start, 'end': end}]
 241             subnet = {'subnet': {'name': name,
 242                                  'network_id': network_id,
 243                                  'ip_version': ip_version,
 244                                  'cidr': cidr_ip,
 245                                  'dns_nameservers': ['8.8.8.8', '8.8.4.4'],
 246                                  'allocation_pools': allocation_pools}}
 247             subnet = self.shell.quantum.create_subnet(subnet)['subnet']
 248             self.add_external_route(subnet)
 249         # TODO: Add route to external network
 250         # e.g. #  route add -net 10.0.3.0/24 dev br-ex gw 10.100.0.5
 251         return subnet
 252
 253     def update_subnet(self, id, fields):
 254         return self.shell.quantum.update_subnet(id, fields)
 255
 256     def delete_subnet(self, id):
 257         #return self.shell.quantum.delete_subnet(id=id)
 258         # inefficient but fault tolerant
 259         subnets = self.shell.quantum.list_subnets()['subnets']
 260         for subnet in subnets:
 261             if subnet['id'] == id:
 262                 self.delete_subnet_ports(subnet['id'])
 263                 self.shell.quantum.delete_subnet(id)
 264                 self.delete_external_route(subnet)
 265         return 1
 266
 267     def get_external_routes(self):
 268         status, output = commands.getstatusoutput('route')
 269         routes = output.split('\n')[3:]
 270         return routes
 271
 272     def add_external_route(self, subnet, routes=[]):
 273         if not routes:
 274             routes = self.get_external_routes()
 275
 276         ports = self.shell.quantum.list_ports()['ports']
 277
 278         gw_ip = subnet['gateway_ip']
 279         subnet_id = subnet['id']
 280
 281         # 1. Find the port associated with the subnet's gateway
 282         # 2. Find the router associated with that port
 283         # 3. Find the port associated with this router and on the external net
 284         # 4. Set up route to the subnet through the port from step 3
 285         ip_address = None
 286         for port in ports:
 287             for fixed_ip in port['fixed_ips']:
 288                 if fixed_ip['subnet_id'] == subnet_id and fixed_ip['ip_address'] == gw_ip:
 289                     gw_port = port
 290                     router_id = gw_port['device_id']
 291                     router = self.shell.quantum.show_router(router_id)['router']
 292                     if router and router.get('external_gateway_info'):
 293                         ext_net = router['external_gateway_info']['network_id']
 294                         for port in ports:
 295                             if port['device_id'] == router_id and port['network_id'] == ext_net:
 296                                 ip_address = port['fixed_ips'][0]['ip_address']
 297
 298         if ip_address:
 299             # check if external route already exists
 300             route_exists = False
 301             if routes:
 302                 for route in routes:
 303                     if subnet['cidr'] in route and ip_address in route:
 304                         route_exists = True
 305             if not route_exists:
 306                 cmd = "route add -net %s dev br-ex gw %s" % (subnet['cidr'], ip_address)
 307                 s, o = commands.getstatusoutput(cmd)
 308                 #print cmd, "\n", s, o
 309
 310         return 1
 311
 312     def delete_external_route(self, subnet):
 313         ports = self.shell.quantum.list_ports()['ports']
 314
 315         gw_ip = subnet['gateway_ip']
 316         subnet_id = subnet['id']
 317
 318         # 1. Find the port associated with the subnet's gateway
 319         # 2. Find the router associated with that port
 320         # 3. Find the port associated with this router and on the external net
 321         # 4. Set up route to the subnet through the port from step 3
 322         ip_address = None
 323         for port in ports:
 324             for fixed_ip in port['fixed_ips']:
 325                 if fixed_ip['subnet_id'] == subnet_id and fixed_ip['ip_address'] == gw_ip:
 326                     gw_port = port
 327                     router_id = gw_port['device_id']
 328                     router = self.shell.quantum.show_router(router_id)['router']
 329                     ext_net = router['external_gateway_info']['network_id']
 330                     for port in ports:
 331                         if port['device_id'] == router_id and port['network_id'] == ext_net:
 332                             ip_address = port['fixed_ips'][0]['ip_address']
 333
 334         if ip_address:
 335             cmd = "route delete -net %s" % (subnet['cidr'])
 336             commands.getstatusoutput(cmd)
 337
 338         return 1
 339
 340     def create_keypair(self, name, public_key):
 341         keys = self.shell.nova.keypairs.findall(name=name)
 342         if keys:
 343             key = keys[0]
 344             # update key
 345             if key.public_key != public_key:
 346                 self.delete_keypair(key.id)
 347                 key = self.shell.nova.keypairs.create(name=name, public_key=public_key)
 348         else:
 349             key = self.shell.nova.keypairs.create(name=name, public_key=public_key)
 350         return key
 351
 352     def delete_keypair(self, id):
 353         keys = self.shell.nova.keypairs.findall(id=id)
 354         for key in keys:
 355             self.shell.nova.keypairs.delete(key)
 356         return 1
 357
 358     def get_private_networks(self, tenant=None):
 359         if not tenant:
 360             tenant = self.shell.nova.tenant
 361         tenant = self.shell.keystone.tenants.find(name=tenant)
 362         search_opts = {"tenant_id": tenant.id, "shared": False}
 363         private_networks = self.shell.quantum.list_networks(**search_opts)
 364         return private_networks
 365
 366     def get_shared_networks(self):
 367         search_opts = {"shared": True}
 368         shared_networks = self.shell.quantum.list_networks(**search_opts)
 369         return shared_networks
 370
 371     def get_network_subnet(self, network_id):
 372         subnet_id = None
 373         subnet = None
 374         if network_id:
 375             os_networks = self.shell.quantum.list_networks(id=network_id)["networks"]
 376             if os_networks:
 377                 os_network = os_networks[0]
 378                 if os_network['subnets']:
 379                     subnet_id = os_network['subnets'][0]
 380                     os_subnets = self.shell.quantum.list_subnets(id=subnet_id)['subnets']
 381                     if os_subnets:
 382                         subnet = os_subnets[0]['cidr']
 383
 384         return (subnet_id, subnet)
 385
 386     def spawn_instance(self, name, key_name=None, hostname=None, image_id=None, security_group=None, pubkeys=[], nics=None, metadata=None):
 387         flavor_name = self.config.nova_default_flavor
 388         flavor = self.shell.nova.flavors.find(name=flavor_name)
 389         #if not image:
 390         #    image = self.config.nova_default_imave
 391         if not security_group:
 392             security_group = self.config.nova_default_security_group
 393
 394         files = {}
 395         if pubkeys:
 396             files['/root/.ssh/authorized_keys'] = "\n".join(pubkeys)
 397
 398         hints = {}
 399         availability_zone = None
 400         if hostname:
 401             availability_zone = 'nova:%s' % hostname
 402         server = self.shell.nova.servers.create(
 403                                             name=name,
 404                                             key_name = key_name,
 405                                             flavor=flavor.id,
 406                                             image=image_id,
 407                                             security_group = security_group,
 408                                             files=files,
 409                                             scheduler_hints=hints,
 410                                             availability_zone=availability_zone,
 411                                             nics=nics,
 412                                             meta=metadata)
 413         return server
 414
 415     def destroy_instance(self, id):
 416         if (self.shell.nova.tenant=="admin"):
 417             # findall() is implemented as a list() followed by a python search of the
 418             # list. Since findall() doesn't accept "all_tenants", we do this using
 419             # list() ourselves. This allows us to delete an instance as admin.
 420             servers = self.shell.nova.servers.list(search_opts={"all_tenants": True})
 421         else:
 422             servers = self.shell.nova.servers.list()
 423         for server in servers:
 424             if server.id == id:
 425                 result=self.shell.nova.servers.delete(server)
 426
 427     def update_instance_metadata(self, id, metadata):
 428         servers = self.shell.nova.servers.findall(id=id)
 429         for server in servers:
 430             self.shell.nova.servers.set_meta(server, metadata)
 431             # note: set_meta() returns a broken Server() object. Don't try to
 432             # print it in the shell or it will fail in __repr__.
 433
 434     def delete_instance_metadata(self, id, metadata):
 435         # note: metadata is a dict. Only the keys matter, not the values.
 436         servers = self.shell.nova.servers.findall(id=id)
 437         for server in servers:
 438             self.shell.nova.servers.delete_meta(server, metadata)
 439