Changeset 0ca27bd34eb64aac08058f459315eeaa5ec227b7

Show
Ignore:
Timestamp:
02/28/07 18:38:25 (11 years ago)
Author:
Eric Sproul <esproul@omniti.com>
git-committer:
Eric Sproul <esproul@omniti.com> 1172687905 +0000
git-parent:

[cb34270e0e1f3d870bd65f6fe1cc7f193c774ee7]

git-author:
Eric Sproul <esproul@omniti.com> 1172687905 +0000
Message:

Config file documentation. Refs #2

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • zetaback

    rcb34270 r0ca27bd  
    197197  exit 0; 
    198198} 
     199 
     200=pod 
     201 
     202=head1 CONFIGURATION 
     203 
     204The zetaback configuration file consists of a default stanza, containing 
     205settings that can be overridden on a per-host basis.  A stanza begins 
     206either with the string 'default', or a fully-qualified hostname, with  
     207settings enclosed in braces ({}).  Single-line comments begin with a hash 
     208('#'), and whitespace is ignored, so feel free to indent for better 
     209readability.  Every host to be backed up must have a host stanza in the 
     210configuration file. 
     211 
     212=head2 Settings 
     213 
     214The following settings are valid in both the default and host scopes: 
     215 
     216=over 
     217 
     218=item store 
     219 
     220The base directory under which to keep backups.  An interpolated variable 
     221'%h' can be used, which expands to the hostname.  There is no default for 
     222this setting. 
     223 
     224=item agent 
     225 
     226The location of the zetaback_agent binary on the host.  There is no default 
     227for this setting. 
     228 
     229=item time_format 
     230 
     231All timestamps within zetaback are in Unix timestamp format.  This setting 
     232provides a string for formatting all timestamps on output.  The sequences 
     233available are identical to those in strftime(3).  If not specified, the 
     234default is '%Y-%m-%d %H:%M:%S'. 
     235 
     236=item backup_interval 
     237 
     238The frequency (in seconds) at which to perform incremental backups.  An  
     239incremental backup will be performed if the current time is more than  
     240backup_interval since the last incremental backup.  If there is no full backup 
     241for a particular filesystem, then a full backup is performed.  There is no  
     242default for this setting. 
     243 
     244=item full_interval 
     245 
     246The frequency (in seconds) at which to perform full backups.  A full backup will 
     247be performed if the current time is more than full_interval since the last full  
     248backup. 
     249 
     250=item retention 
     251 
     252The retention time (in seconds) for backups.  Defaults to (14 * 86400), or two 
     253weeks. 
     254 
     255=back 
     256 
     257=head1 CONFIGURATION EXAMPLES 
     258 
     259=head2 Uniform hosts 
     260 
     261This config results in backups stored in /var/spool/zfs_backups, with a 
     262subdirectory for each host.  Incremental backups will be performed 
     263approximately once per day, assuming zetaback is run hourly.  Full backups 
     264will be done once per week.  Time format and retention are default. 
     265 
     266  default { 
     267    store = /var/spool/zfs_backups/%h 
     268    agent = /usr/local/bin/zetaback_agent 
     269    backup_interval = 83000 
     270    full_interval = 604800 
     271  } 
     272 
     273  host1 {} 
     274 
     275  host2 {} 
     276 
     277=head2 Non-uniform hosts 
     278 
     279Here, host1's and host2's agents are found in different places, and host2's 
     280backups should be stored in a different path. 
     281 
     282  default { 
     283    store = /var/spool/zfs_backups/%h 
     284    agent = /usr/local/bin/zetaback_agent 
     285    backup_interval = 83000 
     286    full_interval = 604800 
     287  } 
     288 
     289  host1 { 
     290    agent = /opt/local/bin/zetaback_agent 
     291  } 
     292 
     293  host2 { 
     294    store = /var/spool/alt_backups/%h 
     295    agent = /www/bin/zetaback_agent 
     296  } 
     297 
     298=cut 
    199299 
    200300sub parse_config() { 
     
    709809=head1 SEE ALSO 
    710810 
    711 zetaback.conf(5), zetaback_agent(1), zetback_agent.conf(5
     811zetaback_agent(1
    712812 
    713813=cut