mylvmbackup

[Description] | [Requirements] | [Mailing list/Bug reports] | [Downloads] | [Sources] | [Documentation/Links]

Description

mylvmbackup is a tool for quickly creating full physical backups of a MySQL server's data files. To perform a backup, mylvmbackup obtains a read lock on all tables and flushes all server caches to disk, makes an LVM snapshot of the volume containing the MySQL data directory, and unlocks the tables again. The snapshot process takes only a small amount of time. When it is done, the server can continue normal operations, while the actual file backup proceeds.

The LVM snapshot is mounted to a temporary directory and all data is backed up using the tar program by default. The archive files are created using names in the form of backup-YYYYMMDD_hhmmss_mysql.tar.gz, where YYYY, MM, DD, hh, mm and ss represent the year, month, day, hour, minute, and second of the time at which the backup occurred. The default prefix backup, date format and file suffix may be modified. The use of timestamped archive names allows you to run mylvmbackup many times without risking to overwrite old archives. It is possible to preserve only a defined number of last backups, to avoid running out of disk space.

Alternatively, instead of tar, you can use rsync, rsnap or zbackup to perform the archiving.

The rsync backup can perform both local backups as well as backing up to a remote server using rsyncd or rsync via SSH.

rsnap is a wrapper around rsync to automatically maintain and rotate a given number of last backups (7 by default). It utilizes hard links to link to unchanged files for saving disk space.

zbackup is a globally-deduplicating backup tool. Feed a large .tar into it, and it will store duplicate regions of it only once, then compress and optionally encrypt the result. Feed another .tar file, and it will also re-use any data found in any previous backups. This way only new changes are stored, and as long as the files are not very different, the amount of storage required is very low. Any of the backup files stored previously can be read back in full at any time.

Moreover, a backup type none is provided for cases where the user wants to use mylvmbackup only for creating the snapshots and intends to perform the actual backup by using the appropriate hooks. (Or for cases where the snapshot itself is considered to be the backup).

mylvmbackup also provides several methods for logging and reporting the progress and success of a backup run. The log messages can either be printed to the console (STDOUT) or logged via syslog. Additionally, a report can be sent to you via email.

Requirements

It is required to run mylvmbackup on the same host where the MySQL server runs. If your MySQL daemon is not listening on localhost or using the default socket location, you must specify --host or --socket. Even though mylvmbackup communicates with the server through a normal client connection to obtain the read lock and flush data, it performs the actual backup by accessing the file system directly. It is also a requirement that the MySQL server's data directory resides on an LVM volume. (It is, however, a good idea to do the LVM backup to a different partition than the one where the data directory resides. Otherwise, there is a good chance that LVM will run out of undo space for LVM snapshot maintenance and the backup will fail.)

The user who invokes mylvmbackup must have sufficient filesystem permissions to create the LVM snapshot and mount it. This includes read/write access to the backup directory.

For proper operation mylvmbackup requires Perl 5 with the DBI and DBD::mysql modules. It also needs Config::IniFiles to read the global configuration file of the program. Date::Format (part of the TimeDate package) is required to create the time stamp used in the backup file names. In addition, it utilizes Getopt::Long, File::Basename and File::Temp, which usually are part of the default Perl distribution. File::Copy::Recursive is used to copy the MySQL configuration file(s). Sys::Syslog is only required in case you want to enable the syslog log facility. The MIME::Lite module is required when you enable the mail reporting functionality. It also requires a functional local sendmail (or alternative) facility.

It also requires several other external programs: GNU tar and gzip to back up the data, LVM utilities (lvcreate, lvremove and lvs) to create and remove the LVM snapshot, and the system utilities mount and umount. Please note that mylvmbackup requires Linux LVM Version 2 or higher. It does not work on LVMv1, as this version does not support writable snapshots.

Optionally, rsync or rsnap may be required instead of tar and gzip, depending on which backup type you choose.

Mailing list/Bug reports

If you want to discuss the usage of mylvmbackup, propose patches or ask for help, there is a mailinglist hosted on Launchpad. You can subscribe and view the mailing list archive via the mylvmbackup Discussion page.

In previous times, we used a mailing list on freelists.org. The old discussions are archived here.

If you want to report a bug, please use the bug tracker on Launchpad.net.

Download released versions

In addition to the packages listed below, I also provide RPM packagages for a number of additional Linux distributions via my home:LenzGr repository on the fabolous openSUSE Build Service.

A package for Debian/Ubuntu Linux is kindly provided and maintained by Norbert Tretkowski. It is now available for Debian "Sid" (Unstable), but the package works fine on stable (Etch) as well.

Robin H. Johnson maintains an ebuild of mylvmbackup for Gentoo Linux.

The latest version of the package can always be obtained by downloading the file mylvmbackup-current.tar.gz.

Older releases

Previous released version of mylvmbackup can be downloaded from here:

Development source tree

On June 25th 2008, the source tree has been moved from Subversion to Bazaar.

The main development branch is now hosted on LaunchPad.net. From there you can browse the bzr tree or create your own branch by using the following command:

bzr branch lp:mylvmbackup

Note: The old Subversion repository has been removed, to avoid confusion. However, the history of changes has been preserved in the bzr repository.

Documentation and Links

Related projects

The following links provide additional background information about LVM on Linux and how to utilize it for performing snapshot backups, particularly with MySQL:

Last changed: Sat, 22 Feb 2014, 23:53