will/aws-missing-tools
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

move to unix time for ec2-automate-backup-awscli.sh

Browse Source
This commit is contained in:
Colin Johnson 2014-04-12 23:06:26 +00:00
parent 00a9a05085
commit 9479e6390c
3 changed files with 97 additions and 87 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
ec2-automate-backup/Beta/ec2-automate-backup-Test-Plan.txt → ec2-automate-backup/Resources/ec2ab-test-plan.txt
View File

@ -1,52 +1,59 @@
ec2ab_exec="/Temp/ec2-automate-backup.sh" ec2ab_exec="/Temp/ec2-automate-backup.sh"
#create two volumes #create two volumes
volume_1=`ec2-create-volume --size 2 GB --availability-zone us-east-1a` volume_1=`ec2-create-volume --size 2 GB --availability-zone us-east-1a`
volume_2=`ec2-create-volume --size 2 GB --availability-zone us-east-1a` volume_2=`ec2-create-volume --size 2 GB --availability-zone us-east-1a`
#get volume id of both volumes #get volume id of both volumes
volume_1_id=`echo "$volume_1" | cut -f 2` volume_1_id=`echo "$volume_1" | cut -f 2`
volume_2_id=`echo "$volume_2" | cut -f 2` volume_2_id=`echo "$volume_2" | cut -f 2`
#tag volume_1 with Backup=true #tag volume_1 with Backup=true
ec2-create-tags $volume_1_id --tag Backup=true ec2-create-tags $volume_1_id --tag Backup=true
#test backing up only volume with tag Backup=true #test backing up only volume with tag Backup=true
# if testing ec2-automate-backup.sh
$ec2ab_exec -s tag -t Backup=true $ec2ab_exec -s tag -t Backup=true
# if testing ec2-automate-backup-awscli.sh
$ec2ab_exec -s tag -t Backup,Values=true
#expected result - snapshot only taken of volume_1 #expected result - snapshot only taken of volume_1
#
#test backing up only EBS volume with IDs "x" and "y" #test backing up only EBS volume with IDs "x" and "y"
$ec2ab_exec -v "$volume_1_id $volume_2_id" $ec2ab_exec -v "$volume_1_id $volume_2_id"
#expected result - snapshot only taken of volume_1 and volume_2 #expected result - snapshot only taken of volume_1 and volume_2
#
#test backing up only EBS volume with IDs "x" and "y" and tagging them with "name" #test backing up only EBS volume with IDs "x" and "y" and tagging them with "name"
$ec2ab_exec -v "$volume_1_id $volume_2_id" -n $ec2ab_exec -v "$volume_1_id $volume_2_id" -n
#expected result - snapshot only taken of volume_1 and volume_2 each with tag "name" set to ec2ab_$volume_id_$current_date #expected result - snapshot only taken of volume_1 and volume_2 each with tag "name" set to ec2ab_$volume_id_$current_date
#
#test backing up only EBS volume with IDs "x" and "y" and tagging them with "user tags" #test backing up only EBS volume with IDs "x" and "y" and tagging them with "user tags"
$ec2ab_exec -v "$volume_1_id $volume_2_id" -u $ec2ab_exec -v "$volume_1_id $volume_2_id" -u
#expected result - snapshot only taken of volume_1 and volume_2 each with tag "user tags" set to Volume=$ebs_selected and Created=$current_date #expected result - snapshot only taken of volume_1 and volume_2 each with tag "user tags" set to Volume=$ebs_selected and Created=$current_date
#
#test backing up only EBS volume with IDs "x" and "y" and tagging them with a tag "PurgeAfterFE=$current_date+604800" #test backing up only EBS volume with IDs "x" and "y" and tagging them with a tag "PurgeAfterFE=$current_date+604800"
$ec2ab_exec -v "$volume_1_id $volume_2_id" -k 7 $ec2ab_exec -v "$volume_1_id $volume_2_id" -k 7
echo "PurgeAfterFE=`date -v +604800S -u +%s`" echo "PurgeAfterFE=`date -v +604800S -u +%s`"
echo "PurgeAfterFE=`date -d +604800sec -u +%s`" echo "PurgeAfterFE=`date -d +604800sec -u +%s`"
#expected result - snapshot taken of volume_1 and volume_2 each with tags "PurgeAfterFE=$current_date+604800" and "PurgeAllow=true" #expected result - snapshot taken of volume_1 and volume_2 each with tags "PurgeAfterFE=$current_date+604800" and "PurgeAllow=true"
#
#test backing up only EBS volume with IDs "x" and "y" and tagging them with a tag "PurgeAfterFE=$current_date+604800" #test backing up only EBS volume with IDs "x" and "y" and tagging them with a tag "PurgeAfterFE=$current_date+604800"
$ec2ab_exec -v "$volume_1_id $volume_2_id" -k 7 -n $ec2ab_exec -v "$volume_1_id $volume_2_id" -k 7 -n
echo "PurgeAfterFE=`date -v+604800S -u +%s`" echo "PurgeAfterFE=`date -v+604800S -u +%s`"
echo "PurgeAfterFE=`date -d +604800sec -u +%s`" echo "PurgeAfterFE=`date -d +604800sec -u +%s`"
#expected result - snapshot taken of volume_1 and volume_2 each with tag "name" set to ec2ab_$volume_id_$date_current a with a tag "PurgeAfterFE=$current_date+604800" #expected result - snapshot taken of volume_1 and volume_2 each with tag "name" set to ec2ab_$volume_id_$date_current a with a tag "PurgeAfterFE=$current_date+604800"
#
#test backing up only EBS volume with IDs "x" and "y" and tagging them with a tag "PurgeAfterFE=$current_date+3600" #test backing up only EBS volume with IDs "x" and "y" and tagging them with a tag "PurgeAfterFE=$current_date+3600"
$ec2ab_exec -v "$volume_1_id $volume_2_id" -k 1h -n $ec2ab_exec -v "$volume_1_id $volume_2_id" -k 1h -n
echo "PurgeAfterFE=`date -v+3600S -u +%s`" echo "PurgeAfterFE=`date -v+3600S -u +%s`"
echo "PurgeAfterFE=`date -d +3600sec -u +%s`" echo "PurgeAfterFE=`date -d +3600sec -u +%s`"
#expected result - snapshot taken of volume_1 and volume_2 each with tag "name" set to ec2ab_$volume_id_$date_current a with a tag "PurgeAfterFE=$current_date+3600" #expected result - snapshot taken of volume_1 and volume_2 each with tag "name" set to ec2ab_$volume_id_$date_current a with a tag "PurgeAfterFE=$current_date+3600"
#
#test backing up only EBS volume with IDs "x" and "y" and tagging them with a tag "PurgeAfterFE=$current_date+3600" #test backing up only EBS volume with IDs "x" and "y" and tagging them with a tag "PurgeAfterFE=$current_date+3600"
$ec2ab_exec -v "$volume_1_id $volume_2_id" -k 30m -n $ec2ab_exec -v "$volume_1_id $volume_2_id" -k 30m -n
echo "PurgeAfterFE=`date -v+1800S -u +%s`" echo "PurgeAfterFE=`date -v+1800S -u +%s`"
echo "PurgeAfterFE=`date -d +1800sec -u +%s`" echo "PurgeAfterFE=`date -d +1800sec -u +%s`"
#expected result - snapshot taken of volume_1 and volume_2 each with tag "name" set to ec2ab_$volume_id_$date_current a with a tag "PurgeAfterFE=$current_date+3600" #expected result - snapshot taken of volume_1 and volume_2 each with tag "name" set to ec2ab_$volume_id_$date_current a with a tag "PurgeAfterFE=$current_date+3600"
#
#test backing up only EBS volume with IDs "x" and "y" and tagging them with a tag "PurgeAfterFE=$current_date+60" and purging snapshots #test backing up only EBS volume with IDs "x" and "y" and tagging them with a tag "PurgeAfterFE=$current_date+60" and purging snapshots
$ec2ab_exec -v "$volume_1_id $volume_2_id" -k 1m -n -p $ec2ab_exec -v "$volume_1_id $volume_2_id" -k 1m -n -p
echo "PurgeAfterFE=`date -v+60S -u +%s`" echo "PurgeAfterFE=`date -v+60S -u +%s`"

