Add [Documentation] to openstack Suite Teardown kw

[integration/test.git] / csit / libraries / OpenStackOperations.robot

diff --git a/csit/libraries/OpenStackOperations.robot b/csit/libraries/OpenStackOperations.robot
index f5c4a929f46ba8f024d666ba2b3a8e111466a303..95dddbeeb1e1c02bed35c6557d445a4700db5236 100644 (file)
--- a/csit/libraries/OpenStackOperations.robot
+++ b/csit/libraries/OpenStackOperations.robot
@@ -1192,5 +1192,9 @@ Cleanup Router
     BuiltIn.Run Keyword And Ignore Error    Delete Router    ${id}
 
 OpenStack Suite Teardown
+    [Documentation]    Wrapper teardown keyword that can be used in any suite running in an openstack environement
+    ...    to clean up all openstack resources. For example, all instances, networks, ports, etc will be listed and
+    ...    and deleted. As other global cleanup tasks are needed, they can be added here and the suites will all
+    ...    benefit automatically.
     OpenStack Cleanup All
     SSHLibrary.Close All Connections