ctdb-doc: Correct documentation for tunables for script timeout

* The defaults for EventScriptTimeout and EventScriptTimeoutCount are
  wrong.

* EventScriptTimeout is the total time for all enabled scripts that
  are run for an event, not a single event script.

* EventScriptTimeoutCount only applies to monitor events.

* EventScriptUnhealthyOnTimeout is obsolete, so remove it.

Signed-off-by: Martin Schwenke <martin@meltin.net>
Reviewed-by: Amitay Isaacs <amitay@gmail.com>

diff --git a/ctdb/doc/ctdb-tunables.7.xml b/ctdb/doc/ctdb-tunables.7.xml
index b029fdb75a89ed496b22d8f939c09833ff0ffc95..329cff2240efc53584b884d68db86d90a15dce00 100644 (file)
--- a/ctdb/doc/ctdb-tunables.7.xml
+++ b/ctdb/doc/ctdb-tunables.7.xml
@@ -166,29 +166,29 @@
 
     <refsect2>
       <title>EventScriptTimeout</title>
-      <para>Default: 20</para>
+      <para>Default: 30</para>
       <para>
-       How long should ctdb let an event script run before aborting it and
-       marking the node unhealthy.
+       Maximum time in seconds to allow an event to run before timing
+       out.  This is the total time for all enabled scripts that are
+       run for an event, not just a single event script.
       </para>
-    </refsect2>
 
-    <refsect2>
-      <title>EventScriptTimeoutCount</title>
-      <para>Default: 1</para>
       <para>
-       How many events in a row needs to timeout before we flag the node UNHEALTHY.
-       This setting is useful if your scripts can not be written so that they
-       do not hang for benign reasons.
+       Note that timeouts are ignored for some events ("takeip",
+       "releaseip", "startrecovery", "recovered") and converted to
+       success.  The logic here is that the callers of these events
+       implement their own additional timeout.
       </para>
     </refsect2>
 
     <refsect2>
-      <title>EventScriptUnhealthyOnTimeout</title>
-      <para>Default: 0</para>
+      <title>EventScriptTimeoutCount</title>
+      <para>Default: 20</para>
       <para>
-       This setting can be be used to make ctdb never become UNHEALTHY if your
-       eventscripts keep hanging/timing out.
+       How many monitor events in a row need to timeout before a node
+       is flagged as UNHEALTHY.  This only applies to monitor events.
+       This setting is useful if scripts can not be written so that
+       they do not hang for benign reasons.
       </para>
     </refsect2>