backup/iwjbackup.txt

   1 iwjbackup.txt
   2 documentation file
   3 Copyright - AND NO WARRANTY - see notes at bottom of file for details.
   4
   5 This is a quick summary of the backup scripts, and some comments on
   6 some of the config files: it's a bit patchy and might have the odd
   7 ommission. The canonical source is the sources, as always :->
   8
   9
  10 To run, the contents of /etc/chiark-backup should be:
  11
  12 warnings.*: files defining how many warnings you get as the system is
  13 brought down to do backups. The defaults are fine.
  14
  15 settings.pl: generic config file: in particular, the name of the tape
  16 device is set here.
  17
  18 tape.*: conventionally, each tape you're going to use in the backup
  19 cycle has a tape number, a name and a config file.  The tape numbers
  20 in use at Relativity are digit strings like `512'.  The name is a
  21 combination of rotation set and volume number; rotation sets are
  22 typically a single letter (`s', `t', `u', `v') at Relativity and
  23 volumes a single digit (`0', `1', `2') at Relativity.  You need at
  24 least two tapes as the system won't write a backup on the same tape it
  25 wrote the last one to.
  26
  27 There are also conventionally incremental tapes whose names are a
  28 fixed letter (`k' in the current scheme) followed by a rotation
  29 letter.  At Relativity we have two of these, `ks' and `kt'.
  30
  31 Syntax of the tape.* files for full dump tapes:
  32   filesystems X
  33   next N
  34   end
  35
  36 where N is the name of the next tape in the *full dump* sequence
  37 (which should be circular; eg
  38 v0->v1->v2->s0->s1->s1->t0->t1->t2->u0->u1->u2->v0->...
  39 and X is a filesystem group name (typically the same as the volume
  40 number).
  41
  42 Each defined filesystem group has a name and a config file
  43 fsys.<name>.  These files define what is backed up and how.  The
  44 filesystem `all' must also exist; it's used for incremental backups
  45 (and it must exist even if you don't do incrementals).
  46
  47 In the fsys.* files:
  48   Empty lines and lines starting '#' are comments and ignored.
  49   Lines starting `excludedir' given regexps of things to exclude
  50    (temp dirs, Netscape's cache, etc).
  51   Lines starting `include' say to include another file when reading
  52    this one.
  53   Lines starting `prefix' give a command prefix necessary to
  54    run things on a remote machine:
  55      prefix <prefix-name> <command-part>
  56   Other lines should be of the form
  57     <directory name>   <backup-type>
  58   for local backups, or
  59     <directory name>   <backup-type>   <prefix-name>
  60   for remote backups.
  61 The file (including any included files) must end with the word 'end'
  62 on a line of its own.
  63
  64 Valid values for <backup-type> are `cpio' (uses cpio to produce
  65 tar-format backups), `dump' (uses dump to dump entire filesystems;
  66 <directory name> should be a mount-point for this), and `zafio' (uses
  67 afio to compress each file as it is backed up).  Only `dump' type
  68 backups perform incremental backups.
  69
  70 expected-diffs is a config file to indicate which
  71 filesystems should *not* be backed up. The scripts do a config
  72 check which involves checking that:
  73  * all filesystems to be backed up are present
  74  * all filesystems that are present are backed up
  75 expected-diffs allows you to make exceptions to this; backing
  76 up your CDROM drive is a bit pointless, frex.
  77 The format here is:
  78 <prefixchar><mountpoint>
  79
  80 where <prefixchar> is ?, ! or nothing, and
  81 <mountpoint> is <prefix>:<mountpoint> for a remote fs or
  82 <mountpoint> for a local one
  83 (examples: "mnementh:/cdrom", "/cdrom").
  84 If <prefixchar> is nothing, the scripts will complain if the fs
  85 is mounted. If it is !, they will complain if it is not mounted.
  86 If ? they won't complain either way (useful for devices that are
  87 not always mounted, like /cdrom).
  88
  89
  90 You may also create `bringup-hook', a script (or program) which will
  91 be run by `bringup' at the end.
  92
  93
  94 Useful scripts (all in /usr/bin):
  95
  96 backup-checkallused: this only does a check of the configuration
  97 files.  It should give a cryptic summary of the configuration and
  98 print 'configuration ok'. If not, fix your config files :->
  99
 100 backup-loaded: this tells the scripts that a currently unlabelled tape
 101 should be treated as tape X: eg:
 102     backup-loaded b3
 103 will cause it to treat it as tape `b3'.  NB: this won't override the
 104 TAPEID label written on the tape; it's just for use with previously
 105 unused tapes.  This applies only to the next time the backup scripts
 106 are invoked.  You can say just
 107     backup-loaded
 108 to go back to the default behaviour, which is to fail if the tape has
 109 no TAPEID.
 110
 111 backup-driver: this is the script to actually run to do a backup.  If
 112 run from the command line, give it the argument 'test' - otherwise it
 113 will attempt to run bringup to change runlevel, on the assumption that
 114 it was run from inittab (see below).  The status report email will be
 115 sent to whatever the unqualified local-part `dump-reports' points to.
 116
 117 backup-takedown: This is for running a reduced level of system
 118 services during backups.  Usage: takedown <freq> where <freq> can be
 119 `now', `soon' or nothing depending on number of warning messages
 120 desired - these correspond to warnings.* files.
 121
 122 To use this you'll need to configure init:
 123  * set up runlevel 5 to provide the level of services you want
 124    (by tweaking the symlinks in /etc/rc5.d or equivalent)
 125  * Add the following to /etc/inittab (tweak paths and VC number
 126    if desired):
 127
 128   # Runlevel 5 is set up to run a reduced level of services during
 129   # backups. (currently this means: no squid, no webserver, no newsserver)
 130   # We also run the backup script automatically on entering runlevel 5:
 131   dm:5:once:backup-driver </dev/tty8 >/dev/tty8 2>&1
 132
 133  * takedown can be run from the command line or via cron.
 134
 135 backup-whatsthis: a simple script to display the TAPEID of the current
 136 tape and optionally list its contents.  This script is a bit of a hack
 137 and may not be fully reliable:
 138
 139  Usage:
 140  whatsthis [--list [n]]
 141
 142 WARNING: it's currently hardwired to assume `cpio' type backups
 143 when listing; it could be trivially hardwired to assume `zafio'
 144 or with slightly more effort it could be done properly :->.
 145
 146
 147 COPYRIGHT and LACK OF WARRANTY information
 148
 149 This file is part of chiark backup, a system for backing up GNU/Linux and
 150 other UN*X-compatible machines, as used on chiark.greenend.org.uk.
 151
 152 chiark backup is:
 153  Copyright (C) 1997-1998,2000-2001 Ian Jackson <ian@chiark.greenend.org.uk>
 154  Copyright (C) 1999 Peter Maydell <pmaydell@chiark.greenend.org.uk>
 155
 156 This is free software; you can redistribute it and/or modify it under the
 157 terms of the GNU General Public License as published by the Free Software
 158 Foundation; either version 2, or (at your option) any later version.
 159
 160 This is distributed in the hope that it will be useful, but WITHOUT ANY
 161 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 162 FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 163 details.
 164
 165 You should have received a copy of the GNU General Public License along
 166 with this program; if not, write to the Free Software Foundation, Inc.,
 167 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.