X-Git-Url: http://git.samba.org/?p=metze%2Fctdb%2Fwip.git;a=blobdiff_plain;f=doc%2Fctdbd.1;h=95734efc9200bbfd30f39faaa318ef4e4f6b7c98;hp=242bd4513c2668dbadc88471abfd1f0dbdeebbb4;hb=0a0526e03ef995b6b6634f5b75c7a17cb7b5df8f;hpb=d6ddea4167ccdad05e88378ee3f22b6125969562
diff --git a/doc/ctdbd.1 b/doc/ctdbd.1
index 242bd451..95734efc 100644
--- a/doc/ctdbd.1
+++ b/doc/ctdbd.1
@@ -1,11 +1,11 @@
.\" Title: ctdbd
.\" Author:
.\" Generator: DocBook XSL Stylesheets v1.73.2
-.\" Date: 07/09/2009
+.\" Date: 12/04/2009
.\" Manual:
.\" Source:
.\"
-.TH "CTDBD" "1" "07/09/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=] {\-\-dbdir=} {\-\-dbdir\-persistent=} [\-\-event\-script\-dir=] [\-i\ \-\-interactive] [\-\-listen=] [\-\-logfile=] [\-\-lvs] {\-\-nlist=} [\-\-no\-lmaster] [\-\-no\-recmaster] [\-\-nosetsched] [\-\-public\-addresses=] [\-\-public\-interface=] {\-\-reclock=} [\-\-single\-public\-ip=] [\-\-socket=] [\-\-start\-as\-disabled] [\-\-start\-as\-stopped] [\-\-syslog] [\-\-torture] [\-\-transport=] [\-\-usage]
+\fBctdbd\fR [\-?\ \-\-help] [\-d\ \-\-debug=] {\-\-dbdir=} {\-\-dbdir\-persistent=} [\-\-event\-script\-dir=] [\-i\ \-\-interactive] [\-\-listen=] [\-\-logfile=] [\-\-lvs] {\-\-nlist=} [\-\-no\-lmaster] [\-\-no\-recmaster] [\-\-nosetsched] {\-\-notification\-script=} [\-\-public\-addresses=] [\-\-public\-interface=] {\-\-reclock=} [\-\-single\-public\-ip=] [\-\-socket=] [\-\-start\-as\-disabled] [\-\-start\-as\-stopped] [\-\-syslog] [\-\-torture] [\-\-transport=] [\-\-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=
+.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=
.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,6 +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 "Removing/Changing NATGW at runtime"
+.PP
+The following are the procedures to change/remove a NATGW configuration at runtime, without having to restart ctdbd\.
+.PP
+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
+If you want to change the NATGW configuration on a node :
+.sp
+.RS 4
+.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= in the sysconfig file, or by adding \-\-notification\-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\.
@@ -524,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