[DRBD-cvs] documentation by lars; more documentation patches by Helmut
drbd-user@lists.linbit.com
drbd-user@lists.linbit.com
Mon, 26 Jan 2004 11:57:09 +0100 (CET)
DRBD CVS committal
Author : lars
Project : drbd
Module : documentation
Dir : drbd/documentation
Modified Files:
datadisk.sgml drbd.conf.sgml drbd.sgml drbdsetup.sgml
Log Message:
more documentation patches by Helmut
===================================================================
RCS file: /var/lib/cvs/drbd/drbd/documentation/datadisk.sgml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -3 -r1.5 -r1.6
--- datadisk.sgml 22 Jan 2004 14:32:51 -0000 1.5
+++ datadisk.sgml 26 Jan 2004 10:57:03 -0000 1.6
@@ -36,14 +36,20 @@
<para>
In order to use <option>/etc/ha.d/resource.d/datadisk</option> you must
define
- a resource, a host, and any other configuration options in the drbd
+ a resource, a host, and any other configuration options in the DRBD
configuration file. See <option>/etc/drbd.conf</option> for details.
- If <replaceable>resource</replaceable> is omited, then all of the
- resouces listed in the config file are affected.
+ If <replaceable>resource</replaceable> is omitted, then all of the
+ resources listed in the config file are affected.
</para>
<para>
Note: This is a symlink to <option>/etc/init.d/drbd</option>.
</para>
+</refsect1>
+
+<refsect1>
+<title>Version</title>
+<simpara>This document is correct for version 0.6.10 of the DRBD distribution.
+</simpara>
</refsect1>
<refsect1>
===================================================================
RCS file: /var/lib/cvs/drbd/drbd/documentation/drbd.conf.sgml,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -3 -r1.13 -r1.14
--- drbd.conf.sgml 22 Jan 2004 14:32:51 -0000 1.13
+++ drbd.conf.sgml 26 Jan 2004 10:57:03 -0000 1.14
@@ -9,7 +9,7 @@
<refnamediv>
<refname>drbd.conf</refname>
- <refpurpose>The configuration file for DRBD's devices</refpurpose>
+ <refpurpose>Configuration file for DRBD's devices</refpurpose>
</refnamediv>
<refsect1>
@@ -17,14 +17,14 @@
<para>
The file <option>/etc/drbd.conf</option> is read by
<option>/etc/init.d/drbd</option> and
-<option>/etc/ha.d/resrouce.d/datadisk</option>
-which are included in the drbd distribution.
+<option>/etc/ha.d/resource.d/datadisk</option>
+which are included in the DRBD distribution.
</para>
<para>
The file format was designed as to allow to have
-a verbatim copy of the file on both nodes of the cluster,
-and in order to keep your configuration manageable you should also
-do so.
+a verbatim copy of the file on both nodes of the cluster.
+It is highly recommended to do so in order to keep your configuration
+manageable.
<example>
<title>A small drbd.conf file</title>
<programlisting>
@@ -66,7 +66,7 @@
<title>File Format</title>
<para>
The file consists of sections and parameter lines.
-A section begins with a keyword, sometimes an additional name and an
+A section begins with a keyword, sometimes an additional name, and an
opening brace.
A section ends with a closing brace.
</para>
@@ -104,7 +104,7 @@
a <option>net</option> and a <option>disk</option> section.
Required parameters in this section: <option>protocol</option>,
<option>fsckcmd</option>. Optional parameters are <option>inittimeout
- </option>, <option>skip-wait</option> and
+ </option>, <option>skip-wait</option>, <option>load-only</option>, and
<option>incon-degr-cmd</option>.
</para>
</listitem>
@@ -140,10 +140,10 @@
of this section's parameters.
Allowed parameters: <option>sync-rate</option>,
<option>sync-max</option>, <option>sync-min</option>,
- <option>sync-nice</option>, <option>skip-sync</option>,
+ <option>sync-nice</option>, <option>sync-group</option>, <option>skip-sync</option>,
<option>connect-int</option>, <option>ping-int</option>,
<option>timeout</option>, <option>tl-size</option>,
- <option>sndbuf-size</option>.
+ <option>sndbuf-size</option>, <option>ko-count</option>.
</para>
</listitem>
</varlistentry>
@@ -192,10 +192,10 @@
<varlistentry>
<term><option>skip-wait</option></term>
<listitem><para>
- If you want startup of drbd to proceed without waiting for
+ If you want startup of DRBD to proceed without waiting for
synchronisation to finish, you can set this option. WARNING:
- only do this if whatever software you're using to manage drbd can
- correctly handle a syncing drbd device (no failover possible), or a cluster in
+ only do this if whatever software you're using to manage DRBD can
+ correctly handle a syncing DRBD device (no failover possible), or a cluster in
degraded mode.
</para>
</listitem>
@@ -216,7 +216,7 @@
In case a node starts up in degraded mode (inittimeout is set) and
its local replica of the data is inconsistent it executes the
<replaceable>command</replaceable>. If the command exits without
- error, datadisk expects the drbd device to be in primary state.
+ error, datadisk expects the DRBD device to be in primary state.
</para>
</listitem>
</varlistentry>
@@ -267,6 +267,11 @@
</variablelist>
</refsect2>
+</refsect1>
+<refsect1>
+<title>Version</title>
+<simpara>This document is correct for version 0.6.10 of the DRBD distribution.
+</simpara>
</refsect1>
<refsect1>
<title>Author</title>
===================================================================
RCS file: /var/lib/cvs/drbd/drbd/documentation/drbd.sgml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -3 -r1.4 -r1.5
--- drbd.sgml 22 Jan 2004 14:32:51 -0000 1.4
+++ drbd.sgml 26 Jan 2004 10:57:03 -0000 1.5
@@ -9,7 +9,7 @@
<refnamediv>
<refname>/etc/init.d/drbd</refname>
- <refpurpose>The start and stop script for DRBD</refpurpose>
+ <refpurpose>Start and stop script for DRBD</refpurpose>
</refnamediv>
<refsynopsisdiv>
@@ -30,14 +30,14 @@
<title>Introduction</title>
<para>
The <option>/etc/init.d/drbd</option> script is used
- to start and stop drbd on a system V style init system.
+ to start and stop DRBD on a system V style init system.
</para>
<para>
In order to use <option>/etc/init.d/drbd</option> you must define
- a resource, a host, and any other configuration options in the drbd
+ a resource, a host, and any other configuration options in the DRBD
configuration file. See <option>/etc/drbd.conf</option> for details.
If <replaceable>resource</replaceable> is omitted, then all of the
- resouces listed in the config file are configured.
+ resources listed in the config file are configured.
</para>
<para>
This script might ask you <quote>Do you want to abort waiting for
@@ -59,6 +59,12 @@
<option>drbd --config /path/to/new/config/file checkconfig</option>.
You need to specify the full path.
</para>
+</refsect1>
+
+<refsect1>
+<title>Version</title>
+<simpara>This document is correct for version 0.6.10 of the DRBD distribution.
+</simpara>
</refsect1>
<refsect1>
===================================================================
RCS file: /var/lib/cvs/drbd/drbd/documentation/drbdsetup.sgml,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -3 -r1.17 -r1.18
--- drbdsetup.sgml 24 Jan 2004 10:47:29 -0000 1.17
+++ drbdsetup.sgml 26 Jan 2004 10:57:03 -0000 1.18
@@ -36,8 +36,11 @@
<arg>-s<arg choice=req><replaceable>size</replaceable></arg></arg>
<arg>-c<arg choice=req><replaceable>time</replaceable></arg></arg>
<arg>-i<arg choice=req><replaceable>time</replaceable></arg></arg>
+ <arg>-t<arg choice=req><replaceable>val</replaceable></arg></arg>
<arg>-k</arg>
+ <arg>-g<arg choice=req><replaceable>group</replaceable></arg></arg>
<arg>-S<arg choice=req><replaceable>size</replaceable></arg></arg>
+ <arg>-K<arg choice=req><replaceable>count</replaceable></arg></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>drbdsetup</command>
@@ -102,17 +105,17 @@
<refsect1>
<title>Description</title>
<para>
-drbdsetup is used to associate drbd devices with their lower
-level block devices, to set up drbd device pairs to mirror their
-lower level block devices and to inspect the configuration of
-running drbd devices.
+drbdsetup is used to associate DRBD devices with their lower
+level block devices, to set up DRBD device pairs to mirror their
+lower level block devices, and to inspect the configuration of
+running DRBD devices.
</para>
</refsect1>
<refsect1>
<title>Note</title>
<para>
-drbdsetup is a low level tool of the drbd program suite. It is
+drbdsetup is a low level tool of the DRBD program suite. It is
used by the datadisk and drbd scripts to communicate with
the device driver.
</para>
@@ -121,9 +124,9 @@
<refsect1>
<title>Commands</title>
<para>
-Each drbd sub-command might require arguments and bring its own
+Each drbdsetup sub-command might require arguments and bring its own
set of options. All values have default units which might be overruled
-by K, M or G. These units are defined in the usual way (e.g. K = 2^10).
+by K, M or G. These units are defined in the usual way (e.g. K = 2^10 = 1024).
</para>
<refsect2>
@@ -146,8 +149,8 @@
<option>--disk-size <replaceable>size</replaceable></option></term>
<listitem><para>
If you need to use the device before connecting, use this option
-to pass the <replaceable>size</replaceable> of the drbd device to
-the driver. Default unit is KB.
+to pass the <replaceable>size</replaceable> of the DRBD device to
+the driver. Default unit is KB (1 KB = 1024 bytes).
</para></listitem>
</varlistentry>
<varlistentry>
@@ -155,11 +158,11 @@
<option>--do-panic</option></term>
<listitem><para>
If the driver of the <replaceable>lower_device</replaceable> reports
-an error to drbd, drbd passes this error on to the upper
+an error to DRBD, DRBD passes this error on to the upper
layers of the operating
system by default. With the <option>-p</option> or
<option>--do-panic</option> you can request that
-drbd triggers a kernel panic instead.
+DRBD triggers a kernel panic instead.
</para></listitem>
</varlistentry>
</variablelist>
@@ -171,25 +174,31 @@
<replaceable>local_addr:port</replaceable> for incoming connections
and to try to connect to <replaceable>remote_addr:port</replaceable>.
If <replaceable>port</replaceable> is omitted, 7788 is used as default.
-On the TCP/IP link the specified <replaceable>protocol</replaceable>
-is used. Valid protocol specifiers are A, B and C.
</para>
+<para>On the TCP/IP link the specified <replaceable>protocol</replaceable>
+is used. Valid protocol specifiers are A, B, and C.</para>
+<para>Protocol A: write IO is reported as completed, if it has reached
+local disk and local tcp send buffer.</para>
+<para>Protocol B: write IO is reported as completed, if it has reached
+local disk and remote buffer cache.</para>
+<para>Protocol C: write IO is reported as completed, if it has
+reached both local and remote disk.</para>
<variablelist>
<varlistentry>
<term><option>-r</option>,
<option>--sync-rate <replaceable>rate</replaceable></option>,
<option>--sync-max <replaceable>rate</replaceable></option></term>
<listitem><para>
-To ensure smooth operation of the application on top of drbd, it is
+To ensure smooth operation of the application on top of DRBD, it is
possible to limit the bandwidth which may be used by background
-synchronisations. It is well possible that this limit is not fully
+synchronizations. It is well possible that this limit is not fully
utilized while the server is otherwise loaded, because synchronization
runs at a very low priority by default (nicelevel +19; but see below).
-The default is 250 KB/sec, the default unit is KB.
+The default is 250 KB/sec, the default unit is KB/sec.
</para></listitem>
</varlistentry>
<varlistentry>
- <term>
+ <term><option>-n</option>,
<option>--sync-min <replaceable>rate</replaceable></option></term>
<listitem><para>
It is possible to guarantee a minimum throughput for the synchronization.
@@ -197,11 +206,11 @@
sync-daemon reprioritizes itself to the highest possible priority
(nicelevel -20; not RealTime class). As soon as speed is back above the
watermark, it flips back to the normal priority, see above. The default
-is 200 KB/sec, the default unit is KB.
+is 200 KB/sec, the default unit is KB/sec.
</para></listitem>
</varlistentry>
<varlistentry>
- <term>
+ <term><option>-P</option>,
<option>--sync-nice <replaceable>nice-level</replaceable></option></term>
<listitem><para>
This sets the normal nice-level for background synchronization.
@@ -215,17 +224,17 @@
<term><option>-k</option>,
<option>--skip-sync </option></term>
<listitem><para>
-This option suppresses the automatic start of the resynchronisation
+This option suppresses the automatic start of the resynchronization
process, which
-is triggered as soon as two drbd devices are connected.
+is triggered as soon as two DRBD devices are connected.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-g</option>,
<option>--sync-group <replaceable>group</replaceable></option></term>
<listitem><para>
-Resynchronisation of all devices in one group runs parallel. Groups are
-serialized in ascending order. You should avoid that drbd devices which
+Resynchronization of all devices in one group runs parallel. Groups are
+serialized in ascending order. You should avoid that devices which
lower devices share one and the same physical disk sync in parallel. The default
group is 0. I.e. per default all devices sync parallel.
</para></listitem>
@@ -234,9 +243,8 @@
<term><option>-c</option>,
<option>--connect-int <replaceable>time</replaceable></option></term>
<listitem><para>
-In case it is not possible to connect to the remote drbd device immediately,
-drbd
-keeps on trying to connect. With this option you can set the time
+In case it is not possible to connect to the remote DRBD device immediately,
+DRBD keeps on trying to connect. With this option you can set the time
between two tries. The default value is 10 seconds, the unit is 1 second.
</para></listitem>
</varlistentry>
@@ -244,9 +252,10 @@
<term><option>-i</option>,
<option>--ping-int <replaceable>time</replaceable></option></term>
<listitem><para>
-If the TCP/IP connection linking a drbd device pair is idle for more than
-<replaceable>time</replaceable> seconds, drbd will generate a keep-alive
-packet to check if its partner is still alive. The default is 10 seconds.
+If the TCP/IP connection linking a DRBD device pair is idle for more than
+<replaceable>time</replaceable> seconds, DRBD will generate a keep-alive
+packet to check if its partner is still alive. The default is 10 seconds,
+the unit is 1 second.
</para></listitem>
</varlistentry>
<varlistentry>
@@ -344,7 +353,7 @@
the device in secondary state.
</para>
<para>
-It is not possible to set both devices of a connected drbd device pair to
+It is not possible to set both devices of a connected DRBD device pair to
primary state.
</para>
<variablelist>
@@ -384,7 +393,7 @@
the device open for write access.
</para>
<para>
-It is however, possible that both devices of a connected drbd device
+It is however, possible that both devices of a connected DRBD device
pair are in secondary state.
</para>
</refsect2>
@@ -393,14 +402,14 @@
<para>
Tries to set the partner of <replaceable>device</replaceable> into secondary
state. This command will return successfully as long as it is possible
-to communicate with the partner, Its return value does not indicate if the
+to communicate with the partner. Its return value does not indicate if the
partner device could change its state.
</para>
</refsect2>
<refsect2>
<title>replicate</title>
<para>
-This forces the pair of connected drbd devices into SyncAll state, which
+This forces the pair of connected DRBD devices into SyncAll state, which
means that all data blocks of the device in primary state are copied to
the device in secondary state.
Since synchronization runs below the filesystem layer, services on the
@@ -434,7 +443,7 @@
<title>wait_sync</title>
<para>
Returns as soon as the <replaceable>device</replaceable> leaves any
-synchronisation state and returns into connected state.
+synchronization state and returns into connected state.
</para>
<variablelist>
<varlistentry>
@@ -455,7 +464,7 @@
Removes the information set by the <option>net</option> command
from the <replaceable>device</replaceable>. This means
that the <replaceable>device</replaceable> goes into unconnected
-state and that it will no longer listen for incomming connections.
+state and that it will no longer listen for incoming connections.
</para>
</refsect2>
<refsect2>
@@ -531,7 +540,7 @@
$ drbdsetup /dev/nb0 net tc2 tc1 B
$ #drbdsetup /dev/nb0 replicate
</screen>
-<para>With release 0.6.x drbd's meta-data management still can not detect changing
+<para>With release 0.6.x DRBD's meta-data management still can not detect changing
mirroring partners. Therefore you might have to issue
the replicate commands as outlined in the example.</para>
<para>Since the snapshot was taken without bringing the on disk file
@@ -543,6 +552,13 @@
</screen>
</example>
</refsect1>
+
+<refsect1>
+<title>Version</title>
+<simpara>This document is correct for version 0.6.10 of the DRBD distribution.
+</simpara>
+</refsect1>
+
<refsect1>
<title>Author</title>
<simpara>Written by Philipp Reisner <email>philipp.reisner@gmx.at</email>.