128
ec2-automate-backup/ec2-automate-backup-awscli.sh
View File

@ -1,15 +1,22 @@
#!/bin/bash - #!/bin/bash -
# Author: Colin Johnson / colin@cloudavail.com
# Contributors: buckelij / https://github.com/buckelij
# Date: 2014-04-12 # Date: 2014-04-12
# Version 0.9 # Version 0.10
# License Type: GNU GENERAL PUBLIC LICENSE, Version 3 # License Type: GNU GENERAL PUBLIC LICENSE, Version 3
# # Author:
# Colin Johnson / https://github.com/colinbjohnson / colin@cloudavail.com
# Contributors:
# Alex Corley / https://github.com/anthroprose
# Jon Higgs / https://github.com/jonhiggs
# Mike / https://github.com/eyesis
# Jeff Vogt / https://github.com/jvogt
# Dave Stern / https://github.com/davestern
# Josef / https://github.com/J0s3f
# buckelij / https://github.com/buckelij
#confirms that executables required for succesful script execution are available #confirms that executables required for succesful script execution are available
prerequisite_check() prerequisite_check()
{ {
for prerequisite in basename aws date cut for prerequisite in basename cut date aws
do 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. #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 hash $prerequisite &> /dev/null
@ -29,7 +36,7 @@ get_EBS_List()
fi fi
ebs_selection_string="--volume-ids $volumeid" ebs_selection_string="--volume-ids $volumeid"
;; ;;
tag) tag)
if [[ -z $tag ]] if [[ -z $tag ]]
then echo "The selected selection_method \"tag\" (-s tag) requires a valid tag (-t Backup,Values=true) for operation. Correct usage is as follows: \"-s tag -t Backup,Values=true.\"" 1>&2 ; exit 64 then echo "The selected selection_method \"tag\" (-s tag) requires a valid tag (-t Backup,Values=true) for operation. Correct usage is as follows: \"-s tag -t Backup,Values=true.\"" 1>&2 ; exit 64
fi fi
@ -46,36 +53,35 @@ get_EBS_List()
fi fi
#returns the list of EBS volumes that matched ebs_selection_string. grep ^VOLUMES is to remove lines that begin "TAGS Backup" #returns the list of EBS volumes that matched ebs_selection_string. grep ^VOLUMES is to remove lines that begin "TAGS Backup"
ebs_backup_list=`echo "$ebs_backup_list_complete" | grep ^VOLUMES | cut -f 7` ebs_backup_list=`echo "$ebs_backup_list_complete" | grep ^VOLUMES | cut -f 7`
#code to right will output list of EBS volumes to be backed up: echo -e "Now outputting ebs_backup_list:\n$ebs_backup_list"
} }
create_EBS_Snapshot_Tags() create_EBS_Snapshot_Tags()
{ {
#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 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="" snapshot_tags=""
#if $name_tag_create is true then append ec2ab_${ebs_selected}_$date_current to the variable $snapshot_tags #if $name_tag_create is true then append ec2ab_${ebs_selected}_$current_date to the variable $snapshot_tags
if $name_tag_create if $name_tag_create
then then
snapshot_tags="$snapshot_tags Key=Name,Value=ec2ab_${ebs_selected}_$date_current" snapshot_tags="$snapshot_tags Key=Name,Value=ec2ab_${ebs_selected}_$current_date"
fi fi
#if $hostname_tag_create is true then append --tag InitiatingHost=`hostname -f` to the variable $snapshot_tags #if $hostname_tag_create is true then append --tag InitiatingHost=`hostname -f` to the variable $snapshot_tags
if $hostname_tag_create if $hostname_tag_create
then then
snapshot_tags="$snapshot_tags Key=InitiatingHost,Value='`hostname -f`'" snapshot_tags="$snapshot_tags Key=InitiatingHost,Value='`hostname -f`'"
fi fi
#if $purge_after_days is true, then append $purge_after_date to the variable $snapshot_tags #if $purge_after_date_fe is true, then append $purge_after_date_fe to the variable $snapshot_tags
if [[ -n $purge_after_days ]] if [[ -n $purge_after_date_fe ]]
then then
snapshot_tags="$snapshot_tags Key=PurgeAfter,Value=$purge_after_date Key=PurgeAllow,Value=true" snapshot_tags="$snapshot_tags Key=PurgeAfterFE,Value=$purge_after_date_fe Key=PurgeAllow,Value=true"
fi fi
#if $user_tags is true, then append Volume=$ebs_selected and Created=$current_date to the variable $snapshot_tags #if $user_tags is true, then append Volume=$ebs_selected and Created=$current_date to the variable $snapshot_tags
if $user_tags if $user_tags
then then
snapshot_tags="$snapshot_tags Key=Volume,Value=${ebs_selected} Key=Created,Value=$date_current" snapshot_tags="$snapshot_tags Key=Volume,Value=${ebs_selected} Key=Created,Value=$current_date"
fi fi
#if $snapshot_tags is not zero length then set the tag on the snapshot using ec2-create-tags #if $snapshot_tags is not zero length then set the tag on the snapshot using aws ec2 create-tags
if [[ -n $snapshot_tags ]] if [[ -n $snapshot_tags ]]
then echo "Tagging Snapshot $ec2_snapshot_resource_id with the following Tags: $snapshot_tags" then echo "Tagging Snapshot $ec2_snapshot_resource_id with the following Tags: $snapshot_tags"
tags_arugment="--tags $snapshot_tags" tags_arugment="--tags $snapshot_tags"
@ -83,7 +89,7 @@ create_EBS_Snapshot_Tags()
fi fi
} }
date_binary_get() get_date_binary()
{ {
#`uname -o (operating system) would be ideal, but OS X / Darwin does not support to -o option` #`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` on OS X defaults to `uname -s` and `uname` on GNU/Linux defaults to `uname -s`
@ -95,59 +101,50 @@ date_binary_get()
esac esac
} }
get_purge_after_date() 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 #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 case $date_binary in
linux-gnu) echo `date -d +${purge_after_days}days -u +%Y-%m-%d` ;; linux-gnu) echo `date -d +${purge_after_value_seconds}sec -u +%s` ;;
osx-posix) echo `date -v+${purge_after_days}d -u +%Y-%m-%d` ;; osx-posix) echo `date -v +${purge_after_value_seconds}S -u +%s` ;;
*) echo `date -d +${purge_after_days}days -u +%Y-%m-%d` ;; *) echo `date -d +${purge_after_value_seconds}sec -u +%s` ;;
esac
}
get_purge_after_date_epoch()
{
#based on the date_binary variable, the case statement below will determine the method to use to determine "purge_after_date_epoch" in the future
case $date_binary in
linux-gnu) echo `date -d $purge_after_date +%s` ;;
osx-posix) echo `date -j -f "%Y-%m-%d" $purge_after_date "+%s"` ;;
*) echo `date -d $purge_after_date +%s` ;;
esac
}
get_date_current_epoch()
{
#based on the date_binary variable, the case statement below will determine the method to use to determine "date_current_epoch" in the future
case $date_binary in
linux-gnu) echo `date -d $date_current +%s` ;;
osx-posix) echo `date -j -f "%Y-%m-%d" $date_current "+%s"` ;;
*) echo `date -d $date_current +%s` ;;
esac esac
} }
purge_EBS_Snapshots() purge_EBS_Snapshots()
{ {
#snapshot_tag_list is a string that contains all snapshots with either the key PurgeAllow set to true. grep ^SNAPSHOTS filters not needed return values # snapshot_tag_list is a string containing any snapshot that contains a tag
# with the key value/pair PurgeAllow=true
snapshot_tag_list=`aws ec2 describe-snapshots --region $region --filters Name=tag:PurgeAllow,Values=true --output text | grep ^SNAPSHOTS` snapshot_tag_list=`aws ec2 describe-snapshots --region $region --filters Name=tag:PurgeAllow,Values=true --output text | grep ^SNAPSHOTS`
#snapshot_purge_allowed is a list of all snapshot_ids with PurgeAllow=true # snapshot_purge_allowed is a string containing Snapshot IDs that are
# allowed to be purged
snapshot_purge_allowed=`echo "$snapshot_tag_list" | cut -f 5` snapshot_purge_allowed=`echo "$snapshot_tag_list" | cut -f 5`
for snapshot_id_evaluated in $snapshot_purge_allowed for snapshot_id_evaluated in $snapshot_purge_allowed
do do
#gets the "PurgeAfter" date which is in UTC with YYYY-MM-DD format (or %Y-%m-%d) #gets the "PurgeAfterFE" date which is in UTC with UNIX Time format (or xxxxxxxxxx / %s)
purge_after_date=`aws ec2 describe-snapshots --region $region --snapshot-ids $snapshot_id_evaluated --output text | grep ^TAGS.*PurgeAfter | cut -f 3` purge_after_fe=`aws ec2 describe-snapshots --region $region --snapshot-ids $snapshot_id_evaluated --output text | grep ^TAGS.*PurgeAfterFE | cut -f 3`
#if purge_after_date is not set then we have a problem. Need to alert user. #if purge_after_date is not set then we have a problem. Need to alert user.
if [[ -z $purge_after_date ]] if [[ -z $purge_after_fe ]]
#Alerts user to the fact that a Snapshot was found with PurgeAllow=true but with no PurgeAfter date. #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 \"PurgeAfter=YYYY-MM-DD\" date. $app_name is unable to determine if $snapshot_id_evaluated should be purged." 1>&2 then echo "A Snapshot with the Snapshot ID $snapshot_id_evaluated has the tag \"PurgeAllow=true\" but does not have a \"PurgeAfterFE=xxxxxxxxxx\" key/value pair. $app_name is unable to determine if $snapshot_id_evaluated should be purged." 1>&2
else else
#convert both the date_current and purge_after_date into epoch time to allow for comparison # if $purge_after_fe is less than $current_date then
date_current_epoch=`get_date_current_epoch` # PurgeAfterFE is earlier than the current date
purge_after_date_epoch=`get_purge_after_date_epoch` # and the snapshot can be safely purged
#perform compparison - if $purge_after_date_epoch is a lower number than $date_current_epoch than the PurgeAfter date is earlier than the current date - and the snapshot can be safely removed if [[ $purge_after_fe < $current_date ]]
if [[ $purge_after_date_epoch < $date_current_epoch ]]
then then
echo "The snapshot \"$snapshot_id_evaluated\" with the Purge After date of $purge_after_date will be deleted." echo "The snapshot \"$snapshot_id_evaluated\" with the PurgeAfterFE date of $purge_after_fe will be deleted."
aws_ec2_delete_snapshot_result=`aws ec2 delete-snapshot --region $region --snapshot-id $snapshot_id_evaluated --output text 2>&1` aws_ec2_delete_snapshot_result=`aws ec2 delete-snapshot --region $region --snapshot-id $snapshot_id_evaluated --output text 2>&1`
fi fi
fi fi
@ -163,9 +160,9 @@ date_binary=""
name_tag_create=false name_tag_create=false
#sets the "InitiatingHost" tag set for a snapshot to false #sets the "InitiatingHost" tag set for a snapshot to false
hostname_tag_create=false hostname_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 #sets the user_tags feature to false - user_tag creates tags on snapshots - by default each snapshot is tagged with volume_id and current_date timestamp
user_tags=false user_tags=false
#sets the Purge Snapshot feature to false - this feature will eventually allow the removal of snapshots that have a "PurgeAfter" tag that is earlier than current date #sets the Purge Snapshot feature to false - if purge_snapshots=true then snapshots will be purged
purge_snapshots=false purge_snapshots=false
#handles options processing #handles options processing
@ -177,7 +174,7 @@ while getopts :s:c:r:v:t:k:pnhu opt
r) region="$OPTARG";; r) region="$OPTARG";;
v) volumeid="$OPTARG";; v) volumeid="$OPTARG";;
t) tag="$OPTARG";; t) tag="$OPTARG";;
k) purge_after_days="$OPTARG";; k) purge_after_input="$OPTARG";;
n) name_tag_create=true;; n) name_tag_create=true;;
h) hostname_tag_create=true;; h) hostname_tag_create=true;;
p) purge_snapshots=true;; p) purge_snapshots=true;;
@ -188,7 +185,7 @@ while getopts :s:c:r:v:t:k:pnhu opt
#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 #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 ]] if [[ -n $cron_primer ]]
then if [[ -f $cron_primer ]] then if [[ -f $cron_primer ]]
then source $cron_primer then source $cron_primer
else else
echo "Cron Primer File \"$cron_primer\" Could Not Be Found." 1>&2 ; exit 70 echo "Cron Primer File \"$cron_primer\" Could Not Be Found." 1>&2 ; exit 70
@ -199,7 +196,7 @@ fi
if [[ -z $region ]] if [[ -z $region ]]
#if the environment variable $EC2_REGION is not set set to us-east-1 #if the environment variable $EC2_REGION is not set set to us-east-1
then if [[ -z $EC2_REGION ]] then if [[ -z $EC2_REGION ]]
#if both #if both
then region="us-east-1" then region="us-east-1"
else else
region=$EC2_REGION region=$EC2_REGION
@ -210,16 +207,17 @@ fi
prerequisite_check prerequisite_check
#sets date variable #sets date variable
date_current=`date -u +%Y-%m-%d` current_date=`date -u +%s`
#sets the PurgeAfter tag to the number of days that a snapshot should be retained
if [[ -n $purge_after_days ]] #sets the PurgeAfterFE tag to the number of seconds that a snapshot should be retained
if [[ -n $purge_after_input ]]
then then
#if the date_binary is not set, call the date_binary_get function #if the date_binary is not set, call the get_date_binary function
if [[ -z $date_binary ]] if [[ -z $date_binary ]]
then date_binary_get then get_date_binary
fi fi
purge_after_date=`get_purge_after_date` purge_after_date_fe=`get_purge_after_date_fe`
echo "Snapshots taken by $app_name will be eligible for purging after the following date: $purge_after_date." 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 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 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
@ -228,7 +226,7 @@ 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" #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 for ebs_selected in $ebs_backup_list
do do
ec2_snapshot_description="ec2ab_${ebs_selected}_$date_current" ec2_snapshot_description="ec2ab_${ebs_selected}_$current_date"
ec2_create_snapshot_result=`aws ec2 create-snapshot --region $region --description $ec2_snapshot_description --volume-id $ebs_selected --output text 2>&1` ec2_create_snapshot_result=`aws ec2 create-snapshot --region $region --description $ec2_snapshot_description --volume-id $ebs_selected --output text 2>&1`
if [[ $? != 0 ]] 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 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

