Add documentation to reboot()

Signed-off-by: Zack Cerza <zack.cerza@inktank.com>

diff --git a/teuthology/task/devstack.py b/teuthology/task/devstack.py
index 6d8575bf3f7ff458717fce06fa4dd00caabff272..07a7961e56f3554164f8c084e3a90d9efe008823 100644 (file)
--- a/teuthology/task/devstack.py
+++ b/teuthology/task/devstack.py
@@ -257,6 +257,18 @@ def set_apache_servername(node):
 
 
 def reboot(node, timeout=300, interval=30):
+    """
+    Reboots a given system, then waits for it to come back up and
+    re-establishes the ssh connection.
+
+    :param node: The teuthology.orchestra.remote.Remote object of the node
+    :param timeout: The amount of time, in seconds, after which to give up
+                    waiting for the node to return
+    :param interval: The amount of time, in seconds, to wait between attempts
+                     to re-establish with the node. This should not be set to
+                     less than maybe 10, to make sure the node actually goes
+                     down first.
+    """
     log.info("Rebooting {host}...".format(host=node.hostname))
     node.run(args=['sudo', 'shutdown', '-r', 'now'])
     reboot_start_time = time.time()