2 # Copyright (C) 2016 Ian Kelling
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
17 # todo: if we cancel in the middle of a btrfs send, then run again immediately, the received subvolume doesn't get a Received UUID: field, and we won't mount it. Need to figure out a solution that will fix this.
20 local -i argc_index
=0 frame i start
=${1:-0} max_indent
=8 indent
23 if [[ $
(shopt -p extdebug
) == *-s* ]]; then
26 for ((frame
=0; frame
< ${#FUNCNAME[@]}-1; frame
++)); do
27 argc
=${BASH_ARGC[frame]}
29 ((frame
< start
)) && continue
30 if (( ${#BASH_SOURCE[@]} > 1 )); then
31 source="${BASH_SOURCE[frame+1]}:${BASH_LINENO[frame]}:"
33 indent
=$
((frame-start
+ 1))
34 indent
=$
((indent
< max_indent ? indent
: max_indent
))
35 printf "%${indent}s↳%sin \`%s" '' "$source" "${FUNCNAME[frame]}"
37 for ((i
=argc_index-1
; i
>= argc_index-argc
; i--
)); do
38 printf " %s" "${BASH_ARGV[i]}"
46 set -E; shopt -s extdebug
51 echo "${BASH_SOURCE[1]}:${BASH_LINENO[0]}: \`$BASH_COMMAND' returned $err"
53 set -e # err trap does not work within an error trap
54 "${_errcatch_cleanup[@]:-:}" # note :-: is to be compatible with set -u
55 echo "$0: exiting with code $err"
64 [[ $EUID == 0 ]] ||
exec sudo
-E "$BASH_SOURCE" "$@"
70 usually -t TARGET_HOST or -s SOURCE_HOST
72 Note, at source location, intentionally not executable, run and read
76 echo "top of script file:"
77 sed -n '1,/^[# ]*end command line/{p;b};q' "$0"
84 m rsync
$dry_run_arg -ahi --relative --delete "$path" "root@$host:/"
88 m
() { if $verbose; then printf "$pre %s\n" "$*"; fi; "$@"; }
89 die
() { printf "$pre %s\n" "$*" >&2; exit 1; }
92 if [[ -e /b
/bash_unpublished
/source-state
]]; then
93 source /b
/bash_unpublished
/source-state
96 # note q is owned by root:1000
104 dry_run
=false
# mostly for testing
106 verbose
=true
; verbose_arg
=-v
107 progress_arg
="--progress"
110 default_args_file
=/etc
/btrbk-run.conf
111 if [[ -s $default_args_file ]]; then
112 set -- $
(< $default_args_file) "$@"
113 # i havent used this feature yet, so warn about it
114 echo "$0: warning: default btrbk-run options set in $default_args_file (sleeping 5 seconds):"
115 cat $default_args_file
122 temp
=$
(getopt
-l cron
,pull-reexec
,help cl
:m
:npqs
:t
:vh
"$@") || usage
1
131 # only creates the config file, does not run btrbk
132 -c) conf_only
=true
; shift ;;
133 # bytes per second, suffix k m g
134 -l) rate_limit
=$2; shift 2 ;;
135 # Comma separated mountpoints to backup. This has defaults set below.
136 -m) IFS
=, mountpoints
=($2); unset IFS
; shift 2 ;;
137 -n) dry_run
=true
; dry_run_arg
=-n; shift ;;
138 -p) progress_arg
="--progress"; shift ;;
139 --pull-reexec) pull_reexec
=true
; shift ;;
140 -q) verbose
=false
; verbose_arg
=; progress_arg
=; shift ;;
141 # source host to receive a backup from
142 -s) source=$2; shift 2 ;;
143 # target hosts to send to. empty is valid for just doing local
144 # snapshot. we have default hosts we will populate.
145 -t) IFS
=, targets
=($2); unset IFS
; shift 2 ;;
146 -v) verbose
=true
; verbose_arg
=-v; shift ;;
149 *) die
"Internal error!" ;;
153 # usefull commands are resume and archive
156 if [[ -v targets
&& $source ]]; then
157 die
"error: -t and -s are mutually exclusive"
161 printf "$pre options: conf_only=%s\ndry_run=%s\nrate_limit=%s\nverbose=%s\ncmd_arg=%s" "$conf_only" "$dry_run" "$rate_limit" "$verbose" "$cmd_arg"
163 ### end options parsing
165 # TODO: i wonder if there should be an option to send to the default
166 # targets, plus any given on the command line.
168 # set default targets
169 if [[ ! -v targets
&& ! $source ]]; then
170 if [[ $HOSTNAME != "$MAIL_HOST" ]] && $cron ; then
171 echo "MAIL_HOST=$MAIL_HOST, nothing to do"
176 if ping -q -c1 -w1 iank.vpn.office.fsf.org
&>/dev
/null
; then
177 home
=iank.vpn.office.fsf.org
190 # might not be connected to the vpn
191 if timeout
-s 9 10 ssh kw
:; then
197 # might not be connected to the vpn
198 if timeout
-s 9 10 ssh kw
:; then
203 die
"error: no default targets for this host, use -t"
208 if [[ -v targets
]]; then
209 echo "targets: ${targets[*]}"
212 if [[ $source ]]; then
213 echo "source: $source"
217 if [[ $mountpoints ]]; then
218 for mp
in ${mountpoints[@]}; do # default mountpoints to sync
219 if [[ -e /nocow
/btrfs-stale
/$mp ]]; then
220 die
"error: $mp is stale, mount-latest-subvol first"
224 # set default mountpoints
226 # no remote backups atm. note, if we do enable this, configuration below will need some changes.
228 # prospective_mps=(/i)
231 prospective_mps
=(/a
/q
)
232 if [[ $HOSTNAME == "$MAIL_HOST" ]]; then
233 prospective_mps
+=(/o
)
237 for mp
in ${prospective_mps[@]}; do # default mountpoints to sync
238 if [[ -e /nocow
/btrfs-stale
/$mp ]]; then
239 echo "$pre warning: $mp stale, not adding to default mountpoints"
242 if awk '{print $2}' /etc
/fstab |
grep -xF $mp &>/dev
/null
; then
248 echo "mountpoints: ${mountpoints[*]}"
252 # pull_reexec stops us from getting into an infinite loop if there is some
253 # kind of weird problem
255 for m
in "${mountpoints[@]}"; do
256 if [[ $m == /a
]]; then
261 if ! $pull_reexec && [[ $source ]] && $pulla ; then
263 scp
$source:/a
/bin
/distro-setup
/btrbk-run
$tmpf
264 if ! diff -q $tmpf $BASH_SOURCE; then
265 echo "$pre found newer version on host $source. reexecing"
266 install -T $tmpf /usr
/local
/bin
/btrbk-run
267 m
/usr
/local
/bin
/btrbk-run
--pull-reexec "${orig_args[@]}"
273 ##### end command line parsing ########
277 if ! which btrbk
&>/dev
/null
; then
278 die
"error: no btrbk binary found"
280 # if our mountpoints are from stale snapshots,
281 # it doesn't make sense to do a backup.
282 check-subvol-stale
${mountpoints[@]} || die
"found stale mountpoints in ${mountpoints[*]}"
284 # for an initial run, btrbk requires the dir to exist.
285 mkdir
-p /mnt
/root
/btrbk
286 local_zone
=$
(date +%z
)
288 if [[ $source ]]; then
289 if ! zone
=$
(ssh root@
$source date +%z
); then
290 die failed to
ssh to root@
$source
292 if [[ $zone != $local_zone ]]; then
293 die
"error: dont confuse yourself with multiple time zones. $h has different timezone than localhost"
300 min_idle_ms
=$
((1000 * 60 * 15))
301 for h
in ${targets[@]}; do
302 if zone
=$
(ssh root@
$h "mkdir -p /mnt/root/btrbk && date +%z"); then
303 if $cron && DISPLAY
=:0 xprintidle
; then
304 # This is a separate ssh because xprintidle can fail and thats ok.
305 # Ignore this host. i sometimes use a non-main machine for testing or web browsing, knowing that
306 # everything will be wiped by the next backup, but I dont want it to happen as Im using
311 if [[ $zone != $local_zone ]]; then
312 die
"error: dont confuse yourself with multiple time zones. $h has different timezone than localhost"
318 if [[ ! $sshable ]] ||
{ ! $cron && [[ $sshfail ]]; }; then
319 die
"failed to ssh to hosts: ${sshfail[*]}"
321 if [[ $sshfail ]]; then
323 echo "$pre error: failed to ssh to ${sshfail[*]} but continuing with other hosts"
325 targets
=(${sshable[@]})
330 cat >/etc
/btrbk.conf
<<EOF
331 ssh_identity /root/.ssh/home
332 # Just a guess that local7 is a good facility to pick.
333 # It's a bit odd that the transaction log has to be logged to
334 # a file or syslog, while other output is sent to std out.
335 # The man does not mention a way for them to be together, but
336 # I dunno if setting a log level like warn might also output
338 transaction_syslog local7
340 # note, i had this because man said 20% speedup, but ran into
341 # this issue, https://github.com/digint/btrbk/issues/275
344 # so we only run one at a time
345 lockfile /var/lock/btrbk.lock
347 # default format of short does not accomidate hourly preservation setting
348 timestamp_format long-iso
350 # only make a snapshot if things have changed
351 snapshot_create onchange
352 # I could make this different from target_preserve,
353 # if one disk had less space.
354 # for now, keeping them equal.
355 snapshot_preserve 36h 14d 8w 24m
356 snapshot_preserve_min 4h
359 # so, total backups = ~89
360 target_preserve 36h 14d 8w 24m
361 target_preserve_min 4h
363 # if something fails and it's not obvious, try doing
364 # btrbk -l debug -v dryrun
366 rate_limit $rate_limit
374 for m
in ${mountpoints[@]}; do
376 if [[ $source ]]; then
377 cat >>/etc
/btrbk.conf
<<EOF
378 volume ssh://$source$vol
380 target send-receive $vol/btrbk
383 cat >>/etc
/btrbk.conf
<<EOF
387 for tg
in ${targets[@]}; do
388 cat >>/etc
/btrbk.conf
<<EOF
389 target send-receive ssh://$tg$vol/btrbk
396 # todo: umount first to ensure we don't have any errors
397 # todo: do some kill fuser stuff to make umount more reliable
407 m btrbk
-v -n $cmd_arg
409 elif [[ $cmd_arg == archive
]]; then
410 if [[ $source ]]; then
411 m btrbk
$verbose_arg $progress_arg $cmd_arg ssh://$source$vol $vol
413 for tg
in ${targets[@]}; do
414 m btrbk
$verbose_arg $progress_arg $cmd_arg $vol ssh://$tg$vol
419 # -q and just using the syslog option seemed nice,
420 # but it doesn't show when a send has a parent and when it doesn't.
421 m btrbk
$verbose_arg $progress_arg $cmd_arg
423 # if we have it, sync to systems which don't
424 if mountpoint
$rsync_mountpoint >/dev
/null
; then
425 for tg
in ${targets[@]}; do
428 for x
in /p
/c
/machine_specific
/*.hosts
; do
429 if grep -qxF $tg $x; then
439 if [[ $source ]]; then
440 m mount-latest-subvol
$verbose_arg
442 m
/a
/exe
/mount-latest-remote
${targets[@]}
447 # todo: move variable data we don't care about backing up
448 # to /nocow and symlink it.
451 # background on btrbk timezones. with short/long, timestamps use local time.
452 # for long, if your local time moves backwards, by moving timezones or
453 # for an hour when daylight savings changes it, you will temporarily get
454 # a more aggressive retention policy for the overlapping period, and
455 # vice versa for the opposite timezone move. The alternative is using
456 # long-iso, which puts timezone info into the timestamp, which means
457 # that instead of shifting time, you shift the start of day/week/month
458 # which is used for retention to your new local time, which means for
459 # example, if you moved forward by 8 hours, the daily/weekly/monthly
460 # retention will be 8 hours more aggressive since midnight is at a new
461 # time, unless you fake the timzeone using the TZ env variable.
462 # However, in the short term, there will be no inconsistencies.
463 # I don't see any problem with shifting when the day starts for
464 # retention, so I'm using long-iso.
466 # note to create a long-iso timestamp: date +%Y%m%dT%H%M%S%z