33
ec2-automate-backup/ec2-automate-backup.sh
View File

@ -16,7 +16,7 @@
#confirms that executables required for succesful script execution are available #confirms that executables required for succesful script execution are available
prerequisite_check() prerequisite_check()
{ {
for prerequisite in basename ec2-create-snapshot ec2-create-tags ec2-describe-snapshots ec2-delete-snapshot date for prerequisite in basename cut date ec2-create-snapshot ec2-create-tags ec2-delete-snapshot ec2-describe-snapshots
do 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. #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 hash $prerequisite &> /dev/null
@ -51,6 +51,7 @@ get_EBS_List()
if [[ $ebs_backup_list_result -gt 0 ]] 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 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 fi
#returns the list of EBS volumes that matched ebs_selection_string.
ebs_backup_list=`echo "$ebs_backup_list_complete" | grep ^VOLUME | cut -f 2` ebs_backup_list=`echo "$ebs_backup_list_complete" | grep ^VOLUME | cut -f 2`
} }
@ -61,8 +62,6 @@ create_EBS_Snapshot_Tags()
#if $name_tag_create is true then append ec2ab_${ebs_selected}_$current_date to the variable $snapshot_tags #if $name_tag_create is true then append ec2ab_${ebs_selected}_$current_date to the variable $snapshot_tags
if $name_tag_create if $name_tag_create
then then
# possible duplicate code ec2_snapshot_resource_id=`echo "$ec2_create_snapshot_result" | cut -f 2`
ec2_snapshot_resource_id=`echo "$ec2_create_snapshot_result" | cut -f 2`
snapshot_tags="$snapshot_tags --tag Name=ec2ab_${ebs_selected}_$current_date" snapshot_tags="$snapshot_tags --tag Name=ec2ab_${ebs_selected}_$current_date"
fi fi
#if $hostname_tag_create is true then append --tag InitiatingHost=`hostname -f` to the variable $snapshot_tags #if $hostname_tag_create is true then append --tag InitiatingHost=`hostname -f` to the variable $snapshot_tags
@ -84,7 +83,7 @@ create_EBS_Snapshot_Tags()
#if $snapshot_tags is not zero length then set the tag on the snapshot using ec2-create-tags #if $snapshot_tags is not zero length then set the tag on the snapshot using ec2-create-tags
if [[ -n $snapshot_tags ]] if [[ -n $snapshot_tags ]]
then echo "Tagging Snapshot $ec2_snapshot_resource_id with the following Tags:" then echo "Tagging Snapshot $ec2_snapshot_resource_id with the following Tags: $snapshot_tags"
ec2-create-tags $ec2_snapshot_resource_id --region $region $snapshot_tags ec2-create-tags $ec2_snapshot_resource_id --region $region $snapshot_tags
fi fi
} }
@ -123,24 +122,30 @@ esac
purge_EBS_Snapshots() purge_EBS_Snapshots()
{ {
#snapshot_tag_list is a string that contains all snapshots with either the key PurgeAllow or PurgeAfterFE set # snapshot_tag_list is a string containing any snapshot that contains
# either the key PurgeAllow or the key PurgeAfterFE
# note that filtering for *both* keys is a requirement or else the
# PurgeAfterFE key/value pair will not be returned
snapshot_tag_list=`ec2-describe-tags --show-empty-fields --region $region --filter resource-type=snapshot --filter key=PurgeAllow,PurgeAfterFE` 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 is a string containing Snapshot IDs that are
# allowed to be purged
snapshot_purge_allowed=`echo "$snapshot_tag_list" | grep .*PurgeAllow'\s'true | cut -f 3` snapshot_purge_allowed=`echo "$snapshot_tag_list" | grep .*PurgeAllow'\s'true | cut -f 3`
for snapshot_id_evaluated in $snapshot_purge_allowed for snapshot_id_evaluated in $snapshot_purge_allowed
do do
#gets the "PurgeAfterFE" date which is in UTC with UNIX Time format (or xxxxxxxxxx / %s) #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` purge_after_fe=`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 purge_after_date is not set then we have a problem. Need to alert user.
if [[ -z $purge_after_date_fe_tag ]] if [[ -z $purge_after_fe ]]
#Alerts user to the fact that a Snapshot was found with PurgeAllow=true but with no PurgeAfterFE date. #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 then echo "A Snapshot with the Snapshot ID $snapshot_id_evaluated has the tag \"PurgeAllow=true\" but does not have a \"PurgeAfterFE=xxxxxxxxxx\" key/value pair. $app_name is unable to determine if $snapshot_id_evaluated should be purged." 1>&2
else 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_fe is less than $current_date then
if [[ $purge_after_date_fe_tag < $current_date ]] # PurgeAfterFE is earlier than the current date
# and the snapshot can be safely purged
if [[ $purge_after_fe < $current_date ]]
then then
echo "The snapshot \"$snapshot_id_evaluated\" with the PurgeAfterFE date of $purge_after_date_fe_tag will be deleted." echo "Snapshot \"$snapshot_id_evaluated\" with the PurgeAfterFE date of $purge_after_fe will be deleted."
ec2-delete-snapshot --region $region $snapshot_id_evaluated ec2-delete-snapshot --region $region $snapshot_id_evaluated
fi fi
fi fi
@ -158,7 +163,7 @@ name_tag_create=false
hostname_tag_create=false hostname_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_date timestamp #sets the user_tags feature to false - user_tag creates tags on snapshots - by default each snapshot is tagged with volume_id and current_date timestamp
user_tags=false 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 #sets the Purge Snapshot feature to false - if purge_snapshots=true then snapshots will be purged
purge_snapshots=false purge_snapshots=false
#handles options processing #handles options processing
@ -236,4 +241,4 @@ done
if $purge_snapshots if $purge_snapshots
then echo "Snapshot Purging is Starting Now." then echo "Snapshot Purging is Starting Now."
purge_EBS_Snapshots purge_EBS_Snapshots
fi fi