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

resolve issue with passed volume ids failing to parse, modify tag input to work with aws cli tool, use --output text to parse text instead of json when parsing output of aws cli commands

Browse Source
This commit is contained in:
Colin Johnson 2014-03-02 18:47:30 +00:00
parent b9e4240646
commit eca59ba434
3 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
aws-missing-tools-resources/QA/ec2-automate-backup/ec2-automate-backup-Test-Plan.txt
View File

@ -1,4 +1,4 @@
ec2ab_exec=/Temp/aws-missing-tools/ec2-automate-backup/ec2-automate-backup.sh ec2ab_exec=/Temp/aws-missing-tools/ec2-automate-backup/ec2-automate-backup-awscli.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`
@ -9,6 +9,8 @@ volume_2_id=`echo "$volume_2" | cut -f 2`
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
$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"

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

@ -1,14 +1,15 @@
#!/bin/bash - #!/bin/bash -
# Author: Colin Johnson / colin@cloudavail.com # Author: Colin Johnson / colin@cloudavail.com
# Date: 2013-02-13 # Contributors: buckelij / https://github.com/buckelij
# Version 0.9 # Date: 2014-03-02
# Version 0.1
# License Type: GNU GENERAL PUBLIC LICENSE, Version 3 # License Type: GNU GENERAL PUBLIC LICENSE, Version 3
# #
#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 for prerequisite in basename aws date cut
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
@ -26,36 +27,35 @@ get_EBS_List()
if [[ -z $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 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 fi
ebs_selection_string="$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 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 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
ebs_selection_string="--filter $tag" ebs_selection_string="--filters Name=tag:$tag"
;; ;;
*) 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 ;; *) 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 esac
#creates a list of all ebs volumes that match the selection string from above #creates a list of all ebs volumes that match the selection string from above
ebs_backup_list_complete=`aws ec2 describe-volumes --region $region $ebs_selection_string 2>&1` ebs_backup_list_complete=`aws ec2 describe-volumes --region $region $ebs_selection_string --output text`
#takes the output of the previous command #takes the output of the previous command
ebs_backup_list_result=`echo $?` ebs_backup_list_result=`echo $?`
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
ebs_backup_list=`echo "$ebs_backup_list_complete" | grep '"VolumeId": ' | awk '{ print $2 }' | tr -d '",' | sort | uniq` #returns the list of EBS volumes that matched ebs_selection_string. grep ^VOLUMES is to remove lines that begin "TAGS Backup"
echo $ebs_backup_list 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" #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="--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}_$date_current to the variable $snapshot_tags
if $name_tag_create if $name_tag_create
then then
ec2_snapshot_resource_id=`echo "$ec2_create_snapshot_result" | grep SnapshotId | awk '{ print $2 }' | tr -d '",'`
snapshot_tags="$snapshot_tags Key=Name,Value=ec2ab_${ebs_selected}_$date_current" snapshot_tags="$snapshot_tags Key=Name,Value=ec2ab_${ebs_selected}_$date_current"
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
@ -77,8 +77,9 @@ 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"
aws ec2 create-tags --resources $ec2_snapshot_resource_id --region $region $snapshot_tags tags_arugment="--tags $snapshot_tags"
aws_ec2_create_tag_result=`aws ec2 create-tags --resources $ec2_snapshot_resource_id --region $region $tags_arugment 2>&1`
fi fi
} }
@ -154,13 +155,10 @@ purge_EBS_Snapshots()
} }
app_name=`basename $0` app_name=`basename $0`
#sets defaults #sets defaults
selection_method="volumeid" 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 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="" 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 #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 name_tag_create=false
#sets the "InitiatingHost" tag set for a snapshot to false #sets the "InitiatingHost" tag set for a snapshot to false
@ -170,6 +168,7 @@ 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 - this feature will eventually allow the removal of snapshots that have a "PurgeAfter" tag that is earlier than current date
purge_snapshots=false purge_snapshots=false
#handles options processing #handles options processing
while getopts :s:c:r:v:t:k:pnhu opt while getopts :s:c:r:v:t:k:pnhu opt
do do
case $opt in case $opt in
@ -230,11 +229,11 @@ get_EBS_List
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}_$date_current"
ec2_create_snapshot_result=`aws ec2 create-snapshot --region $region --description $ec2_snapshot_description --volume-id $ebs_selected 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
else else
ec2_snapshot_resource_id=`echo "$ec2_create_snapshot_result" | grep SnapshotId | awk '{ print $2 }' | tr -d '",'` ec2_snapshot_resource_id=`echo "$ec2_create_snapshot_result" | cut -f 3`
fi fi
create_EBS_Snapshot_Tags create_EBS_Snapshot_Tags
done done

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

@ -53,6 +53,7 @@ create_EBS_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}_$date_current 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` ec2_snapshot_resource_id=`echo "$ec2_create_snapshot_result" | cut -f 2`
snapshot_tags="$snapshot_tags --tag Name=ec2ab_${ebs_selected}_$date_current" snapshot_tags="$snapshot_tags --tag Name=ec2ab_${ebs_selected}_$date_current"
fi fi
@ -152,13 +153,10 @@ purge_EBS_Snapshots()
} }
app_name=`basename $0` app_name=`basename $0`
#sets defaults #sets defaults
selection_method="volumeid" 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 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="" 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 #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 name_tag_create=false
#sets the "InitiatingHost" tag set for a snapshot to false #sets the "InitiatingHost" tag set for a snapshot to false
@ -168,6 +166,7 @@ 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 - this feature will eventually allow the removal of snapshots that have a "PurgeAfter" tag that is earlier than current date
purge_snapshots=false purge_snapshots=false
#handles options processing #handles options processing
while getopts :s:c:r:v:t:k:pnhu opt while getopts :s:c:r:v:t:k:pnhu opt
do do
case $opt in case $opt in