rados: explain that the task is asynchronous by default

Signed-off-by: Loic Dachary <loic@dachary.org>

diff --git a/tasks/rados.py b/tasks/rados.py
index 720da159630d0340bc37daf637c26cb1710bb155..e5f83cbf3a4c7f8eaa66c5d98f73c5999d561766 100644 (file)
--- a/tasks/rados.py
+++ b/tasks/rados.py
@@ -89,6 +89,38 @@ def task(ctx, config):
             pool_prefix: foo
             ...
 
+    The tests are run asynchronously, they are not complete when the task
+    returns. For instance:
+
+        - rados:
+            clients: [client.0]
+            pools: [ecbase]
+            ops: 4000
+            objects: 500
+            op_weights:
+              read: 100
+              write: 100
+              delete: 50
+              copy_from: 50
+        - print: "**** done rados ec-cache-agent (part 2)"
+
+     will run the print task immediately after the rados tasks begins but
+     not after it completes. To make the rados task a blocking / sequential
+     task, use:
+
+        - sequential:
+          - rados:
+              clients: [client.0]
+              pools: [ecbase]
+              ops: 4000
+              objects: 500
+              op_weights:
+                read: 100
+                write: 100
+                delete: 50
+                copy_from: 50
+        - print: "**** done rados ec-cache-agent (part 2)"
+
     """
     log.info('Beginning rados...')
     assert isinstance(config, dict), \