3 A script for cloning systems using rsync.
4 Copyright (c)2008-2016 Alexander Barton <alex@barton.de>
11 Backup all or individual systems.
13 Usage: `backup-script [<options>] [<system> [<system> [...]]]`
17 - `-n`, `--dry-run`: Test run only, don't copy any data.
18 - `-p`, `--progress`: Show progress, see rsync(1).
19 - `-t TAG`, `--tag TAG`: Only run jobs with tag TAG (see "tags" variable below).
21 When no *system* is given, all defined systems are backed up.
23 ### backup-script-wrapper
25 Backup all systems and mail the report to "root".
27 Usage: `backup-script-wrapper`
31 Show information about backups.
33 Usage: `backup-status [-q] [<system> [<system> [...]]]`
37 - `-q`: *quick mode*, don't calculate backup sizes.
42 All default configuration variables are read from the first file found of this
43 list: `/usr/local/etc/backup-scrupt.conf`, `/etc/backup-script.conf` or
44 from `/etc/backup-script.d/backup-script.conf` (deprecated).
46 All systems which should be backed-up are configured using individual files
47 in the configuration directory, which is `/usr/local/etc/backup-script.d/` or
48 `/etc/backup-script.d/` by default (whichever is found first), and can be
49 specified using the `conf_d` variable in the main configuration file.
51 The must be one file for each system to backup (files ending in `*.sh` are
52 skipped, as well as files named `backup-script.conf`). Please avoid spaces and
53 other "special" characters! The filename is used as hostname for the system by
54 default, but this can be overwritten using the `system` configuration variable.
56 Variables in `backup-script.conf` must be prefixed with `default_` to define
57 default values for all systems.
59 All defaults can be overwritten in the individual system configuration files.
63 - `/etc/backups-script.conf`: defaults for all hosts
64 - `/etc/backups-script.d/host01.example.net`: configuration for host 1
65 - `/etc/backups-script.d/clientXY.example.com`: configuration for host 2
68 ## Configuration Variables
72 System host name. Default: file name.
74 *Note:* There is no `default_system` variable!
76 ### [default_]backup_type
78 Backup type to use. Default: `rsync`.
80 - `rsync`: system backup using rsync(1).
81 Use `source_root` to specify the root directory to save.
83 - `scp`: file backup using scp(1).
84 Use `files` to specify the files to copy.
86 - `disabled`: job is disabled and will not be run. This becomes accounted as
87 "success" in the summary and exit code of the backup script.
89 Please note that neither `ssh_args_add`, `rsync_args_add`, `compress`, nor any
90 "exclude" parameters are supported when using the "scp" backup type! And There
91 "scp" backup type never _deletes_ files from the backup store; so if you reduce
92 the list of files to backup, old files will still be kept, because they were
93 already saved in an older generation (but no longer updated).
97 Remote user. Default: `root`.
99 ### [default_]source_root
101 Remote *root* directory, must end with a slash ("/") character! Default: "/".
103 When saving the whole (remote) system ("/"), default excludes are set up
104 automatically, which exclude standard system directories like /sys and /proc.
108 Space separated list of files to copy when using the "scp" `backup_type`.
109 Default: "running-config".
113 Local backup directory. The backup of each system is stored in a folder named
114 like the system (see `system` variable) inside of this target directory.
116 *Note:* There is *no* default, you have to specify this variable, for example as
117 `default_target` in the `backups-script.conf` file!
119 ### [default_]ssh_args_add
121 Additional parameters for `ssh`. Default: none.
123 ### [default_]rsync_args_add
125 Additional parameters for `rsync`. Default: none.
127 ### [default_]exclude_args_add
129 Additional (exclude) parameters for `rsync`. Default: none.
131 *Deprecated! Use "exclude_dirs_add" instead!*
133 ### [default_]exclude_dirs_add
135 Additional directory path names to exclude from the backup. Use full path names
136 separated by spaces. Default: none.
138 ### [default_]compress
140 Enable (1) or disable (0) rsync transfer compression. Default: 1 (on).
144 Enable (1) or disable (0) ping'ing the target system to make sure that it is
145 reachable before calling `rsync`. Default: 1 (on).
149 Enable (1) or disable (0) *local mode*: when local mode is in effect, `rsync` is
150 called without using `ssh`, which is a good idea when saving the local system.
151 Default: 0 (off; use ssh).
153 ### [default_]generations
155 Number of generations to keep. Default: 0 (none).
157 On a suitable target file systems (see `target` variable), this script can
158 generate generations using snapshots: the script creates a new snapshot
159 named with the time stamp for each generation inside of the system directory
160 inside of the target directory.
162 Supported file systems are:
165 All generations are btrfs subvolumes and named after the date and time.
167 All generations are ZFS file systems. Latest generation is named `current`,
168 elders are links to the ZFS snapshot directories.
170 The latest snapshot is always reachable using a symlink named `latest`
171 inside the system directory.
173 ### [default_]io_timeout
175 The maximum I/O timeout in seconds. If no data is transferred for the specified
176 time then rsync will abort. Default: 1800 (30 minutes).
180 Comma-separated list of tags of this job. All uppercase tag names are reserved
181 and become set automatically on runtime:
183 - NONE: Jobs with no other tags at all.
184 - ALL: Matches all jobs, regardless of their tags (see `-t`/`--tags` option).
185 - LOCAL: All jobs running on "localhost".
189 ### [default_]job_pre_exec
191 Optional script to execute before `rsync` starts. Default: none.
193 When the `job_pre_exec` script returns an error (exit code is not 0), the backup
196 ### [default_]job_post_exec
198 Optional script to execute after `rsync` exited. Default: none.
200 ### Compatibility Variables
202 The following configurations variables used by the backup-pull(1) script in job
203 definition files are automatically mapped to the new backup-script variables:
206 * source -> source_root
207 * pre_exec -> job_pre_exec
208 * post_exec -> job_post_exec
213 - 1: Unspecific Error!
214 - 2: Usage information has been shown.
215 - 3: Can't read system definition
216 - 4: PID-file exists!
217 - 5: Pre-exec command failed!
218 - 6: There have been systems with errors!
219 - 7: Not all jobs were run!
220 - 9: Aborted (CTRL-C)!