satellite_backup.sh

#!/bin/bash
#set -xv
#####################################################################################
#
# Script Name:
#  satellite_backup.sh
#
# Purpose:
#       Performs a backup of Red Hat Satellite Server to a local or remote mounted
#       directory. This script is to be used in an environment where weekly full
#       and daily incremental backups are taken. Rentention is goverened by the 
#       RETENTION variable at the top of the script.
#
# Dependencies:
#       Red Hat Satellite 6.2 - katello-backup must be available.
#	Red Hat Satellite 6.3 - satellite-backup must be available
#	Red Hat Satellite 6.4 - foreman-maintain must be available
#	Packages mutt, gzip must be installed and the server must be able to send mail.
#
# Disclaimer:
#	This script is NOT SUPPORTED by Red Hat Global Support Service.
#
# Modification History:
#  v1.0 - 15/03/2018 - Initial Version - Talor Holloway (Red Hat Consulting)
#  v1.1 - 30/08/2018 - peterceeau
#	Use mutt for mail, find it easier to work with.
#  v1.2 - 12/12/2018 - peterceeau
# 	Satellite 6.4 deprecated both katello-backup and satellite-backup in favour
#	of foreman-maintain backup.
#	Add case statement for 6.4 BACKUP_UTILITY. Change order of command line
#	options, original command failed with "ERROR: too many arguments".
# 	New foreman-maintain command has a spinning progress counter which is
#	filling the logfile with lines and lines of output, add grep log before
#	attaching to email.
#  v1.3 - 13/12/2018 - peterceeau
#	Replace grep with sed to improve cleaning up the log before attaching
# 	to email. First sed removes the multiple lines generated by the spinning
#	progress counter. Second sed strips out the ANSI colour codes.
#
# Called by:
#  root crontab
#
#####################################################################################

RETENTION=31 # how long to keep backups for
ALERTS=someone@example.com
REPORTS=someone@example.com
TAG=$(date '+%Y%m%d-%H%M')
LOCKFILE=/tmp/.$(basename $0).lck
LOGDIR=/var/log/satellite_backup
LOG=${LOGDIR}/satellite_backup.log
SKIP_OPTIONS=""
SCRIPTNAME=${0##*/}
MSGS=true
ERRS=true
RV=0
MAIL=/usr/bin/mutt   # Added to enable simpler mail configuration

#####################################################################################
###################  Functions
#####################################################################################

msg()
{
        $MSGS && echo "$*....."
}

msg70()
{
# like msg but doesn't print a new line instead just stops at 70th column {
        $MSGS && printf "%-70s" "$*......"
}

err()
{
        $ERRS && echo "$*....." >&2
}

ok()
{
        $MSGS && echo ok
}

failed()
{
        $MSGS && echo failed
}

usage()
{
        MESSAGE=$*
        echo
        echo "$MESSAGE"
        echo
        echo "$0 -t [full|incremental] -d [</backup_directory>] [-s]"
        echo
        exit 1
}

generate_lock()
{
        if [ -f ${LOCKFILE} ]
        then
                Pid=$(cat $LOCKFILE)
                if ps -fp $Pid  > /dev/null 2>&1
                then
                        MSG="$SCRIPTNAME [ Pid: $Pid ] already running on ${SID} please investigate"
                        #cat $LOG | mail -s "$MSG" $ALERTS
			cat $LOG | ${MAIL} -s "$MSG" $ALERT
                        exit
                else
                        rm -rf $LOCKFILE
                        echo $$ > ${LOCKFILE}
                fi
        else
                echo $$ > ${LOCKFILE}
        fi
}

atexit()
# exit routine
{
	katello-service status >/dev/null
	rv=$?
	if [ $rv -ne 0 ]
	then
	        msg "Starting Satellite as it is not running - something must have gone wrong"
	        katello-service start
	fi

        if [ $RV -gt 0 ]
        then
                MSG="An error occurred whilst performing a ${TYPE} Satellite Backup on $(hostname -s)"
                #cat $LOG | mail -s "$MSG" $ALERTS
		sed -e 's#[^M]\ \ .*[^M]##g' $LOG | sed -r 's#\x1B\[([0-9]{1,2}(;[0-9]{1,2})?)?[m|K]##g' | ${MAIL} -s "$MSG" $ALERTS
        else
                MSG="An ${TYPE} Satellite backup on $(hostname -s) completed successfully"
                #cat $LOG |mail -s "$MSG" $REPORTS
		sed -e 's#[^M]\ \ .*[^M]##g' $LOG | sed -r 's#\x1B\[([0-9]{1,2}(;[0-9]{1,2})?)?[m|K]##g' | ${MAIL} -s "$MSG" $ALERTS
        fi

        # Make sure the lock file is removed
        if [ -f $LOCKFILE ]
        then
                rm -f $LOCKFILE
        fi

        # recycle log files
        if [ -f $LOG ]
        then
                cp -p $LOG $LOG.$TAG
                gzip -f $LOG.$TAG
        fi

        msg "The return value is $RV"
        msg Exiting

        exit $RV
}

run_satver_validation()
{
	SAT_VER=$(rpm -q satellite |awk -F - '{print $2}' |cut -c 1-3)
	case $SAT_VER in
	        6.1|6.2)
			BACKUP_UTILITY=katello-backup
	        ;;
	        6.3)
			BACKUP_UTILITY=satellite-backup
	        ;;
		6.4)
                        BACKUP_UTILITY="foreman-maintain backup offline"
                ;;
	        *)
	                usage "ERROR Unknown Satellite Version"
			RV=50
			exit
	        ;;
	esac
}

