Skip to content

Added settings profile option, addressed #48 #62

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

Open
gboell wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Added settings profile option, addressed #48 #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4d21bf9
Addressed #48
Aug 4, 2014
7a0abf0
Moved the README.md -o settings line
Aug 4, 2014
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
4 changes: 4 additions & 0 deletions ec2-automate-backup/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,10 @@ The script ec2-automate-backup-awscli.sh is a version of ec2-automate-backup.sh

The parameters are the same as ec2-automate-backup.sh with the exception of the tag filter, which must use the aws cli format.

You can also specify the settings profile if you don't want to use the default one.

`-o <profile>` - the settings profile to use.

## Example of use:

ec2-automate-backup-awscli.sh -r us-east-1 -s tag -t 'Backup,Values=true' -k 31 -p -n
Expand Down
25 changes: 15 additions & 10 deletions ec2-automate-backup/ec2-automate-backup-awscli.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ get_EBS_List() {
*) 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
#creates a list of all ebs volumes that match the selection string from above
ebs_backup_list=$(aws ec2 describe-volumes --region $region $ebs_selection_string --output text --query 'Volumes[*].VolumeId')
ebs_backup_list=$(aws --profile $profile ec2 describe-volumes $region_param $ebs_selection_string --output text --query 'Volumes[*].VolumeId')
#takes the output of the previous command
ebs_backup_list_result=$(echo $?)
if [[ $ebs_backup_list_result -gt 0 ]]; then
Expand Down Expand Up @@ -73,7 +73,7 @@ create_EBS_Snapshot_Tags() {
if [[ -n $snapshot_tags ]]; then
echo "Tagging Snapshot $ec2_snapshot_resource_id with the following Tags: $snapshot_tags"
tags_argument="--tags $snapshot_tags"
aws_ec2_create_tag_result=$(aws ec2 create-tags --resources $ec2_snapshot_resource_id --region $region $tags_argument --output text 2>&1)
aws_ec2_create_tag_result=$(aws --profile $profile ec2 create-tags --resources $ec2_snapshot_resource_id $region_param $tags_argument --output text 2>&1)
fi
}

Expand Down Expand Up @@ -110,11 +110,11 @@ esac
purge_EBS_Snapshots() {
# snapshot_purge_allowed is a string containing the SnapshotIDs of snapshots
# that contain a tag with the key value/pair PurgeAllow=true
snapshot_purge_allowed=$(aws ec2 describe-snapshots --region $region --filters Name=tag:PurgeAllow,Values=true --output text --query 'Snapshots[*].SnapshotId')
snapshot_purge_allowed=$(aws --profile $profile ec2 describe-snapshots $region_param --filters Name=tag:PurgeAllow,Values=true --output text --query 'Snapshots[*].SnapshotId')

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_fe=$(aws ec2 describe-snapshots --region $region --snapshot-ids $snapshot_id_evaluated --output text | grep ^TAGS.*PurgeAfterFE | cut -f 3)
purge_after_fe=$(aws --profile $profile ec2 describe-snapshots $region_param --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 [[ -z $purge_after_fe ]]; then
#Alerts user to the fact that a Snapshot was found with PurgeAllow=true but with no PurgeAfterFE date.
Expand All @@ -125,14 +125,15 @@ purge_EBS_Snapshots() {
# and the snapshot can be safely purged
if [[ $purge_after_fe < $current_date ]]; then
echo "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 --profile $profile ec2 delete-snapshot $region_param --snapshot-id $snapshot_id_evaluated --output text 2>&1)
fi
fi
done
}

app_name=$(basename $0)
#sets defaults
profile=default
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=""
Expand All @@ -146,8 +147,9 @@ user_tags=false
purge_snapshots=false
#handles options processing

while getopts :s:c:r:v:t:k:pnhu opt; do
while getopts :o:s:c:r:v:t:k:pnhu opt; do
case $opt in
o) profile="$OPTARG" ;;
s) selection_method="$OPTARG" ;;
c) cron_primer="$OPTARG" ;;
r) region="$OPTARG" ;;
Expand All @@ -173,12 +175,15 @@ fi

#if region is not set then:
if [[ -z $region ]]; then
#if the environment variable $EC2_REGION is not set set to us-east-1
#if the environment variable $EC2_REGION is not set, do not specify it so it uses the config file region
if [[ -z $EC2_REGION ]]; then
region="us-east-1"
region_param=""
else
region=$EC2_REGION
region_param="--region $EC2_REGION"
fi
#if it is set, we use it as is
else
region_param="--region $region"
fi

#calls prerequisitecheck function to ensure that all executables required for script execution are available
Expand All @@ -203,7 +208,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"
for ebs_selected in $ebs_backup_list; do
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 --profile $profile ec2 create-snapshot $region_param --description $ec2_snapshot_description --volume-id $ebs_selected --output text 2>&1)
if [[ $? != 0 ]]; then
echo -e "An error occurred when running ec2-create-snapshot. The error returned is below:\n$ec2_create_snapshot_result" 1>&2 ; exit 70
else
Expand Down
19 changes: 11 additions & 8 deletions ec2-automate-backup/ec2-automate-backup.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ get_EBS_List() {
*) 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
#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)
ebs_backup_list_complete=$(ec2-describe-volumes --show-empty-fields $region_param $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
Expand Down Expand Up @@ -74,7 +74,7 @@ create_EBS_Snapshot_Tags() {
#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: $snapshot_tags"
ec2-create-tags $ec2_snapshot_resource_id --region $region $snapshot_tags
ec2-create-tags $ec2_snapshot_resource_id $region_param $snapshot_tags
fi
}

Expand Down Expand Up @@ -113,7 +113,7 @@ purge_EBS_Snapshots() {
# 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_param --filter resource-type=snapshot --filter key=PurgeAllow,PurgeAfterFE)
# 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)
Expand All @@ -135,7 +135,7 @@ purge_EBS_Snapshots() {
# and the snapshot can be safely purged
if [[ $purge_after_fe < $current_date ]]; then
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_param $snapshot_id_evaluated
fi
fi
done
Expand Down Expand Up @@ -183,12 +183,15 @@ fi

#if region is not set then:
if [[ -z $region ]]; then
#if the environment variable $EC2_REGION is not set set to us-east-1
#if the environment variable $EC2_REGION is not set, do not specify it so it uses the config file region
if [[ -z $EC2_REGION ]]; then
region="us-east-1"
region_param=""
else
region=$EC2_REGION
region_param="--region $EC2_REGION"
fi
#if it is set, we use it as is
else
region_param="--region $region"
fi

#calls prerequisitecheck function to ensure that all executables required for script execution are available
Expand All @@ -213,7 +216,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"
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)
ec2_create_snapshot_result=$(ec2-create-snapshot $region_param -d $ec2_snapshot_description $ebs_selected 2>&1)
if [[ $? != 0 ]]; then
echo -e "An error occurred when running ec2-create-snapshot. The error returned is below:\n$ec2_create_snapshot_result" 1>&2 ; exit 70
else
Expand Down