virt: Add destroy_secrets kwarg to destroy and cleanup

This change adds a simple optional kwarg to the virt driver signature of
destroy and cleanup to allow for callers to control when secrets should
be removed.

Change-Id: I856268b371f7ba712b02189db3c927cd762a4dc3
(cherry picked from commit 1cc52fd)

Author: lyarwood

nova/virt/driver.py

@@ -412,7 +412,7 @@ def spawn(self, context, instance, image_meta, injected_files,
         raise NotImplementedError()
 
     def destroy(self, context, instance, network_info, block_device_info=None,
-                destroy_disks=True):
+                destroy_disks=True, destroy_secrets=True):
         """Destroy the specified instance from the Hypervisor.
 
         If the instance is not found (for example if networking failed), this
@@ -425,11 +425,13 @@ def destroy(self, context, instance, network_info, block_device_info=None,
         :param block_device_info: Information about block devices that should
                                   be detached from the instance.
         :param destroy_disks: Indicates if disks should be destroyed
+        :param destroy_secrets: Indicates if secrets should be destroyed
         """
         raise NotImplementedError()
 
     def cleanup(self, context, instance, network_info, block_device_info=None,
-                destroy_disks=True, migrate_data=None, destroy_vifs=True):
+                destroy_disks=True, migrate_data=None, destroy_vifs=True,
+                destroy_secrets=True):
         """Cleanup the instance resources .
 
         Instance should have been destroyed from the Hypervisor before calling
@@ -442,6 +444,8 @@ def cleanup(self, context, instance, network_info, block_device_info=None,
                                   be detached from the instance.
         :param destroy_disks: Indicates if disks should be destroyed
         :param migrate_data: implementation specific params
+        :param destroy_vifs: Indicates if vifs should be unplugged
+        :param destroy_secrets: Indicates if secrets should be destroyed
         """
         raise NotImplementedError()
 

nova/virt/fake.py

@@ -308,7 +308,7 @@ def resume(self, context, instance, network_info, block_device_info=None):
         pass
 
     def destroy(self, context, instance, network_info, block_device_info=None,
-                destroy_disks=True):
+                destroy_disks=True, destroy_secrets=True):
         key = instance.uuid
         if key in self.instances:
             flavor = instance.flavor
@@ -323,7 +323,8 @@ def destroy(self, context, instance, network_info, block_device_info=None,
                          'inst': self.instances}, instance=instance)
 
     def cleanup(self, context, instance, network_info, block_device_info=None,
-                destroy_disks=True, migrate_data=None, destroy_vifs=True):
+                destroy_disks=True, migrate_data=None, destroy_vifs=True,
+                destroy_secrets=True):
         # cleanup() should not be called when the guest has not been destroyed.
         if instance.uuid in self.instances:
             raise exception.InstanceExists(

nova/virt/hyperv/driver.py

@@ -172,12 +172,13 @@ def reboot(self, context, instance, network_info, reboot_type,
         self._vmops.reboot(instance, network_info, reboot_type)
 
     def destroy(self, context, instance, network_info, block_device_info=None,
-                destroy_disks=True):
+                destroy_disks=True, destroy_secrets=True):
         self._vmops.destroy(instance, network_info, block_device_info,
                             destroy_disks)
 
     def cleanup(self, context, instance, network_info, block_device_info=None,
-                destroy_disks=True, migrate_data=None, destroy_vifs=True):
+                destroy_disks=True, migrate_data=None, destroy_vifs=True,
+                destroy_secrets=True):
         """Cleanup after instance being destroyed by Hypervisor."""
         self.unplug_vifs(instance, network_info)
 

nova/virt/ironic/driver.py

@@ -1263,7 +1263,8 @@ def _sync_remove_cache_entry():
         _sync_remove_cache_entry()
 
     def destroy(self, context, instance, network_info,
-                block_device_info=None, destroy_disks=True):
+                block_device_info=None, destroy_disks=True,
+                destroy_secrets=True):
         """Destroy the specified instance, if it can be found.
 
         :param context: The security context.
@@ -1273,6 +1274,8 @@ def destroy(self, context, instance, network_info,
             information. Ignored by this driver.
         :param destroy_disks: Indicates if disks should be
             destroyed. Ignored by this driver.
+        :param destroy_secrets: Indicates if secrets should be
+            destroyed. Ignored by this driver.
         """
         LOG.debug('Destroy called for instance', instance=instance)
         try:

nova/virt/libvirt/driver.py

@@ -1402,7 +1402,7 @@ def _wait_for_destroy(expected_domid):
                 self._teardown_container(instance)
 
     def destroy(self, context, instance, network_info, block_device_info=None,
-                destroy_disks=True):
+                destroy_disks=True, destroy_secrets=True):
         self._destroy(instance)
         # NOTE(gibi): if there was device detach in progress then we need to
         # unblock the waiting threads and clean up.
@@ -1435,7 +1435,8 @@ def _undefine_domain(self, instance):
             pass
 
     def cleanup(self, context, instance, network_info, block_device_info=None,
-                destroy_disks=True, migrate_data=None, destroy_vifs=True):
+                destroy_disks=True, migrate_data=None, destroy_vifs=True,
+                destroy_secrets=True):
         """Cleanup the instance from the host.
 
         Identify if the instance disks and instance path should be removed
@@ -1449,6 +1450,7 @@ def cleanup(self, context, instance, network_info, block_device_info=None,
         :param destroy_disks: if local ephemeral disks should be destroyed
         :param migrate_data: optional migrate_data object
         :param destroy_vifs: if plugged vifs should be unplugged
+        :param destroy_secrets: Indicates if secrets should be destroyed
         """
         cleanup_instance_dir = False
         cleanup_instance_disks = False

nova/virt/vmwareapi/driver.py

@@ -224,7 +224,8 @@ def _register_openstack_extension(self):
             LOG.debug('Extension %s already exists.', constants.EXTENSION_KEY)
 
     def cleanup(self, context, instance, network_info, block_device_info=None,
-                destroy_disks=True, migrate_data=None, destroy_vifs=True):
+                destroy_disks=True, migrate_data=None, destroy_vifs=True,
+                destroy_secrets=True):
         """Cleanup after instance being destroyed by Hypervisor."""
         pass
 
@@ -593,7 +594,7 @@ def _detach_instance_volumes(self, instance, block_device_info):
                                   instance=instance)
 
     def destroy(self, context, instance, network_info, block_device_info=None,
-                destroy_disks=True):
+                destroy_disks=True, destroy_secrets=True):
         """Destroy VM instance."""
 
         # Destroy gets triggered when Resource Claim in resource_tracker