This article explains how to make incremental or differential backups, with a catalog available to restore (or export) at the point you want, with Butterfly Backup<\/a>.<\/p>\n <\/span> <\/p>\n Butterfly Backup is a simple wrapper of rsync written in python; the first requirement is python3.3<\/a><\/strong> or higher (plus module cryptography<\/a> for init<\/em> action). Other requirements are openssh<\/a><\/strong> and rsync<\/a><\/strong> (version 2.5 or higher). Ok, let\u2019s go! <\/p>\n [Editors note: rsync version 3.2.3 is already installed on Fedora 33 systems]<\/p>\n After that, installing Butterfly Backup is very simple by using the following commands to clone the repository locally, and set up Butterfly Backup for use:<\/p>\n To upgrade, you would use the same commands too.<\/p>\n Butterfly Backup is a server to client tool and is installed on a server (or workstation). The restore process restores the files into the specified client. This process shares some of the options available to the backup process.<\/p>\n Backups are organized accord to precise catalog; this is an example:<\/p>\n Butterfly Backup has six main operations, referred to as actions<\/strong>, you can get information about them with the –help<\/em> command.<\/p>\n Configuration mode is straight forward; If you\u2019re already familiar with the exchange keys and OpenSSH, you probably won\u2019t need it. First, you must create a configuration (rsa keys), for instance:<\/p>\n After creating the configuration, the keys will be installed (copied) on the hosts you want to backup:<\/p>\n There are two backup modes: single<\/em> and bulk<\/em>. The backup of a single machine consists in taking the files and folders indicated in the command line, and putting them into the cataloging structure indicated above. In other words, copy all file and folders of a machine into a path.<\/p>\n This is an examples:<\/p>\n Above all, bulk mode backups share the same options as single mode, with the difference that they accept a file containing a list of hostnames or ips. In this mode backups will performed in parallel (by default 5 machines at a time). Above all, if you want to run fewer or more machines in parallel, specify the –parallel<\/em> parameter.<\/p>\n Incremental of the previous backup, for instance:<\/p>\n There are four backup modes, which you specify with the –mode<\/em> flag: Full<\/strong> (backup all files) , Mirror<\/strong> (backup all files in mirror mode), Differential<\/strong> (is based on the latest Full<\/em> backup) and Incremental<\/strong> (is based on the latest backup). The first time you run backup commands, the catalog is created. The catalog is used for future backups and all the restores that are made through Butterfly Backup. To query this catalog use the list command. Press q<\/em> for exit and select a backup-id:<\/p>\n To export the catalog list use it with an external tool like cat<\/em>, include the –<\/em>–log<\/em> flag:<\/p>\n The restore process is the exact opposite of the backup process. It takes the files from a specific backup and push it to the destination computer. Without specifying the \u201ctype<\/em>\u201d flag that indicates the operating system on which the data are being retrieved, Butterfly Backup will select it directly from the catalog via the backup-id.<\/p>\n<\/blockquote>\n Archive operations are used to store backups by saving disk space.<\/p>\n After that, look in the catalog and see that the backup was actually archived:<\/p>\n Butterfly Backup was born from a very complex need; this tool provides superpowers to rsync, automates the backup and restore process. In addition, the catalog allows you to have a system similar to a “time machine”.<\/p>\n In conclusion, Butterfly Backup is a lightweight, versatile, simple and scriptable backup tool.<\/p>\n One more thing; Easter egg: bb<\/strong> -Vv<\/em><\/p>\n Thank you for reading my post.<\/p>\n Full documentation: https:\/\/butterfly-backup.readthedocs.io\/<\/a> Photo by Manu M<\/a> on Unsplash<\/a><\/em>.<\/p>\n","protected":false},"excerpt":{"rendered":" Introduction This article explains how to make incremental or differential backups, with a catalog available to restore (or export) at the point you want, with Butterfly Backup. Requirements Butterfly Backup is a simple wrapper of rsync written in python; the first requirement is python3.3 or higher (plus module cryptography for init action). Other requirements are […]<\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[48],"tags":[1202,1106,45,61,43,1158,46,47,468,1186,1203,44],"class_list":["post-119622","post","type-post","status-publish","format-standard","hentry","category-fedora-os","tag-archive","tag-backup","tag-fedora","tag-fedora-project-community","tag-for-system-administrators","tag-incremental-backup","tag-magazine","tag-news","tag-python","tag-restore","tag-rsync","tag-using-software"],"_links":{"self":[{"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/posts\/119622","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/comments?post=119622"}],"version-history":[{"count":0,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/posts\/119622\/revisions"}],"wp:attachment":[{"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/media?parent=119622"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/categories?post=119622"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/tags?post=119622"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}Requirements<\/h3>\n
$ sudo dnf<\/strong> install python3 openssh rsync git\n$ sudo pip3<\/strong> install cryptography<\/pre>\n
Installation<\/h2>\n
$ git<\/strong> clone https:\/\/github.com\/MatteoGuadrini\/Butterfly-Backup.git\n$ cd<\/strong> Butterfly-Backup\n$ sudo python3<\/strong> setup.py\n$ bb<\/strong> --help\n$ man<\/strong> bb<\/pre>\n
Example<\/h2>\n
$ tree<\/strong> destination\/of\/backup\n.\n\u251c\u2500\u2500 destination\n\u2502 \u251c\u2500\u2500 hostname or ip of the PC under backup\n\u2502 \u2502 \u251c\u2500\u2500 timestamp folder\n\u2502 \u2502 \u2502 \u251c\u2500\u2500 backup folders\n\u2502 \u2502 \u2502 \u251c\u2500\u2500 backup.log\n\u2502 \u2502 \u2502 \u2514\u2500\u2500 restore.log\n\u2502 \u2502 \u251c\u2500\u2500\u2500 general.log\n\u2502 \u2502 \u2514\u2500\u2500\u2500 symlink of last backup\n\u2502\n\u251c\u2500\u2500 export.log\n\u251c\u2500\u2500 backup.list\n\u2514\u2500\u2500 .catalog.cfg<\/pre>\n
$ bb<\/strong> --help\nusage: bb [-h] [--verbose] [--log] [--dry-run] [--version] {config,backup,restore,archive,list,export} ... Butterfly Backup optional arguments: -h, --help show this help message and exit --verbose, -v Enable verbosity --log, -l Create a log --dry-run, -N Dry run mode --version, -V Print version action: Valid action {config,backup,restore,archive,list,export} Available actions config Configuration options backup Backup options restore Restore options archive Archive options list List options export Export options<\/pre>\nConfiguration<\/h3>\n
$ bb<\/strong> config --new\nSUCCESS: New configuration successfully created!<\/pre>\n
$ bb<\/strong> config --deploy host1\nCopying configuration to host1; write the password:\n\/usr\/bin\/ssh-copy-id: INFO: Source of key(s) to be installed: \"\/home\/arthur\/.ssh\/id_rsa.pub\"\n\/usr\/bin\/ssh-copy-id: INFO: attempting to log in with the new key(s), to filter out any that are already installed\n\/usr\/bin\/ssh-copy-id: INFO: 1 key(s) remain to be installed -- if you are prompted now it is to install the new keys\narthur@host1's password: Number of key(s) added: 1 Now try logging into the machine, with: \"ssh 'arthur@host1'\"\nand check to make sure that only the key(s) you wanted were added. SUCCESS: Configuration copied successfully on host1!<\/pre>\n
Backup<\/h3>\n
The most relevant features of the two backup modes are the parallelism and retention of old backups. See the two parameters –parallel<\/em> and –retention<\/em> in the documentation<\/a>.<\/p>\nSingle backup<\/h4>\n
$ bb<\/strong> backup --computer host1 --destination \/mnt\/backup --data User Config --type Unix\nStart backup on host1\nSUCCESS: Command rsync -ah --no-links arthur@host1:\/home :\/etc \/mnt\/backup\/host1\/2020_09_19__10_28<\/pre>\n
Bulk backup<\/h4>\n
$ cat<\/strong> \/home\/arthur\/pclist.txt\nhost1\nhost2\nhost3\n$ bb<\/strong> backup --list \/home\/arthur\/pclist.txt --destination \/mnt\/backup --data User Config --type Unix\nERROR: The port 22 on host2 is closed!\nERROR: The port 22 on host3 is closed!\nStart backup on host1\nSUCCESS: Command rsync -ahu --no-links --link-dest=\/mnt\/backup\/host1\/2020_09_19__10_28 arthur@host1:\/home :\/etc \/mnt\/backup\/host1\/2020_09_19__10_50<\/pre>\n
The default mode is Incremental<\/em>; Full<\/em> mode is set by default when the flag is not specified.<\/p>\nListing catalog<\/h3>\n
First, let\u2019s query the catalog in our example:<\/p>\n$ bb<\/strong> list --catalog \/mnt\/backup BUTTERFLY BACKUP CATALOG Backup id: aba860b0-9944-11e8-a93f-005056a664e0\nHostname or ip: host1\nTimestamp: 2020-09-19 10:28:12 Backup id: dd6de2f2-9a1e-11e8-82b0-005056a664e0\nHostname or ip: host1\nTimestamp: 2020-09-19 10:50:59<\/pre>\n
$ bb<\/strong> list --catalog \/mnt\/backup --backup-id dd6de2f2-9a1e-11e8-82b0-005056a664e0\nBackup id: dd6de2f2-9a1e-11e8-82b0-005056a664e0\nHostname or ip: host1\nType: Incremental\nTimestamp: 2020-09-19 10:50:59\nStart: 2020-09-19 10:50:59\nFinish: 2020-09-19 11:43:51\nOS: Unix\nExitCode: 0\nPath: \/mnt\/backup\/host1\/2020_09_19__10_50\nList: backup.log\netc\nhome<\/pre>\n
$ bb<\/strong> list --catalog \/mnt\/backup --log\n$ cat<\/strong> \/mnt\/backup\/backup.list<\/pre>\n
Restore<\/h3>\n
This command perform a restore on the same machine of the backup, for instance:<\/p>\n$ bb<\/strong> restore --catalog \/mnt\/backup --backup-id dd6de2f2-9a1e-11e8-82b0-005056a664e0 --computer host1 --log\nWant to do restore path \/mnt\/backup\/host1\/2020_09_19__10_50\/etc? To continue [Y\/N]? y\nWant to do restore path \/mnt\/backup\/host1\/2020_09_19__10_50\/home? To continue [Y\/N]? y\nSUCCESS: Command rsync -ahu -vP --log-file=\/mnt\/backup\/host1\/2020_09_19__10_50\/restore.log \/mnt\/backup\/host1\/2020_09_19__10_50\/etc arthur@host1:\/restore_2020_09_19__10_50\nSUCCESS: Command rsync -ahu -vP --log-file=\/mnt\/backup\/host1\/2020_09_19__10_50\/restore.log \/mnt\/backup\/host1\/2020_09_19__10_50\/home\/* arthur@host1:\/home<\/pre>\n
\n
Archive old backup<\/h3>\n
$ bb<\/strong> archive --catalog \/mnt\/backup\/ --days 1 --destination \/mnt\/archive\/ --verbose --log\nINFO: Check archive this backup f65e5afe-9734-11e8-b0bb-005056a664e0. Folder \/mnt\/backup\/host1\/2020_09_18__17_50\nINFO: Check archive this backup 4f2b5f6e-9939-11e8-9ab6-005056a664e0. Folder \/mnt\/backup\/host1\/2020_09_15__07_26\nSUCCESS: Delete \/mnt\/backup\/host1\/2020_09_15__07_26 successfully.\nSUCCESS: Archive \/mnt\/backup\/host1\/2020_09_15__07_26 successfully.\n$ ls<\/strong> \/mnt\/archive\nhost1\n$ ls<\/strong> \/mnt\/archive\/host1\n2020_09_15__07_26.zip<\/pre>\n
$ bb<\/strong> list --catalog \/mnt\/backup\/ -i 4f2b5f6e-9939-11e8-9ab6-005056a664e0\nBackup id: 4f2b5f6e-9939-11e8-9ab6-005056a664e0\nHostname or ip: host1\nType: Incremental\nTimestamp: 2020-09-15 07:26:46\nStart: 2020-09-15 07:26:46\nFinish: 2020-09-15 08:43:45\nOS: Unix\nExitCode: 0\nPath: \/mnt\/backup\/host1\/2020_09_15__07_26\nArchived: True<\/em><\/pre>\n
Conclusion<\/h2>\n
Github: https:\/\/github.com\/MatteoGuadrini\/Butterfly-Backup<\/a><\/p>\n
\n