Cleanup Plugins
The cleanup step plugins implement cleanup actions to be performed at the very end of testing.
Stop and remove all guests after the testing is finished. Also takes care of pruning irrelevant files and directories from the workdir so that we do not eat up unnecessary disk space after everything is done.
Note that the cleanup step is also run when any of the previous
steps failed (for example when the environment preparation was not
successful) so that provisioned systems are not kept running and
consuming resources.
Common Keys
The following keys are accepted by all plugins of the cleanup step.
- name
The name of the step phase.
Environment variable:
TMT_PLUGIN_CLEANUP_TMT_NAMEIn plan metadata:
name:
On command-line:
--name ... export TMT_PLUGIN_CLEANUP_TMT_NAME=...
- order
Order in which the phase should be handled.
Default:
50Environment variable:
TMT_PLUGIN_CLEANUP_TMT_ORDERIn plan metadata:
order:
On command-line:
--order ... export TMT_PLUGIN_CLEANUP_TMT_ORDER=...
- summary
Concise summary describing purpose of the phase.
Default: not set
Environment variable:
TMT_PLUGIN_CLEANUP_TMT_SUMMARYIn plan metadata:
summary:
On command-line:
--summary ... export TMT_PLUGIN_CLEANUP_TMT_SUMMARY=...
- when
If specified, phase is run only if any rule matches plan context.
Default: not set
Environment variable:
TMT_PLUGIN_CLEANUP_TMT_WHENIn plan metadata:
when: RULE
On command-line:
--when RULE export TMT_PLUGIN_CLEANUP_TMT_WHEN=RULE
tmt
Warning
Please, be aware that the documentation below is a work in progress. We are working on fixing it, adding missing bits and generally making it better. Also, it was originally used for command line help only, therefore the formatting is often suboptimal.
Stop and remove all provisioned guests