planetstack/openstack/driver.py

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