Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add backup space checks #84

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add backup space checks #84

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 45 additions & 3 deletions VmBackup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@
DEFAULT_MAX_BACKUPS = 4
DEFAULT_VDI_EXPORT_FORMAT = 'raw' # xe vdi-export options: 'raw' or 'vhd'
DEFAULT_BACKUP_DIR = '/snapshots/BACKUPS'
DEFAULT_SPACE_THRESHOLD = 20
## DEFAULT_BACKUP_DIR = '\snapshots\BACKUPS' # alt for CIFS mounts
# note - some NAS file servers may fail with ':', so change to your desired format
BACKUP_DIR_PATTERN = '%s/backup-%04d-%02d-%02d-(%02d:%02d:%02d)'
Expand All @@ -91,7 +92,7 @@

config = {}
all_vms = []
expected_keys = ['pool_db_backup', 'max_backups', 'backup_dir', 'status_log', 'vdi_export_format', 'vm-export', 'vdi-export', 'exclude']
expected_keys = ['pool_db_backup', 'max_backups', 'backup_dir', 'status_log', 'vdi_export_format', 'vm-export', 'vdi-export', 'exclude', 'space_threshold']
message = ''
xe_path = '/opt/xensource/bin'

Expand Down Expand Up @@ -190,6 +191,19 @@ def main(session):
error_cnt += 1
# next vm
continue

# Check remaining disk space for backup directory against threshold
log('Checking backup space')
backup_space_remaining = get_remaining_space(config['backup_dir'])
log('Backup space remaining: {}%'.format(backup_space_remaining))
if backup_space_remaining < config['space_threshold']:
log('ERROR Space remaining below threshold {}'.format(backup_space_remaining))
log('Skipping further backups...')
if config_specified:
status_log_vdi_export_end(server_name, 'ERROR Space remaining below threshold {}'.format(backup_space_remaining))
error_cnt += 1
# Skip further backups
break

# -----------------------------------------
# --- begin vdi-export command sequence ---
Expand Down Expand Up @@ -319,7 +333,7 @@ def main(session):
beginTime = datetime.datetime.now()
this_status = 'success'

# get values from vdi-export=
# get values from vm-export=
vm_name = get_vm_name(vm_parm)
vm_max_backups = get_vm_max_backups(vm_parm)
log('vm-export - vm_name: %s max_backups: %s' % (vm_name, vm_max_backups))
Expand Down Expand Up @@ -357,6 +371,19 @@ def main(session):
error_cnt += 1
# next vm
continue

# Check remaining disk space for backup directory against threshold
log('Checking backup space')
backup_space_remaining = get_remaining_space(config['backup_dir'])
log('Backup space remaining: {}%'.format(backup_space_remaining))
if backup_space_remaining < config['space_threshold']:
log('ERROR Space remaining below threshold {}'.format(backup_space_remaining))
log('Skipping further backups...')
if config_specified:
status_log_vm_export_end(server_name, 'ERROR Space remaining below threshold {}'.format(backup_space_remaining))
error_cnt += 1
# Skip further backups
break

# ----------------------------------------
# --- begin vm-export command sequence ---
Expand Down Expand Up @@ -507,6 +534,18 @@ def isInt(s):
except ValueError:
return False

def get_remaining_space(filesystem):
cmd = '/bin/df --output=pcent {}'.format(filesystem)
fs_info = run_get_lastline(cmd)
try:
output = fs_info.lstrip()[:-1]
percent_used = int(output)
except ValueError as e:
log('ERROR Unexpectedly returned non-integer; defaulting to 100%')
percent_used = int(100)
percent_remaining = 100 - percent_used
return percent_remaining

def get_vm_max_backups(vm_parm):
# get max_backups from optional vm-export=VM-NAME:MAX-BACKUP override
# NOTE - if not present then return config['max_backups']
Expand Down Expand Up @@ -981,7 +1020,7 @@ def save_to_config_exclude( key, vm_name):
global warning_match
global error_regex
found_match = False
# Fail fast if exclude param given but empty to prevent from exluding all VMs
# Fail fast if exclude param given but empty to prevent from excluding all VMs
if vm_name == "":
return
if not isNormalVmName(vm_name) and not isRegExValid( vm_name):
Expand Down Expand Up @@ -1172,10 +1211,13 @@ def config_load_defaults():
config['backup_dir'] = str(DEFAULT_BACKUP_DIR)
if not 'status_log' in config.keys():
config['status_log'] = str(DEFAULT_STATUS_LOG)
if not 'space_threshold' in config.keys():
config['space_threshold'] = str(DEFAULT_SPACE_THRESHOLD)

def config_print():
log('VmBackup.py running with these settings:')
log(' backup_dir = %s' % config['backup_dir'])
log(' space_threshold = {}'.format(config['space_threshold']))
log(' status_log = %s' % config['status_log'])
log(' compress = %s' % compress)
log(' max_backups = %s' % config['max_backups'])
Expand Down
3 changes: 3 additions & 0 deletions example.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ max_backups=3
#Backup Directory path (script default /snapshots/BACKUPS)
backup_dir=/path/to/backupspace

# Backup space remaining threshold before further backups are halted (script default 20)
space_threshold=20

# applicable if vdi-export is used
# vdi_export_format either raw or vhd (script default to raw)
vdi_export_format=raw
Expand Down