run_backupdir_validation()
{
	if [ -d $BACKUP_DIRECTORY ] && [ -w $BACKUP_DIRECTORY ]
	then
		msg70 Backup Directory $BACKUP_DIRECTORY is mounted and writeable
		ok
	else
		msg Backup Directory $BACKUP_DIRECTORY either does not exist or is not writable
		RV=10
		exit
	fi

	msg70 Checking Stale NFS Mounts
	read -t1 < <(stat -t "${BACKUP_DIRECTORY}")
        rv=$?
        if [ $rv -eq 0 ]
        then
                ok
        else
                failed
                err "Return value is $rv"
		RV=11
		exit
        fi

	case $TYPE in
	        FULL|Full|full)
			if [ $SKIP_OPTIONS = "" ]
			then
				msg70 Estimating Space Requirements vs Available Space
				EST_SIZE=$(( $(for directory in /var/lib/mongodb /var/lib/pulp /var/lib/pgsql; do du -ms $directory |awk '{print $1}'; done | tr "\n" "+" ) 0 ))
				BACKUP_DIR_FREE_SPACE=$(df -Pm ${BACKUP_DIRECTORY} |awk '{print $4}' |grep -v Available)
				if [ $EST_SIZE -gt $BACKUP_DIR_FREE_SPACE ]
				then
					failed
					echo "Estimated Backup size is $EST_SIZE megabytes."
					echo "Free space in $BACKUP_DIRECTORY is $BACKUP_DIR_FREE_SPACE megabytes"
					echo "Insufficent space to run a backup"
					RV=999
					exit
				else
					ok
				fi
			fi
		;;
	esac
	
	if [ ! -d ${BACKUP_DIRECTORY}/incr ]
	then
		mkdir -p ${BACKUP_DIRECTORY}/incr
	fi

	if [ ! -d ${BACKUP_DIRECTORY}/full ]
	then
		mkdir -p ${BACKUP_DIRECTORY}/full
	fi
}

run_full()
{
        echo "================================================================"
        echo "$TYPE backup of Satellite started at $(date)"
        echo "================================================================"

	#$BACKUP_UTILITY ${BACKUP_DIRECTORY}/full --assumeyes ${SKIP_OPTIONS}
	#peterceeau: order is important for new satellite 6.4 backup command
	$BACKUP_UTILITY --assumeyes ${BACKUP_DIRECTORY}/full
        rv=$?
        if [ $rv -eq 0 ]
        then
                ok
        else
                failed
                err "Return value is $rv"
		RV=12
		exit
        fi

        echo "================================================================"
        echo "$TYPE backup of Satellite ended at $(date)"
        echo "================================================================"
}

