回顧 backupninja
backupninja的一個(gè)獨(dú)特的地方是它可以完全拋棄/etc/backup.d中的純文本配置文件和操作文件,軟件自己會(huì)搞定。另外,我們可以編寫自定義腳本(又叫 “handler”)放在/usr/share/backupninja 目錄下來完成不同類型的備份操作。此外,可以通過ninjahelper的基于ncurses的交互式菜單(又叫“helper”)來指導(dǎo)我們創(chuàng)建一些配置文件,使得人工錯(cuò)誤降到最低。
創(chuàng)建定制的Handler與Helper
這一節(jié)的目標(biāo)是創(chuàng)建一個(gè)腳本,將home目錄以gzip或bzip2壓縮包的形式備份起來,不包括音樂與視頻文件。我們將這個(gè)文件命名為home,將它放在/usr/backup/ninja目錄下。
盡管你可以使用默認(rèn)的tar handler(參考 /usr/share/backupninja/tar 與 /usr/share/backupninja/tar.helper)來達(dá)到這個(gè)效果,但是我們使用這種方法來展示如何創(chuàng)建實(shí)用的 handler 腳本與基于 ncurses 的 helper。你可以根據(jù)你的需求來決定如何運(yùn)用這里的方法。
由于 handlers 來源于主腳本,所以無需以#!/bin/bash開始的釋伴行(shebang line)。
我們編寫的 handler (/usr/share/backupninja/home)如下所示。已經(jīng)詳細(xì)注釋了。getconf 函數(shù)用來讀取備份操作的配置文件。如果你指定了一個(gè)變量的值,那么它會(huì)覆蓋配置文件中對(duì)應(yīng)變量的值:
#/home 目錄 handler 腳本
# 每個(gè)備份文件會(huì)通過 FQDN 來鑒別主機(jī)
getconf backupname
# 備份文件的保存目錄
getconf backupdir
# 默認(rèn)壓縮
getconf compress
# 包含 /home 目錄
getconf includes
#不包含 *.mp3 與 *.mp4 文件
getconf excludes
# 要打包備份文件的默認(rèn)擴(kuò)展名
getconf EXTENSION
# tar 程序的絕對(duì)路徑
getconf TAR `which tar`
# date 程序的絕對(duì)路徑
getconf DATE `which date`
# 日期格式
DATEFORMAT="%Y-%m-%d"
# 如果備份目錄不存在,以致命錯(cuò)誤退出
if [ ! -d "$backupdir" ]
then
mkdir -p "$backupdir" || fatal "Can not make directory $backupdir"
fi
# 如果備份目錄不可寫,同樣以致命錯(cuò)誤退出
if [ ! -w "$backupdir" ]
then
fatal "Directory $backupdir is not writable"
fi
# 根據(jù)壓縮格式選擇對(duì)應(yīng)的tar選項(xiàng)
case $compress in
"gzip")
compress_option="-z"
EXTENSION="tar.gz"
;;
"bzip")
compress_option="-j"
EXTENSION="tar.bz2"
;;
"none")
compress_option=""
;;
*)
warning "Unknown compress filter ($tar_compress)"
compress_option=""
EXTENSION="tar.gz"
;;
esac
# 不包含一些文件類型/目錄
exclude_options=""
for i in $excludes
do
exclude_options="$exclude_options --exclude $i"
done
# 調(diào)試信息,執(zhí)行備份操作
debug "Running backup: " $TAR -c -p -v $compress_option $exclude_options \
-f "$backupdir/$backupname-"`$DATE "+$DATEFORMAT"`".$EXTENSION" \
$includes
# 將標(biāo)準(zhǔn)輸出重定向到以.list為擴(kuò)展的文件
# 將標(biāo)準(zhǔn)錯(cuò)誤輸出重定向到以.err為擴(kuò)展的文件
$TAR -c -p -v $compress_option $exclude_options \
-f "$backupdir/$backupname-"`$DATE "+$DATEFORMAT"`".$EXTENSION" \
$includes \
> "$backupdir/$backupname-"`$DATE "+$DATEFORMAT"`.list \
2> "$backupdir/$backupname-"`$DATE "+$DATEFORMAT"`.err
[ $? -ne 0 ] fatal "Tar backup failed"
接下來我們將要?jiǎng)?chuàng)建helper文件(/usr/share/backupninja/home.helper)。這樣,hendlers將會(huì)以菜單的形式在ninjahelper中顯示:
# 備份操作描述,以下劃線分割單詞
HELPERS="$HELPERS home:backup_of_home_directories"
home_wizard() {
home_title="Home action wizard"
backupname=`hostname --fqdn`
# 指定備份操作的時(shí)間
inputBox "$home_title" "When to run this action?" "everyday at 01"
[ $? = 1 ] return
home_when_run="when = $REPLY"
# 指定備份文件名
inputBox "$home_title" "\"Name\" of backups" "$backupname"
[ $? = 1 ] return
home_backupname="backupname = $REPLY"
backupname="$REPLY"
# 指定保存?zhèn)浞菸募哪J(rèn)路徑
inputBox "$home_title" "Directory where to store the backups" "/var/backups/home"
[ $? = 1 ] return
home_backupdir="backupdir = $REPLY"
# 指定復(fù)選框的默認(rèn)值
radioBox "$home_title" "Compression" \
"none" "No compression" off \
"gzip" "Compress with gzip" on \
"bzip" "Compress with bzip" off
[ $? = 1 ] return;
result="$REPLY"
home_compress="compress = $REPLY "
REPLY=
while [ -z "$REPLY" ]; do
formBegin "$home_title: Includes"
formItem "Include:" /home/gacanepa
formDisplay
[ $? = 0 ] || return 1
home_includes="includes = "
for i in $REPLY; do
[ -n "$i" ] home_includes="$home_includes $i"
done
done
REPLY=
while [ -z "$REPLY" ]; do
formBegin "$home_title: Excludes"
formItem "Exclude:" *.mp3
formItem "Exclude:" *.mp4
# 按需增加多個(gè)“Exclude”文本框指定其他不須包含的內(nèi)容
formItem "Exclude:"
formItem "Exclude:"
formDisplay
[ $? = 0 ] || return 1
home_excludes="excludes = "
for i in $REPLY; do
[ -n "$i" ] home_excludes="$home_excludes $i"
done
done
# 保存配置
get_next_filename $configdirectory/10.home
cat > $next_filename EOF
$home_when_run
$home_backupname
$home_backupdir
$home_compress
$home_includes
$home_excludes
# tar 程序的路徑,必須為GNU tar
TAR `which tar`
DATE `which date`
DATEFORMAT "%Y-%m-%d"
EXTENSION tar
EOF
# 將配置文件的權(quán)限改為600
chmod 600 $next_filename
}
運(yùn)行 ninjahelper
當(dāng)創(chuàng)建了名為home的handler腳本以及對(duì)應(yīng)的home.helper后,運(yùn)行ninjahelper命令創(chuàng)建一個(gè)新的備份操作。
#ninjahelper
選擇 create a new backup action(創(chuàng)建一個(gè)新的備份操作)。
![](/d/20211018/5e4ac18615db893c55f4a2203d26574c.gif)
接下來將看到可選的操作類型,這里選擇“backup of home directories"(備份home目錄):
![](/d/20211018/3af80fe845ef2d72bb60915cb3bec680.gif)
然后會(huì)顯示在helper中設(shè)置的默認(rèn)值(這里只顯示了3個(gè))。可以編輯文本框中的值。注意,關(guān)于“when”變量的語法,參考文檔的日程安排章節(jié)。
![](/d/20211018/8aed9ec2a20da8ea9823d8795e18759c.gif)
當(dāng)完成備份操作的創(chuàng)建后,它會(huì)顯示在ninjahelper的初始化菜單中:
![](/d/20211018/f6d3ab30ad5e856eee8f85cde14cd93b.gif)
按回車鍵顯示這個(gè)備份操作的選項(xiàng)。因?yàn)樗浅:?jiǎn)單,所以我們可以隨便對(duì)它進(jìn)行一些實(shí)驗(yàn)。
注意,“run this action now"(立即運(yùn)行)選項(xiàng)會(huì)不顧日程表安排的時(shí)間而立即進(jìn)行備份操作:
![](/d/20211018/e5b5cc665a4d47dc16a70552558b9ac9.gif)
備份操作會(huì)發(fā)生一些錯(cuò)誤,debug會(huì)提供一些有用的信息以幫助你定位錯(cuò)誤并糾正。例如,當(dāng)備份操作有錯(cuò)誤并且沒有被糾正,那么當(dāng)它運(yùn)行時(shí)將會(huì)打印出如下所示的錯(cuò)誤信息。
![](/d/20211018/9b146ce3c462f2052662fe7c39b03d23.gif)
上面的圖片告訴我們,用于完成備份操作的連接沒有建立,因?yàn)樗枰溄拥倪h(yuǎn)程主機(jī)似乎宕機(jī)了。另外,在helper文件中指定的目標(biāo)目錄不存在。當(dāng)糾正這些問題后,重新開始備份操作。
需要牢記的事情:
當(dāng)你在/usr/share/backupninja 下新建了一個(gè)自定義腳本(如foobar)來處理特殊的備份操作時(shí),那么你還需要編寫與之對(duì)應(yīng)的helper(foobar.helper)文件,ninjahelper 將通過它生成名為10.foobar(下一個(gè)操作為11,以此類推)的文件,保存在/etc/backup.d目錄下,而這個(gè)文件才是備份操作的真正的配置文件。
可以通過ninjahelper設(shè)定好備份操作的執(zhí)行時(shí)間,或按照“when”變量中設(shè)置的頻率來執(zhí)行。