Usage¶
Configuration¶
Once the twindb-backup package is installed you need to edit configuration file /etc/twindb/twindb-backup.cfg.
Let’s review each configuration section.
Source¶
[source] section defines what to backup.
twindb-backup supports backing up local directories and MySQL database.
In backup_dirs you specify which directories to backup. Each directory is separated by a white space.
backup_mysql tells whether the tool backups MySQL or not.
[source]
backup_dirs=/etc /root /home
backup_mysql=no
Destination¶
[destination] specifies where to store backup copies.
backup_destination can be either ssh (if you want to store backups on a remote SSH server)
or s3 (if you want to store backups in Amazon S3).
In the optional keep_local_path you can specify a local path where the tool will store a local copy of the backup.
It’s useful if you want to stream a MySQL backup to S3 and would like to keep a local copy as well.
[destination]
backup_destination=ssh
keep_local_path=/var/backup/local
Compression¶
In [compression] section you can specify compression program such as gzip,pigz,bzip2 and lbzip2.
You can use parallel compression by using pigz or lbzip2, and specify number of threads to use in parallel.
Number of threads defaults to number of cores minus one, if not specified.
Level specifies the compression level from 1 to 9
[compression]
program=pigz
#threads=4
#level=9
Amazon S3¶
In [s3] section you specify Amazon credentials as well as an S3 bucket where to store backups.
[s3]
# S3 destination settings
AWS_ACCESS_KEY_ID=XXXXX
AWS_SECRET_ACCESS_KEY=YYYYY
AWS_DEFAULT_REGION=us-east-1
BUCKET=twindb-backups
Google Cloud Storage¶
In [gcs] section you specify Google credentials as well as cloud storage bucket where to store backups.
[gcs]
# GCS destination settings
GC_CREDENTIALS_FILE=XXXXX
GC_ENCRYPTION_KEY=
BUCKET=twindb-backups
SSH Settings¶
If your backup destination is an SSH server, you specify ssh parameters in [ssh] section.
It is assumed you configured SSH keys authentication. It will not work if you need to enter a password to login to backup_host.
[ssh]
backup_host=127.0.0.1
backup_dir=/tmp/backup
ssh_user=root
ssh_key=/root/.ssh/id_rsa
ssh_port=22
MySQL¶
XtraBackup needs to connect to MySQL. In [mysql] section you specify a defaults file with user and password.
Besides this, You can specify period for MySQL full backup.
The expire_log_days optionsspecifies for how many days the binlog should be kept.
By default it’s seven days.
[mysql]
mysql_defaults_file=/etc/twindb/my.cnf
full_backup=daily
expire_log_days=7
Encryption¶
The tool uses GPG for encrypting/decrypting backup copies. If you want to enable encryption add [gpg] section to the configuration file.
It’s your responsibility to generate and manage the encryption key.
[gpg]
keyring = /root/.gnupg/pubring.gpg
secret_keyring = /root/.gnupg/secring.gpg
recipient = backupuser@youdomain.com
Retention Policy¶
In [retention] section you specify how many copies you want to keep on the remote storage (s3 or ssh).
[retention]
hourly_copies=24
daily_copies=7
weekly_copies=4
monthly_copies=12
yearly_copies=3
Local Retention Policy¶
if keep_local_path is defined in Destination the tool will apply [retention_local] on the local copies.
[retention_local]
hourly_copies=1
daily_copies=1
weekly_copies=0
monthly_copies=0
yearly_copies=0
Running Intervals¶
By default twindb-backup will run hourly, daily, weekly, monthly and yearly.
If you would like to skip some runs [intervals] section is the right place to do so.
[intervals]
run_hourly=yes
run_daily=yes
run_weekly=yes
run_monthly=yes
run_yearly=yes
Email notification¶
The RPM package installs a cron job. If a backup job fails it will send standard error output to the specified email.
The email address is specified in the cron configuration file /etc/cron.d/twindb-backup.
MAILTO=nagios@twindb.com
@hourly root twindb-backup backup hourly
@daily root twindb-backup backup daily
@weekly root twindb-backup backup weekly
@monthly root twindb-backup backup monthly
@yearly root twindb-backup backup yearly