planetstack/observer/steps/garbage_collector.py

   1 import os
   2 import base64
   3 import traceback
   4 from collections import defaultdict
   5 from django.db.models import F, Q
   6 from planetstack.config import Config
   7 from util.logger import Logger, logging
   8 from observer.openstacksyncstep import OpenStackSyncStep
   9 from deployment_auth import deployment_auth
  10 from core.models import *
  11
  12 logger = Logger(level=logging.INFO)
  13
  14 class GarbageCollector(OpenStackSyncStep):
  15     requested_interval = 86400
  16     provides=[]
  17
  18     def call(self, **args):
  19         try:
  20             #self.gc_roles()
  21             #self.gc_tenants()
  22             #self.gc_users()
  23             #self.gc_user_tenant_roles()
  24             #self.gc_slivers()
  25             #self.gc_sliver_ips()
  26             #self.gc_external_routes()
  27             pass
  28         except:
  29             traceback.print_exc()
  30
  31     def gc_roles(self):
  32         """
  33          all role that don't already exist in keystone. Remove keystone roles that
  34         don't exist in planetstack
  35         """
  36         # sync all roles that don't already in keystone
  37         keystone_roles = self.driver.shell.keystone.roles.findall()
  38         keystone_role_names = [kr.name for kr in keystone_roles]
  39         pending_roles = Role.objects.all()
  40         pending_role_names = [r.role_type for r in pending_roles]
  41         # don't delete roles for now
  42         """
  43         # delete keystone roles that don't exist in planetstack
  44         for keystone_role in keystone_roles:
  45             if keystone_role.name == 'admin':
  46                 continue
  47             if keystone_role.name not in pending_role_names:
  48                 try:
  49                     self.driver.delete_role({id: keystone_role.id})
  50                 except:
  51                     traceback.print_exc()
  52         """
  53
  54     def gc_tenants(self):
  55         """
  56         Remove sites and slices that no don't exist in openstack db if they
  57         have an enacted time (enacted != None).
  58         """
  59         # get all sites that where enacted != null. We can assume these sites
  60         # have previously been synced and need to be checed for deletion.
  61         sites = Site.objects.filter(enacted__isnull=False)
  62         site_dict = {}
  63         for site in sites:
  64             site_dict[site.login_base] = site
  65
  66         # get all slices that where enacted != null. We can assume these slices
  67         # have previously been synced and need to be checed for deletion.
  68         slices = Slice.objects.filter(enacted__isnull=False)
  69         slice_dict = {}
  70         for slice in slices:
  71             slice_dict[slice.name] = slice
  72
  73         # delete keystone tenants that don't have a site record
  74         for deployment in deployment_auth:
  75             driver = self.driver.admin_driver(deployment=deployment)
  76             tenants = driver.shell.keystone.tenants.findall()
  77
  78             system_tenants = ['admin','service', 'invisible_to_admin']
  79             for tenant in tenants:
  80                 if tenant.name in system_tenants:
  81                     continue
  82                 if tenant.name not in site_dict and tenant.name not in slice_dict:
  83                     try:
  84                         driver.delete_tenant(tenant.id)
  85                         logger.info("deleted tenant: %s" % (tenant))
  86                     except:
  87                         logger.log_exc("delete tenant failed: %s" % tenant)
  88
  89
  90     def gc_users(self):
  91         """
  92         Remove users that do not exist in openstack db if they have an
  93         enacted time (enacted != None).
  94         """
  95         # get all users that where enacted != null. We can assume these users
  96         # have previously been synced and need to be checed for deletion.
  97         users = User.objects.filter(enacted__isnull=False)
  98         user_dict = {}
  99         for user in users:
 100             user_dict[user.kuser_id] = user
 101
 102         # delete keystone users that don't have a user record
 103         system_users = ['admin', 'nova', 'quantum', 'glance', 'cinder', 'swift', 'service', 'demo']
 104         for deployment in deployment_auth:
 105             driver = self.driver.admin_driver(deployment=deployment)
 106             users = driver.shell.keystone.users.findall()
 107             for user in users:
 108                 if user.name in system_users:
 109                     continue
 110                 if user.id not in user_dict:
 111                     try:
 112                         self.driver.delete_user(user.id)
 113                         logger.info("deleted user: %s" % user)
 114                     except:
 115                         logger.log_exc("delete user failed: %s" % user)
 116
 117
 118     def gc_user_tenant_roles(self):
 119         """
 120         Remove roles that don't exist in openstack db if they have
 121         an enacted time (enacted != None).
 122         """
 123         # get all site privileges and slice memberships that have been enacted
 124         user_tenant_roles = defaultdict(list)
 125         for site_priv in SitePrivilege.objects.filter(enacted__isnull=False):
 126             user_tenant_roles[(site_priv.user.kuser_id, site_priv.site.tenant_id)].append(site_priv.role.role)
 127         for slice_memb in SlicePrivilege.objects.filter(enacted__isnull=False):
 128             user_tenant_roles[(slice_memb.user.kuser_id, slice_memb.slice.tenant_id)].append(slice_memb.role.role)
 129
 130         # Some user tenant role aren't stored in planetstack but they must be preserved.
 131         # Role that fall in this category are
 132         # 1. Never remove a user's role that their home site
 133         # 2. Never remove a user's role at a slice they've created.
 134         # Keep track of all roles that must be preserved.
 135         users = User.objects.all()
 136         for deployment in deployment_auth:
 137             driver = self.driver.admin_driver(deployment=deployment)
 138             tenants = driver.shell.keystone.tenants.list()
 139             for user in users:
 140                 # skip admin roles
 141                 if user.kuser_id == self.driver.admin_user.id:
 142                     continue
 143
 144                 ignore_tenant_ids = []
 145                 k_user = driver.shell.keystone.users.find(id=user.kuser_id)
 146                 ignore_tenant_ids = [s['tenant_id'] for s in user.slices.values()]
 147                 if user.site:
 148                     ignore_tenant_ids.append(user.site.tenant_id)
 149
 150                 # get user roles in keystone
 151                 for tenant in tenants:
 152                     # skip preserved tenant ids
 153                     if tenant.tenant_id in ignore_tenant_ids:
 154                         continue
 155                     # compare user tenant roles
 156                     user_tenant_role_ids = user_tenant_roles.get((user.kuser_id, tenant.id), [])
 157
 158                     if user_tenant_role_ids:
 159                         # The user has roles at the tenant. Check if roles need to
 160                         # be updated.
 161                         k_user_roles =  driver.shell.keystone.roles.roles_for_user(k_user, tenant)
 162                         for k_user_role in k_user_roles:
 163                             if k_user_role.role_id not in user_tenant_role_ids:
 164                                 driver.shell.keyston.remove_user_role(k_user, k_user_role, tenant)
 165                                 logger.info("removed user role %s for %s at %s" % \
 166                                            (k_user_role, k_user.username, tenant.name))
 167                     else:
 168                         # remove all roles the user has at the tenant.
 169                         for k_user_role in k_user_roles:
 170                             driver.shell.keyston.remove_user_role(k_user, k_user_role, tenant)
 171                             logger.info("removed user role %s for %s at %s" % \
 172                                        (k_user_role, k_user.username, tenant.name))
 173
 174     def gc_slivers(self):
 175         """
 176         Remove slivers that no don't exist in openstack db if they have
 177         an enacted time (enacted != None).
 178         """
 179         # get all slivers where enacted != null. We can assume these users
 180         # have previously been synced and need to be checed for deletion.
 181         slivers = Sliver.objects.filter(enacted__isnull=False)
 182         sliver_dict = {}
 183         for sliver in slivers:
 184             sliver_dict[sliver.instance_id] = sliver
 185
 186         for tenant in self.driver.shell.keystone.tenants.list():
 187             # delete sliver that don't have a sliver record
 188             tenant_driver = self.driver.client_driver(tenant=tenant.name, deployment=sliver.node.deployment)
 189             for instance in tenant_driver.nova.servers.list():
 190                 if instance.uuid not in sliver_dict:
 191                     try:
 192                         tenant_driver.destroy_instance(instance.uuid)
 193                         logger.info("destroyed sliver: %s" % (instance))
 194                     except:
 195                         logger.log_exc("destroy sliver failed: %s" % instance)
 196
 197
 198     def gc_sliver_ips(self):
 199         """
 200         Update ips that have changed.
 201         """
 202         # fill in null ip addresses
 203         slivers = Sliver.objects.filter(ip=None)
 204         for sliver in slivers:
 205             # update connection
 206
 207             driver = self.driver.client_driver(tenant=sliver.slice.name, deployment=sliver.node.deployment)
 208             servers = driver.shell.nova.servers.findall(id=sliver.instance_id)
 209             if not servers:
 210                 continue
 211             server = servers[0]
 212             ips = server.addresses.get(sliver.slice.name, [])
 213             if ips and sliver.ip != ips[0]['addr']:
 214                 sliver.ip = ips[0]['addr']
 215                 sliver.save()
 216                 logger.info("updated sliver ip: %s %s" % (sliver, ips[0]))
 217
 218     def gc_external_routes(self):
 219         pass
 220
 221     def gc_nodes(self):
 222          # collect local nodes
 223         nodes = Node.objects.all()
 224         nodes_dict = {}
 225         for node in nodes:
 226             nodes_dict[node.name] = node
 227
 228         # collect nova nodes:
 229         compute_nodes_dict = {}
 230         for deployment in deployment_auth:
 231             driver = self.driver.admin_driver(deployment=deployment)
 232             compute_nodes = driver.nova.hypervisors.list()
 233             for compute_node in compute_nodes:
 234                 compute_nodes_dict[compute_node.hypervisor_hostname] = compute_node
 235
 236         # remove old nodes
 237         old_node_names = set(nodes_dict.keys()).difference(compute_nodes_dict.keys())
 238         Node.objects.filter(name__in=old_node_names).delete()
 239
 240     def gc_images(self):
 241         # collect local images
 242         images = Image.objects.all()
 243         images_dict = {}
 244         for image in images:
 245             images_dict[image.name] = image
 246
 247         # collect glance images
 248         glance_images_dict = {}
 249         for deployment in deployment_auth:
 250             driver = self.driver.admin_driver(deployment=deployment)
 251             glance_images = driver.shell.glance.get_images()
 252             for glance_image in glance_images:
 253                 glance_images_dict[glance_image['name']] = glance_image
 254
 255         # remove old images
 256         old_image_names = set(images_dict.keys()).difference(glance_images_dict.keys())
 257         Image.objects.filter(name__in=old_image_names).delete()