wilddog64 / my-pythonlib

Dreambox Python Library

This python library provide a common python functionality across Dreambox Corp. Currently, the library provide a limit support for AWS through awscli command line utility.

dreambox.aws.core

This is the core library one that provide for various aws functions within dreambox.aws namespace. The library currently provide the following functions:

aws_cmd

This is the most fundamental function in dreambox.aws namespace. All other aws related functions are wrapper around it. The function call the aws command line tool via python subprocess library and return result as a json object.

The function accepts the following parameters,

• cmd_cat: accept a valid aws commands. For aws support commands refer to aws help for more detail information. This is a require parameter.
• profile: a profile define in ~/.aws/config. For how to setup ~/.aws configuration file, refer to this document for more information. This is an optional parameter. If no value is provided, the default value is dreambox.
• region: this will accept a valid region present in AWS service. It is an optional. If no value provide, the default value will be us-east-1
• subcmd: a valid sub-command for a given aws command. Refer to AWS Command Line Interface for detail. This is a require parameter.
• **options: any valid option for a given aws command sub-command .... Refer to AWS Command Line Interface

note: in python, this mean it will take a list of key/value pair as a function parameters. See example below for what it means.

Upon the success call, the function will return a json object back to caller. It is up to calling function how to parse the object to provide usable information.

function usages

• aws_cmd(cmd_cat='autoscaling', profile='dreambox', subcmd='describe-auto-scaling-groups', query='...')
• aws_cmd(cmd_cat='autoscaling', subcmd='describe-auto-scaling-groups', query='...')

will tranfer into this

aws --profile dreambox --region us-east-1 autoscaling describe-auto-scaling-group --query ...

• aws_cmd(cmd_cat='ec2', subcmd='describe-instances', instance_ids='...', query='...')

will be transfer to this

aws --profile dreambox --region us-east-1 ec2 describe-instances --instance-ids ... --query ...

_note: '-' in the instance-id will crash with python keyword (as this is a minus sign), so we have to replace it with '_'. The function will replace it back with '-'. _

aws_ec2cmd

This function will execute aws ec2 command category. This function calls aws_cmd internally. It accepts the following parameters:

• profile: a profile define in ~/.aws/config. For how to setup ~/.aws configuration file, refer to this document for more information. This is an optional parameter. If no value is provided, the default value is dreambox.
• region: this will accept a valid region present in AWS service. It is an optional. If no value provide, the default value will be us-east-1
• subcmd: a valid sub-command for a given aws command. Refer to AWS Command Line Interface for detail. This is a require parameter.
• **options: any valid option for a given aws command sub-command .... Refer to AWS Command Line Interface

function usages

• aws_ec2cmd(ec2profile='dreambox', ec2region='us-east-1', subcmd='describe-instances')
• aws_ec2cmd('dreambox', 'us-east-1', 'describe-instances')

The above functions call will transfer into this,

aws --profile dreambox --region us-east-1 describe-instances

• aws_ec2cmd('dreambox', 'us-east-1', 'describe-instances', instance_id='...', query='...')

The above function call will transfer into this,

aws --profile dreambox --region us-east-1 describe-instances --instance-id ... --query ...

aws_asgcmd

This function takes in charge of executing aws autoscaling command groups. The function accepts the following parameters,

• profile: a profile define in ~/.aws/config. For how to setup ~/.aws configuration file, refer to this document for more information. This is an optional parameter. If no value is provided, the default value is dreambox.
• region: this will accept a valid region present in AWS service. It is an optional. If no value provide, the default value will be us-east-1
• subcmd: a valid sub-command for aws autoscaling. Refer to AWS Command Line Interface for detail. This is a require parameter.
• **options: any valid option for a given aws command sub-command .... Refer to AWS Command Line Interface

function usages

• aws_asgcmd(ec2profile='dreambox', ec2region='us-east-1', 'describe-auto-scaling-groups')
• aws_asgcmd('dreambox', 'us-east-1', 'describe-auto-scaling-groups')

The above function statements will transfer into this,

aws --profile dreambox --region us-east-1 describe-auto-scaling-groups

• aws_asgcmd('dreambox', 'us-east-1', 'describe-auto-scaling-groups' query='...')

The above function statement will transfer into this,

aws --profile dreambox --region us-east-1 describe-auto-scaling-groups

dreambox.ops.deployment

This namespace provides functionality to manage AWS Auto Scaling Group. It provides the following functions. It dpends on the dreambox.aws.core for some basic operations.

get_all_asgs

This function return all the auto scaling groups define in a given aws region. The function accepts the following parameters:

• profile: a profile define in ~/.aws/config. For how to setup ~/.aws configuration file, refer to this document for more information. This is an optional parameter. If no value is provided, the default value is dreambox.
• region: this will accept a valid region present in AWS service. It is an optional. If no value provide, the default value will be us-east-1
• **options: any valid option for a given aws command sub-command ....

function usages

• get_all_asgs(ec2profile='dreambox', ec2region='us-east-1')

The above call will transfer to this aws command,

aws --profile dreambox --region us-east-1 autoscaling auto-scaling-groups

• get_all_asgs(query='...')

The above call will transfer into,

aws --profile dreambox --region us-east-1 autoscaling auto-scaling-groups --query '...'

• get_only_play_asgs(query='...')

The above call will translate into this,

aws --profile dreambox --region us-east-1 autoscaling auto-scaling-group --query '...'

get_ec2_instances_hostnames_from_asg_groups

This function will take a list of asg groups and find the corresponding PublicDnsName, and Tag: Key=Name, Value back to the caller. The function accepts these parameters,

• profile: a profile define in ~/.aws/config. For how to setup ~/.aws configuration file, refer to this document for more information. This is an optional parameter. If no value is provided, the default value is dreambox.
• region: this will accept a valid region present in AWS service. It is an optional. If no value provide, the default value will be us-east-1

function usages

asg_query='AutoScalingGroups[*].[Tags[?Key==`Name`].Value,Instances[].InstanceId][]'
result = get_only_play_asgs(query=asg_query)
get_ec2_instances_hostnames_from_asg_groups(asg_group=result)

The get_ec2_instances_hostnames_from_asg_groups will need an asg group to feed with.

dreambox.utils

This namespace provides a set of handy functions

make_hash_of_hashes

This function accept a list of even number elements and turn them into a hash of hashes. The function takes one parameter,

• my_list: a python list object

Upon a successful call, a hash object will return

function usage

result = dreambox.utils.make_hash_of_hashes(my_list)

result is a hash with hashes object

Package Structure

├── README.md
├── dreambox
│   ├── __init__.py
│   ├── aws
│   │   ├── __init__.py
│   │   ├── asg.py
│   │   ├── autoscaling.py
│   │   ├── cfn.py
│   │   ├── cfn_common.py
│   │   ├── cloudformation.py
│   │   ├── core.py
│   │   ├── ec2.py
│   │   ├── s3.py
│   │   └── security.py
│   ├── etc
│   │   └── conf.yml
│   ├── git
│   │   ├── __init__.py
│   │   ├── client.py
│   │   └── core.py
│   ├── json
│   │   ├── __init__.py
│   │   ├── chef_env.py
│   │   └── core.py
│   ├── ops
│   │   ├── __init__.py
│   │   ├── aws_common.py
│   │   ├── common.py
│   │   ├── deployment.py
│   │   ├── fabfile.py
│   │   └── git_client.py
│   └── utils.py
├── ops
├── setup.py