Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Tests for EC2 tags

Project description

EC2 Tag conditionals

CircleCI Coverage Status

This is a python library and shell command that answers the question:

"Is this instance tagged with the given tag and have a given value"

It is designed to be run on AWS's EC2 instances.

It will always fail if it's not on AWS, so tags should only be tested for truthiness, not falseness.

As a Library

from ec2_tag_conditional import InstanceTags

tags = InstanceTags()

if tags['Env'] == 'prod':
    do_prod_thing()
 else:
    do_other_thing()

As a command line script

> instance-tags "Env=prod"
> echo $?
0

> instance-tags "Madeup=NotThere"
> echo $?
1

> instance-tags "Env=prod" && do_prod_thing

Example use cases

This code was written with the following use case in mind:

You have n servers in a auto scaling group, launched from a custom AMI (golden image). The nature of the application running on the servers is that, for some functions to work (backup, reporting), a given set of tasks should only be run by one server.

This server is called a 'controller'. The script that created the ASG also tags (in the AWS metadata) one (and only one) of the servers with controller=True.

When the AMI is baked, the images don't need to know if they are a controller or not, as cron tasks can be written like:

instance-tags "controller=True" && do_controller_only

Or for controllers in production (rather than dev or staging environments):

instance-tags "controller=True" && instance-tags "Env=prod" && do_controller_only

Because the exit code of the instance-tags script is 1 if the tag with the given value isn't found on the instance, the script wont run on any server that isn't an EC2 instance with the given values.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for ec2_tag_conditional, version 0.1.2
Filename, size File type Python version Upload date Hashes
Filename, size ec2_tag_conditional-0.1.2-py3-none-any.whl (3.6 kB) File type Wheel Python version py3 Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page