Document the procedure to remove/change the NATGW configuration at
[metze/ctdb/wip.git] / doc / ctdbd.1
index 973e708767dccb59afe4fed5e45d6679a10538b1..95734efc9200bbfd30f39faaa318ef4e4f6b7c98 100644 (file)
@@ -1,11 +1,11 @@
 .\"     Title: ctdbd
 .\"    Author: 
 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
-.\"      Date: 07/28/2009
+.\"      Date: 12/04/2009
 .\"    Manual: 
 .\"    Source: 
 .\"
-.TH "CTDBD" "1" "07/28/2009" "" ""
+.TH "CTDBD" "1" "12/04/2009" "" ""
 .\" disable hyphenation
 .nh
 .\" disable justification (adjust text to left margin only)
@@ -16,7 +16,7 @@ ctdbd - The CTDB cluster daemon
 .HP 6
 \fBctdbd\fR
 .HP 6
-\fBctdbd\fR [\-?\ \-\-help] [\-d\ \-\-debug=<INTEGER>] {\-\-dbdir=<directory>} {\-\-dbdir\-persistent=<directory>} [\-\-event\-script\-dir=<directory>] [\-i\ \-\-interactive] [\-\-listen=<address>] [\-\-logfile=<filename>] [\-\-lvs] {\-\-nlist=<filename>} [\-\-no\-lmaster] [\-\-no\-recmaster] [\-\-nosetsched] [\-\-public\-addresses=<filename>] [\-\-public\-interface=<interface>] {\-\-reclock=<filename>} [\-\-single\-public\-ip=<address>] [\-\-socket=<filename>] [\-\-start\-as\-disabled] [\-\-start\-as\-stopped] [\-\-syslog] [\-\-torture] [\-\-transport=<STRING>] [\-\-usage]
+\fBctdbd\fR [\-?\ \-\-help] [\-d\ \-\-debug=<INTEGER>] {\-\-dbdir=<directory>} {\-\-dbdir\-persistent=<directory>} [\-\-event\-script\-dir=<directory>] [\-i\ \-\-interactive] [\-\-listen=<address>] [\-\-logfile=<filename>] [\-\-lvs] {\-\-nlist=<filename>} [\-\-no\-lmaster] [\-\-no\-recmaster] [\-\-nosetsched] {\-\-notification\-script=<filename>} [\-\-public\-addresses=<filename>] [\-\-public\-interface=<interface>] {\-\-reclock=<filename>} [\-\-single\-public\-ip=<address>] [\-\-socket=<filename>] [\-\-start\-as\-disabled] [\-\-start\-as\-stopped] [\-\-syslog] [\-\-torture] [\-\-transport=<STRING>] [\-\-usage]
 .SH "DESCRIPTION"
 .PP
 ctdbd is the main ctdb daemon\.
@@ -113,6 +113,15 @@ Normally ctdb will change its scheduler to run as a real\-time process\. This is
 This option is used to tell ctdbd to NOT run as a real\-time process and instead run ctdbd as a normal userspace process\. This is useful for debugging and when you want to run ctdbd under valgrind or gdb\. (You dont want to attach valgrind or gdb to a real\-time process\.)
 .RE
 .PP
+\-\-notification\-script=<filename>
+.RS 4
+This specifies a script which will be invoked by ctdb when certain state changes occur in ctdbd and when you may want to trigger this to run certain scripts\.
+.sp
+This file is usually /etc/ctdb/notify\.sh \.
+.sp
+See the NOTIFICATION SCRIPT section below for more information\.
+.RE
+.PP
 \-\-public_addresses=<filename>
 .RS 4
 When used with IP takeover this specifies a file containing the public ip addresses to use on the cluster\. This file contains a list of ip addresses netmasks and interfaces\. When ctdb is operational it will distribute these public ip addresses evenly across the available nodes\.
@@ -508,19 +517,48 @@ The NAT\-GW node is assigned the CTDB_NATGW_PUBLIC_IP to the designated interfac
 All other nodes in the group are configured with a default route of metric 10 pointing to the designated NAT GW node\.
 .PP
 This is implemented in the 11\.natgw eventscript\. Please see the eventscript for further information\.
-.SS "Activating NATGW without forcing a cluster restart"
+.SS "Removing/Changing NATGW at runtime"
 .PP
-Normally you would update the configuration and restart the nodes to activate NATGW\. It is however also possible to manually start NATGW without restarting CTDB, but it does require a recovery\.
+The following are the procedures to change/remove a NATGW configuration at runtime, without having to restart ctdbd\.
 .PP
-To activate NATGW functionality on a cluster without restarting the actual nodes you can use the following process :
+If you want to remove NATGW completely from a node, use these steps:
+.sp
+.RS 4
+.nf
+1, Run \'CTDB_BASE=/etc/ctdb /etc/ctdb/events\.d/11\.natgw removenatgw\'
+2, Then remove the configuration from /etc/sysconfig/ctdb
+    
+.fi
+.RE
 .PP
-Activating NATGW on a running system
+If you want to change the NATGW configuration on a node :
+.sp
 .RS 4
-Configure NATGW as described above on all nodes\.
-Run "echo 3 > /proc/sys/net/ipv4/conf/all/arp_ignore" on all nodes\.
-Run "echo 2 > /proc/sys/net/ipv4/conf/all/arp_announce" on all nodes\.
-Force a recovery by running "ctdb recover"\.
+.nf
+1, Run \'CTDB_BASE=/etc/ctdb /etc/ctdb/events\.d/11\.natgw removenatgw\'
+2, Then change the configuration in /etc/sysconfig/ctdb
+3, Run \'CTDB_BASE=/etc/ctdb /etc/ctdb/events\.d/11\.natgw updatenatgw\'
+    
+.fi
 .RE
+.SH "NOTIFICATION SCRIPT"
+.PP
+Notification scripts are used with ctdb to have a call\-out from ctdb to a user\-specified script when certain state changes occur in ctdb\. This is commonly to set up either sending SNMP traps or emails when a node becomes unhealthy and similar\.
+.PP
+This is activated by setting CTDB_NOTIFY_SCRIPT=<your script> in the sysconfig file, or by adding \-\-notification\-script=<your script>\.
+.PP
+See /etc/ctdb/notify\.sh for an example script\.
+.PP
+CTDB currently generates notifications on these state changes:
+.SS "unhealthy"
+.PP
+This call\-out is triggered when the node changes to UNHEALTHY state\.
+.SS "healthy"
+.PP
+This call\-out is triggered when the node changes to HEALTHY state\.
+.SS "startup"
+.PP
+This call\-out is triggered when ctdb has started up and all managed services are up and running\.
 .SH "CLAMAV DAEMON"
 .PP
 CTDB has support to manage the popular anti\-virus daemon ClamAV\. This support is implemented through the eventscript : /etc/ctdb/events\.d/31\.clamd\.
@@ -537,11 +575,11 @@ CTDB_CLAMD_SOCKET="/path/to/clamd\.socket"
 .fi
 .RE
 .PP
-Second, activate the eventscript by making it executable:
+Second, activate the eventscript
 .sp
 .RS 4
 .nf
-chmod +x /etc/ctdb/events\.d/31\.clamd
+ctdb enablescript 31\.clamd
 .fi
 .RE
 .PP