git.sesse.net Git - backup.sh/blob - backup.sh

   1 #!/bin/sh
   2 # backup.sh
   3 #
   4 # Backup up Unix-like computers
   5 #
   6 # itk@samfundet.no
   7 #
   8 # This script was first checked into RCS in 2000, and has since backed up a few
   9 # servers almost every day, whenever not broken.
  10 #
  11 # It's a bit peculiar, but quite effective. The following is worth keeping in
  12 # mind when hacking:
  13 #
  14 # KISS. And by that I mean really simple. Only regular Unix commands, please
  15 # (but GNU extensions are used).
  16 #
  17 # Because of the way we run this script from cron, informational logging goes
  18 # to stderr and warnings and errors to stdout. This way, we get mail whenever
  19 # stuff fails, and other output is redirected to the log file.
  20 #
  21 # The computers are backed up in parallell (but the filesystems on each
  22 # computer in serial). This is implemented highly simplistic, with forking
  23 # subshells. The script has no concept about threads, and stuff might go wrong,
  24 # which usually requires manual cleanups.
  25 #
  26 # The script is halfway Norwegian and halfway English. Newer modifications are
  27 # in English, we should probably stick to that.
  28 #
  29 # Known issues:
  30 #
  31 # o $R has no proper meaning because of the forking subshell stuff. We need a
  32 #   more robust way of returning non-zero on errors, which we probably don't
  33 #   right now.
  34 # o The code around line 211 and downwards is messy.
  35 #
  36
  37 # Configuration
  38 LOCKFILE=/home/backup/backuprun.lockfile
  39 confdir=/home/backup/conf/           # Configuration files
  40 storagedir=/backup                   # Where we keep backups
  41 maksantallfulle=3                    # Number of full backups
  42 dagermellomfulle=30                  # Days between full backups
  43 DATE=`date "+%Y%m%d%H%M"`            #format: touch
  44 DATEs=`date "+%Y-%m-%d %H:%M"`       #format: tar
  45
  46 # Exclude-pattern
  47 exclude=$confdir/exclude
  48 [ ! -f $exclude ] && printf "tmp\ncore\n" > $exclude
  49
  50 # Initially, we consider everything to be just fine.
  51 R=0
  52
  53 # Die more or less gracefully (at least notify user)
  54 die() {
  55         echo `date`": Something nasty happened, and since I fork a lot:"
  56         echo `date`": I CANNOT CLEAN UP THE MESS MYSELF."
  57         echo `date`": You need to get rid of lost process named stuff like $0, tar and ssh."
  58         exit 255
  59 }
  60
  61 # Trap C-c and kill
  62 trap die SIGINT SIGTERM
  63
  64 # Don't start if we're already running
  65 if [ -e $LOCKFILE ]; then
  66         echo `date`": $LOCKFILE exists for pid `cat $LOCKFILE`, exiting."
  67         echo `date`": $LOCKFILE exists for pid `cat $LOCKFILE`, exiting." >&2
  68         exit 1
  69 fi;
  70 touch $LOCKFILE
  71 echo $$ > $LOCKFILE
  72
  73 #syntax of remotestat:
  74 #hostname:/directory/
  75 remotestatf=$confdir/remotestat
  76 [ -f $remotestatf ] && remotestat=`cat $remotestatf`
  77 ###
  78
  79 PATH=/local/bin:$PATH:/store/bin
  80 export PATH
  81
  82 echo `date`": Backup run starting" >&2
  83
  84 umask 027
  85
  86 # The computers we want to back up
  87 unixcomputers=`cat $confdir/computers.unix \
  88   | grep -v "^#" \
  89   | grep -v "^$" `
  90
  91 # Backup only one computer, from command line?
  92 if [ $1 ] ; then
  93   unixcomputers=$1
  94 fi;
  95
  96
  97 #selve backupen
  98 # krever at noen variabler er satt
  99 # krever at vi er i rett katalog
 100 backup()
 101 {
 102
 103  echo -n `date` >&2
 104  printf " $computer: $computer:$filesystem $backuplevel backup" >&2
 105
 106  if [ "$backuplevel" = "daglig" ] || [ "$backuplevel" = "incremental" ]
 107  then
 108   lastd=`cat ../.date`
 109   lastcmd="--newer='$lastd'"
 110  else
 111   lastcmd=""
 112  fi
 113
 114  #if this client has a special tar
 115  #we need to find a better solution to this conf-issue
 116  if [ -f $confdir/tar.$computer ] ; then
 117    tar=`cat $confdir/tar.$computer`
 118  else
 119    tar=tar
 120  fi
 121
 122  # expand the exclude-path for use with tar
 123  exf=`ssh root@$computer "ls ~/.backup/exclude"`
 124
 125  # We try to run tar on the remote computer
 126  #    z gzip it
 127  #    c create archive
 128  #    C change to directory first
 129  #    . where to start taring (see C)
 130  #    $lastcmd only files newer than this
 131  #    --one-file-system don't traverse file systems
 132  #    --exclude-from file to get exclusion pattern from
 133  #    Pipe the stuff over ssh to ourselves, run pee to cat the contents to a
 134  #    file and build a file list, respectivly.
 135  TARFILE=$DATE.tmp
 136  TARCMD="ssh root@$computer \"$tar --one-file-system -zcf - -C $filesystem . $lastcmd \
 137         --exclude-from=$exf\" | pee \"cat > $TARFILE\" \"tar tzvf -\""
 138  echo `date`" $computer: Running $TARCMD" >&2
 139  eval $TARCMD > $DATE.idx
 140
 141  if [ -s $TARFILE ]; then
 142   # File is >0 in size, we assume it worked.
 143
 144   # Move tar file in place
 145   mv $TARFILE $DATE.tgz
 146
 147   # Update timestamp
 148   echo $DATEs > ../.date && touch -t $DATE ../.date
 149
 150   # Make a sorted filelist as well
 151   sort -k6 < $DATE.idx > $DATE.sdx
 152
 153   # Fix permissions
 154   chmod 600 *tgz                      #only for us
 155   chmod 644 *sdx *idx 2>/dev/null     #everyone can read
 156
 157  else
 158   # Something wrong happened.
 159   rm $TARFILE
 160   echo `date`" $computer: $TARFILE empty. $backuplevel backup of $computer:$filesystem failed and deleted"
 161
 162   # We don't want to return 0
 163   R=1
 164  fi
 165
 166 }
 167
 168 for computer in $unixcomputers
 169 do
 170 (
 171  # Check that the target filesystem is mounted (actually check that it's not
 172  # the root filesystem)
 173  rootfilesystem=`df -P /`
 174  targetfilesystem=`df -P "$storagedir/$computer"`
 175  if [ "$rootfilesystem" == "$targetfilesystem" ]; then
 176         echo `date`" $computer: Target filesystem ($storagedir/$computer) was mounted on /. Aborting"
 177         continue
 178  fi
 179
 180  echo `date`" $computer: Backing up $computer" >&2
 181
 182  # Try to SSH to the computer without entering a password.
 183  if ! `ssh -n -o NumberOfPasswordPrompts=0 root@$computer /bin/true`; then
 184   echo `date`" $computer: Could not use passwordless SSH."
 185
 186   # We don't want to return 0
 187   R=1
 188   # Do next computer
 189   continue;
 190  fi
 191
 192  filesystems=""
 193
 194  # Check dump bit in fstab
 195  filesystems=`ssh -n root@$computer "cat /etc/fstab" \
 196   | grep -v nfs \
 197   | grep -v "^#" \
 198   | grep -v "^$" \
 199   | awk '{ if ( $(NF-1) != "0" ) print $2}' `
 200
 201  # Clean up our dir at this client
 202  if ! ssh root@$computer "rm -r ~/.backup ; mkdir -m 700 ~/.backup"; then
 203   echo `date`" $computer: Could not create backup staging area at $computer:~/.backup - skipping backup of $computer"
 204   R=1
 205   continue;
 206  fi
 207
 208  # Try to copy $exclude to $computer
 209  if ! scp $exclude root@$computer:~/.backup/exclude > /dev/null; then
 210   echo `date`" $computer: Could not copy exclude.txt to $computer - skipping backup of $computer"
 211   R=1
 212   continue;
 213  fi
 214
 215  # Try to copy preeexec and postexec if they exist
 216 # TODO: Gah, clean this mess!
 217  [ -f $confdir/preexec.$computer ] && (
 218     scp $confdir/preexec.$computer  root@$computer:~/.backup/preexec >&2 ||
 219      ( echo `date`" $computer: Could not copy preexec.$computer to $computer:~/.backup/preexec - skipping backup of $computer"
 220        R=1
 221        continue
 222      )
 223     )
 224  [ -f $confdir/postexec.$computer ] && (
 225     scp $confdir/postexec.$computer root@$computer:~/.backup/postexec >&2 ||
 226      ( echo `date`" $computer: Could not copy postexec.$computer to $computer:~/.backup/postexec - skipping backup of $computer"
 227        R=1
 228        continue
 229      )
 230     )
 231
 232  # Try to run preexec if it exist
 233  if ! ssh root@$computer "[ ! -f ~/.backup/preexec ] || /bin/bash -x ~/.backup/preexec" >&2; then
 234         echo `date`" $computer: Could not run $computer:~/.backup/preexec - skipping backup of $computer"
 235         R=1
 236         continue
 237  fi
 238
 239
 240  for filesystem in $filesystems
 241  do
 242   # Remove / and $ (for Windows) for path names
 243   sfilesystem=`echo $filesystem | tr '\/\$' '__'`
 244
 245   # Prepare storage area
 246   mkdir -m 755 -p $storagedir/$computer/$sfilesystem/{full,daglig} 2>/dev/null
 247   echo $filesystem > ${storagedir}/${computer}/.${sfilesystem}.name
 248   chmod 644 ${storagedir}/${computer}/.${sfilesystem}.name
 249
 250   # Default backuplevel
 251   backuplevel=daglig
 252
 253   if [ ! -f $storagedir/$computer/$sfilesystem/.date ]
 254   then
 255    # Take the first full backup of this filesystem on this computer
 256    backuplevel=full
 257    echo $DATEs > $storagedir/$computer/$sfilesystem/.date
 258   fi
 259
 260   # Check if we want a full backup
 261   if [ -z "`find $storagedir/$computer/$sfilesystem/full/ -name \*tgz -mtime -$dagermellomfulle`" ]; then
 262    backuplevel=full
 263   fi
 264
 265   # We want to be here
 266   cd $storagedir/$computer/$sfilesystem/$backuplevel || die
 267
 268   # Perform the actual backup
 269   backup
 270
 271   # Check if this box has a custom number of full backups
 272   if [ -f $confdir/maksfulle.$computer ] ; then
 273     mf=$((`cat $confdir/maksfulle.$computer`+1))
 274   else
 275     mf=$(($maksantallfulle+1))
 276   fi
 277
 278   # Delete old full backups
 279   for full in `ls -1t $storagedir/$computer/$sfilesystem/full/*tgz | tail -n +$mf`
 280   do
 281    prefix=`echo $full | sed "s/\.[^.]*$//"`
 282    echo `date`": $computer:$filesystem Deleting full backup $prefix" >&2
 283    rm $prefix*
 284   done
 285
 286   # Delete incremental backups older than the oldest full backup
 287   oldf=`ls -t1 $storagedir/$computer/$sfilesystem/full/*tgz | tail -1`
 288   find \
 289      $storagedir/$computer/$sfilesystem/daglig \
 290      -type f \
 291      \! -newer $oldf \
 292      -printf "`date`: $computer: Deleting old incremental backup: %p\n" \
 293      -exec rm {} \; >&2
 294  done
 295
 296  # Try to run postexec if it exist
 297  if ! ssh root@$computer "[ ! -f ~/.backup/postexec ] || /bin/bash -x ~/.backup/postexec" >&2; then
 298         echo `date`" $computer: Could not run $computer:~/.backup/postexec"
 299         R=1
 300  fi
 301
 302 ) &
 303 done
 304
 305 wait
 306
 307 # Remove lockfile
 308 rm $LOCKFILE
 309
 310 # Did anything go wrong?
 311 # (IMPORTANT NOTE: The R-business does not work as expected, since this script
 312 # forks itself).
 313 if [ $R != 0 ]; then
 314         echo `date`": Backup run ended with errors, check logs."
 315         exit 1
 316 else
 317         echo `date`": Backup run ended" >&2
 318 fi