openstack/openstacksdk
Code Issues Proposed changes

Allow resources to be skipped on project cleanup

Browse Source 
Story: 2010370
Task: 46596
Change-Id: Id6d68e40656c92910f491fe3b66e40c69b44e352
Signed-off-by: Jan Hartkopf <jhartkopf@inovex.de>
This commit is contained in:
Jan Hartkopf
2023-03-27 15:46:36 +02:00
parent e7ee461d9b
commit 068cc997d5
10 changed files with 303 additions and 218 deletions
Download Patch File Download Diff File Expand all files Collapse all files

150
openstack/block_storage/v3/_proxy.py
View File

@@ -1675,6 +1675,7 @@ class Proxy(_base_proxy.BaseBlockStorageProxy):
identified_resources=None, identified_resources=None,
filters=None, filters=None,
resource_evaluation_fn=None, resource_evaluation_fn=None,
skip_resources=None,
): ):
# It is not possible to delete backup if there are dependent backups. # It is not possible to delete backup if there are dependent backups.
# In order to be able to do cleanup those is required to have multiple # In order to be able to do cleanup those is required to have multiple
@@ -1684,11 +1685,63 @@ class Proxy(_base_proxy.BaseBlockStorageProxy):
# required to limit amount of iterations we do (currently pick 10). In # required to limit amount of iterations we do (currently pick 10). In
# dry_run all those iterations are doing not what we want, therefore # dry_run all those iterations are doing not what we want, therefore
# only iterate in a real cleanup mode. # only iterate in a real cleanup mode.
if dry_run: if not self.should_skip_resource_cleanup("backup", skip_resources):
# Just iterate and evaluate backups in dry_run mode if dry_run:
for obj in self.backups(details=False): # Just iterate and evaluate backups in dry_run mode
for obj in self.backups(details=False):
need_delete = self._service_cleanup_del_res(
self.delete_backup,
obj,
dry_run=dry_run,
client_status_queue=client_status_queue,
identified_resources=identified_resources,
filters=filters,
resource_evaluation_fn=resource_evaluation_fn,
)
else:
# Set initial iterations conditions
need_backup_iteration = True
max_iterations = 10
while need_backup_iteration and max_iterations > 0:
# Reset iteration controls
need_backup_iteration = False
max_iterations -= 1
backups = []
# To increase success chance sort backups by age, dependent
# backups are logically younger.
for obj in self.backups(
details=True, sort_key='created_at', sort_dir='desc'
):
if not obj.has_dependent_backups:
# If no dependent backups - go with it
need_delete = self._service_cleanup_del_res(
self.delete_backup,
obj,
dry_run=dry_run,
client_status_queue=client_status_queue,
identified_resources=identified_resources,
filters=filters,
resource_evaluation_fn=resource_evaluation_fn,
)
if not dry_run and need_delete:
backups.append(obj)
else:
# Otherwise we need another iteration
need_backup_iteration = True
# Before proceeding need to wait for backups to be deleted
for obj in backups:
try:
self.wait_for_delete(obj)
except exceptions.SDKException:
# Well, did our best, still try further
pass
if not self.should_skip_resource_cleanup("snapshot", skip_resources):
snapshots = []
for obj in self.snapshots(details=False):
need_delete = self._service_cleanup_del_res( need_delete = self._service_cleanup_del_res(
self.delete_backup, self.delete_snapshot,
obj, obj,
dry_run=dry_run, dry_run=dry_run,
client_status_queue=client_status_queue, client_status_queue=client_status_queue,
@@ -1696,74 +1749,25 @@ class Proxy(_base_proxy.BaseBlockStorageProxy):
filters=filters, filters=filters,
resource_evaluation_fn=resource_evaluation_fn, resource_evaluation_fn=resource_evaluation_fn,
) )
else: if not dry_run and need_delete:
# Set initial iterations conditions snapshots.append(obj)
need_backup_iteration = True
max_iterations = 10
while need_backup_iteration and max_iterations > 0:
# Reset iteration controls
need_backup_iteration = False
max_iterations -= 1
backups = []
# To increase success chance sort backups by age, dependent
# backups are logically younger.
for obj in self.backups(
details=True, sort_key='created_at', sort_dir='desc'
):
if not obj.has_dependent_backups:
# If no dependent backups - go with it
need_delete = self._service_cleanup_del_res(
self.delete_backup,
obj,
dry_run=dry_run,
client_status_queue=client_status_queue,
identified_resources=identified_resources,
filters=filters,
resource_evaluation_fn=resource_evaluation_fn,
)
if not dry_run and need_delete:
backups.append(obj)
else:
# Otherwise we need another iteration
need_backup_iteration = True
# Before proceeding need to wait for backups to be deleted # Before deleting volumes need to wait for snapshots to be deleted
for obj in backups: for obj in snapshots:
try: try:
self.wait_for_delete(obj) self.wait_for_delete(obj)
except exceptions.SDKException: except exceptions.SDKException:
# Well, did our best, still try further # Well, did our best, still try further
pass pass
snapshots = [] if not self.should_skip_resource_cleanup("volume", skip_resources):
for obj in self.snapshots(details=False): for obj in self.volumes(details=True):
need_delete = self._service_cleanup_del_res( self._service_cleanup_del_res(
self.delete_snapshot, self.delete_volume,
obj, obj,
dry_run=dry_run, dry_run=dry_run,
client_status_queue=client_status_queue, client_status_queue=client_status_queue,
identified_resources=identified_resources, identified_resources=identified_resources,
filters=filters, filters=filters,
resource_evaluation_fn=resource_evaluation_fn, resource_evaluation_fn=resource_evaluation_fn,
) )
if not dry_run and need_delete:
snapshots.append(obj)
# Before deleting volumes need to wait for snapshots to be deleted
for obj in snapshots:
try:
self.wait_for_delete(obj)
except exceptions.SDKException:
# Well, did our best, still try further
pass
for obj in self.volumes(details=True):
self._service_cleanup_del_res(
self.delete_volume,
obj,
dry_run=dry_run,
client_status_queue=client_status_queue,
identified_resources=identified_resources,
filters=filters,
resource_evaluation_fn=resource_evaluation_fn,
)

