| Martin Kopec | f62dbc1 | 2019-12-12 00:20:41 +0000 | [diff] [blame] | 1 | Tempest cleanup |
| 2 | =============== |
| 3 | |
| 4 | Documentation regarding tempest cleanup can be found at the following |
| 5 | link: |
| 6 | https://docs.openstack.org/tempest/latest/cleanup.html |
| 7 | |
| 8 | When init_saved_state and dry_run variables are set to false, the role |
| 9 | execution will run tempest cleanup which deletes resources not present in the |
| 10 | saved_state.json file. |
| 11 | |
| 12 | **Role Variables** |
| 13 | |
| 14 | .. zuul:rolevar:: devstack_base_dir |
| 15 | :default: /opt/stack |
| 16 | |
| 17 | The devstack base directory. |
| 18 | |
| 19 | .. zuul:rolevar:: init_saved_state |
| 20 | :default: false |
| 21 | |
| 22 | When true, tempest cleanup --init-saved-state will be executed which |
| 23 | initializes the saved state of the OpenStack deployment and will output |
| 24 | a saved_state.json file containing resources from the deployment that will |
| 25 | be preserved from the cleanup command. This should be done prior to running |
| 26 | Tempest tests. |
| 27 | |
| 28 | .. zuul:rolevar:: dry_run |
| 29 | :default: false |
| 30 | |
| 31 | When true, tempest cleanup creates a report (./dry_run.json) of the |
| 32 | resources that would be cleaned up if the role was ran with dry_run option |
| 33 | set to false. |