run_incremental()
{
        echo "================================================================"
        echo "$TYPE backup of Satellite started at $(date)"
        echo "================================================================"

	if [ $(find ${BACKUP_DIRECTORY}/full |egrep -c 'katello-backup|satellite-backup') -gt 0 ]
	then
                LASTFULL=$(find ${BACKUP_DIRECTORY}/full -type d |sort -rn |head -1)
                #$BACKUP_UTILITY ${BACKUP_DIRECTORY}/incr --incremental ${LASTFULL} --assumeyes ${SKIP_OPTIONS}
		#peterceeau: order is important for new satellite 6.4 backup command
                $BACKUP_UTILITY --incremental ${LASTFULL} --assumeyes ${BACKUP_DIRECTORY}/incr

	        rv=$?
 		if [ $rv -eq 0 ]
	 	then
	                ok
 	        else
 	                failed
 	                err "Return value is $rv"
 		        RV=13
			exit
  	        fi

                echo "================================================================"
                echo "$TYPE backup of Satellite ended at $(date)"
                echo "================================================================"
        else
		echo "No Full Backup Found"
		echo "Switching to Full backup"
		TYPE=Full
		run_full
	fi
}

run_expiration()
{

        echo "================================================================"
        echo "Satellite Backup Expiration started at $(date)"
        echo "================================================================"

	msg Removing Daily Incremental Backups - ${RETENTION} days
	for incr_dir in $(/usr/bin/find ${BACKUP_DIRECTORY}/incr -type d -mtime +${RETENTION} -name "*katello-backup*" -o -type d -mtime +${RETENTION} -name "*satellite-backup*")
	do
		msg70 Removing $incr_dir
		rm -rf $incr_dir
                rv=$?
                if [ $rv -eq 0 ]
                then
                        ok
                else
                        failed
                        err "Return value is $rv"
			RV=14
			exit
                fi
	done

	msg Removing Weekly Full Backups - ${RETENTION} days plus 7 to cater for a weeks worth of incrementals tied to the full
	for full_dir in $(/usr/bin/find ${BACKUP_DIRECTORY}/full -type d -mtime +$(( $RETENTION + 7)) -name "*katello-backup*" -o -type d -mtime +$(( $RETENTION + 7)) -name "*satellite-backup*")
	do
		msg70 Removing $full_dir
		rm -rf $full_dir
                rv=$?
                if [ $rv -eq 0 ]
                then
                        ok
                else
                        failed
                        err "Return value is $rv"
			RV=15
			exit
                fi
	done

        echo "================================================================"
        echo "Satellite Backup Expiration ended at $(date)"
        echo "================================================================"
}

#####################################################################################
###################  Main (Main MAIN Main)
#####################################################################################

# Process options have been passed to the script
while getopts ":t:d:s" opt
do
        case $opt in
                t)      TYPE=${OPTARG} ;;
                d)      BACKUP_DIRECTORY=${OPTARG} ;;
		s)	SKIP_OPTIONS="--skip-pulp-content" ;;
                *)      usage "ERROR: Unknown Option"; exit ;;
        esac
done

[ -z "$TYPE" ] && usage "ERROR: Specify the backup type"
[ -z "$BACKUP_DIRECTORY" ] && usage "ERROR: Specify the backup directory"

# Check we are running as root
if [ $(whoami) != root ]
then
        echo "This script must run as the root user"
        RV=2
        exit
fi

# Make sure /sbin is in our $PATH
export PATH=$PATH:/sbin

# Generate the lock file
generate_lock

# make sure log directory exists
if [ ! -d $LOGDIR ]
then
	mkdir -p $LOGDIR
fi

# redirect stdout and stderr to the log file
exec >$LOG 2>&1

# Call function at the end if the script exists cleanly.
trap atexit 0

msg "Validating the Satellite Version"
run_satver_validation

msg "Validating the Backup directory"
run_backupdir_validation

case $TYPE in
        FULL|Full|full)
                msg "Running a Full Satellite Backup"
                run_full
        ;;
        INCREMENTAL|Incremental|incremental|INC|Inc|inc|INCR|Incr|incr)
                msg "Running an Incremental Satellite Backup"
                run_incremental
        ;;
        *)
                usage "ERROR Unknown Backup Type"
		RV=666
		exit
        ;;
esac

msg "Kicking off Expiration of old backups"
run_expiration

# If script ends with RV=0 then atexit() is called due to trap.