4
openstack/cloud/openstackcloud.py
View File

@@ -813,6 +813,7 @@ class _OpenStackCloudMixin:
status_queue=None, status_queue=None,
filters=None, filters=None,
resource_evaluation_fn=None, resource_evaluation_fn=None,
skip_resources=None,
): ):
"""Cleanup the project resources. """Cleanup the project resources.
@@ -829,6 +830,8 @@ class _OpenStackCloudMixin:
:param resource_evaluation_fn: A callback function, which will be :param resource_evaluation_fn: A callback function, which will be
invoked for each resurce and must return True/False depending on invoked for each resurce and must return True/False depending on
whether resource need to be deleted or not. whether resource need to be deleted or not.
:param skip_resources: List of specific resources whose cleanup should
be skipped.
""" """
dependencies = {} dependencies = {}
get_dep_fn_name = '_get_cleanup_dependencies' get_dep_fn_name = '_get_cleanup_dependencies'
@@ -879,6 +882,7 @@ class _OpenStackCloudMixin:
identified_resources=cleanup_resources, identified_resources=cleanup_resources,
filters=filters, filters=filters,
resource_evaluation_fn=resource_evaluation_fn, resource_evaluation_fn=resource_evaluation_fn,
skip_resources=skip_resources,
) )
except exceptions.ServiceDisabledException: except exceptions.ServiceDisabledException:
# same reason as above # same reason as above

4
openstack/compute/v2/_proxy.py
View File

