From 6baaf5bec3ba0094c71d83315170acb5dc729711 Mon Sep 17 00:00:00 2001 From: Ronnie Sahlberg Date: Thu, 2 Jul 2009 12:45:14 +1000 Subject: [PATCH] document the ipreallocate command --- doc/ctdb.1 | 7 +++++-- doc/ctdb.1.html | 48 +++++++++++++++++++++++++----------------------- doc/ctdb.1.xml | 6 ++++++ 3 files changed, 36 insertions(+), 25 deletions(-) diff --git a/doc/ctdb.1 b/doc/ctdb.1 index 5e451e98..dc6fc44c 100644 --- a/doc/ctdb.1 +++ b/doc/ctdb.1 @@ -1,11 +1,11 @@ .\" Title: ctdb .\" Author: .\" Generator: DocBook XSL Stylesheets v1.73.2 -.\" Date: 06/25/2009 +.\" Date: 07/02/2009 .\" Manual: .\" Source: .\" -.TH "CTDB" "1" "06/25/2009" "" "" +.TH "CTDB" "1" "07/02/2009" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -480,6 +480,9 @@ This command will shutdown a specific CTDB daemon\. .SS "recover" .PP This command will trigger the recovery daemon to do a cluster recovery\. +.SS "ipreallocate" +.PP +This command will force the recovery master to perform a full ip reallocation process and redistribute all ip addresses\. This is useful to "reset" the allocations back to its default state if they have been changed using the "moveip" command\. While a "recover" will also perform this reallocation, a recovery is much more hevyweight since it will also rebuild all the databases\. .SS "killtcp " .PP This command will kill the specified TCP connection by issuing a TCP RST to the srcip:port endpoint\. This is a command used by the ctdb eventscripts\. diff --git a/doc/ctdb.1.html b/doc/ctdb.1.html index a5413abf..c589d72b 100644 --- a/doc/ctdb.1.html +++ b/doc/ctdb.1.html @@ -370,15 +370,17 @@ Reclock file:/gpfs/.ctdb/shared

recover

This command will trigger the recovery daemon to do a cluster recovery. -

killtcp <srcip:port> <dstip:port>

+

ipreallocate

+ This command will force the recovery master to perform a full ip reallocation process and redistribute all ip addresses. This is useful to "reset" the allocations back to its default state if they have been changed using the "moveip" command. While a "recover" will also perform this reallocation, a recovery is much more hevyweight since it will also rebuild all the databases. +

killtcp <srcip:port> <dstip:port>

This command will kill the specified TCP connection by issuing a TCP RST to the srcip:port endpoint. This is a command used by the ctdb eventscripts. -

gratiousarp <ip> <interface>

+

gratiousarp <ip> <interface>

This command will send out a gratious arp for the specified interface through the specified interface. This command is mainly used by the ctdb eventscripts. -

reloadnodes

+

reloadnodes

This command is used when adding new nodes, or removing existing nodes from an existing cluster.

Procedure to add a node: @@ -412,7 +414,7 @@ Reclock file:/gpfs/.ctdb/shared

5, Use 'ctdb status' on all nodes and verify that the deleted node no longer shows up in the list..

-

tickle <srcip:port> <dstip:port>

+

tickle <srcip:port> <dstip:port>

This command will will send a TCP tickle to the source host for the specified TCP connection. A TCP tickle is a TCP ACK packet with an invalid sequence and @@ -424,10 +426,10 @@ Reclock file:/gpfs/.ctdb/shared TCP connection has been disrupted and that the client will need to reestablish. This greatly speeds up the time it takes for a client to detect and reestablish after an IP failover in the ctdb cluster. -

gettickles <ip>

+

gettickles <ip>

This command is used to show which TCP connections are registered with CTDB to be "tickled" if there is a failover. -

repack [max_freelist]

+

repack [max_freelist]

Over time, when records are created and deleted in a TDB, the TDB list of free space will become fragmented. This can lead to a slowdown in accessing TDB records. This command is used to defragment a TDB database and pruning the freelist.

@@ -442,7 +444,7 @@ Reclock file:/gpfs/.ctdb/shared Example: ctdb repack 1000

By default, this operation is issued from the 00.ctdb event script every 5 minutes. -

vacuum [max_records]

+

vacuum [max_records]

Over time CTDB databases will fill up with empty deleted records which will lead to a progressive slow down of CTDB database access. This command is used to prune all databases and delete all empty records from the cluster.

@@ -458,12 +460,12 @@ Reclock file:/gpfs/.ctdb/shared Example: ctdb vacuum

By default, this operation is issued from the 00.ctdb event script every 5 minutes. -

Debugging Commands

+

Debugging Commands

These commands are primarily used for CTDB development and testing and should not be used for normal administration. -

process-exists <pid>

+

process-exists <pid>

