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