Bond devices can have any name the user configures, so

[metze/ctdb/wip.git] / config / events.d / README

diff --git a/config/events.d/README b/config/events.d/README
index be9dbb23c63715b1775c3685ee5b681e0150f264..ac7a8f403f89a60feb3c84a799145572c004e315 100644 (file)
--- a/config/events.d/README
+++ b/config/events.d/README
@@ -18,6 +18,9 @@ The eventscripts are called with varying number of arguments.
 The first argument is the "event" and the rest of the arguments depend
 on which event was triggered.
 
+All of the events except the 'shutdown' and 'startrecovery' events will be
+called with the ctdb daemon in NORMAL mode (ie. not in recovery)
+
 The events currently implemented are
 startup
        This event does not take any additional arguments.
@@ -72,7 +75,9 @@ takeip
        This event takes three additional arguments :
        'interface' 'ipaddress' and 'netmask'
 
-       This event will always be followed by a 'recovered' event onse
+       Before this event there will always be a 'startrecovery' event.
+
+       This event will always be followed by a 'recovered' event once
        all ipaddresses have been reassigned to new nodes and the ctdb database
        has been recovered.
        If multiple ip addresses are reassigned during recovery it is
@@ -100,9 +105,14 @@ releaseip
 
        Example: 60.nfs
 
+startrecovery
+       This event is triggered everytime we start a recovery process
+       or before we start changing ip address allocations.
+
 recovered
-       This event is triggered everytime a full ctdb recovery has completed
-       and all public ip addresses have been reassigned among the nodes.
+       This event is triggered every time we have finished a full recovery
+       and also after we have finished reallocating the public ip addresses
+       across the cluster.
 
        Example: 60.nfs which if the ip address configuration has changed
        during the recovery (i.e. if addresses have been taken over or
@@ -110,6 +120,12 @@ recovered
        service and also send out statd notifications to all registered 
        clients.
        
+stopped
+       This event is called when a node is STOPPED and can be used to
+       perform additional cleanup that is required.
+       Note that a stopped node is considered inactive, so it will not
+       be issuing the recovered event once the cluster has recovered.
+       See 91.lvs for a use of this event.
 
 Additional note for takeip, releaseip, recovered: