602422987946e1c87b4dbf3e86094108056706c2
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" "$@"
27 usually -t TARGET_HOST
29 echo "top of script file:"
30 sed -n '1,/^[# ]*end command line/{p;b};q' "$0"
34 script_dir
=$
(dirname $
(readlink
-f "$BASH_SOURCE"))
36 # note q is owned by root:1000
37 # note p/m is owned 1000:1000 and chmod 700
46 dry_run
=false
# mostly for testing
48 verbose
=true
; verbose_arg
=-v
49 progress_arg
="--progress"
51 default_args_file
=/etc
/btrbk-run.conf
52 if [[ -s $default_args_file ]]; then
53 set -- $
(< $default_args_file) "$@"
56 temp
=$
(getopt
-l help cl
:m
:nps
:t
:vh
"$@") || usage
1
60 # only creates the config file, does not run btrbk
61 -c) conf_only
=true
; shift ;;
62 # bytes per second, suffix k m g
63 -l) rate_limit
=$2; shift 2 ;;
64 # Comma separated mountpoints to backup. This has defaults set below.
65 -m) IFS
=, mountpoints
=($2); unset IFS
; shift 2 ;;
66 -n) dry_run
=true
; dry_run_arg
=-n; shift ;;
67 -p) progress_arg
="--progress"; shift ;;
68 -q) verbose
=false
; verbose_arg
=; progress_arg
=; shift ;;
69 # source host to receive a backup from
70 -s) source=$2; shift 2 ;;
71 # target hosts to send to. empty is valid for just doing local
72 # snapshot. we have default hosts we will populate.
73 -t) IFS
=, targets
=($2); unset IFS
; shift 2 ;;
74 -v) verbose
=true
; verbose_arg
=-v; shift ;;
77 *) echo "$0: Internal error!" ; exit 1 ;;
81 # usefull commands are resume and archive
84 if [[ -s $default_args_file ]]; then
85 echo "$0: warning: default btrbk-run options set in $default_args_file (sleeping 5 seconds):"
86 cat $default_args_file
90 if [[ -v targets
&& $source ]]; then
91 echo "$0: error: -t and -s are mutually exclusive" >&2
95 echo -e "$0: options: conf_only=$conf_only\ndry_run=$dry_run\nrate_limit=$rate_limit\nverbose=$verbose\ncmd_arg=$cmd_arg"
98 if [[ ! -v targets
&& ! $source ]]; then
101 if [[ $HOSTNAME == "$MAIL_HOST" ]]; then
102 targets
=($HOME_DOMAIN)
107 if [[ $HOSTNAME == "$MAIL_HOST" ]]; then
108 if timeout
-s 9 10 ssh x2
:; then
117 echo "$0: error: no default targets for this host, use -t"
123 if [[ -v targets
]]; then
124 echo "targets: ${targets[*]}"
127 if [[ $source ]]; then
128 echo "source: $source"
133 # set default mountpoints
135 # no remote backups atm. note, if we do enable this, configuration below will need some changes.
137 # prospective_mps=(/i)
140 prospective_mps
=(/a
/q
)
141 if [[ $HOSTNAME == "$MAIL_HOST" ]]; then
142 prospective_mps
+=(/o
)
146 case ${targets[0]} in
152 for mp
in ${prospective_mps[@]}; do # default mountpoints to sync
153 if [[ -e /nocow
/btrfs-stale
/$mp ]]; then
154 echo "$0: warning: $mp stale, not adding to default mountpoints"
157 if awk '{print $2}' /etc
/fstab |
grep -xF $mp &>/dev
/null
; then
162 echo "mountpoints: ${mountpoints[*]}"
164 ##### end command line parsing ########
169 m rsync
$dry_run_arg -ahi --relative --delete "$path" "root@$host:/"
173 m
() { printf "%s: %s\n" "${0##*/}" "$*"; "$@"; }
176 if ! which btrbk
&>/dev
/null
; then
177 echo "$0: error: no btrbk binary found"
180 # if our mountpoints are from stale snapshots,
181 # it doesn't make sense to do a backup.
182 check-subvol-stale
${mountpoints[@]} ||
exit 1
185 cat >/etc
/btrbk.conf
<<EOF
186 ssh_identity /root/.ssh/home
187 # Just a guess that local7 is a good facility to pick.
188 # It's a bit odd that the transaction log has to be logged to
189 # a file or syslog, while other output is sent to std out.
190 # The man does not mention a way for them to be together, but
191 # I dunno if setting a log level like warn might also output
193 transaction_syslog local7
198 # so we only run one at a time
199 lockfile /var/lock/btrbk.lock
201 # default format of short does not accomidate hourly preservation setting
202 timestamp_format long-iso
204 # only make a snapshot if things have changed
205 snapshot_create onchange
206 # I could make this different from target_preserve,
207 # if one disk had less space.
208 # for now, keeping them equal.
209 snapshot_preserve 36h 14d 8w 24m
210 snapshot_preserve_min 4h
213 # so, total backups = ~89
214 target_preserve 36h 14d 8w 24m
215 target_preserve_min 4h
217 # if something fails and it's not obvious, try doing
218 # btrbk -l debug -v dryrun
220 rate_limit $rate_limit
225 for tg
in ${targets[@]:-$HOSTNAME}; do
226 # for an initial run, btrbk requires the dir to exist.
227 ssh root@
$tg mkdir
-p /mnt
/root
/btrbk
233 for m
in ${mountpoints[@]}; do
235 if [[ $source ]]; then
236 cat >>/etc
/btrbk.conf
<<EOF
237 volume ssh://$source$vol
239 target send-receive $vol/btrbk
242 cat >>/etc
/btrbk.conf
<<EOF
246 for tg
in ${targets[@]}; do
247 cat >>/etc
/btrbk.conf
<<EOF
248 target send-receive ssh://$tg$vol/btrbk
255 # todo: umount first to ensure we don't have any errors
256 # todo: do some kill fuser stuff to make umount more reliable
266 m btrbk
-v -n $cmd_arg
267 elif [[ $cmd_arg == archive
]]; then
268 if [[ $source ]]; then
269 m btrbk
$verbose_arg $progress_arg $cmd_arg ssh://$source$vol $vol
271 for tg
in ${targets[@]}; do
272 m btrbk
$verbose_arg $progress_arg $cmd_arg $vol ssh://$tg$vol
277 # -q and just using the syslog option seemed nice,
278 # but it doesn't show when a send has a parent and when it doesn't.
279 m btrbk
$verbose_arg $progress_arg $cmd_arg
281 # if we have it, sync to systems which don't
282 if mountpoint
$rsync_mountpoint >/dev
/null
; then
283 for tg
in ${targets[@]}; do
286 for x
in /p
/c
/machine_specific
/*.hosts
; do
287 if grep -qxF $tg $x; then
297 PATH
=$script_dir:$PATH
298 if [[ $source ]]; then
299 m mount-latest-subvol
301 m mount-latest-remote
${targets[@]}
304 # todo: move variable data we don't care about backing up
305 # to /nocow and symlink it.
308 # background on btrbk timezones. with short/long, timestamps use local time.
309 # for long, if your local time moves backwards, by moving timezones or
310 # for an hour when daylight savings changes it, you will temporarily get
311 # a more aggressive retention policy for the overlapping period, and
312 # vice versa for the opposite timezone move. The alternative is using
313 # long-iso, which puts timezone info into the timestamp, which means
314 # that instead of shifting time, you shift the start of day/week/month
315 # which is used for retention to your new local time, which means for
316 # example, if you moved forward by 8 hours, the daily/weekly/monthly
317 # retention will be 8 hours more aggressive since midnight is at a new
318 # time, unless you fake the timzeone using the TZ env variable.
319 # However, in the short term, there will be no inconsistencies.
320 # I don't see any problem with shifting when the day starts for
321 # retention, so I'm using long-iso.
323 # note to create a long-iso timestamp: date +%Y%m%dT%H%M%S%z