306 lines
14 KiB
Bash
Executable File
306 lines
14 KiB
Bash
Executable File
#!/bin/bash -
|
|
# Author: Colin Johnson / colin@cloudavail.com
|
|
# Date: 2013-02-17
|
|
# Version 0.9 Beta
|
|
# License Type: GNU GENERAL PUBLIC LICENSE, Version 3
|
|
#
|
|
#confirms that executables required for succesful script execution are available
|
|
prerequisite_check()
|
|
{
|
|
check_values=$1
|
|
|
|
if [[ -z $check_values ]]
|
|
then
|
|
check_values='ec2-create-snapshot ec2-create-tags ec2-describe-snapshots ec2-delete-snapshot date'
|
|
fi
|
|
|
|
for prerequisite in basename $check_values
|
|
do
|
|
#use of "hash" chosen as it is a shell builtin and will add programs to hash table, possibly speeding execution. Use of type also considered - open to suggestions.
|
|
hash $prerequisite &> /dev/null
|
|
if [[ $? == 1 ]] #has exits with exit status of 70, executable was not found
|
|
then echo "In order to use `basename $0`, the executable \"$prerequisite\" must be installed." 1>&2 ; exit 70
|
|
fi
|
|
done
|
|
}
|
|
|
|
#get_EBS_List gets a list of available EBS instances depending upon the selection_method of EBS selection that is provided by user input
|
|
get_EBS_List()
|
|
{
|
|
case $selection_method in
|
|
volumeid)
|
|
if [[ -z $volumeid ]]
|
|
then echo "The selection method \"volumeid\" (which is $app_name's default selection_method of operation or requested by using the -s volumeid parameter) requires a volumeid (-v volumeid) for operation. Correct usage is as follows: \"-v vol-6d6a0527\",\"-s volumeid -v vol-6d6a0527\" or \"-v \"vol-6d6a0527 vol-636a0112\"\" if multiple volumes are to be selected." 1>&2 ; exit 64
|
|
fi
|
|
ebs_selection_string="$volumeid"
|
|
;;
|
|
tag)
|
|
if [[ -z $tag ]]
|
|
then echo "The selected selection_method \"tag\" (-s tag) requires a valid tag (-t key=value) for operation. Correct usage is as follows: \"-s tag -t backup=true\" or \"-s tag -t Name=my_tag.\"" 1>&2 ; exit 64
|
|
fi
|
|
ebs_selection_string="--filter tag:$tag"
|
|
;;
|
|
regioncopy)
|
|
if [[ -z $region_copy_destinations ]]
|
|
then echo "The selected selection_method \"regioncopy\" (-s regioncopy) requires valid region names (-d '[region name(s)]') or 'all' for operation. Correct usage is as follows: \"-s regioncopy -d 'us-west-1'\" or \"-s regioncopy -d 'us-west-1 us-west-2'.\"" 1>&2 ; exit 64
|
|
fi
|
|
;;
|
|
*) echo "If you specify a selection_method (-s selection_method) for selecting EBS volumes you must select either \"volumeid\" (-s volumeid) or \"tag\" (-s tag)." 1>&2 ; exit 64 ;;
|
|
esac
|
|
|
|
if [[ -n $ebs_selection_string ]]
|
|
then
|
|
#creates a list of all ebs volumes that match the selection string from above
|
|
ebs_backup_list_complete=`ec2-describe-volumes --show-empty-fields --region $region $ebs_selection_string 2>&1`
|
|
#takes the output of the previous command
|
|
ebs_backup_list_result=`echo $?`
|
|
if [[ $ebs_backup_list_result -gt 0 ]]
|
|
then echo -e "An error occured when running ec2-describe-volumes. The error returned is below:\n$ebs_backup_list_complete" 1>&2 ; exit 70
|
|
fi
|
|
ebs_backup_list=`echo "$ebs_backup_list_complete" | grep ^VOLUME | cut -f 2`
|
|
#code to right will output list of EBS volumes to be backed up: echo -e "Now outputting ebs_backup_list:\n$ebs_backup_list"
|
|
fi
|
|
}
|
|
|
|
create_EBS_Snapshot_Tags()
|
|
{
|
|
echo "create_EBS_Snapshot_Tags region_copy_scheduled_destinations=$region_copy_scheduled_destinations"
|
|
|
|
#snapshot tags holds all tags that need to be applied to a given snapshot - by aggregating tags we ensure that ec2-create-tags is called only onece
|
|
snapshot_tags=""
|
|
#if $name_tag_create is true then append ec2ab_${ebs_selected}_$current_date to the variable $snapshot_tags
|
|
if $name_tag_create
|
|
then
|
|
ec2_snapshot_resource_id=`echo "$ec2_create_snapshot_result" | cut -f 2`
|
|
snapshot_tags="$snapshot_tags --tag Name=ec2ab_${ebs_selected}_$current_date"
|
|
fi
|
|
#if $purge_after_date_fe is true, then append $purge_after_date_fe to the variable $snapshot_tags
|
|
if [[ -n $purge_after_date_fe ]]
|
|
then
|
|
snapshot_tags="$snapshot_tags --tag PurgeAfterFE=$purge_after_date_fe --tag PurgeAllow=true"
|
|
fi
|
|
|
|
#if $user_tags is true, then append Volume=$ebs_selected and Created=$current_date to the variable $snapshot_tags
|
|
if $user_tags
|
|
then
|
|
snapshot_tags="$snapshot_tags --tag Volume=${ebs_selected} --tag Created=$current_date"
|
|
fi
|
|
|
|
#if $name_tag_create is true then append RegionCopy=[region]:scheduled,[region]:scheduled to the variable $snapshot_tags
|
|
if [[ -n $region_copy_scheduled_destinations ]]
|
|
then
|
|
ec2_snapshot_resource_id=`echo "$ec2_create_snapshot_result" | cut -f 2`
|
|
regions=$(echo $region_copy_scheduled_destinations | sed 's/ */:scheduled,/g')
|
|
snapshot_tags="$snapshot_tags --tag RegionCopy=${regions}:scheduled"
|
|
echo "tagging $ec2_snapshot_resource_id with $snapshot_tags"
|
|
fi
|
|
|
|
#if $snapshot_tags is not zero length then set the tag on the snapshot using ec2-create-tags
|
|
if [[ -n $snapshot_tags ]]
|
|
then echo "Tagging Snapshot $ec2_snapshot_resource_id with the following Tags:"
|
|
ec2-create-tags $ec2_snapshot_resource_id --region $region $snapshot_tags
|
|
fi
|
|
}
|
|
|
|
get_date_binary()
|
|
{
|
|
#`uname -o (operating system) would be ideal, but OS X / Darwin does not support to -o option`
|
|
#`uname` on OS X defaults to `uname -s` and `uname` on GNU/Linux defaults to `uname -s`
|
|
uname_result=`uname`
|
|
case $uname_result in
|
|
Darwin) date_binary="osx-posix" ;;
|
|
Linux) date_binary="linux-gnu" ;;
|
|
*) date_binary="unknown" ;;
|
|
esac
|
|
}
|
|
|
|
get_purge_after_date_fe()
|
|
{
|
|
case $purge_after_input in
|
|
#any number of numbers followed by a letter "d" or "days" multiplied by 86400 (number of seconds in a day)
|
|
[0-9]*d) purge_after_value_seconds=$(( ${purge_after_input%?} * 86400 )) ;;
|
|
#any number of numbers followed by a letter "h" or "hours" multiplied by 3600 (number of seconds in an hour)
|
|
[0-9]*h) purge_after_value_seconds=$(( ${purge_after_input%?} * 3600 )) ;;
|
|
#any number of numbers followed by a letter "m" or "minutes" multiplied by 60 (number of seconds in a minute)
|
|
[0-9]*m) purge_after_value_seconds=$(( ${purge_after_input%?} * 60 ));;
|
|
#no trailing digits default is days - multiply by 86400 (number of minutes in a day)
|
|
*) purge_after_value_seconds=$(( $purge_after_input * 86400 ));;
|
|
esac
|
|
#based on the date_binary variable, the case statement below will determine the method to use to determine "purge_after_days" in the future
|
|
case $date_binary in
|
|
linux-gnu) echo `date -d +${purge_after_value_seconds}sec -u +%s` ;;
|
|
osx-posix) echo `date -v +${purge_after_value_seconds}S -u +%s` ;;
|
|
*) echo `date -d +${purge_after_value_seconds}sec -u +%s` ;;
|
|
esac
|
|
}
|
|
|
|
purge_EBS_Snapshots()
|
|
{
|
|
#snapshot_tag_list is a string that contains all snapshots with either the key PurgeAllow or PurgeAfterFE set
|
|
snapshot_tag_list=`ec2-describe-tags --show-empty-fields --region $region --filter resource-type=snapshot --filter key=PurgeAllow,PurgeAfterFE`
|
|
#snapshot_purge_allowed is a list of all snapshot_ids with PurgeAllow=true
|
|
snapshot_purge_allowed=`echo "$snapshot_tag_list" | grep .*PurgeAllow'\s'true | cut -f 3`
|
|
|
|
for snapshot_id_evaluated in $snapshot_purge_allowed
|
|
do
|
|
#gets the "PurgeAfterFE" date which is in UTC with UNIX Time format (or xxxxxxxxxx / %s)
|
|
purge_after_date_fe_tag=`echo "$snapshot_tag_list" | grep .*$snapshot_id_evaluated'\s'PurgeAfterFE.* | cut -f 5`
|
|
#if purge_after_date is not set then we have a problem. Need to alert user.
|
|
if [[ -z $purge_after_date_fe_tag ]]
|
|
#Alerts user to the fact that a Snapshot was found with PurgeAllow=true but with no PurgeAfterFE date.
|
|
then echo "A Snapshot with the Snapshot ID $snapshot_id_evaluated has the tag \"PurgeAllow=true\" but does not have a \"PurgeAfterFE=xxxxxxxxxx\" date where PurgeAfterFE is UNIX time. $app_name is unable to determine if $snapshot_id_evaluated should be purged." 1>&2
|
|
else
|
|
#perform comparison - if $purge_after_date_epoch is a lower number than $current_date_epoch than the PurgeAfterFE date is earlier than the current date - and the snapshot can be safely removed
|
|
if [[ $purge_after_date_fe_tag < $current_date ]]
|
|
then
|
|
echo "The snapshot \"$snapshot_id_evaluated\" with the PurgeAfterFE date of $purge_after_date_fe_tag will be deleted."
|
|
ec2-delete-snapshot --region $region $snapshot_id_evaluated
|
|
fi
|
|
fi
|
|
done
|
|
}
|
|
|
|
region_copy_EBS_Snapshots()
|
|
{
|
|
#snapshots_to_region_copy is a list of all snapshot_ids with RegionCopy=.*:scheduled.*
|
|
# tr and $'n' substitution used so $IFS doesn't have to be
|
|
# manipulated with for loops and the cut command
|
|
snapshot_tag_list=$(ec2-describe-tags --show-empty-fields --region $region --filter resource-type=snapshot --filter key=RegionCopy | grep ':scheduled' | cut -f3,5- | tr '[\t ]' '~')
|
|
|
|
for snapshot_data in $(echo ${snapshot_tag_list//$'\n'/ } | cut -f1-)
|
|
do
|
|
snapshot_id=$(echo $snapshot_data | cut -d'~' -f1)
|
|
regions=$(echo $snapshot_data | cut -d'~' -f2-)
|
|
original_regions=$regions
|
|
region_copy_tag=''
|
|
for region_data in ${regions//,/ }
|
|
do
|
|
destination_region=$(echo $region_data | cut -d: -f1)
|
|
status=$(echo $region_data | cut -d: -f2-)
|
|
region_copy_tag_append="$destination_region:$status"
|
|
if [[ "$region_copy_destinations" = "all" || -n $(echo "$region_copy_destinations"| grep $destination_region) ]]
|
|
then
|
|
current_datetime=$(date +%Y-%m-%d_%H:%M:%S)
|
|
if [ "$status" = "scheduled" ]
|
|
then
|
|
ec2_copy_snapshot_complete=$(ec2-copy-snapshot -r $region -s $snapshot_id --region $destination_region)
|
|
ec2_copy_snapshot_result=`echo $?`
|
|
if [[ $ec2_copy_snapshot_result -gt 0 ]]
|
|
then
|
|
echo -e "An error occured when running ec2-copy-snapshot. The error returned is below:\n$ec2_copy_snapshot_complete" 1>&2 ; exit 70
|
|
else
|
|
region_copy_tag_append="$destination_region:$current_datetime"
|
|
echo "The snapshot \"$snapshot_id\" is being copied to $destination_region."
|
|
fi
|
|
fi
|
|
fi
|
|
region_copy_tag="${region_copy_tag},$region_copy_tag_append"
|
|
done
|
|
|
|
if [[ "${region_copy_tag#,}" != "$original_regions" ]]
|
|
then
|
|
ec2-create-tags $snapshot_id --region $region --tag RegionCopy=${region_copy_tag#,}
|
|
fi
|
|
done
|
|
}
|
|
|
|
app_name=`basename $0`
|
|
|
|
#sets defaults
|
|
selection_method="volumeid"
|
|
|
|
#date_binary allows a user to set the "date" binary that is installed on their system and, therefore, the options that will be given to the date binary to perform date calculations
|
|
date_binary=""
|
|
|
|
#sets the "Name" tag set for a snapshot to false - using "Name" requires that ec2-create-tags be called in addition to ec2-create-snapshot
|
|
name_tag_create=false
|
|
#sets the user_tags feature to false - user_tag creates tags on snapshots - by default each snapshot is tagged with volume_id and current_data timestamp
|
|
user_tags=false
|
|
#sets the Purge Snapshot feature to false - this feature will eventually allow the removal of snapshots that have a "PurgeAfterFE" tag that is earlier than current date
|
|
purge_snapshots=false
|
|
#handles options processing
|
|
while getopts :s:c:r:v:t:k:g:d:l:pnu opt
|
|
do
|
|
case $opt in
|
|
s) selection_method="$OPTARG";;
|
|
c) cron_primer="$OPTARG";;
|
|
r) region="$OPTARG";;
|
|
v) volumeid="$OPTARG";;
|
|
t) tag="$OPTARG";;
|
|
k) purge_after_input="$OPTARG";;
|
|
g) region_copy_scheduled_destinations="$OPTARG";;
|
|
d) region_copy_destinations="$OPTARG";;
|
|
n) name_tag_create=true;;
|
|
p) purge_snapshots=true;;
|
|
u) user_tags=true;;
|
|
*) echo "Error with Options Input. Cause of failure is most likely that an unsupported parameter was passed or a parameter was passed without a corresponding option." 1>&2 ; exit 64;;
|
|
esac
|
|
done
|
|
|
|
#sources "cron_primer" file for running under cron or other restricted environments - this file should contain the variables and environment configuration required for ec2-automate-backup to run correctly
|
|
if [[ -n $cron_primer ]]
|
|
then if [[ -f $cron_primer ]]
|
|
then source $cron_primer
|
|
else
|
|
echo "Cron Primer File \"$cron_primer\" Could Not Be Found." 1>&2 ; exit 70
|
|
fi
|
|
fi
|
|
|
|
#if region is not set then:
|
|
if [[ -z $region ]]
|
|
#if the environment variable $EC2_REGION is not set set to us-east-1
|
|
then if [[ -z $EC2_REGION ]]
|
|
#if both
|
|
then region="us-east-1"
|
|
else
|
|
region=$EC2_REGION
|
|
fi
|
|
fi
|
|
|
|
#calls prerequisitecheck function to ensure that all executables required for script execution are available
|
|
prerequisite_check
|
|
|
|
#sets date variable
|
|
current_date=`date -u +%s`
|
|
|
|
#sets the PurgeAfterFE tag to the number of seconds that a snapshot should be retained
|
|
if [[ -n $purge_after_input ]]
|
|
then
|
|
#if the date_binary is not set, call the get_date_binary function
|
|
if [[ -z $date_binary ]]
|
|
then get_date_binary
|
|
fi
|
|
purge_after_date_fe=`get_purge_after_date_fe`
|
|
echo "Snapshots taken by $app_name will be eligible for purging after the following date (the purge after date given in seconds from epoch): $purge_after_date_fe."
|
|
fi
|
|
|
|
#get_EBS_List gets a list of EBS instances for which a snapshot is desired. The list of EBS instances depends upon the selection_method that is provided by user input
|
|
get_EBS_List
|
|
|
|
#the loop below is called once for each volume in $ebs_backup_list - the currently selected EBS volume is passed in as "ebs_selected"
|
|
for ebs_selected in $ebs_backup_list
|
|
do
|
|
ec2_snapshot_description="ec2ab_${ebs_selected}_$current_date"
|
|
ec2_create_snapshot_result=`ec2-create-snapshot --region $region -d $ec2_snapshot_description $ebs_selected 2>&1`
|
|
if [[ $? != 0 ]]
|
|
then echo -e "An error occured when running ec2-create-snapshot. The error returned is below:\n$ec2_create_snapshot_result" 1>&2 ; exit 70
|
|
else
|
|
ec2_snapshot_resource_id=`echo "$ec2_create_snapshot_result" | cut -f 2`
|
|
fi
|
|
create_EBS_Snapshot_Tags
|
|
done
|
|
|
|
#if purge_snapshots is true, then run purge_EBS_Snapshots function
|
|
if $purge_snapshots
|
|
then echo "Snapshot Purging is Starting Now."
|
|
purge_EBS_Snapshots
|
|
fi
|
|
|
|
#if region_copy_destinations is true, then run region_copy_EBS_Snapshots function
|
|
if [[ -n $region_copy_destinations ]]
|
|
then echo "Snapshot Copying to regions $region_copy_destinations is Starting Now."
|
|
prerequisite_check ec2-copy-snapshot
|
|
region_copy_EBS_Snapshots
|
|
fi
|
|
|