This command checks if a specific process exists on the CTDB host. This is mainly used by Samba to check if remote instances of samba are still running or not. -

getdbmap

+

getdbmap

This command lists all clustered TDB databases that the CTDB daemon has attached to. Some databases are flagged as PERSISTENT, this means that the database stores data persistently and the data will remain across reboots. One example of such a database is secrets.tdb where information about how the cluster was joined to the domain is stored.

Most databases are not persistent and only store the state information that the currently running samba daemons need. These databases are always wiped when ctdb/samba starts and when a node is rebooted. @@ -482,25 +484,25 @@ dbid:0x2672a57f name:idmap2.tdb path:/var/ctdb/persistent/idmap2.tdb.0 PERSISTEN dbid:0xb775fff6 name:secrets.tdb path:/var/ctdb/persistent/secrets.tdb.0 PERSISTENT dbid:0xe98e08b6 name:group_mapping.tdb path:/var/ctdb/persistent/group_mapping.tdb.0 PERSISTENT dbid:0x7bbbd26c name:passdb.tdb path:/var/ctdb/persistent/passdb.tdb.0 PERSISTENT -

catdb <dbname>

+

catdb <dbname>

This command will dump a clustered TDB database to the screen. This is a debugging command. -

getmonmode

+

getmonmode

This command returns the monutoring mode of a node. The monitoring mode is either ACTIVE or DISABLED. Normally a node will continously monitor that all other nodes that are expected are in fact connected and that they respond to commands.

ACTIVE - This is the normal mode. The node is actively monitoring all other nodes, both that the transport is connected and also that the node responds to commands. If a node becomes unavailable, it will be marked as DISCONNECTED and a recovery is initiated to restore the cluster.

DISABLED - This node is not monitoring that other nodes are available. In this mode a node failure will not be detected and no recovery will be performed. This mode is useful when for debugging purposes one wants to attach GDB to a ctdb process but wants to prevent the rest of the cluster from marking this node as DISCONNECTED and do a recovery. -

setmonmode <0|1>

+

setmonmode <0|1>

This command can be used to explicitely disable/enable monitoring mode on a node. The main purpose is if one wants to attach GDB to a running ctdb daemon but wants to prevent the other nodes from marking it as DISCONNECTED and issuing a recovery. To do this, set monitoring mode to 0 on all nodes before attaching with GDB. Remember to set monitoring mode back to 1 afterwards. -

attach <dbname>

+

attach <dbname>

This is a debugging command. This command will make the CTDB daemon create a new CTDB database and attach to it. -

dumpmemory

+

dumpmemory

This is a debugging command. This command will make the ctdb daemon to write a fill memory allocation map to standard output. -

rddumpmemory

+

rddumpmemory

This is a debugging command. This command will dump the talloc memory allocation tree for the recovery daemon to standard output. -

freeze

+

freeze

This command will lock all the local TDB databases causing clients that are accessing these TDBs such as samba3 to block until the databases are thawed. @@ -508,20 +510,20 @@ dbid:0x7bbbd26c name:passdb.tdb path:/var/ctdb/persistent/passdb.tdb.0 PERSISTEN This is primarily used by the recovery daemon to stop all samba daemons from accessing any databases while the database is recovered and rebuilt. -

thaw

+

thaw

Thaw a previously frozen node. -

eventscript <arguments>

+

eventscript <arguments>

This is a debugging command. This command can be used to manually invoke and run the eventscritps with arbitrary arguments. -

backupdb <database> <file>

+

backupdb <database> <file>

This command can be used to copy the entire content of a database out to a file. This file can later be read back into ctdb using the restoredb command. This is mainly useful for backing up persistent databases such as secrets.tdb and similar. -

restoredb <file>

+

restoredb <file>

This command restores a persistent database that was previously backed up using backupdb. -

SEE ALSO

+

SEE ALSO

ctdbd(1), onnode(1) http://ctdb.samba.org/ -

COPYRIGHT/LICENSE


+

COPYRIGHT/LICENSE


Copyright (C) Andrew Tridgell 2007
Copyright (C) Ronnie sahlberg 2007

diff --git a/doc/ctdb.1.xml b/doc/ctdb.1.xml index 8d0c6417..b0661fd3 100644 --- a/doc/ctdb.1.xml +++ b/doc/ctdb.1.xml @@ -691,6 +691,12 @@ Reclock file:/gpfs/.ctdb/shared + ipreallocate + + This command will force the recovery master to perform a full ip reallocation process and redistribute all ip addresses. This is useful to "reset" the allocations back to its default state if they have been changed using the "moveip" command. While a "recover" will also perform this reallocation, a recovery is much more hevyweight since it will also rebuild all the databases. + + + killtcp <srcip:port> <dstip:port> This command will kill the specified TCP connection by issuing a -- 2.34.1