sin/samba-mirror
1
0
Fork 0
mirror of https://github.com/samba-team/samba.git synced 2025-01-11 05:18:09 +03:00
Code

document some public tunables

Browse Source 
(This used to be ctdb commit 61fd50e2b3aa9a3ed32bc81a8e28464f267dc490)
This commit is contained in:
Ronnie Sahlberg 2008-03-04 13:06:46 +11:00
parent 4600834377
commit 5afb32f976
3 changed files with 221 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

75
ctdb/doc/ctdbd.1
View File

@ -1,11 +1,11 @@
.\" Title: ctdbd .\" Title: ctdbd
.\" Author: .\" Author:
.\" Generator: DocBook XSL Stylesheets v1.71.0 <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets v1.71.0 <http://docbook.sf.net/>
.\" Date: 02/22/2008 .\" Date: 03/04/2008
.\" Manual: .\" Manual:
.\" Source: .\" Source:
.\" .\"
.TH "CTDBD" "1" "02/22/2008" "" "" .TH "CTDBD" "1" "03/04/2008" "" ""
.\" disable hyphenation .\" disable hyphenation
.nh .nh
.\" disable justification (adjust text to left margin only) .\" disable justification (adjust text to left margin only)
@ -261,6 +261,77 @@ DISABLED \- This node has been administratively disabled. This node is still fun
UNHEALTHY \- A service provided by this node is malfunctioning and should be investigated. The CTDB daemon itself is operational and participates in the cluster. Its public IP address has been taken over by a different node and no services are currently being hosted. All unhealthy nodes should be investigated and require an administrative action to rectify. UNHEALTHY \- A service provided by this node is malfunctioning and should be investigated. The CTDB daemon itself is operational and participates in the cluster. Its public IP address has been taken over by a different node and no services are currently being hosted. All unhealthy nodes should be investigated and require an administrative action to rectify.
.PP .PP
BANNED \- This node failed too many recovery attempts and has been banned from participating in the cluster for a period of RecoveryBanPeriod seconds. Any public IP address has been taken over by other nodes. This node does not provide any services. All banned nodes should be investigated and require an administrative action to rectify. This node does not perticipate in the CTDB cluster but can still be communicated with. I.e. ctdb commands can be sent to it. BANNED \- This node failed too many recovery attempts and has been banned from participating in the cluster for a period of RecoveryBanPeriod seconds. Any public IP address has been taken over by other nodes. This node does not provide any services. All banned nodes should be investigated and require an administrative action to rectify. This node does not perticipate in the CTDB cluster but can still be communicated with. I.e. ctdb commands can be sent to it.
.SH "PUBLIC TUNABLES"
.PP
These are the public tuneables that can be used to control how ctdb behaves.
.SS "KeepaliveInterval"
.PP
Default: 1
.PP
How often should the nodes send keepalives to eachother.
.SS "KeepaliveLimit"
.PP
Default: 5
.PP
After how many keepalive intervals without any traffic should a node wait until marking the peer as DISCONNECTED.
.SS "MonitorInterval"
.PP
Default: 15
.PP
How often should ctdb run the event scripts to check for a nodes health.
.SS "TickleUpdateInterval"
.PP
Default: 20
.PP
How often will ctdb record and store the "tickle" information used to kickstart stalled tcp connections after a recovery.
.SS "EventScriptTimeout"
.PP
Default: 20
.PP
How long should ctdb let an event script run before aborting it and marking the node unhealthy.
.SS "RecoveryBanPeriod"
.PP
Default: 300
.PP
If a node becomes banned causing repetitive recovery failures. The node will eventually become banned from the cluster. This controls how long the culprit node will be banned from the cluster before it is allowed to try to join the cluster again. Dont set to small. A node gets banned for a reason and it is usually due to real problems with the node.
.SS "DatabaseHashSize"
.PP
Default: 100000
.PP
Size of the hash chains for the local store of the tdbs that ctdb manages.
.SS "RerecoveryTimeout"
.PP
Default: 10
.PP
Once a recovery has completed, no additional recoveries are permitted until this timeout has expired.
.SS "EnableBans"
.PP
Default: 1
.PP
When set to 0, this disables BANNING completely in the cluster and thus nodes can not get banned, even it they break. Dont set to 0.
.SS "DeterministicIPs"
.PP
Default: 1
.PP
When enabled, this tunable makes ctdb try to keep public ip addresses locked to specific nodes as far as possible. This makes it easier for debugging since you can know that as long as all nodes are healthy public ip X will always be hosted by node Y.
.PP
The cost of using deterministic ip address assignment is that it disables part of the logic where ctdb tries to reduce the number of public ip assignment changes in the cluster. This tunable may increase the number of ip failover/failbacks that are performed on the cluster by a small margin.
.SS "DisableWhenUnhealthy"
.PP
Default: 0
.PP
When set, As soon as a node becomes unhealthy, that node will also automatically become permanently DISABLED. Once a node is DISABLED, the only way to make it participate in the cluster again and host services is by manually enabling the node again using 'ctdb enable'.
.PP
This disables parts of the resilience and robustness of the cluster and should ONLY be used when the system administrator is actively monitoring the cluster, so that nodes can be enabled again.
.SS "NoIPFailback"
.PP
Default: 0
.PP
When set to 1, ctdb will not perform failback of ip addresses when a node becomes healthy. Ctdb WILL perform failover of public ip addresses when a node becomes UNHEALTHY, but when the node becomes HEALTHY again, ctdb will not fail the addresses back.
.PP
Use with caution! Normally when a node becomes available to the cluster ctdb will try to reassign public ip addresses onto the new node as a way to distribute the workload evenly across the clusternode. Ctdb tries to make sure that all running nodes have approximately the same number of public addresses it hosts.
.PP
when you enable this tunable, CTDB will no longer attempt to rebalance the cluster by failing ip addresses back to the new nodes. An unbalanced cluster will therefore remain unbalanced until there is manual intervention from the administrator. (When this parameter is set, you can manually fail public ip addresses over to the new node(s) using the 'ctdb moveip' command.
.SH "SEE ALSO" .SH "SEE ALSO"
.PP .PP
ctdb(1), onnode(1) ctdb(1), onnode(1)

47
ctdb/doc/ctdbd.1.html
View File

@ -259,10 +259,53 @@
investigated and require an administrative action to rectify. This node investigated and require an administrative action to rectify. This node
does not perticipate in the CTDB cluster but can still be communicated does not perticipate in the CTDB cluster but can still be communicated
with. I.e. ctdb commands can be sent to it. with. I.e. ctdb commands can be sent to it.
</p></div><div class="refsect1" lang="en"><a name="id2528891"></a><h2>SEE ALSO</h2><p> </p></div><div class="refsect1" lang="en"><a name="id2528891"></a><h2>PUBLIC TUNABLES</h2><p>
These are the public tuneables that can be used to control how ctdb behaves.
</p><div class="refsect2" lang="en"><a name="id2528901"></a><h3>KeepaliveInterval</h3><p>Default: 1</p><p>
How often should the nodes send keepalives to eachother.
</p></div><div class="refsect2" lang="en"><a name="id2528915"></a><h3>KeepaliveLimit</h3><p>Default: 5</p><p>
After how many keepalive intervals without any traffic should a node
wait until marking the peer as DISCONNECTED.
</p></div><div class="refsect2" lang="en"><a name="id2528929"></a><h3>MonitorInterval</h3><p>Default: 15</p><p>
How often should ctdb run the event scripts to check for a nodes health.
</p></div><div class="refsect2" lang="en"><a name="id2528943"></a><h3>TickleUpdateInterval</h3><p>Default: 20</p><p>
How often will ctdb record and store the "tickle" information used to
kickstart stalled tcp connections after a recovery.
</p></div><div class="refsect2" lang="en"><a name="id2528958"></a><h3>EventScriptTimeout</h3><p>Default: 20</p><p>
How long should ctdb let an event script run before aborting it and
marking the node unhealthy.
</p></div><div class="refsect2" lang="en"><a name="id2528972"></a><h3>RecoveryBanPeriod</h3><p>Default: 300</p><p>
If a node becomes banned causing repetitive recovery failures. The node will
eventually become banned from the cluster.
This controls how long the culprit node will be banned from the cluster
before it is allowed to try to join the cluster again.
Dont set to small. A node gets banned for a reason and it is usually due
to real problems with the node.
</p></div><div class="refsect2" lang="en"><a name="id2528991"></a><h3>DatabaseHashSize</h3><p>Default: 100000</p><p>
Size of the hash chains for the local store of the tdbs that ctdb manages.
</p></div><div class="refsect2" lang="en"><a name="id2529005"></a><h3>RerecoveryTimeout</h3><p>Default: 10</p><p>
Once a recovery has completed, no additional recoveries are permitted until this timeout has expired.
</p></div><div class="refsect2" lang="en"><a name="id2529020"></a><h3>EnableBans</h3><p>Default: 1</p><p>
When set to 0, this disables BANNING completely in the cluster and thus nodes can not get banned, even it they break. Dont set to 0.
</p></div><div class="refsect2" lang="en"><a name="id2529034"></a><h3>DeterministicIPs</h3><p>Default: 1</p><p>
When enabled, this tunable makes ctdb try to keep public ip addresses locked to specific nodes as far as possible. This makes it easier for debugging since you can know that as long as all nodes are healthy public ip X will always be hosted by node Y.
</p><p>
The cost of using deterministic ip address assignment is that it disables part of the logic where ctdb tries to reduce the number of public ip assignment changes in the cluster. This tunable may increase the number of ip failover/failbacks that are performed on the cluster by a small margin.
</p></div><div class="refsect2" lang="en"><a name="id2529060"></a><h3>DisableWhenUnhealthy</h3><p>Default: 0</p><p>
When set, As soon as a node becomes unhealthy, that node will also automatically become permanently DISABLED. Once a node is DISABLED, the only way to make it participate in the cluster again and host services is by manually enabling the node again using 'ctdb enable'.
</p><p>
This disables parts of the resilience and robustness of the cluster and should ONLY be used when the system administrator is actively monitoring the cluster, so that nodes can be enabled again.
</p></div><div class="refsect2" lang="en"><a name="id2529083"></a><h3>NoIPFailback</h3><p>Default: 0</p><p>
When set to 1, ctdb will not perform failback of ip addresses when a node becomes healthy. Ctdb WILL perform failover of public ip addresses when a node becomes UNHEALTHY, but when the node becomes HEALTHY again, ctdb will not fail the addresses back.
</p><p>
Use with caution! Normally when a node becomes available to the cluster
ctdb will try to reassign public ip addresses onto the new node as a way to distribute the workload evenly across the clusternode. Ctdb tries to make sure that all running nodes have approximately the same number of public addresses it hosts.
</p><p>
when you enable this tunable, CTDB will no longer attempt to rebalance the cluster by failing ip addresses back to the new nodes. An unbalanced cluster will therefore remain unbalanced until there is manual intervention from the administrator. (When this parameter is set, you can manually fail public ip addresses over to the new node(s) using the 'ctdb moveip' command.
</p></div></div><div class="refsect1" lang="en"><a name="id2529120"></a><h2>SEE ALSO</h2><p>
ctdb(1), onnode(1) ctdb(1), onnode(1)
<a href="http://ctdb.samba.org/" target="_top">http://ctdb.samba.org/</a> <a href="http://ctdb.samba.org/" target="_top">http://ctdb.samba.org/</a>
</p></div><div class="refsect1" lang="en"><a name="id2528904"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br> </p></div><div class="refsect1" lang="en"><a name="id2529133"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br>
Copyright (C) Andrew Tridgell 2007<br> Copyright (C) Andrew Tridgell 2007<br>
Copyright (C) Ronnie sahlberg 2007<br> Copyright (C) Ronnie sahlberg 2007<br>
<br> <br>

103
ctdb/doc/ctdbd.1.xml
View File

@ -499,6 +499,108 @@
</para> </para>
</refsect1> </refsect1>
<refsect1>
<title>PUBLIC TUNABLES</title>
<para>
These are the public tuneables that can be used to control how ctdb behaves.
</para>
<refsect2><title>KeepaliveInterval</title>
<para>Default: 1</para>
<para>
How often should the nodes send keepalives to eachother.
</para>
</refsect2>
<refsect2><title>KeepaliveLimit</title>
<para>Default: 5</para>
<para>
After how many keepalive intervals without any traffic should a node
wait until marking the peer as DISCONNECTED.
</para>
</refsect2>
<refsect2><title>MonitorInterval</title>
<para>Default: 15</para>
<para>
How often should ctdb run the event scripts to check for a nodes health.
</para>
</refsect2>
<refsect2><title>TickleUpdateInterval</title>
<para>Default: 20</para>
<para>
How often will ctdb record and store the "tickle" information used to
kickstart stalled tcp connections after a recovery.
</para>
</refsect2>
<refsect2><title>EventScriptTimeout</title>
<para>Default: 20</para>
<para>
How long should ctdb let an event script run before aborting it and
marking the node unhealthy.
</para>
</refsect2>
<refsect2><title>RecoveryBanPeriod</title>
<para>Default: 300</para>
<para>
If a node becomes banned causing repetitive recovery failures. The node will
eventually become banned from the cluster.
This controls how long the culprit node will be banned from the cluster
before it is allowed to try to join the cluster again.
Dont set to small. A node gets banned for a reason and it is usually due
to real problems with the node.
</para>
</refsect2>
<refsect2><title>DatabaseHashSize</title>
<para>Default: 100000</para>
<para>
Size of the hash chains for the local store of the tdbs that ctdb manages.
</para>
</refsect2>
<refsect2><title>RerecoveryTimeout</title>
<para>Default: 10</para>
<para>
Once a recovery has completed, no additional recoveries are permitted until this timeout has expired.
</para>
</refsect2>
<refsect2><title>EnableBans</title>
<para>Default: 1</para>
<para>
When set to 0, this disables BANNING completely in the cluster and thus nodes can not get banned, even it they break. Dont set to 0.
</para>
</refsect2>
<refsect2><title>DeterministicIPs</title>
<para>Default: 1</para>
<para>
When enabled, this tunable makes ctdb try to keep public ip addresses locked to specific nodes as far as possible. This makes it easier for debugging since you can know that as long as all nodes are healthy public ip X will always be hosted by node Y.
</para>
<para>
The cost of using deterministic ip address assignment is that it disables part of the logic where ctdb tries to reduce the number of public ip assignment changes in the cluster. This tunable may increase the number of ip failover/failbacks that are performed on the cluster by a small margin.
</para>
</refsect2>
<refsect2><title>DisableWhenUnhealthy</title>
<para>Default: 0</para>
<para>
When set, As soon as a node becomes unhealthy, that node will also automatically become permanently DISABLED. Once a node is DISABLED, the only way to make it participate in the cluster again and host services is by manually enabling the node again using 'ctdb enable'.
</para>
<para>
This disables parts of the resilience and robustness of the cluster and should ONLY be used when the system administrator is actively monitoring the cluster, so that nodes can be enabled again.
</para>
</refsect2>
<refsect2><title>NoIPFailback</title>
<para>Default: 0</para>
<para>
When set to 1, ctdb will not perform failback of ip addresses when a node becomes healthy. Ctdb WILL perform failover of public ip addresses when a node becomes UNHEALTHY, but when the node becomes HEALTHY again, ctdb will not fail the addresses back.
</para>
<para>
Use with caution! Normally when a node becomes available to the cluster
ctdb will try to reassign public ip addresses onto the new node as a way to distribute the workload evenly across the clusternode. Ctdb tries to make sure that all running nodes have approximately the same number of public addresses it hosts.
</para>
<para>
When you enable this tunable, CTDB will no longer attempt to rebalance the cluster by failing ip addresses back to the new nodes. An unbalanced cluster will therefore remain unbalanced until there is manual intervention from the administrator. When this parameter is set, you can manually fail public ip addresses over to the new node(s) using the 'ctdb moveip' command.
</para>
</refsect2>
</refsect1>
<refsect1><title>SEE ALSO</title> <refsect1><title>SEE ALSO</title>
<para> <para>
@ -506,6 +608,7 @@
<ulink url="http://ctdb.samba.org/"/> <ulink url="http://ctdb.samba.org/"/>
</para> </para>
</refsect1> </refsect1>
<refsect1><title>COPYRIGHT/LICENSE</title> <refsect1><title>COPYRIGHT/LICENSE</title>
<literallayout> <literallayout>
Copyright (C) Andrew Tridgell 2007 Copyright (C) Andrew Tridgell 2007