@@ -2548,7 +2548,11 @@ class Proxy(proxy.Proxy):
identified_resources=None, identified_resources=None,
filters=None, filters=None,
resource_evaluation_fn=None, resource_evaluation_fn=None,
skip_resources=None,
): ):
if self.should_skip_resource_cleanup("server", skip_resources):
return
servers = [] servers = []
for obj in self.servers(): for obj in self.servers():
need_delete = self._service_cleanup_del_res( need_delete = self._service_cleanup_del_res(

52
openstack/dns/v2/_proxy.py
View File

@@ -667,27 +667,33 @@ class Proxy(proxy.Proxy):
identified_resources=None, identified_resources=None,
filters=None, filters=None,
resource_evaluation_fn=None, resource_evaluation_fn=None,
skip_resources=None,
): ):
# Delete all zones if not self.should_skip_resource_cleanup("zone", skip_resources):
for obj in self.zones(): # Delete all zones
self._service_cleanup_del_res( for obj in self.zones():
self.delete_zone, self._service_cleanup_del_res(
obj, self.delete_zone,
dry_run=dry_run, obj,
client_status_queue=client_status_queue, dry_run=dry_run,
identified_resources=identified_resources, client_status_queue=client_status_queue,
filters=filters, identified_resources=identified_resources,
resource_evaluation_fn=resource_evaluation_fn, filters=filters,
) resource_evaluation_fn=resource_evaluation_fn,
# Unset all floatingIPs )
# NOTE: FloatingIPs are not cleaned when filters are set
for obj in self.floating_ips(): if not self.should_skip_resource_cleanup(
self._service_cleanup_del_res( "floating_ip", skip_resources
self.unset_floating_ip, ):
obj, # Unset all floatingIPs
dry_run=dry_run, # NOTE: FloatingIPs are not cleaned when filters are set
client_status_queue=client_status_queue, for obj in self.floating_ips():
identified_resources=identified_resources, self._service_cleanup_del_res(
filters=filters, self.unset_floating_ip,
resource_evaluation_fn=resource_evaluation_fn, obj,
) dry_run=dry_run,
client_status_queue=client_status_queue,
identified_resources=identified_resources,
filters=filters,
resource_evaluation_fn=resource_evaluation_fn,
)

258
openstack/network/v2/_proxy.py
View File

@@ -6212,106 +6212,137 @@ class Proxy(proxy.Proxy, Generic[T]):
identified_resources=None, identified_resources=None,
filters=None, filters=None,
resource_evaluation_fn=None, resource_evaluation_fn=None,
skip_resources=None,
): ):
project_id = self.get_project_id() project_id = self.get_project_id()
# Delete floating_ips in the project if no filters defined OR all
# filters are matching and port_id is empty
for obj in self.ips(project_id=project_id):
self._service_cleanup_del_res(
self.delete_ip,
obj,
dry_run=dry_run,
client_status_queue=client_status_queue,
identified_resources=identified_resources,
filters=filters,
resource_evaluation_fn=fip_cleanup_evaluation,
)
# Delete (try to delete) all security groups in the project if not self.should_skip_resource_cleanup(
# Let's hope we can't drop SG in use "floating_ip", skip_resources
for obj in self.security_groups(project_id=project_id): ):
if obj.name != 'default': # Delete floating_ips in the project if no filters defined OR all
# filters are matching and port_id is empty
for obj in self.ips(project_id=project_id):
self._service_cleanup_del_res( self._service_cleanup_del_res(
self.delete_security_group, self.delete_ip,
obj, obj,
dry_run=dry_run, dry_run=dry_run,
client_status_queue=client_status_queue, client_status_queue=client_status_queue,
identified_resources=identified_resources, identified_resources=identified_resources,
filters=filters, filters=filters,
resource_evaluation_fn=resource_evaluation_fn, resource_evaluation_fn=fip_cleanup_evaluation,
) )
# Networks are crazy, try to delete router+net+subnet if not self.should_skip_resource_cleanup(
# if there are no "other" ports allocated on the net "security_group", skip_resources
for net in self.networks(project_id=project_id): ):
network_has_ports_allocated = False # Delete (try to delete) all security groups in the project
router_if = list() # Let's hope we can't drop SG in use
for port in self.ports(project_id=project_id, network_id=net.id): for obj in self.security_groups(project_id=project_id):
self.log.debug('Looking at port %s' % port) if obj.name != 'default':
if port.device_owner in [
'network:router_interface',
'network:router_interface_distributed',
'network:ha_router_replicated_interface',
]:
router_if.append(port)
elif port.device_owner == 'network:dhcp':
# we don't treat DHCP as a real port
continue
elif port.device_owner is None or port.device_owner == '':
# Nobody owns the port - go with it
continue
elif (
identified_resources
and port.device_id not in identified_resources
):
# It seems some no other service identified this resource
# to be deleted. We can assume it doesn't count
network_has_ports_allocated = True
if network_has_ports_allocated:
# If some ports are on net - we cannot delete it
continue
self.log.debug('Network %s should be deleted' % net)
# __Check__ if we need to drop network according to filters
network_must_be_deleted = self._service_cleanup_del_res(
self.delete_network,
net,
dry_run=True,
client_status_queue=None,
identified_resources=None,
filters=filters,
resource_evaluation_fn=resource_evaluation_fn,
)
if not network_must_be_deleted:
# If not - check another net
continue
# otherwise disconnect router, drop net, subnet, router
# Disconnect
for port in router_if:
if client_status_queue:
client_status_queue.put(port)
if not dry_run:
try:
self.remove_interface_from_router(
router=port.device_id, port_id=port.id
)
except exceptions.SDKException:
self.log.error('Cannot delete object %s' % obj)
# router disconnected, drop it
self._service_cleanup_del_res(
self.delete_router,
self.get_router(port.device_id),
dry_run=dry_run,
client_status_queue=client_status_queue,
identified_resources=identified_resources,
filters=None,
resource_evaluation_fn=None,
)
# Drop ports not belonging to anybody
for port in self.ports(project_id=project_id, network_id=net.id):
if port.device_owner is None or port.device_owner == '':
self._service_cleanup_del_res( self._service_cleanup_del_res(
self.delete_port, self.delete_security_group,
port, obj,
dry_run=dry_run,
client_status_queue=client_status_queue,
identified_resources=identified_resources,
filters=filters,
resource_evaluation_fn=resource_evaluation_fn,
)
if (
not self.should_skip_resource_cleanup("network", skip_resources)
and not self.should_skip_resource_cleanup("port", skip_resources)
and not self.should_skip_resource_cleanup("subnet", skip_resources)
):
# Networks are crazy, try to delete router+net+subnet
# if there are no "other" ports allocated on the net
for net in self.networks(project_id=project_id):
network_has_ports_allocated = False
router_if = list()
for port in self.ports(
project_id=project_id, network_id=net.id
):
self.log.debug('Looking at port %s' % port)
if port.device_owner in [
'network:router_interface',
'network:router_interface_distributed',
'network:ha_router_replicated_interface',
]:
router_if.append(port)
elif port.device_owner == 'network:dhcp':
# we don't treat DHCP as a real port
continue
elif port.device_owner is None or port.device_owner == '':
# Nobody owns the port - go with it
continue
elif (
identified_resources
and port.device_id not in identified_resources
):
# It seems some no other service identified this resource
# to be deleted. We can assume it doesn't count
network_has_ports_allocated = True
if network_has_ports_allocated:
# If some ports are on net - we cannot delete it
continue
self.log.debug('Network %s should be deleted' % net)
# __Check__ if we need to drop network according to filters
network_must_be_deleted = self._service_cleanup_del_res(
self.delete_network,
net,
dry_run=True,
client_status_queue=None,
identified_resources=None,
filters=filters,
resource_evaluation_fn=resource_evaluation_fn,
)
if not network_must_be_deleted:
# If not - check another net
continue
# otherwise disconnect router, drop net, subnet, router
# Disconnect
for port in router_if:
if client_status_queue:
client_status_queue.put(port)
if not dry_run:
try:
self.remove_interface_from_router(
router=port.device_id, port_id=port.id
)
except exceptions.SDKException:
self.log.error('Cannot delete object %s' % obj)
# router disconnected, drop it
self._service_cleanup_del_res(
self.delete_router,
self.get_router(port.device_id),
dry_run=dry_run,
client_status_queue=client_status_queue,
identified_resources=identified_resources,
filters=None,
resource_evaluation_fn=None,
)
# Drop ports not belonging to anybody
for port in self.ports(
project_id=project_id, network_id=net.id
):
if port.device_owner is None or port.device_owner == '':
self._service_cleanup_del_res(
self.delete_port,
port,
dry_run=dry_run,
client_status_queue=client_status_queue,
identified_resources=identified_resources,
filters=None,
resource_evaluation_fn=None,
)
# Drop all subnets in the net (no further conditions)
for obj in self.subnets(
project_id=project_id, network_id=net.id
):
self._service_cleanup_del_res(
self.delete_subnet,
obj,
dry_run=dry_run, dry_run=dry_run,
client_status_queue=client_status_queue, client_status_queue=client_status_queue,
identified_resources=identified_resources, identified_resources=identified_resources,
@@ -6319,43 +6350,38 @@ class Proxy(proxy.Proxy, Generic[T]):
resource_evaluation_fn=None, resource_evaluation_fn=None,
) )
# Drop all subnets in the net (no further conditions) # And now the network itself (we are here definitely only if we
for obj in self.subnets(project_id=project_id, network_id=net.id): # need that)
self._service_cleanup_del_res( self._service_cleanup_del_res(
self.delete_subnet, self.delete_network,
obj, net,
dry_run=dry_run, dry_run=dry_run,
client_status_queue=client_status_queue, client_status_queue=client_status_queue,
identified_resources=identified_resources, identified_resources=identified_resources,
filters=None, filters=None,
resource_evaluation_fn=None, resource_evaluation_fn=None,
) )
else:
# And now the network itself (we are here definitely only if we self.log.debug(
# need that) "Skipping cleanup of networks, ports and subnets "
self._service_cleanup_del_res( "as those resources require none of them to be "
self.delete_network, "excluded, but at least one should be kept"
net,
dry_run=dry_run,
client_status_queue=client_status_queue,
identified_resources=identified_resources,
filters=None,
resource_evaluation_fn=None,
) )
# It might happen, that we have routers not attached to anything if not self.should_skip_resource_cleanup("router", skip_resources):
for obj in self.routers(): # It might happen, that we have routers not attached to anything
ports = list(self.ports(device_id=obj.id)) for obj in self.routers():
if len(ports) == 0: ports = list(self.ports(device_id=obj.id))
self._service_cleanup_del_res( if len(ports) == 0:
self.delete_router, self._service_cleanup_del_res(
obj, self.delete_router,
dry_run=dry_run, obj,
client_status_queue=client_status_queue, dry_run=dry_run,
identified_resources=identified_resources, client_status_queue=client_status_queue,
filters=None, identified_resources=identified_resources,
resource_evaluation_fn=None, filters=None,
) resource_evaluation_fn=None,
)
def fip_cleanup_evaluation(obj, identified_resources=None, filters=None): def fip_cleanup_evaluation(obj, identified_resources=None, filters=None):

