How to Clean Up Expired Resources
A resource can be tagged with an expiration tag that instructs Resoto to clean it up after it has reached a certain age. This can serve as a safety net for when a CI job fails or the IaC tool aborts halfway through its run, or even as the primary means of managing resource lifecycles.
Resoto's cleanup_expired plugin can find and delete expired resources.
Prerequisites​
This guide assumes that you have already installed and configured Resoto to collect your cloud resources.
Directions​
Execute the following command in Resoto Shell to open the Resoto Worker configuration for editing:
> config edit resoto.workerEnable cleanup by modifying the
resotoworkersection of the configuration as follows:resotoworker:
# Enable cleanup of resources
cleanup: true
# Do not actually cleanup resources, just create log messages
cleanup_dry_run: false
# How many cleanup threads to run in parallel
cleanup_pool_size: 16When cleanup is enabled, marked resources will be deleted as a part of the
collect_and_cleanupworkflow, which runs each hour by default.tipSet
cleanup_dry_runtotrueto simulate cleanup without actually deleting resources.Update the
plugin_cleanup_expiredsection, setting theenabledproperty totrue:cleanup_expired plugin configurationplugin_cleanup_expired:
# Enable plugin?
enabled: true
The plugin will now run each time Resoto emits the post_cleanup_plan event. The post_cleanup_plan event is emitted in the cleanup phase of the collect_and_cleanup workflow.
Each time the cleanup_expired plugin runs, expired resources will be flagged for removal during the next cleanup run.
A resource's expiration time can be defined either with an ISO 8601 timestamp or time delta:
| Tag Name | Description | Example |
|---|---|---|
resoto:expires | ISO 8601 timestamp | 2022-09-21T10:40:11+00:00 |
resoto:expiration or expiration | Time delta from resource creation time | 24h |
Please see the Resource Expiration for more information about expiration tags.
If you would like to apply expiration tags to existing resources, How to Find Untagged Resources describes how to find untagged resources.
How to Clean Up Untagged Resources describes how to clean up untagged resources, which can be helpful in enforcing tagging policies.
