Sentinel: sentinel.conf self-documenation improved.

[redis.git] / sentinel.conf

diff --git a/sentinel.conf b/sentinel.conf
index 45c34401de386ad9631a1d23dc0a70ca67e196fe..367b3de454350790aa76f46e00f24de375d672cf 100644 (file)
--- a/sentinel.conf
+++ b/sentinel.conf
@@ -52,6 +52,27 @@ sentinel parallel-syncs mymaster 1
 # Default is 15 minutes.
 sentinel failover-timeout mymaster 900000
 
+# SCRIPTS EXECTION
+#
+# sentinel notification-script and sentinel reconfig-script are used in order
+# to configure scripts that are called to notify the system administrator
+# or to reconfigure clients after a failover. The scripts are executed
+# with the following rules for error handling:
+#
+# If script exists with "1" the execution is retried later (up to a maximum
+# number of times currently set to 10).
+#
+# If script exists with "2" (or an higher value) the script execution is
+# not retried.
+#
+# If script terminates because it receives a signal the behavior is the same
+# as exit code 1.
+#
+# A script has a maximum running time of 60 seconds. After this limit is
+# reached the script is terminated with a SIGKILL and the execution retried.
+
+# NOTIFICATION SCRIPT
+#
 # sentinel notification-script <master-name> <script-path>
 # 
 # Call the specified notification script for any sentienl event that is