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 trap 'echo "$0:$LINENO:error: \"$BASH_COMMAND\" returned $?" >&2' ERR
22 [[ $EUID == 0 ]] ||
exec sudo
-E "$BASH_SOURCE" "$@"
28 usually -t TARGET_HOST or -s SOURCE_HOST
30 Note, at source location, intentionally not executable, run and read
34 echo "top of script file:"
35 sed -n '1,/^[# ]*end command line/{p;b};q' "$0"
42 m rsync
$dry_run_arg -ahi --relative --delete "$path" "root@$host:/"
46 m
() { if $verbose; then printf "$pre %s\n" "$*"; fi; "$@"; }
47 die
() { printf "$pre %s\n" "$*" >&2; exit 1; }
50 if [[ -e /b
/bash_unpublished
/source-semi-priv
]]; then
51 source /b
/bash_unpublished
/source-semi-priv
54 # note q is owned by root:1000
62 dry_run
=false
# mostly for testing
64 verbose
=true
; verbose_arg
=-v
65 progress_arg
="--progress"
68 default_args_file
=/etc
/btrbk-run.conf
69 if [[ -s $default_args_file ]]; then
70 set -- $
(< $default_args_file) "$@"
71 # i havent used this feature yet, so warn about it
72 echo "$0: warning: default btrbk-run options set in $default_args_file (sleeping 5 seconds):"
73 cat $default_args_file
80 temp
=$
(getopt
-l cron
,pull-reexec
,help cl
:m
:npqs
:t
:vh
"$@") || usage
1
89 # only creates the config file, does not run btrbk
90 -c) conf_only
=true
; shift ;;
91 # bytes per second, suffix k m g
92 -l) rate_limit
=$2; shift 2 ;;
93 # Comma separated mountpoints to backup. This has defaults set below.
94 -m) IFS
=, mountpoints
=($2); unset IFS
; shift 2 ;;
95 -n) dry_run
=true
; dry_run_arg
=-n; shift ;;
96 -p) progress_arg
="--progress"; shift ;;
97 --pull-reexec) pull_reexec
=true
; shift ;;
98 -q) verbose
=false
; verbose_arg
=; progress_arg
=; shift ;;
99 # source host to receive a backup from
100 -s) source=$2; shift 2 ;;
101 # target hosts to send to. empty is valid for just doing local
102 # snapshot. we have default hosts we will populate.
103 -t) IFS
=, targets
=($2); unset IFS
; shift 2 ;;
104 -v) verbose
=true
; verbose_arg
=-v; shift ;;
107 *) die
"Internal error!" ;;
111 # usefull commands are resume and archive
114 if [[ -v targets
&& $source ]]; then
115 die
"error: -t and -s are mutually exclusive"
119 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"
121 ### end options parsing
123 # TODO: i wonder if there should be an option to send to the default
124 # targets, plus any given on the command line.
126 # set default targets
127 if [[ ! -v targets
&& ! $source ]]; then
128 if [[ $HOSTNAME != "$MAIL_HOST" ]] && $cron ; then
129 echo "MAIL_HOST=$MAIL_HOST, nothing to do"
134 if ping -q -c1 -w1 iank.vpn.office.fsf.org
&>/dev
/null
; then
135 home
=iank.vpn.office.fsf.org
148 # might not be connected to the vpn
149 if timeout
-s 9 10 ssh kw
:; then
155 # might not be connected to the vpn
156 if timeout
-s 9 10 ssh kw
:; then
161 die
"error: no default targets for this host, use -t"
166 if [[ -v targets
]]; then
167 echo "targets: ${targets[*]}"
170 if [[ $source ]]; then
171 echo "source: $source"
175 if [[ $mountpoints ]]; then
176 for mp
in ${mountpoints[@]}; do # default mountpoints to sync
177 if [[ -e /nocow
/btrfs-stale
/$mp ]]; then
178 die
"error: $mp is stale, mount-latest-subvol first"
182 # set default mountpoints
184 # no remote backups atm. note, if we do enable this, configuration below will need some changes.
186 # prospective_mps=(/i)
189 prospective_mps
=(/a
/q
)
190 if [[ $HOSTNAME == "$MAIL_HOST" ]]; then
191 prospective_mps
+=(/o
)
195 for mp
in ${prospective_mps[@]}; do # default mountpoints to sync
196 if [[ -e /nocow
/btrfs-stale
/$mp ]]; then
197 echo "$pre warning: $mp stale, not adding to default mountpoints"
200 if awk '{print $2}' /etc
/fstab |
grep -xF $mp &>/dev
/null
; then
206 echo "mountpoints: ${mountpoints[*]}"
210 # pull_reexec stops us from getting into an infinite loop if there is some
211 # kind of weird problem
213 for m
in "${mountpoints[@]}"; do
214 if [[ $m == /a
]]; then
219 if ! $pull_reexec && [[ $source ]] && $pulla ; then
221 scp
$source:/a
/bin
/distro-setup
/btrbk-run
$tmpf
222 if ! diff -q $tmpf $BASH_SOURCE; then
223 echo "$pre found newer version on host $source. reexecing"
224 install -T $tmpf /usr
/local
/bin
/btrbk-run
225 m
/usr
/local
/bin
/btrbk-run
--pull-reexec "${orig_args[@]}"
231 ##### end command line parsing ########
235 if ! which btrbk
&>/dev
/null
; then
236 die
"error: no btrbk binary found"
238 # if our mountpoints are from stale snapshots,
239 # it doesn't make sense to do a backup.
240 check-subvol-stale
${mountpoints[@]} || die
"found stale mountpoints in ${mountpoints[*]}"
242 # for an initial run, btrbk requires the dir to exist.
243 mkdir
-p /mnt
/root
/btrbk
244 local_zone
=$
(date +%z
)
246 if [[ $source ]]; then
247 if ! zone
=$
(ssh root@
$source date +%z
); then
248 die failed to
ssh to root@
$source
250 if [[ $zone != $local_zone ]]; then
251 die
"error: dont confuse yourself with multiple time zones. $h has different timezone than localhost"
258 min_idle_ms
=$
((1000 * 60 * 15))
259 for h
in ${targets[@]}; do
260 if zone
=$
(ssh root@
$h "mkdir -p /mnt/root/btrbk && date +%z"); then
261 if $cron && DISPLAY
=:0 xprintidle
; then
262 # This is a separate ssh because xprintidle can fail and thats ok.
263 # Ignore this host. i sometimes use a non-main machine for testing or web browsing, knowing that
264 # everything will be wiped by the next backup, but I dont want it to happen as Im using
269 if [[ $zone != $local_zone ]]; then
270 die
"error: dont confuse yourself with multiple time zones. $h has different timezone than localhost"
276 if [[ ! $sshable ]] ||
{ ! $cron && [[ $sshfail ]]; }; then
277 die
"failed to ssh to hosts: ${sshfail[*]}"
279 if [[ $sshfail ]]; then
281 echo "$pre error: failed to ssh to ${sshfail[*]} but continuing with other hosts"
283 targets
=(${sshable[@]})
288 cat >/etc
/btrbk.conf
<<EOF
289 ssh_identity /root/.ssh/home
290 # Just a guess that local7 is a good facility to pick.
291 # It's a bit odd that the transaction log has to be logged to
292 # a file or syslog, while other output is sent to std out.
293 # The man does not mention a way for them to be together, but
294 # I dunno if setting a log level like warn might also output
296 transaction_syslog local7
298 # note, i had this because man said 20% speedup, but ran into
299 # this issue, https://github.com/digint/btrbk/issues/275
302 # so we only run one at a time
303 lockfile /var/lock/btrbk.lock
305 # default format of short does not accomidate hourly preservation setting
306 timestamp_format long-iso
308 # only make a snapshot if things have changed
309 snapshot_create onchange
310 # I could make this different from target_preserve,
311 # if one disk had less space.
312 # for now, keeping them equal.
313 snapshot_preserve 36h 14d 8w 24m
314 snapshot_preserve_min 4h
317 # so, total backups = ~89
318 target_preserve 36h 14d 8w 24m
319 target_preserve_min 4h
321 # if something fails and it's not obvious, try doing
322 # btrbk -l debug -v dryrun
324 rate_limit $rate_limit
332 for m
in ${mountpoints[@]}; do
334 if [[ $source ]]; then
335 cat >>/etc
/btrbk.conf
<<EOF
336 volume ssh://$source$vol
338 target send-receive $vol/btrbk
341 cat >>/etc
/btrbk.conf
<<EOF
345 for tg
in ${targets[@]}; do
346 cat >>/etc
/btrbk.conf
<<EOF
347 target send-receive ssh://$tg$vol/btrbk
354 # todo: umount first to ensure we don't have any errors
355 # todo: do some kill fuser stuff to make umount more reliable
365 m btrbk
-v -n $cmd_arg
367 elif [[ $cmd_arg == archive
]]; then
368 if [[ $source ]]; then
369 m btrbk
$verbose_arg $progress_arg $cmd_arg ssh://$source$vol $vol
371 for tg
in ${targets[@]}; do
372 m btrbk
$verbose_arg $progress_arg $cmd_arg $vol ssh://$tg$vol
377 # -q and just using the syslog option seemed nice,
378 # but it doesn't show when a send has a parent and when it doesn't.
379 m btrbk
$verbose_arg $progress_arg $cmd_arg
381 # if we have it, sync to systems which don't
382 if mountpoint
$rsync_mountpoint >/dev
/null
; then
383 for tg
in ${targets[@]}; do
386 for x
in /p
/c
/machine_specific
/*.hosts
; do
387 if grep -qxF $tg $x; then
397 if [[ $source ]]; then
398 m mount-latest-subvol
$verbose_arg
400 m
/a
/exe
/mount-latest-remote
${targets[@]}
405 # todo: move variable data we don't care about backing up
406 # to /nocow and symlink it.
409 # background on btrbk timezones. with short/long, timestamps use local time.
410 # for long, if your local time moves backwards, by moving timezones or
411 # for an hour when daylight savings changes it, you will temporarily get
412 # a more aggressive retention policy for the overlapping period, and
413 # vice versa for the opposite timezone move. The alternative is using
414 # long-iso, which puts timezone info into the timestamp, which means
415 # that instead of shifting time, you shift the start of day/week/month
416 # which is used for retention to your new local time, which means for
417 # example, if you moved forward by 8 hours, the daily/weekly/monthly
418 # retention will be 8 hours more aggressive since midnight is at a new
419 # time, unless you fake the timzeone using the TZ env variable.
420 # However, in the short term, there will be no inconsistencies.
421 # I don't see any problem with shifting when the day starts for
422 # retention, so I'm using long-iso.
424 # note to create a long-iso timestamp: date +%Y%m%dT%H%M%S%z