#!/bin/bash
-# Copyright (C) 2016 Ian Kelling
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
+# Configure & run btrbk & related work on Ian's computers.
+# Copyright (C) 2024 Ian Kelling
-# http://www.apache.org/licenses/LICENSE-2.0
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+# SPDX-License-Identifier: GPL-3.0-or-later
# todo: if we cancel in the middle of a btrfs send, then run again
[[ $EUID == 0 ]] || exec sudo -E "${BASH_SOURCE[0]}" "$@"
-source /usr/local/lib/err
+set -e; . /usr/local/lib/bash-bear; set +e
+shopt -s nullglob
usage() {
cat <<'EOF'
script_name="${BASH_SOURCE[0]}"
script_name="${script_name##*/}"
+d() {
+ if $dry_run || $conf_only; then
+ printf "$pre dry-run: %s\n" "$*"
+ else
+ printf "$pre running: %s\n" "$*"
+ "$@"
+ fi
+}
m() { if $verbose; then printf "$pre %s\n" "$*"; fi; "$@"; }
e() { printf "$pre %s\n" "$*"; }
die() { printf "$pre error: %s\n" "$*" >&2; echo "$pre exiting with status 1" >&2; exit 1; }
mexit() { echo "$pre exiting with status $1"; exit $1; }
+uninstalled-file-die() {
+ die "uninstalled file $1. run install-my-scripts or rerun with -f"
+}
+
+set-location() {
+ case $HOSTNAME in
+ kw)
+ at_work=true
+ ;;
+ kd|frodo)
+ at_home=true
+ ;;
+ x2|x3|sy|so)
+ if [[ $(dig +short @10.2.0.1 -x 10.2.0.2 2>&1 ||:) == kd.b8.nz. ]] \
+ && ip n show 10.2.0.1 | grep . &>/dev/null; then
+ # note: logic duplicated in 11-iank
+ at_home=true
+ elif ping -q -c1 -w1 hal.office.fsf.org &>/dev/null \
+ && ip n show 192.168.0.26 | grep . &>/dev/null; then
+ at_work=true
+ fi
+ ;;
+ esac
+}
+
+exit-if-no-default-targets() {
+ if ! $force && [[ $HOSTNAME != "$MAIL_HOST" ]]; then
+ echo "MAIL_HOST=$MAIL_HOST, nothing to do"
+ mexit 0
+ fi
+ case $HOSTNAME in
+ kw|kd|frodo|x2|x3|sy|so) : ;;
+ *)
+ die "error: no default targets for this host, use -t"
+ ;;
+ esac
+}
+
+add-x3-target() {
+ # main work machine
+ if ping -q -c1 -w1 x3.office.fsf.org &>/dev/null; then
+ targets+=(x3.office.fsf.org)
+ elif ping -q -c1 -w1 $h.b8.nz &>/dev/null; then
+ # in case we took it home
+ targets+=(x3.b8.nz)
+ elif ping -q -c1 -w1 ${h}w.b8.nz &>/dev/null; then
+ targets+=(x3w.b8.nz)
+ else
+ targets+=(x3wg.b8.nz)
+ fi
+}
+
+add-wireless-target() {
+ local host
+ if [[ ! $1 ]]; then
+ set -- $h
+ fi
+ for host; do
+ # c = cabled, w = wireless
+ if ping -q -c1 -w1 ${host}c.b8.nz &>/dev/null; then
+ targets+=(${host}c.b8.nz)
+ elif ping -q -c1 -w1 $host.b8.nz &>/dev/null; then
+ targets+=($host.b8.nz)
+ elif ping -q -c1 -w1 ${host}w.b8.nz &>/dev/null; then
+ targets+=(${host}w.b8.nz)
+ fi
+ done
+}
+
+qconf() {
+ case $sub in
+ q)
+ # q has sensitive data i dont want to backup for so long
+ cat >>/etc/btrbk$conf_suf.conf <<EOF
+snapshot_preserve $q_preserve
+snapshot_preserve_min 2h
+snapshot_dir btrbk
+target_preserve $q_preserve
+target_preserve_min 2h
+EOF
+ ;;
+ esac
+
+}
+
+
# latest $MAIL_HOST
if [[ -e /b/bash_unpublished/source-state ]]; then
source /b/bash_unpublished/source-state
sleep 5
fi
+once_args_file=/etc/btrbk-run-once.conf
+if mv -f $once_args_file $once_args_file-tmp 2> >(sed '/No such file or directory/d'); then
+ # shellcheck disable=SC2046 # we want word splitting
+ set -- $(< $once_args_file-tmp) "$@"
+ # i havent used this feature yet, so warn about it
+ echo "$0: btrbk-run options set in $once_args_file:"
+ cat $once_args_file-tmp
+ rm -f $once_args_file-tmp
+fi
+
+
targets=()
early=false
fast=false
# switch mail-host, no need to repeat the same checks again.
--fast) fast=true ;;
-i) incremental_strict=true ;;
- # note this implies resume and -p
+ # note this implies resume and -p because it is just meant to make
+ # other hosts have the same snapshots, not do any expiry or new
+ # backups.
-k) kd_spread=true ;;
# bytes per second, suffix k m g
-l) rate_limit=$2; shift ;;
cmd_arg="$1"
-uninstalled-file-die() {
- die "uninstalled file $1. run install-my-scripts or rerun with -f"
-}
if ! $force && { $check_installed || [[ ! $source ]]; } ; then
install_bin_files=(
uninstalled-file-die $f
fi
done
- if ! diff -q /a/bin/errhandle/err /usr/local/lib/err; then
+ if ! diff -q /a/bin/bash-bear-trap/bash-bear /usr/local/lib/bash-bear; then
uninstalled-file-die err
fi
if $check_installed; then
fi
cmd_arg=resume
preserve_arg=-p
- h=sy
- add-wireless-target-h
+ add-wireless-target sy so
fi
if [[ ! $cmd_arg ]]; then
fi
cd /a/opt/btrbk
m make install
+ cd /
fi
# TODO: i wonder if there should be an option to send to the default
at_home=false
-set-location() {
- case $HOSTNAME in
- kw)
- at_work=true
- ;;
- kd|frodo)
- at_home=true
- ;;
- x2|x3|sy)
- if [[ $(dig +short @10.2.0.1 -x 10.2.0.2 2>&1 ||:) == kd.b8.nz. ]] \
- && ip n show 10.2.0.1 | grep . &>/dev/null; then
- at_home=true
- elif ping -q -c1 -w1 hal.office.fsf.org &>/dev/null \
- && ip n show 192.168.0.26 | grep . &>/dev/null; then
- at_work=true
- fi
- ;;
- esac
-}
-
-exit-if-no-default-targets() {
- if ! $force && [[ $HOSTNAME != "$MAIL_HOST" ]]; then
- echo "MAIL_HOST=$MAIL_HOST, nothing to do"
- mexit 0
- fi
- case $HOSTNAME in
- kw|kd|frodo|x2|x3|sy) : ;;
- *)
- die "error: no default targets for this host, use -t"
- ;;
- esac
-}
-
-add-x3-target() {
- # main work machine
- if ping -q -c1 -w1 x3.office.fsf.org &>/dev/null; then
- targets+=(x3.office.fsf.org)
- elif ping -q -c1 -w1 $h.b8.nz &>/dev/null; then
- # in case we took it home
- targets+=(x3.b8.nz)
- else
- targets+=(x3wg.b8.nz)
- fi
-}
-
-add-wireless-target-h() {
- if ping -q -c1 -w1 $h.b8.nz &>/dev/null; then
- targets+=($h.b8.nz)
- elif ping -q -c1 -w1 ${h}w.b8.nz &>/dev/null; then
- targets+=(${h}w.b8.nz)
- fi
-}
-
-
# set default targets
if [[ ! -v targets && ! $source ]]; then
exit-if-no-default-targets
wireless_home_hosts=(
x2
sy
+ so
)
for h in ${wireless_home_hosts[@]}; do
if [[ $HOSTNAME != "$h" ]]; then
- add-wireless-target-h
+ add-wireless-target
fi
done
elif $at_work; then
- targets+=(i.b8.nz)
+ targets+=(b8.nz)
for h in x2 x3 kw; do
if [[ $HOSTNAME == "$h" ]]; then
continue
fi
done
else
- targets+=(i.b8.nz)
+ targets+=(b8.nz)
fi
fi
*)
prospective_mps=()
if [[ $source ]]; then
- source_state="$(ssh $source cat /a/bin/bash_unpublished/source-state)"
+ source_state="$(ssh $source 'cat /a/bin/bash_unpublished/source-state; echo source_host=$HOSTNAME')"
eval "$source_state"
- source_host="$(ssh $source cat /etc/hostname)"
+ # shellcheck disable=SC2154 # assigned in the above eval.
if [[ $source_host == "$MAIL_HOST" ]]; then
prospective_mps+=(/o)
fi
if [[ $source_host == "$HOST2" ]]; then
- prospective_mps+=(/a /ar /qr /qd /q)
+ prospective_mps+=(/a /qr /qd /q)
fi
else
if [[ $HOSTNAME == "$MAIL_HOST" ]]; then
prospective_mps+=(/o)
fi
if [[ $HOSTNAME == "$HOST2" ]]; then
- prospective_mps+=(/a /ar /qr /qd /q)
+ prospective_mps+=(/a /qr /qd /q)
fi
if $kd_spread; then
- prospective_mps=(/a /ar /o /qr /qd /q)
+ prospective_mps=(/a /o /qr /qd /q)
fi
fi
# note: put q last just in case its specific retention options were to
done
fi
-if (( ! ${#mountpoints[@]} )); then
+tmp=$(( ${#mountpoints[@]} == 0 ))
+if (( tmp )); then
die didnt get mountpoint arg and had no defaults
fi
echo copying output to $log_path
exec &> >(pee cat 'ts "%F %T"|dd of='$log_path' status=none')
-
+# print some non-default opts
if $verbose; then
- printf " options: conf_only=%s\ndry_run=%s\nrate_limit=%s\nverbose=%s\ncmd_arg=%s" "$conf_only" "$dry_run" "$rate_limit" "$verbose" "$cmd_arg"
+ opts_show=()
+ if ! $conf_only; then
+ opts_show+=(conf_only=true)
+ fi
+ if ! $dry_run; then
+ opts_show+=(dry_run=true)
+ fi
+ if [[ $rate_limit != no ]]; then
+ opts_show+=("rate_limit=$rate_limit")
+ fi
+ if [[ $cmd_arg != run ]]; then
+ opts_show+=(cmd_arg=$cmd_arg)
+ fi
+ if (( ${#opts_show[@]} >= 1 )); then
+ first=true
+ for opt in ${opts_show[@]}; do
+ if $first; then
+ printf "%s" "$opt"
+ first=false
+ else
+ printf " %s" "$opt"
+ fi
+ done
+ echo
+ fi
fi
if [[ -v targets ]]; then
echo "mountpoints: ${mountpoints[*]}"
-
-
# pull_reexec stops us from getting into an infinite loop if there is some
# kind of weird problem
pulla=false
if ! $pull_reexec && [[ $source ]] && $pulla ; then
tmpf=$(mktemp)
m rsync -ra $source:/usr/local/bin/{mount-latest-subvol,check-subvol-stale} /usr/local/bin
- m rsync -ra $source:/usr/local/lib/err /usr/local/lib
+ m rsync -ra $source:/usr/local/lib/bash-bear /usr/local/lib
m scp $source:/a/bin/distro-setup/btrbk-run $tmpf
if ! diff -q $tmpf ${BASH_SOURCE[0]}; then
e "found different version on host $source. reexecing"
fi
fi
-
+# todo: check if we have no snapshots yet, because I always want to run
+# archive instead of run. Likely, I should give an error unless a cli
+# override is passed. perhaps check-subvol-stale could give the error.
+# see the error message "no snapshots found" in that file.
if ! $fast; then
# if our mountpoints are from stale snapshots,
# it doesn't make sense to do a backup.
sshable=()
sshfail=()
+ remote_str_cmd="mkdir -p /mnt/root/btrbk /mnt/o/btrbk && \
+date +%z && \
+df --output=size,pcent / | tail -n1"
+
for h in ${targets[@]}; do
if $fast || $conf_only; then
# Use some typical values in this case
root_size=$(( 1024 * 1024 * 2000 )) #2tb
percent_used=10
zone=$(date +%z)
- elif remote_str=$(timeout -s 9 6 ssh root@$h "mkdir -p /mnt/root/btrbk /mnt/o/btrbk && date +%z && df --output=size,pcent / | tail -n1"); then
+ elif remote_str=$(timeout -s 9 6 ssh root@$h "$remote_str_cmd"); then
mapfile -t tmp_array <<<"$remote_str"
zone="${tmp_array[0]}"
IFS=" " read -r root_size percent_used <<<"${tmp_array[1]}"
percent_used=${percent_used%%%}
- if (( ${#tmp_array[@]} != 2 )); then
+ tmp=$(( ${#tmp_array[@]} != 2 ))
+ if (( tmp )); then
die "error: didnt get 2 lines in test ssh to target $h. investigate"
fi
case $percent_used in
# we may be booted into a bootstrap fs or something
min_root_kb=$(( 1024 * 1024 * 200 )) # 200 gb
- if (( root_size < min_root_kb )); then
+ tmp=$(( root_size < min_root_kb ))
+ if (( tmp )); then
+ e "warning: $h: root_size=$root_size < 200gb, perhaps it is booted to bootstrap vol. skipping for now"
continue
fi
- if (( percent_used >= 98 )); then
+ tmp=$(( percent_used >= 98 ))
+ if (( tmp )); then
die "error: filesystem on target $h is $percent_used % full"
fi
fi
done
if [[ ! ${sshable[*]} ]] || { $force && [[ ${sshfail[*]} ]]; }; then
- die "failed to ssh to hosts: ${sshfail[*]}"
+ die "see skipped host warning above or sshfail hosts: ${sshfail[*]}"
else
if [[ ${sshfail[*]} ]]; then
ret=1
target_preserve $std_preserve
target_preserve_min 6h
-# i tried this when investigating: clone no source subvolume found error
-#incremental_prefs sro:1 srn:1 sao san:1 aro:1 arn:1
+# it seems very likely that not doing this could result in clone source not found
+# errors, for example when expiry happens differently on different hosts,
+# also, as btrbk does by default, if a failed send happens, on the next run it
+# will warn about a stray subvolume, but then create a backup of a newer subvol
+# and use an older subvol as the parent.
+incremental_prefs sao:1
# if something fails and it's not obvious, try doing
# btrbk -l debug -v dryrun
EOF
fi
-qconf() {
- case $sub in
- q)
- # q has sensitive data i dont want to backup for so long
- cat >>/etc/btrbk$conf_suf.conf <<EOF
-snapshot_preserve $q_preserve
-snapshot_preserve_min 2h
-snapshot_dir btrbk
-target_preserve $q_preserve
-target_preserve_min 2h
-EOF
- ;;
- esac
-
-}
# make /q be last
mp_count=${#mountpoints[@]}
fi
done
+
+
+snap_list_cmds=()
+tg_snaps=()
+declare -A source_snaps
+
for m in ${mountpoints[@]}; do
case $m in
/o)
esac
sub=${m#/}
+ snap_list_cmds+=("echo $vol/btrbk/$sub.*;")
+
if [[ $source ]]; then
+ tmp_a=($vol/btrbk/$sub.*)
+ tg_snaps+=("${tmp_a[*]}")
cat >>/etc/btrbk$conf_suf.conf <<EOF
volume ssh://$bbksource$vol
subvolume $sub
cat >>/etc/btrbk$conf_suf.conf <<EOF
target send-receive $vol/btrbk
EOF
- fi
- if (( ${#targets[@]} )); then
+ else # we have targets
+ for snap in "$vol/btrbk/$sub."*; do
+ source_snaps[$snap]=t
+ done
+
cat >>/etc/btrbk$conf_suf.conf <<EOF
volume $vol
subvolume $sub
fi
done
+# Delete any subvols on the receiving host that don't exist on the
+# sending host. Otherwise, the receiving host could have snapshots that
+# aren't on the sending side, and thus become odd leaf subvols, and then
+# btrbk could try to use them when we sync back, creating a weird tree
+# instead of linear parent/child relationship. Maybe this could lead to
+# a missing source subvol error, so lets avoid it.
+
+get-orphan-tg-snaps() {
+ orphan_tg_snaps=()
+ for (( i=0; i < ${#mountpoints[@]}; i++ )); do
+ orphan_start_count=${#orphan_tg_snaps[@]}
+ tg_snap_count=0
+ for tg_snap in ${tg_snaps[$i]}; do
+ tg_snap_count=$(( tg_snap_count + 1 ))
+ if [[ ! ${source_snaps[$tg_snap]} ]]; then
+ orphan_tg_snaps+=("$tg_snap")
+ fi
+ done
+ orphan_mp_count=$(( ${#orphan_tg_snaps[@]} - orphan_start_count ))
+ # sanity checking
+ tmp=$(( tg_snap_count > 1 && tg_snap_count == orphan_mp_count ))
+ if (( tmp )) ; then
+ die "something went wrong checking orphans on $tg: for mountpoint ${mountpoints[$i]}, $orphan_mp_count"
+ fi
+ done
+}
+
+if [[ $source ]]; then
+ for snap in $(ssh root@$source "shopt -s nullglob; ${snap_list_cmds[*]}"); do
+ source_snaps[$snap]=t
+ done
+ get-orphan-tg-snaps
+ tmp=$(( ${#orphan_tg_snaps[*]} >= 1 ))
+ if (( tmp )); then
+ d btrfs sub del ${orphan_tg_snaps[*]}
+ fi
+else # we have targets
+ for tg in ${targets[@]}; do
+ tmp_str=$(ssh root@$tg "shopt -s nullglob; ${snap_list_cmds[*]}")
+ mapfile -t tg_snaps <<<"$tmp_str"
+ get-orphan-tg-snaps
+ tmp=$(( ${#orphan_tg_snaps[*]} >= 1 ))
+ if (( tmp )); then
+ d ssh root@$tg "btrfs sub del ${orphan_tg_snaps[*]}"
+ fi
+ done
+fi
+
# todo: umount first to ensure we don't have any errors
# todo: do some kill fuser stuff to make umount more reliable
done
fi
+# todo, we get hostnames earlier, reuse that.
if [[ $ret == 0 ]]; then
for tg in ${targets[@]}; do
h=$(ssh $tg hostname)
if [[ $h == kd && $HOSTNAME == x3 && $HOSTNAME == "$MAIL_HOST" ]]; then
- ssh root$tg systemctl --no-block start btrbk-spread
+ m ssh root@$tg 'btrbk-spread-wrap &>/dev/null </dev/null &'
fi
- rsync -a -f"- */" -f"+ *" /var/log/btrbk/ root@$tg:/var/log/btrbk/$tg
- ssh root@$tg /usr/local/bin/mail-backup-clean
+ rsync --mkpath -a -f"- */" -f"+ *" /var/log/btrbk/ root@$tg:/var/log/btrbk/$tg
+ cmd=/usr/local/bin/mail-backup-clean
+ ssh root@$tg "if test -x $cmd; then $cmd; fi"
done
if [[ $source ]]; then
- rsync -a -f"- */" -f"+ *" $source:/var/log/btrbk/ /var/log/btrbk/$source
+ rsync --mkpath -a -f"- */" -f"+ *" $source:/var/log/btrbk/ /var/log/btrbk/$source
fi
fi
iankelling.org / git / distro-setup / blobdiff