From TBwiki

(Difference between revisions)

Revision as of 14:56, 12 January 2017

This procedure shows how to configure a periodic database backup using a bash script (tbdbbackup) executed from a Tmedia host unix cron jobs. Cron allows Linux and Unix users to run commands or scripts at a given date and time.

Overview

The tbdbbackup script support the following features:

Backup the TMG-CONTROL configuration database into a backup file
Backup file name formatted as tbdbbackup_<hostname>_toolpack_<version>_<date>_<time>.sql.gz

 tbdbbackup_TB014369_toolpack_2_8_2017_01_11_15h52m.sql.gz

Keep N days of local backup files in /lib/tb/toolpack/pkg/database_backups. Default is 7 days.
Backup files are listed on the Web portal in Backups->Manual Database Backup
Optional copy to a remote server supporting SSH Key-Based Authentication
- Copy the backup file on a remote server (using scp) - optional
- Keep M days of backup files on the remote server (using ssh) - optional

On latest product version, the script should be available from the /usr/bin. To validate if you have the script on your Tmedia:

Connect to the Tmedia using SSH as root

[root@TB014369 ~]# which tbdbbackup
/usr/bin/tbdbbackup

Install

From repository

If you don't have the script already installed in /usr/bin, you can update the tb_tools package on your Tmedia. This will install the /usr/bin/tbdbbackup.
NOTE: this will ovewrite /usr/bin/tbcopycdr. If you previously customized the CDR copy script, make sure to make a copy before updating.

yum update tb_tools

Manually

If you don't have access to the repository from the Tmedia. 1. Get the script from either:

Download the latest tb_tools rpm package from TelcoBridges repository (http://repo.telcobridges.com/centos/7/os/x86_64/Packages/) and decompress it to get the script (see How to Extract a RPM

Example for linux:

mkdir tb_tools
cd tb_tools
wget http://repo.telcobridges.com/centos/7/os/x86_64/Packages/tb_tools-1.2-30.el7.tb.noarch.rpm
rpm2cpio tb_tools-1.2-30.el7.tb.noarch.rpm | cpio -idmv

Get it here: tbdbbackup [click to download]

2. Copy the scrips to Tmedia (using a sftp client)

Copy tbdbbackup and tbtoolpackenv to /usr/bin on your Tmedia
Connect to the Tmedia using SSH as root and make tbdbbackup script executable

chmod +x /usr/bin/tbdbbackup

Configuration

The script is configured with user variables.

CONFIG_FILE: Configuration file name and location. By default, it is set to /root/tbdbbackup.cfg.

CONFIG_FILE=/root/tbdbbackup.cfg

tbdbbackup.cfg file example:

LOCAL_BACKUP_MAX_DAYS="1"
REMOTE_BACKUP_MAX_DAYS="1"
REMOTE_HOST=192.168.101.170
REMOTE_PORT=22
REMOTE_DIR="/root/backup_test"
REMOTE_USER=root

The configuration file can redefine any of the following user variables. To see the default variables:

head -n 45 /usr/bin/tbdbbackup

LOCAL_BACKUP_MAX_DAYS : Keep the local backup files for that number of days. Set to 7 days by default.

# Comment to deactivate local backup file cleanup
LOCAL_BACKUP_MAX_DAYS="7"

REMOTE_BACKUP_MAX_DAYS : Keep the local backup files for that number of days. Set to 7 days by default.

# Comment to deactivate remote backup file cleanup, REMOTE_HOST must configured
REMOTE_BACKUP_MAX_DAYS="7"

REMOTE_HOST : Remote host name or Ip address. Remote host copy is deactivated by default.

# Uncomment the following line to activate remote copy
#REMOTE_HOST=10.10.10.10

REMOTE_PORT : Remote host ssh port.

REMOTE_PORT=22

REMOTE_DIR : Remote directory where to copy the backup files (/root/backup by default)

REMOTE_DIR="/root/backup"

REMOTE_USER : Remote host login user.

REMOTE_USER=root

CONNECT_TIMEOUT : scp connection timeout

CONNECT_TIMEOUT=10

HOSTNAME : Configure backup file <hostname> name part.

# By default take the Tmedia hostname for the backup 'hostname'.
HOSTNAME=$(hostname)

Remote Server Copy

You must create an SSH key pair and copy it to the remote server, if the remote server copy is configured. This will enable the Tmedia to copy the backup files to the remote host without asking for a password:

Connect to the Tmedia using SSH as root

Create Tmedia public/private dsa key pair

ssh-keygen -t rsa

Note: Do not add a pass phrase, simply press enter until the key pair is generate.

Append the content of the public key to the remote host authorized keys

Tmedia public key location

/root/.ssh/id_rsa.pub

Remote Host authorized keys location

~/.ssh/authorized_keys

More details here: Password-less SSH

Troubleshooting

1.Manually run the script

/root/tbdbbackup

2.Check if the backup is locally created:

ls -alt /lib/tb/toolpack/pkg/database_backups/

3.If the remote copy is configured, make sure the file was copied on the remote server

4.To test the "LOCAL_BACKUP_MAX_DAYS" (if configured), you can perform the following:

run the script a few times to create multiple files
use "touch" to change the date of a file to a date older then "LOCAL_BACKUP_MAX_DAYS" days ago. For example, if "LOCAL_BACKUP_MAX_DAYS" is set to 15 days, set the date of the file as "16 days ago".

[root@TB014369]# ls -alt /lib/tb/toolpack/pkg/database_backups/
total 820
-rw-r--r--  1 root  root  206638 Jan 11 16:40 tbdbbackup_TB014369_toolpack_2_8_2017_01_11_16h40m.sql.gz
-rw-r--r--  1 root  root  206612 Jan 11 15:52 tbdbbackup_TB014369_toolpack_2_8_2017_01_11_15h52m.sql.gz

[root@TB014369 database_backups]# touch -d "16 days ago" /lib/tb/toolpack/pkg/database_backups/tbdbbackup_TB014369_toolpack_2_8_2017_01_11_16h40m.sql.gz

[root@TB014369]# ls -alt /lib/tb/toolpack/pkg/database_backups/
total 820
-rw-r--r--  1 root  root  206612 Jan 11 15:52 tbdbbackup_TB014369_toolpack_2_8_2017_01_11_15h52m.sql.gz
-rw-r--r--  1 root  root  206638 Dec 26 16:43 tbdbbackup_TB014369_toolpack_2_8_2017_01_11_16h40m.sql.gz

run the script again; the file tbdbbackup_TB014369_toolpack_2_8_2017_01_11_16h40m.sql.gz should have been removed from /lib/tb/toolpack/pkg/database_backups/

5. Look at the script log file in /lib/tb/toolpack/pkg/database_backups/tbdbbackup.log

# cat /lib/tb/toolpack/pkg/database_backups/tbdbbackup.log 
Start scheduled backup: Thu Jan 12 11:53:12 EST 2017
+ mysqldump -u tbdb -ptbdbpw --opt toolpack_2_10 > tbdbbackup_TB014369_toolpack_2_10_2017_01_12_11h53m.sql
  => OK
+ gzip -f tbdbbackup_TB014369_toolpack_2_10_2017_01_12_11h53m.sql
  => OK
+ Delete local files older then 7 days:
  Nothing to delete
Stop scheduled backup: Thu Jan 12 11:53:21 EST 2017

Schedule the Script

Modify the system crontab to execute the script.

Create or modify the crontab on the Tmedia

crontab -e

Add new line with the cron configuration

Example:

Frequency	Cron Configuration
hourly (top of the hour)	`0 * * * * /root/tbdbbackup`
daily (midnight)	`0 0 * * * /root/tbdbbackup`

@@ Line 1: / Line 1: @@
 This procedure shows how to configure a periodic database backup using a bash script (''tbdbbackup'') executed from a Tmedia host unix cron jobs. Cron allows Linux and Unix users to run commands or scripts at a given date and time.<br><br>
-= "tbdbbackup" Script =
+= Overview =
 The ''tbdbbackup'' script support the following features:
 *Backup the TMG-CONTROL configuration database into a backup file
@@ Line 12: / Line 12: @@
 **Keep M days of backup files on the remote server (using ssh) - optional
-= Get the Script =
 On latest product version, the script should be available from the ''/usr/bin''. To validate if you have the script on your Tmedia:
 *Connect to the [[Tmedia]] using SSH as root
@@ Line 18: / Line 17: @@
   /usr/bin/tbdbbackup
-If the script is not already installed, you can:<br>
+= Install =
-. Update ''tb_tools'' package on your Tmedia ('''NOTE''': this will ovewrite /usr/bin/tbcopycdr. If you customized the CDR copy script, make sure to have a copy)
+== From repository ==
+If you don't have the script already installed in /usr/bin, you can update the ''tb_tools'' package on your Tmedia. This will install the /usr/bin/tbdbbackup. <br>
+'''NOTE''': this will ovewrite /usr/bin/tbcopycdr. If you previously customized the CDR copy script, make sure to make a copy before updating.
   yum update tb_tools
-. Or get the script directly from the latest ''tb_tools'' rpm package
+== Manually ==
+If you don't have access to the repository from the Tmedia.
+. Get the script from either:
+*Download the latest ''tb_tools'' rpm package from TelcoBridges repository (http://repo.telcobridges.com/centos/7/os/x86_64/Packages/) and decompress it to get the script (see [http://www.e7z.org/open-rpm.htm How to Extract a RPM]<br>
+Example for linux:
   mkdir tb_tools
   cd tb_tools
@@ Line 28: / Line 33: @@
   rpm2cpio tb_tools-1.2-30.el7.tb.noarch.rpm | cpio -idmv
-. Or get it here: [[Media:tbdbbackup|tbdbbackup [click to download]]]
+*Get it here: [[Media:tbdbbackup|tbdbbackup [click to download]]]
-= Configure the Script =
+. Copy the scrips to Tmedia (using a sftp client)
-. Copy the script to /root
+*Copy ''tbdbbackup'' and ''tbtoolpackenv'' to /usr/bin on your [[Tmedia]]
-'''Note''': You must copy the script to another location to avoid loosing your configurations when upgrading your host (yum update).
+*Connect to the [[Tmedia]] using SSH as root and make ''tbdbbackup'' script executable
-  cp /usr/bin/tbdbbackup /root/tbdbbackup
+ chmod +x /usr/bin/tbdbbackup
-  chmod +x /root/tbdbbackup
-. Edit the script file:
+= Configuration =
-  vim /root/tbdbbackup
+The script is configured with '''user variables'''.
+*''CONFIG_FILE'': Configuration file name and location. By default, it is set to /root/tbdbbackup.cfg.
+ CONFIG_FILE=/root/tbdbbackup.cfg
+''tbdbbackup.cfg'' file example:
+  LOCAL_BACKUP_MAX_DAYS="1"
+ REMOTE_BACKUP_MAX_DAYS="1"
+ REMOTE_HOST=192.168.101.170
+ REMOTE_PORT=22
+ REMOTE_DIR="/root/backup_test"
+ REMOTE_USER=root
+The configuration file can redefine any of the following user variables.
+To see the default variables:
+ head -n 45 /usr/bin/tbdbbackup
-. Configure the following variables:
 *''LOCAL_BACKUP_MAX_DAYS'' : Keep the local backup files for that number of days. Set to 7 days by default.
-  # Add '#' in front of the line to disable the local backup file cleanup
+ # Comment to deactivate local backup file cleanup
-  #LOCAL_BACKUP_MAX_DAYS="7"
+ LOCAL_BACKUP_MAX_DAYS="7"
 *''REMOTE_BACKUP_MAX_DAYS'' :  Keep the local backup files for that number of days. Set to 7 days by default.
-  # Add '#' in front of the line to disable the remote backup file cleanup
+ # Comment to deactivate remote backup file cleanup, REMOTE_HOST must configured
-  #LOCAL_BACKUP_MAX_DAYS="7"
+ REMOTE_BACKUP_MAX_DAYS="7"
-*''REMOTE_HOST'' : Remote host name or Ip address.
+*''REMOTE_HOST'' : Remote host name or Ip address. Remote host copy is deactivated by default.
-  # Add '#' in front of the line to disable the remote copy
+ # Uncomment the following line to activate remote copy
-  #REMOTE_HOST = 10.10.10.10
+ #REMOTE_HOST=10.10.10.10
-*''REMOTE_PORT'' : Remote host name or Ip address
+*''REMOTE_PORT'' : Remote host ssh port.
-*''REMOTE_DIR'' : Remote host directory where the backup files will be copied
+ REMOTE_PORT=22
-*''REMOTE_USER'' : Remote host user
+*''REMOTE_DIR'' : Remote directory where to copy the backup files (/root/backup by default)
+ REMOTE_DIR="/root/backup"
+*''REMOTE_USER'' : Remote host login user.
+ REMOTE_USER=root
+*''CONNECT_TIMEOUT'' : ''scp'' connection timeout
+ CONNECT_TIMEOUT=10
+*''HOSTNAME'' : Configure backup file <hostname> name part.
+ # By default take the Tmedia hostname for the backup 'hostname'.
+ HOSTNAME=$(hostname)
-= Create an SSH Key =
+= Remote Server Copy =
 You must create an SSH key pair and copy it to the remote server, if the remote server copy is configured. This will enable the [[Tmedia]] to copy the backup files to the remote host without asking for a password:
@@ Line 70: / Line 96: @@
 More details here: [[Password_less_ssh|Password-less SSH]]
-= Test your Script =
+= Troubleshooting =
-.Manually run the script/;
+.Manually run the script
   /root/tbdbbackup
@@ Line 79: / Line 105: @@
 .If the remote copy is configured, make sure the file was copied on the remote server
-.Test "LOCAL_BACKUP_MAX_DAYS" (if configured):
+.To test the "LOCAL_BACKUP_MAX_DAYS" (if configured), you can perform the following:
 *run the script a few times to create multiple files
 *use "touch" to change the date of a file to a date older then "LOCAL_BACKUP_MAX_DAYS" days ago. For example, if "LOCAL_BACKUP_MAX_DAYS" is set to 15 days, set the date of the file as "16 days ago".
@@ Line 96: / Line 122: @@
 *run the script again; the file ''tbdbbackup_TB014369_toolpack_2_8_2017_01_11_16h40m.sql.gz'' should have been removed from ''/lib/tb/toolpack/pkg/database_backups/''
-= Schedule the Script in a Cron Job =
+. Look at the script log file in /lib/tb/toolpack/pkg/database_backups/tbdbbackup.log
-*Create a new crontab on the [[Tmedia]]
+ # cat /lib/tb/toolpack/pkg/database_backups/tbdbbackup.log
+ Start scheduled backup: Thu Jan 12 11:53:12 EST 2017
+ + mysqldump -u tbdb -ptbdbpw --opt toolpack_2_10 > tbdbbackup_TB014369_toolpack_2_10_2017_01_12_11h53m.sql
+   => OK
+ + gzip -f tbdbbackup_TB014369_toolpack_2_10_2017_01_12_11h53m.sql
+   => OK
+ + Delete local files older then 7 days:
+   Nothing to delete
+ Stop scheduled backup: Thu Jan 12 11:53:21 EST 2017
+= Schedule the Script =
+Modify the system crontab to execute the script.
+*Create or modify the crontab on the [[Tmedia]]
   crontab -e
 *Add new line with the cron configuration

Scheduled Database Backup

Revision as of 14:56, 12 January 2017

Contents

Overview

Install

From repository

Manually

Configuration

Remote Server Copy

Troubleshooting

Schedule the Script

Views

Personal tools

Navigation

Search

Toolbox