6
openstack/object_store/v1/_proxy.py
View File

@@ -1130,7 +1130,13 @@ class Proxy(proxy.Proxy):
identified_resources=None, identified_resources=None,
filters=None, filters=None,
resource_evaluation_fn=None, resource_evaluation_fn=None,
skip_resources=None,
): ):
if self.should_skip_resource_cleanup(
"container", skip_resources
) or self.should_skip_resource_cleanup("object", skip_resources):
return
is_bulk_delete_supported = False is_bulk_delete_supported = False
bulk_delete_max_per_request = None bulk_delete_max_per_request = None
try: try:

4
openstack/orchestration/v1/_proxy.py
View File

@@ -549,7 +549,11 @@ class Proxy(proxy.Proxy):
identified_resources=None, identified_resources=None,
filters=None, filters=None,
resource_evaluation_fn=None, resource_evaluation_fn=None,
skip_resources=None,
): ):
if self.should_skip_resource_cleanup("stack", skip_resources):
return
stacks = [] stacks = []
for obj in self.stacks(): for obj in self.stacks():
need_delete = self._service_cleanup_del_res( need_delete = self._service_cleanup_del_res(

27
openstack/proxy.py
View File

@@ -100,7 +100,7 @@ class Proxy(adapter.Adapter, Generic[T]):
influxdb_config=None, influxdb_config=None,
influxdb_client=None, influxdb_client=None,
*args, *args,
**kwargs **kwargs,
): ):
# NOTE(dtantsur): keystoneauth defaults retriable_status_codes to None, # NOTE(dtantsur): keystoneauth defaults retriable_status_codes to None,
# override it with a class-level value. # override it with a class-level value.
@@ -144,7 +144,7 @@ class Proxy(adapter.Adapter, Generic[T]):
connect_retries=1, connect_retries=1,
global_request_id=None, global_request_id=None,
*args, *args,
**kwargs **kwargs,
): ):
conn = self._get_connection() conn = self._get_connection()
if not global_request_id: if not global_request_id:
@@ -180,7 +180,7 @@ class Proxy(adapter.Adapter, Generic[T]):
connect_retries=connect_retries, connect_retries=connect_retries,
raise_exc=raise_exc, raise_exc=raise_exc,
global_request_id=global_request_id, global_request_id=global_request_id,
**kwargs **kwargs,
), ),
), ),
expiration_time=expiration_time, expiration_time=expiration_time,
@@ -196,7 +196,7 @@ class Proxy(adapter.Adapter, Generic[T]):
connect_retries=connect_retries, connect_retries=connect_retries,
raise_exc=raise_exc, raise_exc=raise_exc,
global_request_id=global_request_id, global_request_id=global_request_id,
**kwargs **kwargs,
) )
for h in response.history: for h in response.history:
@@ -623,7 +623,7 @@ class Proxy(adapter.Adapter, Generic[T]):
requires_id=True, requires_id=True,
base_path=None, base_path=None,
skip_cache=False, skip_cache=False,
**attrs **attrs,
): ):
"""Fetch a resource """Fetch a resource
@@ -665,7 +665,7 @@ class Proxy(adapter.Adapter, Generic[T]):
paginated=True, paginated=True,
base_path=None, base_path=None,
jmespath_filters=None, jmespath_filters=None,
**attrs **attrs,
) -> Generator[T, None, None]: ) -> Generator[T, None, None]:
"""List a resource """List a resource
@@ -736,6 +736,7 @@ class Proxy(adapter.Adapter, Generic[T]):
identified_resources=None, identified_resources=None,
filters=None, filters=None,
resource_evaluation_fn=None, resource_evaluation_fn=None,
skip_resources=None,
): ):
return None return None
@@ -814,6 +815,20 @@ class Proxy(adapter.Adapter, Generic[T]):
else: else:
return False return False
def should_skip_resource_cleanup(self, resource=None, skip_resources=None):
if resource is None or skip_resources is None:
return False
resource_name = f"{self.service_type.replace('-', '_')}.{resource}"
if resource_name in skip_resources:
self.log.debug(
f"Skipping resource {resource_name} " "in project cleanup"
)
return True
return False
# TODO(stephenfin): Remove this and all users. Use of this generally indicates # TODO(stephenfin): Remove this and all users. Use of this generally indicates
# a missing Resource type. # a missing Resource type.

