[cedar-backup-svn] SF.net SVN: cedar-backup: [808] cedar-backup2/trunk
Brought to you by:
pronovic
Menu
▾
▴
[cedar-backup-svn] SF.net SVN: cedar-backup: [808] cedar-backup2/trunk
|
From: <pro...@us...> - 2007-12-15 21:12:42
|
Revision: 808
http://cedar-backup.svn.sourceforge.net/cedar-backup/?rev=808&view=rev
Author: pronovic
Date: 2007-12-15 13:12:36 -0800 (Sat, 15 Dec 2007)
Log Message:
-----------
Update manual to discuss new peers configuration
Modified Paths:
--------------
cedar-backup2/trunk/Changelog
cedar-backup2/trunk/manual/src/config.xml
Modified: cedar-backup2/trunk/Changelog
===================================================================
--- cedar-backup2/trunk/Changelog 2007-12-15 20:59:51 UTC (rev 807)
+++ cedar-backup2/trunk/Changelog 2007-12-15 21:12:36 UTC (rev 808)
@@ -5,6 +5,7 @@
- Add a new <peers> configuration section (PeersConfig)
- Change peers configuration in <stage> to just override <peers>
- Modify stage process to take peers list from peers section (if available)
+ - Updated user manual to discuss new peers configuration section
Version 2.14.0 19 Sep 2007
Modified: cedar-backup2/trunk/manual/src/config.xml
===================================================================
--- cedar-backup2/trunk/manual/src/config.xml 2007-12-15 20:59:51 UTC (rev 807)
+++ cedar-backup2/trunk/manual/src/config.xml 2007-12-15 21:12:36 UTC (rev 808)
@@ -187,6 +187,13 @@
<backup_group>group</backup_group>
<rcp_command>/usr/bin/scp -B</rcp_command>
</options>
+ <peers>
+ <peer>
+ <name>debian</name>
+ <type>local</type>
+ <collect_dir>/opt/backup/collect</collect_dir>
+ </peer>
+ </peers>
<collect>
<collect_dir>/opt/backup/collect</collect_dir>
<collect_mode>daily</collect_mode>
@@ -203,11 +210,6 @@
</collect>
<stage>
<staging_dir>/opt/backup/staging</staging_dir>
- <peer>
- <name>debian</name>
- <type>local</type>
- <collect_dir>/opt/backup/collect</collect_dir>
- </peer>
</stage>
<store>
<source_dir>/opt/backup/staging</source_dir>
@@ -408,7 +410,7 @@
</para>
<para>
This value is also used as the default remote backup user
- for remote peers in the staging section.
+ for remote peers.
</para>
<para>
<emphasis>Restrictions:</emphasis> Must be non-empty
@@ -447,9 +449,8 @@
</para>
<para>
This value is used as the default value for all remote
- peers in the staging section. Technically, this value is
- not needed by clients, but we require it for all config
- files anyway.
+ peers. Technically, this value is not needed by clients,
+ but we require it for all config files anyway.
</para>
<para>
<emphasis>Restrictions:</emphasis> Must be non-empty
@@ -672,6 +673,236 @@
<!-- ################################################################# -->
+ <sect2 id="cedar-config-configfile-peers">
+
+ <title>Peers Configuration</title>
+
+ <para>
+ The peers configuration section contains a list of the peers
+ managed by a master. This section is only required on a master.
+ </para>
+
+ <para>
+ This is an example peers configuration section:
+ </para>
+
+ <programlisting>
+<peers>
+ <peer>
+ <name>machine1</name>
+ <type>local</type>
+ <collect_dir>/opt/backup/collect</collect_dir>
+ </peer>
+ <peer>
+ <name>machine2</name>
+ <type>remote</type>
+ <backup_user>backup</backup_user>
+ <collect_dir>/opt/backup/collect</collect_dir>
+ </peer>
+</peers>
+ </programlisting>
+
+ <para>
+ The following elements are part of the peers configuration section:
+ </para>
+
+ <variablelist>
+
+ <varlistentry>
+ <term><literal>peer</literal> (local version)</term>
+ <listitem>
+ <para>Local client peer in a backup pool.</para>
+ <para>
+ This is a subsection which contains information about a
+ specific local client peer managed by a master.
+ </para>
+ <para>
+ This section can be repeated as many times as is
+ necessary. At least one remote or local peer must be
+ configured.
+ </para>
+ <para>
+ The local peer subsection must contain the following fields:
+ </para>
+
+ <variablelist>
+
+ <varlistentry>
+ <term><literal>name</literal></term>
+ <listitem>
+ <para>Name of the peer, typically a valid hostname.</para>
+ <para>
+ For local peers, this value is only used for
+ reference. However, it is good practice to list
+ the peer's hostname here, for consistency with
+ remote peers.
+ </para>
+ <para>
+ <emphasis>Restrictions:</emphasis> Must be non-empty,
+ and unique among all peers.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>type</literal></term>
+ <listitem>
+ <para>Type of this peer.</para>
+ <para>
+ This value identifies the type of the peer. For
+ a local peer, it must always be <literal>local</literal>.
+ </para>
+ <para>
+ <emphasis>Restrictions:</emphasis> Must be <literal>local</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>collect_dir</literal></term>
+ <listitem>
+ <para>Collect directory to stage from for this peer.</para>
+ <para>
+ The master will copy all files in this directory
+ into the appropriate staging directory. Since
+ this is a local peer, the directory is assumed to
+ be reachable via normal filesystem operations
+ (i.e. <command>cp</command>).
+ </para>
+ <para>
+ <emphasis>Restrictions:</emphasis> Must be an absolute path.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>peer</literal> (remote version)</term>
+ <listitem>
+ <para>Remote client peer in a backup pool.</para>
+ <para>
+ This is a subsection which contains information about a
+ specific remote client peer managed by a master. A remote
+ peer is one which can be reached via an rsh-based network
+ call.
+ </para>
+ <para>
+ This section can be repeated as many times as is
+ necessary. At least one remote or local peer must be
+ configured.
+ </para>
+ <para>
+ The remote peer subsection must contain the following fields:
+ </para>
+
+ <variablelist>
+
+ <varlistentry>
+ <term><literal>name</literal></term>
+ <listitem>
+ <para>Hostname of the peer.</para>
+ <para>
+ For remote peers, this must be a valid DNS
+ hostname or IP address which can be resolved
+ during an rsh-based network call.
+ </para>
+ <para>
+ <emphasis>Restrictions:</emphasis> Must be non-empty,
+ and unique among all peers.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>type</literal></term>
+ <listitem>
+ <para>Type of this peer.</para>
+ <para>
+ This value identifies the type of the peer. For
+ a remote peer, it must always be <literal>remote</literal>.
+ </para>
+ <para>
+ <emphasis>Restrictions:</emphasis> Must be <literal>remote</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>collect_dir</literal></term>
+ <listitem>
+ <para>Collect directory to stage from for this peer.</para>
+ <para>
+ The master will copy all files in this directory
+ into the appropriate staging directory. Since
+ this is a remote peer, the directory is assumed to
+ be reachable via rsh-based network operations
+ (i.e. <command>scp</command> or the configured
+ rcp command).
+ </para>
+ <para>
+ <emphasis>Restrictions:</emphasis> Must be an absolute path.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>backup_user</literal></term>
+ <listitem>
+ <para>Name of backup user on the remote peer.</para>
+ <para>
+ This username will be used when copying files from
+ the remote peer via an rsh-based network connection.
+ </para>
+ <para>
+ This field is optional. if it doesn't exist, the
+ backup will use the default backup user from the
+ options section.
+ </para>
+ <para>
+ <emphasis>Restrictions:</emphasis> Must be non-empty.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>rcp_command</literal></term>
+ <listitem>
+ <para>The rcp-compatible copy command for this peer.</para>
+ <para>
+ The rcp command should be the exact command used for
+ remote copies, including any required options. If you are
+ using <command>scp</command>, you should pass it the
+ <option>-B</option> option, so <command>scp</command> will
+ not ask for any user input (which could hang the backup).
+ A common example is something like <command>/usr/bin/scp
+ -B</command>.
+ </para>
+ <para>
+ This field is optional. if it doesn't exist, the
+ backup will use the default rcp command from the
+ options section.
+ </para>
+ <para>
+ <emphasis>Restrictions:</emphasis> Must be non-empty.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+
+ </sect2>
+
+ <!-- ################################################################# -->
+
<sect2 id="cedar-config-configfile-collect">
<title>Collect Configuration</title>
@@ -1311,18 +1542,37 @@
<para>
The stage configuration section contains configuration options
- related the the stage action. The section defines the set of peers
- in a backup pool, and then also indicates where data from those
- peers should be staged to.
+ related the the stage action. The section indicates where date
+ from peers can be staged to.
</para>
+
+ <para>
+ This section can also (optionally) override the list of peers so
+ that not all peers are staged. If you provide
+ <emphasis>any</emphasis> peers in this section, then the list of
+ peers here completely replaces the list of peers in the peers
+ configuration section for the purposes of staging.
+ </para>
<para>
- This is an example stage configuration section:
+ This is an example stage configuration section for the simple case
+ where the list of peers is taken from peers configuration:
</para>
<programlisting>
<stage>
<staging_dir>/opt/backup/stage</staging_dir>
+</stage>
+ </programlisting>
+
+ <para>
+ This is an example stage configuration section that overrides the
+ default list of peers:
+ </para>
+
+ <programlisting>
+<stage>
+ <staging_dir>/opt/backup/stage</staging_dir>
<peer>
<name>machine1</name>
<type>local</type>
@@ -1387,6 +1637,12 @@
configured.
</para>
<para>
+ <emphasis>Remember</emphasis>, if you provide
+ <emphasis>any</emphasis> local or remote peer in staging
+ configuration, the global peer configuration is completely
+ replaced by the staging peer configuration.
+ </para>
+ <para>
The local peer subsection must contain the following fields:
</para>
@@ -1461,6 +1717,12 @@
configured.
</para>
<para>
+ <emphasis>Remember</emphasis>, if you provide
+ <emphasis>any</emphasis> local or remote peer in staging
+ configuration, the global peer configuration is completely
+ replaced by the staging peer configuration.
+ </para>
+ <para>
The remote peer subsection must contain the following fields:
</para>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