10
openstack/tests/unit/test_proxy.py
View File

@@ -728,6 +728,7 @@ class TestProxyCleanup(base.TestCase):
self.res_no_updated.created_at = '2020-01-02T03:04:05' self.res_no_updated.created_at = '2020-01-02T03:04:05'
self.sot = proxy.Proxy(self.session) self.sot = proxy.Proxy(self.session)
self.sot.service_type = "block-storage"
self.delete_mock = mock.Mock() self.delete_mock = mock.Mock()
@@ -867,3 +868,12 @@ class TestProxyCleanup(base.TestCase):
) )
) )
self.assertEqual(self.res, q.get_nowait()) self.assertEqual(self.res, q.get_nowait())
def test_should_skip_resource_cleanup(self):
excluded = ["block_storage.backup"]
self.assertTrue(
self.sot.should_skip_resource_cleanup("backup", excluded)
)
self.assertFalse(
self.sot.should_skip_resource_cleanup("volume", excluded)
)

6
releasenotes/notes/project-cleanup-exclude-option-65cba962eaa5b61a.yaml Normal file
View File

@@ -0,0 +1,6 @@
---
features:
- |
Project cleanup now supports skipping specific resources,
which will be kept as-is. Resource names are based on the
resource registry names, e. g. "block_storage.volume".