class EnvironmentBuilder(object):
def __init__(self, vpc_name, config=None, region_name=None, profile_name=None, log=None):
"""
vpc_name:
The human readable Name tag of this VPC.
config:
The dict returned by botoform.config.ConfigLoader's load method.
"""
self.vpc_name = vpc_name
self.config = config if config is not None else {}
self.log = log if log is not None else Log()
self.boto = BotoConnections(region_name, profile_name)
self.reflect = False
def apply_all(self):
"""Build the environment specified in the config."""
try:
self._apply_all(self.config)
except Exception as e:
self.log.emit('Botoform failed to build environment!', 'error')
self.log.emit('Failure reason: {}'.format(e), 'error')
self.log.emit(traceback.format_exc(), 'debug')
self.log.emit('Tearing down failed environment!', 'error')
self.evpc.terminate()
raise
def _apply_all(self, config):
# Make sure amis is setup early. (TODO: raise exception if missing)
self.amis = config['amis']
# set a var for no_cfg.
no_cfg = {}
# builds the vpc.
self.build_vpc(config.get('vpc_cidr', None))
# attach EnrichedVPC to self.
self.evpc = EnrichedVPC(self.vpc_name, self.boto.region_name, self.boto.profile_name, self.log)
# attach VPN gateway to the VPC
self.attach_vpn_gateway(config.get('vpn_gateway', no_cfg))
# create and associate DHCP Options Set
self.dhcp_options(config.get('dhcp_options', no_cfg))
# the order of these method calls matters for new VPCs.
self.route_tables(config.get('route_tables', no_cfg))
self.subnets(config.get('subnets', no_cfg))
self.associate_route_tables_with_subnets(config.get('subnets', no_cfg))
self.security_groups(config.get('security_groups', no_cfg))
self.key_pairs(config.get('key_pairs', []))
self.db_instances(config.get('db_instances', no_cfg))
new_instances = self.instance_roles(
config.get('instance_roles', no_cfg)
)
# lets do more work while new_instances move from pending to running.
self.endpoints(config.get('endpoints', []))
self.security_group_rules(config.get('security_groups', no_cfg))
# lets finish building the new instances.
self.finish_instance_roles(
config.get('instance_roles', no_cfg), new_instances,
)
self.log.emit('done! don\'t you look awesome. : )')
def build_vpc(self, cidrblock):
"""Build VPC"""
self.log.emit('creating vpc ({}, {})'.format(self.vpc_name, cidrblock))
vpc = self.boto.ec2.create_vpc(CidrBlock = cidrblock)
self.log.emit('tagging vpc (Name:{})'.format(self.vpc_name), 'debug')
update_tags(vpc, Name = self.vpc_name)
self.log.emit('modifying vpc for dns support', 'debug')
vpc.modify_attribute(EnableDnsSupport={'Value': True})
self.log.emit('modifying vpc for dns hostnames', 'debug')
vpc.modify_attribute(EnableDnsHostnames={'Value': True})
igw_name = 'igw-' + self.vpc_name
self.log.emit('creating internet_gateway ({})'.format(igw_name))
gw = self.boto.ec2.create_internet_gateway()
self.log.emit('tagging gateway (Name:{})'.format(igw_name), 'debug')
update_tags(gw, Name = igw_name)
self.log.emit('attaching igw to vpc ({})'.format(igw_name))
vpc.attach_internet_gateway(
DryRun=False,
InternetGatewayId=gw.id,
VpcId=vpc.id,
)
def attach_vpn_gateway(self, vpn_gateway_cfg):
"""Attach defined VPN gateway to VPC"""
if vpn_gateway_cfg:
vgw_id = vpn_gateway_cfg.get('id', None)
if vgw_id is not None:
self.log.emit('attaching vgw ({}) to vpc ({})'.format(vgw_id, self.vpc_name))
# attach_vpn_gateway is available with ec2 client object
self.evpc.attach_vpn_gateway(vgw_id)
#self.vgw_id = vgw_id
#self.boto.ec2_client.attach_vpn_gateway(
# DryRun=False,
# VpnGatewayId = self.vgw_id,
# VpcId = self.evpc.id,
#)
## check & wait till VGW (2 min.) is attached
#count = 0
#while(not self.evpc.is_vgw_attached(vgw_id)):
# time.sleep(10)
# count += 1
# if count == 11:
# raise Exception({"message":"VPN Gateway is not yet attached.", "VGW_ID":vgw_id})
def dhcp_options(self, dhcp_options_cfg):
"""Creates DHCP Options Set and associates with VPC"""
for dhcp_name, data in dhcp_options_cfg.items():
longname = '{}-{}'.format(self.evpc.name, dhcp_name)
self.log.emit('creating DHCP Options Set {}'.format(longname))
dhcp_options_id = self.evpc.create_dhcp_options(data)
# associate DHCP Options with VPC
self.log.emit('associating DHCP Options {} ({}) with VPC {}'.format(longname, dhcp_options_id, self.vpc_name))
self.evpc.associate_dhcp_options(
DhcpOptionsId=dhcp_options_id
)
self.evpc.reload()
update_tags(self.evpc.dhcp_options, Name=longname)
def route_tables(self, route_cfg):
"""Build route_tables defined in config"""
for rt_name, data in route_cfg.items():
longname = '{}-{}'.format(self.evpc.name, rt_name)
route_table = self.evpc.get_route_table(longname)
if route_table is None:
self.log.emit('creating route_table ({})'.format(longname))
if data.get('main', False) == True:
route_table = self.evpc.get_main_route_table()
else:
route_table = self.evpc.create_route_table()
self.log.emit('tagging route_table (Name:{})'.format(longname), 'debug')
update_tags(route_table, Name = longname)
# TODO: move to separate method ...
# gatewayId, natGatewayId, networkInterfaceId,
# vpcPeeringConnectionId or instanceId
# add routes to route_table defined in configuration.
for route in data.get('routes', []):
destination, target = route
self.log.emit('adding route {} to route_table ({})'.format(route, longname))
if target.lower() == 'internet_gateway':
# TODO: ugly but we assume only one internet gateway.
route_table.create_route(
DestinationCidrBlock = destination,
GatewayId = list(self.evpc.internet_gateways.all())[0].id,
)
if target.lower() == 'vpn_gateway':
# TODO: ugly but we assume only one VPN gateway.
route_table.create_route(
DestinationCidrBlock = destination,
GatewayId = self.evpc.vgw_id,
)
# if routed to VPN gateway propagate the route.
self.boto.ec2_client.enable_vgw_route_propagation(
RouteTableId = route_table.route_table_id,
GatewayId = self.evpc.vgw_id,
)
def subnets(self, subnet_cfg):
"""Build subnets defined in config."""
sizes = sorted([x['size'] for x in subnet_cfg.values()])
cidrs = allocate(self.evpc.cidr_block, sizes)
azones = self.evpc.azones
subnets = {}
for size, cidr in zip(sizes, cidrs):
subnets.setdefault(size, []).append(cidr)
for name, sn in subnet_cfg.items():
longname = '{}-{}'.format(self.evpc.name, name)
az_letter = sn.get('availability_zone', None)
if az_letter is not None:
az_name = self.evpc.region_name + az_letter
else:
az_index = int(name.split('-')[-1]) - 1
az_name = azones[az_index]
cidr = subnets[sn['size']].pop()
self.log.emit('creating subnet {} in {}'.format(cidr, az_name))
subnet = self.evpc.create_subnet(
CidrBlock = str(cidr),
AvailabilityZone = az_name
)
self.log.emit('tagging subnet (Name:{})'.format(longname), 'debug')
update_tags(
subnet,
Name = longname,
description = sn.get('description', ''),
)
# Modifying the subnet's public IP addressing behavior.
if sn.get('public', False) == True:
subnet.map_public_ip_on_launch = True
def associate_route_tables_with_subnets(self, subnet_cfg):
for sn_name, sn_data in subnet_cfg.items():
rt_name = sn_data.get('route_table', None)
if rt_name is None:
continue
self.log.emit('associating rt {} with sn {}'.format(rt_name, sn_name))
self.evpc.associate_route_table_with_subnet(rt_name, sn_name)
def endpoints(self, route_tables):
"""Build VPC endpoints for given route_tables"""
if len(route_tables) == 0:
return None
self.log.emit(
'creating vpc endpoints in {}'.format(', '.join(route_tables))
)
self.evpc.vpc_endpoint.create_all(route_tables)
def security_groups(self, security_group_cfg):
"""Build Security Groups defined in config."""
for sg_name, rules in security_group_cfg.items():
sg = self.evpc.get_security_group(sg_name)
if sg is not None:
continue
longname = '{}-{}'.format(self.evpc.name, sg_name)
self.log.emit('creating security_group {}'.format(longname))
security_group = self.evpc.create_security_group(
GroupName = longname,
Description = longname,
)
self.log.emit(
'tagging security_group (Name:{})'.format(longname), 'debug'
)
update_tags(security_group, Name = longname)
def security_group_rules(self, security_group_cfg):
"""Build Security Group Rules defined in config."""
self.security_group_inbound_rules(security_group_cfg)
self.security_group_outbound_rules(security_group_cfg)
def security_group_inbound_rules(self, security_group_cfg):
"""Build inbound rule for Security Group defined in config."""
msg = "inbound connection from '{}' to '{}' over ports {} ({})"
for sg_name, rules in security_group_cfg.items():
sg = self.evpc.get_security_group(sg_name)
permissions = []
for rule in rules.get('inbound', {}):
protocol = rule[1]
from_port, to_port = get_port_range(rule[2], protocol)
src_sg = self.evpc.get_security_group(rule[0])
permission = {
'IpProtocol' : protocol,
'FromPort' : from_port,
'ToPort' : to_port,
}
if src_sg is None:
permission['IpRanges'] = [{'CidrIp' : rule[0]}]
else:
permission['UserIdGroupPairs'] = [{'GroupId':src_sg.id}]
permissions.append(permission)
fmsg = msg.format(rule[0],sg_name,rule[2],rule[1].upper())
self.log.emit(fmsg)
if permissions:
sg.authorize_ingress(
IpPermissions = permissions
)
def security_group_outbound_rules(self, security_group_cfg):
"""Build outbound rule for Security Group defined in config."""
msg = "outbound connection to '{}' from '{}' over ports {} ({})"
for sg_name, rules in security_group_cfg.items():
sg = self.evpc.get_security_group(sg_name)
permissions = []
for rule in rules.get('outbound', {}):
self.log.emit("revoking default outbound rule from {}".format(sg_name))
sg.revoke_egress(
IpPermissions = [
{
'IpProtocol' : '-1',
'FromPort' : -1,
'ToPort' : -1,
'IpRanges' : [ { 'CidrIp' : '0.0.0.0/0' } ],
}
]
)
protocol = rule[1]
from_port, to_port = get_port_range(rule[2], protocol)
src_sg = self.evpc.get_security_group(rule[0])
permission = {
'IpProtocol' : protocol,
'FromPort' : from_port,
'ToPort' : to_port,
}
if src_sg is None:
permission['IpRanges'] = [{'CidrIp' : rule[0]}]
else:
permission['UserIdGroupPairs'] = [{'GroupId':src_sg.id}]
permissions.append(permission)
fmsg = msg.format(rule[0],sg_name,rule[2],rule[1].upper())
self.log.emit(fmsg)
if permissions:
sg.authorize_egress(
IpPermissions = permissions
)
def key_pairs(self, key_pair_cfg):
key_pair_cfg.append('default')
for short_key_pair_name in key_pair_cfg:
if self.evpc.key_pair.get_key_pair(short_key_pair_name) is None:
self.log.emit('creating key pair {}'.format(short_key_pair_name))
self.evpc.key_pair.create_key_pair(short_key_pair_name)
def instance_roles(self, instance_role_cfg):
"""Returns a list of new created EnrichedInstance objects."""
new_instances = []
for role_name, role_data in instance_role_cfg.items():
desired_count = role_data.get('count', 0)
role_instances = self.instance_role(
role_name,
role_data,
desired_count,
)
new_instances += role_instances
return new_instances
def instance_role(self, role_name, role_data, desired_count):
self.log.emit('creating role: {}'.format(role_name))
ami = self.amis[role_data['ami']][self.evpc.region_name]
key_pair = self.evpc.key_pair.get_key_pair(
role_data.get('key_pair', 'default')
)
security_groups = map(
self.evpc.get_security_group,
role_data.get('security_groups', [])
)
subnets = map(
self.evpc.get_subnet,
role_data.get('subnets', [])
)
if len(subnets) == 0:
self.log.emit(
'no subnets found for role: {}'.format(role_name), 'warning'
)
# exit early.
return None
# sort by subnets by amount of instances, smallest first.
subnets = sorted(
subnets,
key = lambda sn : collection_len(sn.instances),
)
# determine the count of this role's existing instances.
# Note: we look for role in all subnets, not just the listed subnets.
existing_count = len(self.evpc.get_role(role_name))
if existing_count >= desired_count:
# for now we exit early, maybe terminate extras...
self.log.emit(existing_count + ' ' + desired_count, 'debug')
return None
# determine count of additional instances needed to reach desired_count.
needed_count = desired_count - existing_count
needed_per_subnet = needed_count / len(subnets)
needed_remainder = needed_count % len(subnets)
role_instances = []
for subnet in subnets:
# ensure Run_Instance_Idempotency.html#client-tokens
client_token = str(uuid4())
# figure out how many instances this subnet needs to create ...
existing_in_subnet = len(self.evpc.get_role(role_name, subnet.instances.all()))
count = needed_per_subnet - existing_in_subnet
if needed_remainder != 0:
needed_remainder -= 1
count += 1
if count == 0:
# skip this subnet, it doesn't need to launch any instances.
continue
subnet_name = make_tag_dict(subnet)['Name']
msg = '{} instances of role {} launching into {}'
self.log.emit(msg.format(count, role_name, subnet_name))
# create a batch of instances in subnet!
instances = subnet.create_instances(
ImageId = ami,
InstanceType = role_data.get('instance_type'),
MinCount = count,
MaxCount = count,
KeyName = key_pair.name,
SecurityGroupIds = get_ids(security_groups),
ClientToken = client_token,
)
# accumulate all new instances into a single list.
role_instances += instances
# cast role Instance objets to EnrichedInstance objects.
role_instances = self.evpc.get_instances(role_instances)
self.tag_instances(role_name, role_instances)
return role_instances
def tag_instances(self, role_name, instances):
"""Accept a list of EnrichedInstance, objects create tags."""
msg = 'tagging instance {} (Name:{}, role:{})'
for instance in instances:
h = '{}-{}-{}'
hostname = h.format(self.evpc.name, role_name, instance.id_human)
self.log.emit(msg.format(instance.identity, hostname, role_name))
update_tags(instance, Name = hostname, role = role_name)
def tag_instance_volumes(self, instance):
"""Accept an EnrichedInstance, tag all attached volumes."""
msg = 'tagging volumes for instance {} (Name:{})'
for volume in instance.volumes.all():
self.log.emit(msg.format(instance.identity, instance.identity))
update_tags(volume, Name = instance.identity)
def add_eip_to_instance(self, instance):
eip1_msg = 'allocating eip and associating with {}'
eip2_msg = 'allocated eip {} and associated with {}'
self.log.emit(eip1_msg.format(instance.identity))
eip = instance.allocate_eip()
self.log.emit(eip2_msg.format(eip.public_ip, instance.identity))
def finish_instance_roles(self, instance_role_cfg, instances):
for instance in instances:
self.log.emit('waiting for {} to start'.format(instance.identity))
instance.wait_until_running()
self.tag_instance_volumes(instance)
# allocate eips and associate for the needful instances.
if instance_role_cfg[instance.role].get('eip', False) == True:
self.add_eip_to_instance(instance)
try:
self.log.emit('locking new instances to prevent termination')
self.evpc.lock_instances(instances)
except:
self.log.emit('could not lock instances, continuing...', 'warning')
def db_instances(self, db_instance_cfg):
"""Build RDS DB Instances."""
for rds_name, db_cfg in db_instance_cfg.items():
self.log.emit('creating {} RDS db_instance ...'.format(rds_name))
# make list of security group ids.
security_groups = map(
self.evpc.get_security_group,
db_cfg.get('security_groups', [])
)
sg_ids = get_ids(security_groups)
# make list of subnet ids.
subnets = map(
self.evpc.get_subnet,
db_cfg.get('subnets', [])
)
sn_ids = get_ids(subnets)
self.evpc.rds.create_db_subnet_group(
DBSubnetGroupName = rds_name,
DBSubnetGroupDescription = db_cfg.get('description',''),
SubnetIds = sn_ids,
)
self.evpc.rds.create_db_instance(
DBInstanceIdentifier = rds_name,
DBSubnetGroupName = rds_name,
DBName = db_cfg.get('name', rds_name),
VpcSecurityGroupIds = sg_ids,
DBInstanceClass = db_cfg.get('class', 'db.t2.medium'),
AllocatedStorage = db_cfg.get('allocated_storage', 100),
Engine = db_cfg.get('engine'),
EngineVersion = db_cfg.get('engine_version', ''),
Iops = db_cfg.get('iops', 0),
MultiAZ = db_cfg.get('multi_az', False),
MasterUsername = db_cfg.get('master_username'),
MasterUserPassword = generate_password(16),
BackupRetentionPeriod = db_cfg.get('backup_retention_period', 0),
Tags = [ { 'Key' : 'vpc_name', 'Value' : self.evpc.vpc_name } ],
)
class EnvironmentBuilder(object):
def __init__(self,
vpc_name,
config=None,
region_name=None,
profile_name=None,
log=None):
"""
vpc_name:
The human readable Name tag of this VPC.
config:
The dict returned by botoform.config.ConfigLoader's load method.
"""
self.vpc_name = vpc_name
self.config = config if config is not None else {}
self.log = log if log is not None else Log()
self.boto = BotoConnections(region_name, profile_name)
self.reflect = False
def apply_all(self):
"""Build the environment specified in the config."""
try:
self._apply_all(self.config)
except Exception as e:
self.log.emit('Botoform failed to build environment!', 'error')
self.log.emit('Failure reason: {}'.format(e), 'error')
self.log.emit(traceback.format_exc(), 'debug')
self.log.emit('Tearing down failed environment!', 'error')
self.evpc.terminate()
raise
def _apply_all(self, config):
# Make sure amis is setup early. (TODO: raise exception if missing)
self.amis = config['amis']
# set a var for no_cfg.
no_cfg = {}
# build the vpc.
vpc_cidr = config.get('vpc_cidr', '172.31.0.0/16')
vpc_tenancy = config.get('vpc_tenancy', 'default')
self.build_vpc(vpc_cidr, vpc_tenancy)
# attach EnrichedVPC to self.
self.evpc = EnrichedVPC(self.vpc_name, self.boto.region_name,
self.boto.profile_name, self.log)
# create and attach internet gateway to vpc.
self.build_internet_gateway()
# attach VPN gateway to the VPC
self.attach_vpn_gateway(config.get('vpn_gateway', no_cfg))
# create and associate DHCP Options Set
self.dhcp_options(config.get('dhcp_options', no_cfg))
# iam instance profiles / iam roles need to be created early because
# there isn't a way to make launch config idempotent and safe to retry...
self.instance_profiles(config.get('instance_roles', no_cfg))
# the order of these method calls matters for new VPCs.
self.route_tables(config.get('route_tables', no_cfg))
self.subnets(config.get('subnets', no_cfg))
self.security_groups(config.get('security_groups', no_cfg))
self.key_pairs(config.get('key_pairs', []))
self.associate_route_tables_with_subnets(config.get('subnets', no_cfg))
self.db_instances(config.get('db_instances', no_cfg))
self.instance_roles(config.get('instance_roles', no_cfg))
self.autoscaling_instance_roles(config.get('instance_roles', no_cfg))
# lets do more work while new_instances move from pending to running.
self.endpoints(config.get('endpoints', []))
self.security_group_rules(config.get('security_groups', no_cfg))
self.load_balancers(config.get('load_balancers', no_cfg))
# block until instance_role counts are sane.
self.wait_for_instance_roles_to_exist(
config.get('instance_roles', no_cfg))
# lets finish building the new instances.
self.finish_instance_roles(config.get('instance_roles', no_cfg))
# run after tagging instances in case we have a NAT instance_role.
self.route_table_rules(config.get('route_tables', no_cfg))
if config.get('private_zone', False):
self.log.emit('managing route53 private zone.')
self.evpc.route53.create_private_zone()
self.evpc.route53.refresh_private_zone()
self.tags(config.get('tags', no_cfg))
self.log.emit('done! don\'t you look awesome. : )')
def build_vpc(self, cidrblock='172.31.0.0/16', tenancy='default'):
"""Build VPC"""
msg_vpc = 'creating vpc ({}, {}) with {} tenancy'
self.log.emit(msg_vpc.format(self.vpc_name, cidrblock, tenancy))
vpc = self.boto.ec2.create_vpc(
CidrBlock=cidrblock,
InstanceTenancy=tenancy,
)
self.log.emit('tagging vpc (Name:{})'.format(self.vpc_name), 'debug')
update_tags(vpc, Name=self.vpc_name)
self.log.emit('modifying vpc for dns support', 'debug')
vpc.modify_attribute(EnableDnsSupport={'Value': True})
self.log.emit('modifying vpc for dns hostnames', 'debug')
vpc.modify_attribute(EnableDnsHostnames={'Value': True})
def build_internet_gateway(self):
"""Build and attach Internet Gateway to VPC."""
igw_name = 'igw-' + self.evpc.name
self.log.emit('creating internet_gateway ({})'.format(igw_name))
gw = self.boto.ec2.create_internet_gateway()
self.log.emit('tagging gateway (Name:{})'.format(igw_name), 'debug')
update_tags(gw, Name=igw_name)
self.log.emit('attaching igw to vpc ({})'.format(igw_name))
self.evpc.attach_internet_gateway(
DryRun=False,
InternetGatewayId=gw.id,
VpcId=self.evpc.id,
)
def attach_vpn_gateway(self, vpn_gateway_cfg):
"""Attach defined VPN gateway to VPC"""
if vpn_gateway_cfg:
vgw_id = vpn_gateway_cfg.get('id', None)
if vgw_id is not None:
self.log.emit('attaching vgw ({}) to vpc ({})'.format(
vgw_id, self.vpc_name))
# attach_vpn_gateway is available with ec2 client object
self.evpc.attach_vpn_gateway(vgw_id)
#self.vgw_id = vgw_id
#self.boto.ec2_client.attach_vpn_gateway(
# DryRun=False,
# VpnGatewayId = self.vgw_id,
# VpcId = self.evpc.id,
#)
## check & wait till VGW (2 min.) is attached
#count = 0
#while(not self.evpc.is_vgw_attached(vgw_id)):
# time.sleep(10)
# count += 1
# if count == 11:
# raise Exception({"message":"VPN Gateway is not yet attached.", "VGW_ID":vgw_id})
@retry(wait_exponential_multiplier=1000, wait_exponential_max=10000)
def _get_dhcp_options_from_id(self, dhcp_options_id):
return self.boto.ec2.DhcpOptions(dhcp_options_id)
def create_dhcp_options(self, dhcp_configurations):
"""Creates and return a new dhcp_options set."""
response = self.boto.ec2_client.create_dhcp_options(
DhcpConfigurations=dhcp_configurations)
dhcp_options_id = nested_lookup('DhcpOptionsId', response)[0]
dhcp_options = self._get_dhcp_options_from_id(dhcp_options_id)
self.log.emit('tagging dhcp_options (Name:{})'.format(self.evpc.name),
'debug')
update_tags(dhcp_options, Name=self.evpc.name)
self.log.emit('associating dhcp_options to {}'.format(self.evpc.name))
dhcp_options.associate_with_vpc(VpcId=self.evpc.id)
def dhcp_options(self, dhcp_options_cfg):
"""Creates DHCP Options Set and associates with VPC"""
self.log.emit('creating DHCP Options Set for {}'.format(
self.evpc.name))
dhcp_configurations = [
{
'Key': 'domain-name',
'Values': [self.evpc.route53.private_zone_name]
},
]
# only add domain-name-servers if not empty...
if dhcp_options_cfg.get('domain-name-servers', []):
dhcp_configurations.append({
'Key':
'domain-name-servers',
'Values':
dhcp_options_cfg['domain-name-servers']
})
self.create_dhcp_options(dhcp_configurations)
def route_tables(self, route_cfg):
"""Build route_tables defined in config"""
for rt_name, data in route_cfg.items():
longname = '{}-{}'.format(self.evpc.name, rt_name)
route_table = self.evpc.get_route_table(longname)
if route_table is None:
self.log.emit('creating route_table ({})'.format(longname))
if data.get('main', False) == True:
route_table = self.evpc.get_main_route_table()
else:
route_table = self.evpc.create_route_table()
self.log.emit('tagging route_table (Name:{})'.format(longname),
'debug')
update_tags(route_table, Name=longname)
def route_table_rules(self, route_cfg):
"""Build route table rules defined in config"""
# currently supports: igw, vgw, and instance_roles
for rt_name, data in route_cfg.items():
# this method assumes the route_table was already created.
route_table = self.evpc.get_route_table(rt_name)
for route in data.get('routes', []):
destination, target = route
self.log.emit('adding route {} to route_table ({})'.format(
route, route_table.name))
if target.lower() == 'internet_gateway':
# TODO: ugly but we assume only one internet gateway.
route_table.create_route(
DestinationCidrBlock=destination,
GatewayId=list(
self.evpc.internet_gateways.all())[0].id,
)
elif target.lower() == 'vpn_gateway':
# TODO: ugly but we assume only one VPN gateway.
route_table.create_route(
DestinationCidrBlock=destination,
GatewayId=self.evpc.vgw_id,
)
# if routed to VPN gateway propagate the route.
self.boto.ec2_client.enable_vgw_route_propagation(
RouteTableId=route_table.route_table_id,
GatewayId=self.evpc.vgw_id,
)
else:
# availability_zones of subnets associated to route_table.
azones = [
a.subnet.availability_zone
for a in route_table.associations
if a.subnet is not None
]
# assume the target is an instance_role.
instances = self.evpc.get_role(target)
# by default just randomly select one of the instances in the role.
nat_instance = choice(instances)
# try to correlate the route_table's associated subnet's availability_zone
# and the nat instance's subnet's availability_zone. Not always possible.
for instance in instances:
if instance.subnet.availability_zone in azones:
nat_instance = instance
self.log.emit('disable source dest check for {}'.format(
nat_instance.identity))
nat_instance.disable_source_dest_check(False)
route_table.create_route(
DestinationCidrBlock=destination,
InstanceId=nat_instance.id,
)
def subnets(self, subnet_cfg):
"""Build subnets defined in config."""
sizes = sorted([x['size'] for x in subnet_cfg.values()])
cidrs = allocate(self.evpc.cidr_block, sizes)
azones = self.evpc.azones
subnets = {}
for size, cidr in zip(sizes, cidrs):
subnets.setdefault(size, []).append(cidr)
for name, sn in subnet_cfg.items():
longname = '{}-{}'.format(self.evpc.name, name)
az_letter = sn.get('availability_zone', None)
if az_letter is not None:
az_name = self.evpc.region_name + az_letter
else:
az_index = int(name.split('-')[-1]) - 1
az_name = azones[az_index]
cidr = subnets[sn['size']].pop()
self.log.emit('creating subnet {} in {}'.format(cidr, az_name))
subnet = self.evpc.create_subnet(CidrBlock=str(cidr),
AvailabilityZone=az_name)
self.log.emit('tagging subnet (Name:{})'.format(longname), 'debug')
update_tags(
subnet,
Name=longname,
description=sn.get('description', ''),
)
if sn.get('public', False) == True:
# Modify the subnet's public IP addressing behavior.
msg_mod = 'modifying subnet to map public IPs on instance launch ({})'
self.log.emit(msg_mod.format(longname))
self.boto.ec2_client.modify_subnet_attribute(
SubnetId=subnet.id,
MapPublicIpOnLaunch={'Value': True},
)
def associate_route_tables_with_subnets(self, subnet_cfg):
for sn_name, sn_data in subnet_cfg.items():
rt_name = sn_data.get('route_table', None)
if rt_name is None:
continue
self.log.emit('associating rt {} with sn {}'.format(
rt_name, sn_name))
self.evpc.associate_route_table_with_subnet(rt_name, sn_name)
def endpoints(self, route_tables):
"""Build VPC endpoints for given route_tables"""
if len(route_tables) == 0:
return None
self.log.emit('creating vpc endpoints in {}'.format(
', '.join(route_tables)))
self.evpc.vpc_endpoint.create_all(route_tables)
def security_groups(self, security_group_cfg):
"""Build Security Groups defined in config."""
for sg_name, rules in security_group_cfg.items():
sg = self.evpc.get_security_group(sg_name)
if sg is not None:
continue
longname = '{}-{}'.format(self.evpc.name, sg_name)
self.log.emit('creating security_group {}'.format(longname))
security_group = self.evpc.create_security_group(
GroupName=longname,
Description=longname,
)
self.log.emit('tagging security_group (Name:{})'.format(longname),
'debug')
update_tags(security_group, Name=longname)
def security_group_rules(self, security_group_cfg):
"""Build Security Group Rules defined in config."""
self.security_group_inbound_rules(security_group_cfg)
self.security_group_outbound_rules(security_group_cfg)
def security_group_rule_to_permission(self, rule):
"""Return a permission dictionary from a rule tuple."""
protocol = rule[1]
from_port, to_port = get_port_range(rule[2], protocol)
sg = self.evpc.get_security_group(rule[0])
permission = {
'IpProtocol': protocol,
'FromPort': from_port,
'ToPort': to_port,
}
if sg is None:
permission['IpRanges'] = [{'CidrIp': rule[0]}]
else:
permission['UserIdGroupPairs'] = [{'GroupId': sg.id}]
return permission
def security_group_rules_to_permissions(self,
sg_name,
rules,
direction='inbound'):
msg = "{} rule: '{}' {} '{}' over ports {} ({})"
symbol = {'inbound': '->', 'outbound': '<-'}.get(direction, '->')
permissions = []
for rule in rules.get(direction, {}):
permissions.append(self.security_group_rule_to_permission(rule))
self.log.emit(
msg.format(direction, rule[0], symbol, sg_name, rule[2],
rule[1].upper()))
return permissions
def security_group_inbound_rules(self, security_group_cfg):
"""Build inbound rule for Security Group defined in config."""
for sg_name, rules in security_group_cfg.items():
sg = self.evpc.get_security_group(sg_name)
permissions = self.security_group_rules_to_permissions(
sg_name, rules, 'inbound')
if permissions:
sg.authorize_ingress(IpPermissions=permissions)
def security_group_outbound_rules(self, security_group_cfg):
"""Build outbound rule for Security Group defined in config."""
for sg_name, rules in security_group_cfg.items():
sg = self.evpc.get_security_group(sg_name)
permissions = self.security_group_rules_to_permissions(
sg_name, rules, 'outbound')
if permissions:
self.log.emit(
"revoking default outbound rule from {}".format(sg_name))
self.security_group_outbound_revoke_default_rule(sg)
sg.authorize_egress(IpPermissions=permissions)
def security_group_outbound_revoke_default_rule(self, sg):
sg.revoke_egress(IpPermissions=[{
'IpProtocol': '-1',
'FromPort': -1,
'ToPort': -1,
'IpRanges': [{
'CidrIp': '0.0.0.0/0'
}],
}])
def key_pairs(self, key_pair_cfg):
key_pair_cfg.append('default')
for short_key_pair_name in key_pair_cfg:
if self.evpc.key_pair.get_key_pair(short_key_pair_name) is None:
self.log.emit(
'creating key pair {}'.format(short_key_pair_name))
self.evpc.key_pair.create_key_pair(short_key_pair_name)
def get_instance_profile(self, instance_profile_name):
"""Return instance_profile or None."""
for profile in list(self.boto.iam.instance_profiles.all()):
if profile.name == instance_profile_name:
return profile
def create_instance_profile(self, instance_profile_name):
"""Create instance_profile and role, return instance_profile."""
instance_profile = self.boto.iam.create_instance_profile(
InstanceProfileName=instance_profile_name)
iam_role = self.boto.iam.create_role(
RoleName=instance_profile_name,
AssumeRolePolicyDocument=DEFAULT_EC2_TRUST_POLICY,
)
instance_profile.add_role(RoleName=instance_profile_name, )
return instance_profile
# retry because instance_profile / iam role not ready right away...
@retry(wait_exponential_multiplier=1000, wait_exponential_max=10000)
def wait_for_instance_profile(self, instance_profile_name):
msg = 'waiting for {} instance_profile / iam_role to exist ...'
if self.get_instance_profile(instance_profile_name) is None:
self.log.emit(msg.format(instance_profile_name))
raise Exception(msg.format(instance_profile_name))
def _get_or_create_iam_instance_profile(self, instance_profile_name):
instance_profile = self.get_instance_profile(instance_profile_name)
if instance_profile is None:
instance_profile = self.create_instance_profile(
instance_profile_name)
return instance_profile
def instance_profiles(self, instance_role_cfg):
msg = "make sure {} instance_profile and iam_role exist"
for role_name, role_data in instance_role_cfg.items():
profile_name = role_data.get('instance_profile_name', None)
if profile_name:
self.log.emit(msg.format(profile_name))
self._get_or_create_iam_instance_profile(profile_name)
def instance_roles(self, instance_role_cfg):
"""Create instance roles defined in config."""
for role_name, role_data in instance_role_cfg.items():
desired_count = role_data.get('count', 0)
self.instance_role(
role_name,
role_data,
desired_count,
)
def instance_role(self, role_name, role_data, desired_count):
if role_data.get('autoscaling', False) == True:
# exit early if this instance_role is autoscaling.
return None
self.log.emit('creating role: {}'.format(role_name))
ami = self.amis[role_data['ami']][self.evpc.region_name]
key_pair = self.evpc.key_pair.get_key_pair(
role_data.get('key_pair', 'default'))
security_groups = map_filter_false(
self.evpc.get_security_group, role_data.get('security_groups', []))
subnets = map_filter_false(self.evpc.get_subnet,
role_data.get('subnets', []))
if len(subnets) == 0:
self.log.emit('no subnets found for role: {}'.format(role_name),
'warning')
# exit early.
return None
# sort by subnets by amount of instances, smallest first.
subnets = sorted(
subnets,
key=lambda sn: collection_len(sn.instances),
)
# determine the count of this role's existing instances.
# Note: we look for role in all subnets, not just the listed subnets.
existing_count = len(self.evpc.get_role(role_name))
if existing_count >= desired_count:
# for now we exit early, maybe terminate extras...
msg = 'skipping role: {} (existing_count {} is greater than or equal to {})'
self.log.emit(msg.format(role_name, existing_count, desired_count),
'debug')
return None
# determine count of additional instances needed to reach desired_count.
needed_count = desired_count - existing_count
needed_per_subnet = desired_count / len(subnets)
needed_remainder = desired_count % len(subnets)
block_device_map = get_block_device_map_from_role_config(role_data)
role_instances = []
kwargs = {
'ImageId': ami,
'InstanceType': role_data.get('instance_type'),
'KeyName': key_pair.name,
'SecurityGroupIds': get_ids(security_groups),
'BlockDeviceMappings': block_device_map,
'UserData': role_data.get('userdata', ''),
'IamInstanceProfile': {},
}
profile_name = role_data.get('instance_profile_name', None)
if profile_name:
kwargs['IamInstanceProfile'] = {'Name': profile_name}
for subnet in subnets:
# ensure Run_Instance_Idempotency.html#client-tokens
kwargs['ClientToken'] = str(uuid4())
# figure out how many instances this subnet needs to create ...
existing_in_subnet = len(
self.evpc.get_role(role_name, subnet.instances.all()))
count = needed_per_subnet - existing_in_subnet
if needed_remainder != 0:
needed_remainder -= 1
count += 1
if count == 0:
# skip this subnet, it doesn't need to launch any instances.
continue
subnet_name = make_tag_dict(subnet)['Name']
msg = '{} instances of role {} launching into {} subnet'
self.log.emit(msg.format(count, role_name, subnet_name))
# create a batch of instances in subnet!
kwargs['MinCount'] = kwargs['MaxCount'] = count
instances = self._create_instances(subnet, **kwargs)
# accumulate all new instances into a single list.
role_instances += instances
# add role tag to each instance.
for instance in role_instances:
update_tags(instance, role=role_name)
# retry because iam role not ready right away...
@retry(wait_exponential_multiplier=1000, wait_exponential_max=10000)
def _create_instances(self, subnet, **kwargs):
return subnet.create_instances(**kwargs)
def autoscaling_instance_roles(self, instance_role_cfg):
"""Create Autoscaling Groups and Launch Configurations."""
for role_name, role_data in instance_role_cfg.items():
desired_count = role_data.get('count', 0)
self.autoscaling_instance_role(
role_name,
role_data,
desired_count,
)
def autoscaling_instance_role(self, role_name, role_data, desired_count):
if role_data.get('autoscaling', False) != True:
# exit early if this instance_role is not autoscaling.
return None
long_role_name = '{}-{}'.format(self.evpc.name, role_name)
ami = self.amis[role_data['ami']][self.evpc.region_name]
key_pair = self.evpc.key_pair.get_key_pair(
role_data.get('key_pair', 'default'))
security_groups = map_filter_false(
self.evpc.get_security_group, role_data.get('security_groups', []))
subnets = map_filter_false(self.evpc.get_subnet,
role_data.get('subnets', []))
block_device_map = get_block_device_map_from_role_config(role_data)
kwargs = {
'LaunchConfigurationName': long_role_name,
'ImageId': ami,
'InstanceType': role_data.get('instance_type'),
'KeyName': key_pair.name,
'SecurityGroups': get_ids(security_groups),
'BlockDeviceMappings': block_device_map,
'UserData': role_data.get('userdata', ''),
}
profile_name = role_data.get('instance_profile_name', None)
if profile_name:
# only add profile if set. Empty string causes error.
kwargs['IamInstanceProfile'] = profile_name
self.wait_for_instance_profile(profile_name)
self.log.emit('creating launch configuration for role: {}'.format(
long_role_name))
self.evpc.autoscaling.create_launch_configuration(**kwargs)
self.log.emit(
'creating autoscaling group for role: {}'.format(long_role_name))
self.evpc.autoscaling.create_auto_scaling_group(
AutoScalingGroupName=long_role_name,
LaunchConfigurationName=long_role_name,
MinSize=desired_count,
MaxSize=desired_count,
DesiredCapacity=desired_count,
VPCZoneIdentifier=','.join(get_ids(subnets)),
Tags=[
{
'Key': 'role',
'Value': role_name,
'PropagateAtLaunch': True,
},
])
# retry because autoscaled instances don't have the role tag right away.
@retry(wait_exponential_multiplier=1000, wait_exponential_max=10000)
def tag_instance_name(self, instance):
"""Accept a EnrichedInstance, objects create tags."""
msg = 'tagging instance {} (Name:{})'
h = '{}-{}-{}'
hostname = h.format(self.evpc.name, instance.role, instance.id_human)
self.log.emit(msg.format(instance.identity, hostname))
update_tags(instance, Name=hostname)
def tag_instance_volumes(self, instance):
"""Accept an EnrichedInstance, tag all attached volumes."""
msg = 'tagging volumes for instance {} (Name:{})'
for volume in instance.volumes.all():
self.log.emit(msg.format(instance.identity, instance.identity))
update_tags(volume, Name=instance.identity)
def add_eip_to_instance(self, instance):
eip1_msg = 'allocating and associating eip for {}'
eip2_msg = 'associated eip {} to {}'
self.log.emit(eip1_msg.format(instance.identity))
eip = instance.allocate_and_associate_eip()
self.log.emit(eip2_msg.format(eip.public_ip, instance.identity))
@retry(wait_exponential_multiplier=1000, wait_exponential_max=10000)
def wait_for_instance_roles_to_exist(self, instance_role_cfg):
raw_msg = 'waiting: we desire {} instances but only {} exist in role {}'
roles = self.evpc.roles
for role_name, role_cfg in instance_role_cfg.items():
desired_count = role_cfg.get('count', 0)
actual_count = len(roles.get(role_name, []))
if desired_count > actual_count:
msg = raw_msg.format(desired_count, actual_count, role_name)
self.log.emit(msg, 'debug')
raise Exception(msg)
def finish_instance_roles(self, instance_role_cfg, instances=None):
instances = self.evpc.get_instances(instances)
for instance in instances:
self.log.emit('waiting for {} to start'.format(instance))
instance.wait_until_running()
# this method call will block (retry) until instance is named.
self.tag_instance_name(instance)
self.tag_instance_volumes(instance)
requires_eip = instance_role_cfg.get(instance.role,
{}).get('eip', False)
if requires_eip and len(instance.eips) == 0:
# if instance role should have an eip but doesn't have one, add one.
self.add_eip_to_instance(instance)
try:
self.log.emit(
'locking new normal (not autoscaled) instances to prevent termination'
)
self.evpc.lock_instances(self.evpc.get_normal_instances(instances))
except:
self.log.emit('could not lock instances, continuing...', 'warning')
def db_instances(self, db_instance_cfg):
"""Build RDS DB Instances."""
for rds_name, db_cfg in db_instance_cfg.items():
self.log.emit('creating {} RDS db_instance ...'.format(rds_name))
# make list of security group ids.
security_groups = map_filter_false(
self.evpc.get_security_group,
db_cfg.get('security_groups', []))
sg_ids = get_ids(security_groups)
# make list of subnet ids.
subnets = map_filter_false(self.evpc.get_subnet,
db_cfg.get('subnets', []))
sn_ids = get_ids(subnets)
self.evpc.rds.create_db_subnet_group(
DBSubnetGroupName=rds_name,
DBSubnetGroupDescription=db_cfg.get('description', ''),
SubnetIds=sn_ids,
)
self.evpc.rds.create_db_instance(
DBInstanceIdentifier=rds_name,
DBSubnetGroupName=rds_name,
DBName=db_cfg.get('name', rds_name),
VpcSecurityGroupIds=sg_ids,
DBInstanceClass=db_cfg.get('class', 'db.t2.medium'),
AllocatedStorage=db_cfg.get('allocated_storage', 100),
Engine=db_cfg.get('engine'),
EngineVersion=db_cfg.get('engine_version', ''),
Iops=db_cfg.get('iops', 0),
MultiAZ=db_cfg.get('multi_az', False),
MasterUsername=db_cfg.get('master_username'),
MasterUserPassword=generate_password(16),
BackupRetentionPeriod=db_cfg.get('backup_retention_period', 0),
Tags=[{
'Key': 'vpc_name',
'Value': self.evpc.vpc_name
}],
)
def load_balancers(self, load_balancer_cfg):
"""Build ELB load balancers."""
for lb_name, lb_cfg in load_balancer_cfg.items():
lb_fullname = '{}-{}'.format(self.evpc.name, lb_name)
self.log.emit('creating {} load_balancer ...'.format(lb_fullname))
# make list of security group ids.
security_groups = map_filter_false(
self.evpc.get_security_group,
lb_cfg.get('security_groups', []))
sg_ids = get_ids(security_groups)
# make list of subnet ids.
subnets = map_filter_false(self.evpc.get_subnet,
lb_cfg.get('subnets', []))
sn_ids = get_ids(subnets)
scheme = 'internet-facing'
if lb_cfg.get('internal', False):
scheme = 'internal'
listeners = lb_cfg.get('listeners', [])
self.evpc.elb.create_load_balancer(
LoadBalancerName=lb_fullname,
Subnets=sn_ids,
SecurityGroups=sg_ids,
Scheme=scheme,
Tags=[
{
'Key': 'vpc_name',
'Value': self.evpc.vpc_name
},
{
'Key': 'role',
'Value': lb_cfg['instance_role']
},
],
Listeners=self.evpc.elb.format_listeners(listeners),
)
self.log.emit('created {} load_balancer ...'.format(lb_fullname))
self.log.emit(
'Configure Health Check for {} load_balancer ...'.format(
lb_fullname))
hc_cfg = lb_cfg.get('healthcheck', {})
hc_default_target = 'TCP:{}'.format(listeners[0][1])
self.evpc.elb.configure_health_check(
LoadBalancerName=lb_fullname,
HealthCheck={
'Target': hc_cfg.get('target', hc_default_target),
'Interval': hc_cfg.get('interval', 15),
'Timeout': hc_cfg.get('timeout', 5),
'UnhealthyThreshold': hc_cfg.get('unhealthy_threshold', 4),
'HealthyThreshold': hc_cfg.get('healthy_threshold', 4)
})
self.log.emit(
'Configured Health Check for {} load_balancer ...'.format(
lb_fullname))
asg_name = '{}-{}'.format(self.evpc.name, lb_cfg['instance_role'])
if asg_name in self.evpc.autoscaling.get_related_autoscaling_group_names(
):
self.log.emit(
'attaching {} load balancer to {} autoscaling group ...'.
format(lb_fullname, asg_name))
self.evpc.autoscaling.attach_load_balancers(
AutoScalingGroupName=asg_name,
LoadBalancerNames=[lb_fullname],
)
else:
self.log.emit(
'registering {} role to {} load balancer ...'.format(
lb_cfg['instance_role'], lb_fullname))
self.evpc.elb.register_role_with_load_balancer(
lb_fullname, lb_cfg['instance_role'])
def tags(self, tag_cfg):
reserved_tags = [
'Name', 'role', 'aws:autoscaling:groupName', 'key_pairs',
'private_hosted_zone_id', 'vpc_name'
]
safe_tags = {}
for key, value in tag_cfg.items():
if key not in reserved_tags:
safe_tags[key] = str(value)
taggable_resources = self.evpc.taggable_resources
for resource in taggable_resources:
if safe_tags:
self.log.emit('tagging {} with {} ...'.format(
resource, safe_tags))
update_tags(resource, **safe_tags)
class EnvironmentBuilder(object):
def __init__(self, vpc_name, config=None, region_name=None, profile_name=None, log=None):
"""
vpc_name:
The human readable Name tag of this VPC.
config:
The dict returned by botoform.config.ConfigLoader's load method.
"""
self.vpc_name = vpc_name
self.config = config if config is not None else {}
self.log = log if log is not None else Log()
self.boto = BotoConnections(region_name, profile_name)
self.reflect = False
def apply_all(self):
"""Build the environment specified in the config."""
try:
self._apply_all(self.config)
except Exception as e:
self.log.emit('Botoform failed to build environment!', 'error')
self.log.emit('Failure reason: {}'.format(e), 'error')
self.log.emit(traceback.format_exc(), 'debug')
self.log.emit('Tearing down failed environment!', 'error')
self.evpc.terminate()
raise
def _apply_all(self, config):
# Make sure amis is setup early. (TODO: raise exception if missing)
self.amis = config['amis']
# set a var for no_cfg.
no_cfg = {}
# builds the vpc.
self.build_vpc(config.get('vpc_cidr', None))
# attach EnrichedVPC to self.
self.evpc = EnrichedVPC(self.vpc_name, self.boto.region_name, self.boto.profile_name, self.log)
# create and attach internet gateway to vpc.
self.build_internet_gateway()
# attach VPN gateway to the VPC
self.attach_vpn_gateway(config.get('vpn_gateway', no_cfg))
# create and associate DHCP Options Set
self.dhcp_options(config.get('dhcp_options', no_cfg))
# iam instance profiles / iam roles need to be created early because
# there isn't a way to make launch config idempotent and safe to retry...
self.instance_profiles(
config.get('instance_roles', no_cfg)
)
# the order of these method calls matters for new VPCs.
self.route_tables(config.get('route_tables', no_cfg))
self.subnets(config.get('subnets', no_cfg))
self.security_groups(config.get('security_groups', no_cfg))
self.key_pairs(config.get('key_pairs', []))
self.associate_route_tables_with_subnets(config.get('subnets', no_cfg))
self.db_instances(config.get('db_instances', no_cfg))
self.instance_roles(
config.get('instance_roles', no_cfg)
)
self.autoscaling_instance_roles(
config.get('instance_roles', no_cfg)
)
# lets do more work while new_instances move from pending to running.
self.endpoints(config.get('endpoints', []))
self.security_group_rules(config.get('security_groups', no_cfg))
self.load_balancers(config.get('load_balancers', no_cfg))
# block until instance_role counts are sane.
self.wait_for_instance_roles_to_exist(
config.get('instance_roles', no_cfg)
)
# lets finish building the new instances.
self.finish_instance_roles(
config.get('instance_roles', no_cfg)
)
# run after tagging instances in case we have a NAT instance_role.
self.route_table_rules(config.get('route_tables', no_cfg))
if config.get('private_zone', False):
self.log.emit('managing route53 private zone.')
self.evpc.route53.create_private_zone()
self.evpc.route53.refresh_private_zone()
self.log.emit('done! don\'t you look awesome. : )')
def build_vpc(self, cidrblock):
"""Build VPC"""
self.log.emit('creating vpc ({}, {})'.format(self.vpc_name, cidrblock))
vpc = self.boto.ec2.create_vpc(CidrBlock = cidrblock)
self.log.emit('tagging vpc (Name:{})'.format(self.vpc_name), 'debug')
update_tags(vpc, Name = self.vpc_name)
self.log.emit('modifying vpc for dns support', 'debug')
vpc.modify_attribute(EnableDnsSupport={'Value': True})
self.log.emit('modifying vpc for dns hostnames', 'debug')
vpc.modify_attribute(EnableDnsHostnames={'Value': True})
def build_internet_gateway(self):
"""Build and attach Internet Gateway to VPC."""
igw_name = 'igw-' + self.evpc.name
self.log.emit('creating internet_gateway ({})'.format(igw_name))
gw = self.boto.ec2.create_internet_gateway()
self.log.emit('tagging gateway (Name:{})'.format(igw_name), 'debug')
update_tags(gw, Name = igw_name)
self.log.emit('attaching igw to vpc ({})'.format(igw_name))
self.evpc.attach_internet_gateway(
DryRun=False,
InternetGatewayId=gw.id,
VpcId=self.evpc.id,
)
def attach_vpn_gateway(self, vpn_gateway_cfg):
"""Attach defined VPN gateway to VPC"""
if vpn_gateway_cfg:
vgw_id = vpn_gateway_cfg.get('id', None)
if vgw_id is not None:
self.log.emit('attaching vgw ({}) to vpc ({})'.format(vgw_id, self.vpc_name))
# attach_vpn_gateway is available with ec2 client object
self.evpc.attach_vpn_gateway(vgw_id)
#self.vgw_id = vgw_id
#self.boto.ec2_client.attach_vpn_gateway(
# DryRun=False,
# VpnGatewayId = self.vgw_id,
# VpcId = self.evpc.id,
#)
## check & wait till VGW (2 min.) is attached
#count = 0
#while(not self.evpc.is_vgw_attached(vgw_id)):
# time.sleep(10)
# count += 1
# if count == 11:
# raise Exception({"message":"VPN Gateway is not yet attached.", "VGW_ID":vgw_id})
@retry(wait_exponential_multiplier=1000, wait_exponential_max=10000)
def _get_dhcp_options_from_id(self, dhcp_options_id):
return self.boto.ec2.DhcpOptions(dhcp_options_id)
def create_dhcp_options(self, dhcp_configurations):
"""Creates and return a new dhcp_options set."""
response = self.boto.ec2_client.create_dhcp_options(
DhcpConfigurations = dhcp_configurations
)
dhcp_options_id = nested_lookup('DhcpOptionsId', response)[0]
dhcp_options = self._get_dhcp_options_from_id(dhcp_options_id)
self.log.emit('tagging dhcp_options (Name:{})'.format(self.evpc.name), 'debug')
update_tags(dhcp_options, Name = self.evpc.name)
self.log.emit('associating dhcp_options to {}'.format(self.evpc.name))
dhcp_options.associate_with_vpc(VpcId = self.evpc.id)
def dhcp_options(self, dhcp_options_cfg):
"""Creates DHCP Options Set and associates with VPC"""
self.log.emit('creating DHCP Options Set for {}'.format(self.evpc.name))
cfg = dhcp_options_cfg
dhcp_configurations = [
{ 'Key' : 'domain-name-servers', 'Values' : cfg['domain-name-servers']},
{ 'Key' : 'domain-name', 'Values' : [self.evpc.route53.private_zone_name] },
]
self.create_dhcp_options(dhcp_configurations)
def route_tables(self, route_cfg):
"""Build route_tables defined in config"""
for rt_name, data in route_cfg.items():
longname = '{}-{}'.format(self.evpc.name, rt_name)
route_table = self.evpc.get_route_table(longname)
if route_table is None:
self.log.emit('creating route_table ({})'.format(longname))
if data.get('main', False) == True:
route_table = self.evpc.get_main_route_table()
else:
route_table = self.evpc.create_route_table()
self.log.emit('tagging route_table (Name:{})'.format(longname), 'debug')
update_tags(route_table, Name = longname)
def route_table_rules(self, route_cfg):
"""Build route table rules defined in config"""
# currently supports: igw, vgw, and instance_roles
for rt_name, data in route_cfg.items():
# this method assumes the route_table was already created.
route_table = self.evpc.get_route_table(rt_name)
for route in data.get('routes', []):
destination, target = route
self.log.emit('adding route {} to route_table ({})'.format(route, route_table.name))
if target.lower() == 'internet_gateway':
# TODO: ugly but we assume only one internet gateway.
route_table.create_route(
DestinationCidrBlock = destination,
GatewayId = list(self.evpc.internet_gateways.all())[0].id,
)
elif target.lower() == 'vpn_gateway':
# TODO: ugly but we assume only one VPN gateway.
route_table.create_route(
DestinationCidrBlock = destination,
GatewayId = self.evpc.vgw_id,
)
# if routed to VPN gateway propagate the route.
self.boto.ec2_client.enable_vgw_route_propagation(
RouteTableId = route_table.route_table_id,
GatewayId = self.evpc.vgw_id,
)
else:
# availability_zones of subnets associated to route_table.
azones = [a.subnet.availability_zone for a in route_table.associations if a.subnet is not None]
# assume the target is an instance_role.
instances = self.evpc.get_role(target)
# by default just randomly select one of the instances in the role.
nat_instance = choice(instances)
# try to correlate the route_table's associated subnet's availability_zone
# and the nat instance's subnet's availability_zone. Not always possible.
for instance in instances:
if instance.subnet.availability_zone in azones:
nat_instance = instance
self.log.emit('disable source dest check for {}'.format(nat_instance.identity))
nat_instance.disable_source_dest_check(False)
route_table.create_route(
DestinationCidrBlock = destination,
InstanceId = nat_instance.id,
)
def subnets(self, subnet_cfg):
"""Build subnets defined in config."""
sizes = sorted([x['size'] for x in subnet_cfg.values()])
cidrs = allocate(self.evpc.cidr_block, sizes)
azones = self.evpc.azones
subnets = {}
for size, cidr in zip(sizes, cidrs):
subnets.setdefault(size, []).append(cidr)
for name, sn in subnet_cfg.items():
longname = '{}-{}'.format(self.evpc.name, name)
az_letter = sn.get('availability_zone', None)
if az_letter is not None:
az_name = self.evpc.region_name + az_letter
else:
az_index = int(name.split('-')[-1]) - 1
az_name = azones[az_index]
cidr = subnets[sn['size']].pop()
self.log.emit('creating subnet {} in {}'.format(cidr, az_name))
subnet = self.evpc.create_subnet(
CidrBlock = str(cidr),
AvailabilityZone = az_name
)
self.log.emit('tagging subnet (Name:{})'.format(longname), 'debug')
update_tags(
subnet,
Name = longname,
description = sn.get('description', ''),
)
# Modifying the subnet's public IP addressing behavior.
if sn.get('public', False) == True:
subnet.map_public_ip_on_launch = True
def associate_route_tables_with_subnets(self, subnet_cfg):
for sn_name, sn_data in subnet_cfg.items():
rt_name = sn_data.get('route_table', None)
if rt_name is None:
continue
self.log.emit('associating rt {} with sn {}'.format(rt_name, sn_name))
self.evpc.associate_route_table_with_subnet(rt_name, sn_name)
def endpoints(self, route_tables):
"""Build VPC endpoints for given route_tables"""
if len(route_tables) == 0:
return None
self.log.emit(
'creating vpc endpoints in {}'.format(', '.join(route_tables))
)
self.evpc.vpc_endpoint.create_all(route_tables)
def security_groups(self, security_group_cfg):
"""Build Security Groups defined in config."""
for sg_name, rules in security_group_cfg.items():
sg = self.evpc.get_security_group(sg_name)
if sg is not None:
continue
longname = '{}-{}'.format(self.evpc.name, sg_name)
self.log.emit('creating security_group {}'.format(longname))
security_group = self.evpc.create_security_group(
GroupName = longname,
Description = longname,
)
self.log.emit(
'tagging security_group (Name:{})'.format(longname), 'debug'
)
update_tags(security_group, Name = longname)
def security_group_rules(self, security_group_cfg):
"""Build Security Group Rules defined in config."""
self.security_group_inbound_rules(security_group_cfg)
self.security_group_outbound_rules(security_group_cfg)
def security_group_rule_to_permission(self, rule):
"""Return a permission dictionary from a rule tuple."""
protocol = rule[1]
from_port, to_port = get_port_range(rule[2], protocol)
sg = self.evpc.get_security_group(rule[0])
permission = {
'IpProtocol' : protocol,
'FromPort' : from_port,
'ToPort' : to_port,
}
if sg is None:
permission['IpRanges'] = [{'CidrIp' : rule[0]}]
else:
permission['UserIdGroupPairs'] = [{'GroupId':sg.id}]
return permission
def security_group_rules_to_permissions(self, sg_name, rules, direction='inbound'):
msg = "{} rule: '{}' {} '{}' over ports {} ({})"
symbol = { 'inbound' : '->', 'outbound' : '<-' }.get(direction, '->')
permissions = []
for rule in rules.get(direction, {}):
permissions.append(self.security_group_rule_to_permission(rule))
self.log.emit(
msg.format(direction, rule[0], symbol, sg_name, rule[2], rule[1].upper())
)
return permissions
def security_group_inbound_rules(self, security_group_cfg):
"""Build inbound rule for Security Group defined in config."""
for sg_name, rules in security_group_cfg.items():
sg = self.evpc.get_security_group(sg_name)
permissions = self.security_group_rules_to_permissions(sg_name, rules, 'inbound')
if permissions:
sg.authorize_ingress(
IpPermissions = permissions
)
def security_group_outbound_rules(self, security_group_cfg):
"""Build outbound rule for Security Group defined in config."""
for sg_name, rules in security_group_cfg.items():
sg = self.evpc.get_security_group(sg_name)
permissions = self.security_group_rules_to_permissions(sg_name, rules, 'outbound')
if permissions:
self.log.emit("revoking default outbound rule from {}".format(sg_name))
self.security_group_outbound_revoke_default_rule(sg)
sg.authorize_egress(
IpPermissions = permissions
)
def security_group_outbound_revoke_default_rule(self, sg):
sg.revoke_egress(
IpPermissions = [
{
'IpProtocol' : '-1', 'FromPort' : -1, 'ToPort' : -1,
'IpRanges' : [ { 'CidrIp' : '0.0.0.0/0' } ],
}
]
)
def key_pairs(self, key_pair_cfg):
key_pair_cfg.append('default')
for short_key_pair_name in key_pair_cfg:
if self.evpc.key_pair.get_key_pair(short_key_pair_name) is None:
self.log.emit('creating key pair {}'.format(short_key_pair_name))
self.evpc.key_pair.create_key_pair(short_key_pair_name)
def get_instance_profile(self, instance_profile_name):
"""Return instance_profile or None."""
for profile in list(self.boto.iam.instance_profiles.all()):
if profile.name == instance_profile_name:
return profile
def create_instance_profile(self, instance_profile_name):
"""Create instance_profile and role, return instance_profile."""
instance_profile = self.boto.iam.create_instance_profile(
InstanceProfileName = instance_profile_name
)
iam_role = self.boto.iam.create_role(
RoleName = instance_profile_name,
AssumeRolePolicyDocument = DEFAULT_EC2_TRUST_POLICY,
)
instance_profile.add_role(
RoleName = instance_profile_name,
)
return instance_profile
# retry because instance_profile / iam role not ready right away...
@retry(wait_exponential_multiplier=1000, wait_exponential_max=10000)
def wait_for_instance_profile(self, instance_profile_name):
msg = 'waiting for {} instance_profile / iam_role to exist ...'
if self.get_instance_profile(instance_profile_name) is None:
self.log.emit(msg.format(instance_profile_name))
raise Exception(msg.format(instance_profile_name))
def _get_or_create_iam_instance_profile(self, instance_profile_name):
instance_profile = self.get_instance_profile(instance_profile_name)
if instance_profile is None:
instance_profile = self.create_instance_profile(instance_profile_name)
return instance_profile
def instance_profiles(self, instance_role_cfg):
msg = "make sure {} instance_profile and iam_role exist"
for role_name, role_data in instance_role_cfg.items():
profile_name = role_data.get('instance_profile_name', None)
if profile_name:
self.log.emit(msg.format(profile_name))
self._get_or_create_iam_instance_profile(profile_name)
def instance_roles(self, instance_role_cfg):
"""Create instance roles defined in config."""
for role_name, role_data in instance_role_cfg.items():
desired_count = role_data.get('count', 0)
role_instances = self.instance_role(
role_name,
role_data,
desired_count,
)
def instance_role(self, role_name, role_data, desired_count):
if role_data.get('autoscaling', False) == True:
# exit early if this instance_role is autoscaling.
return []
self.log.emit('creating role: {}'.format(role_name))
ami = self.amis[role_data['ami']][self.evpc.region_name]
key_pair = self.evpc.key_pair.get_key_pair(
role_data.get('key_pair', 'default')
)
security_groups = map(
self.evpc.get_security_group,
role_data.get('security_groups', [])
)
subnets = map(
self.evpc.get_subnet,
role_data.get('subnets', [])
)
if len(subnets) == 0:
self.log.emit(
'no subnets found for role: {}'.format(role_name), 'warning'
)
# exit early.
return None
# sort by subnets by amount of instances, smallest first.
subnets = sorted(
subnets,
key = lambda sn : collection_len(sn.instances),
)
# determine the count of this role's existing instances.
# Note: we look for role in all subnets, not just the listed subnets.
existing_count = len(self.evpc.get_role(role_name))
if existing_count >= desired_count:
# for now we exit early, maybe terminate extras...
self.log.emit('{} {}'.format(existing_count, desired_count), 'debug')
return None
# determine count of additional instances needed to reach desired_count.
needed_count = desired_count - existing_count
needed_per_subnet = desired_count / len(subnets)
needed_remainder = desired_count % len(subnets)
block_device_map = get_block_device_map_from_role_config(role_data)
role_instances = []
kwargs = {
'ImageId' : ami,
'InstanceType' : role_data.get('instance_type'),
'KeyName' : key_pair.name,
'SecurityGroupIds' : get_ids(security_groups),
'BlockDeviceMappings' : block_device_map,
'UserData' : role_data.get('userdata', ''),
'IamInstanceProfile' : {},
}
profile_name = role_data.get('instance_profile_name', None)
if profile_name:
kwargs['IamInstanceProfile'] = { 'Name' : profile_name }
for subnet in subnets:
# ensure Run_Instance_Idempotency.html#client-tokens
kwargs['ClientToken'] = str(uuid4())
# figure out how many instances this subnet needs to create ...
existing_in_subnet = len(self.evpc.get_role(role_name, subnet.instances.all()))
count = needed_per_subnet - existing_in_subnet
if needed_remainder != 0:
needed_remainder -= 1
count += 1
if count == 0:
# skip this subnet, it doesn't need to launch any instances.
continue
subnet_name = make_tag_dict(subnet)['Name']
msg = '{} instances of role {} launching into {} subnet'
self.log.emit(msg.format(count, role_name, subnet_name))
# create a batch of instances in subnet!
kwargs['MinCount'] = kwargs['MaxCount'] = count
instances = self._create_instances(subnet, **kwargs)
# accumulate all new instances into a single list.
role_instances += instances
# add role tag to each instance.
for instance in role_instances:
update_tags(instance, role = role_name)
# retry because iam role not ready right away...
@retry(wait_exponential_multiplier=1000, wait_exponential_max=10000)
def _create_instances(self, subnet, **kwargs):
return subnet.create_instances(**kwargs)
def autoscaling_instance_roles(self, instance_role_cfg):
"""Create Autoscaling Groups and Launch Configurations."""
for role_name, role_data in instance_role_cfg.items():
desired_count = role_data.get('count', 0)
self.autoscaling_instance_role(
role_name,
role_data,
desired_count,
)
def autoscaling_instance_role(self, role_name, role_data, desired_count):
if role_data.get('autoscaling', False) != True:
# exit early if this instance_role is not autoscaling.
return None
long_role_name = '{}-{}'.format(self.evpc.name, role_name)
ami = self.amis[role_data['ami']][self.evpc.region_name]
key_pair = self.evpc.key_pair.get_key_pair(
role_data.get('key_pair', 'default')
)
security_groups = map(
self.evpc.get_security_group,
role_data.get('security_groups', [])
)
subnets = map(
self.evpc.get_subnet,
role_data.get('subnets', [])
)
block_device_map = get_block_device_map_from_role_config(role_data)
kwargs = {
'LaunchConfigurationName' : long_role_name,
'ImageId' : ami,
'InstanceType' : role_data.get('instance_type'),
'KeyName' : key_pair.name,
'SecurityGroups' : get_ids(security_groups),
'BlockDeviceMappings' : block_device_map,
'UserData' : role_data.get('userdata', ''),
}
profile_name = role_data.get('instance_profile_name', None)
if profile_name:
# only add profile if set. Empty string causes error.
kwargs['IamInstanceProfile'] = profile_name
self.wait_for_instance_profile(profile_name)
self.log.emit('creating launch configuration for role: {}'.format(long_role_name))
self.evpc.autoscaling.create_launch_configuration(**kwargs)
self.log.emit('creating autoscaling group for role: {}'.format(long_role_name))
self.evpc.autoscaling.create_auto_scaling_group(
AutoScalingGroupName = long_role_name,
LaunchConfigurationName = long_role_name,
MinSize = desired_count,
MaxSize = desired_count,
DesiredCapacity = desired_count,
VPCZoneIdentifier = ','.join(get_ids(subnets)),
Tags = [
{ 'Key' : 'role', 'Value' : role_name, 'PropagateAtLaunch' : True, },
]
)
# retry because autoscaled instances don't have the role tag right away.
@retry(wait_exponential_multiplier=1000, wait_exponential_max=10000)
def tag_instance_name(self, instance):
"""Accept a EnrichedInstance, objects create tags."""
msg = 'tagging instance {} (Name:{})'
h = '{}-{}-{}'
hostname = h.format(self.evpc.name, instance.role, instance.id_human)
self.log.emit(msg.format(instance.identity, hostname))
update_tags(instance, Name = hostname)
def tag_instance_volumes(self, instance):
"""Accept an EnrichedInstance, tag all attached volumes."""
msg = 'tagging volumes for instance {} (Name:{})'
for volume in instance.volumes.all():
self.log.emit(msg.format(instance.identity, instance.identity))
update_tags(volume, Name = instance.identity)
def add_eip_to_instance(self, instance):
eip1_msg = 'allocating and associating eip for {}'
eip2_msg = 'associated eip {} to {}'
self.log.emit(eip1_msg.format(instance.identity))
eip = instance.allocate_and_associate_eip()
self.log.emit(eip2_msg.format(eip.public_ip, instance.identity))
@retry(wait_exponential_multiplier=1000, wait_exponential_max=10000)
def wait_for_instance_roles_to_exist(self, instance_role_cfg):
raw_msg = 'waiting: we desire {} instances but only {} exist in role {}'
roles = self.evpc.roles
for role_name, role_cfg in instance_role_cfg.items():
desired_count = role_cfg.get('count', 0)
actual_count = len(roles.get(role_name, []))
if desired_count > actual_count:
msg = raw_msg.format(desired_count, actual_count, role_name)
self.log.emit(msg, 'debug')
raise Exception(msg)
def finish_instance_roles(self, instance_role_cfg, instances=None):
instances = self.evpc.get_instances(instances)
for instance in instances:
self.log.emit('waiting for {} to start'.format(instance))
instance.wait_until_running()
# this method call will block (retry) until instance is named.
self.tag_instance_name(instance)
self.tag_instance_volumes(instance)
requires_eip = instance_role_cfg.get(instance.role, {}).get('eip', False)
if requires_eip and len(instance.eips) == 0:
# if instance role should have an eip but doesn't have one, add one.
self.add_eip_to_instance(instance)
try:
self.log.emit('locking new normal (not autoscaled) instances to prevent termination')
self.evpc.lock_instances(self.evpc.get_normal_instances(instances))
except:
self.log.emit('could not lock instances, continuing...', 'warning')
def db_instances(self, db_instance_cfg):
"""Build RDS DB Instances."""
for rds_name, db_cfg in db_instance_cfg.items():
self.log.emit('creating {} RDS db_instance ...'.format(rds_name))
# make list of security group ids.
security_groups = map(
self.evpc.get_security_group,
db_cfg.get('security_groups', [])
)
sg_ids = get_ids(security_groups)
# make list of subnet ids.
subnets = map(
self.evpc.get_subnet,
db_cfg.get('subnets', [])
)
sn_ids = get_ids(subnets)
self.evpc.rds.create_db_subnet_group(
DBSubnetGroupName = rds_name,
DBSubnetGroupDescription = db_cfg.get('description',''),
SubnetIds = sn_ids,
)
self.evpc.rds.create_db_instance(
DBInstanceIdentifier = rds_name,
DBSubnetGroupName = rds_name,
DBName = db_cfg.get('name', rds_name),
VpcSecurityGroupIds = sg_ids,
DBInstanceClass = db_cfg.get('class', 'db.t2.medium'),
AllocatedStorage = db_cfg.get('allocated_storage', 100),
Engine = db_cfg.get('engine'),
EngineVersion = db_cfg.get('engine_version', ''),
Iops = db_cfg.get('iops', 0),
MultiAZ = db_cfg.get('multi_az', False),
MasterUsername = db_cfg.get('master_username'),
MasterUserPassword = generate_password(16),
BackupRetentionPeriod = db_cfg.get('backup_retention_period', 0),
Tags = [ { 'Key' : 'vpc_name', 'Value' : self.evpc.vpc_name } ],
)
def load_balancers(self, load_balancer_cfg):
"""Build ELB load balancers."""
for lb_name, lb_cfg in load_balancer_cfg.items():
lb_fullname = '{}-{}'.format(self.evpc.name, lb_name)
self.log.emit('creating {} load_balancer ...'.format(lb_fullname))
# make list of security group ids.
security_groups = map(
self.evpc.get_security_group,
lb_cfg.get('security_groups', [])
)
sg_ids = get_ids(security_groups)
# make list of subnet ids.
subnets = map(
self.evpc.get_subnet,
lb_cfg.get('subnets', [])
)
sn_ids = get_ids(subnets)
scheme = 'internet-facing'
if lb_cfg.get('internal', False):
scheme = 'internal'
listeners = lb_cfg.get('listeners', [])
self.evpc.elb.create_load_balancer(
LoadBalancerName = lb_fullname,
Subnets = sn_ids,
SecurityGroups = sg_ids,
Scheme = scheme,
Tags = [
{ 'Key' : 'vpc_name', 'Value' : self.evpc.vpc_name },
{ 'Key' : 'role', 'Value' : lb_cfg['instance_role'] },
],
Listeners = self.evpc.elb.format_listeners(listeners),
)
self.log.emit('created {} load_balancer ...'.format(lb_fullname))
self.log.emit('Configure Health Check for {} load_balancer ...'.format(lb_fullname))
hc_cfg = lb_cfg.get('healthcheck', {})
hc_default_target = 'TCP:{}'.format(listeners[0][1])
self.evpc.elb.configure_health_check(
LoadBalancerName= lb_fullname,
HealthCheck={
'Target': hc_cfg.get('target',hc_default_target),
'Interval': hc_cfg.get('interval',15),
'Timeout': hc_cfg.get('timeout',5),
'UnhealthyThreshold': hc_cfg.get('unhealthy_threshold',4),
'HealthyThreshold': hc_cfg.get('healthy_threshold',4)
}
)
self.log.emit('Configured Health Check for {} load_balancer ...'.format(lb_fullname))
asg_name = '{}-{}'.format(self.evpc.name, lb_cfg['instance_role'])
if asg_name in self.evpc.autoscaling.get_related_autoscaling_group_names():
self.log.emit('attaching {} load balancer to {} autoscaling group ...'.format(lb_fullname, asg_name))
self.evpc.autoscaling.attach_load_balancers(
AutoScalingGroupName = asg_name,
LoadBalancerNames = [lb_fullname],
)
else:
self.log.emit('registering {} role to {} load balancer ...'.format(lb_cfg['instance_role'], lb_fullname))
self.evpc.elb.register_role_with_load_balancer(lb_fullname, lb_cfg['instance_role'])
class EnvironmentBuilder(object):
def __init__(self, vpc_name, config=None, region_name=None, profile_name=None, log=None):
"""
vpc_name:
The human readable Name tag of this VPC.
config:
The dict returned by botoform.config.ConfigLoader's load method.
"""
self.vpc_name = vpc_name
self.config = config if config is not None else {}
self.log = log if log is not None else Log()
self.boto = BotoConnections(region_name, profile_name)
self.reflect = False
def apply_all(self):
"""Build the environment specified in the config."""
try:
self._apply_all(self.config)
except Exception as e:
self.log.emit('Botoform failed to build environment!', 'error')
self.log.emit('Failure reason: {}'.format(e), 'error')
self.log.emit(traceback.format_exc(), 'debug')
self.log.emit('Tearing down failed environment!', 'error')
#self.evpc.terminate()
raise
def _apply_all(self, config):
# Make sure amis is setup early. (TODO: raise exception if missing)
self.amis = config['amis']
# set a var for no_cfg.
no_cfg = {}
# attach EnrichedVPC to self.
self.evpc = EnrichedVPC(self.vpc_name, self.boto.region_name, self.boto.profile_name)
# the order of these method calls matters for new VPCs.
self.route_tables(config.get('route_tables', no_cfg))
self.subnets(config.get('subnets', no_cfg))
self.associate_route_tables_with_subnets(config.get('subnets', no_cfg))
self.security_groups(config.get('security_groups', no_cfg))
self.key_pairs(config.get('key_pairs', []))
new_instances = self.instance_roles(
config.get('instance_roles', no_cfg)
)
# lets do more work while new_instances move from pending to running.
self.endpoints(config.get('endpoints', []))
self.security_group_rules(config.get('security_groups', no_cfg))
# lets finish building the new instances.
self.finish_instance_roles(
config.get('instance_roles', no_cfg), new_instances,
)
self.log.emit('done! don\'t you look awesome. : )')
def build_vpc(self, cidrblock):
"""Build VPC"""
self.log.emit('creating vpc ({}, {})'.format(self.vpc_name, cidrblock))
vpc = self.boto.ec2.create_vpc(CidrBlock = cidrblock)
self.log.emit('tagging vpc (Name:{})'.format(self.vpc_name), 'debug')
update_tags(vpc, Name = self.vpc_name)
self.log.emit('modifying vpc for dns support', 'debug')
vpc.modify_attribute(EnableDnsSupport={'Value': True})
self.log.emit('modifying vpc for dns hostnames', 'debug')
vpc.modify_attribute(EnableDnsHostnames={'Value': True})
igw_name = 'igw-' + self.vpc_name
self.log.emit('creating internet_gateway ({})'.format(igw_name))
gw = self.boto.ec2.create_internet_gateway()
self.log.emit('tagging gateway (Name:{})'.format(igw_name), 'debug')
update_tags(gw, Name = igw_name)
self.log.emit('attaching igw to vpc ({})'.format(igw_name))
vpc.attach_internet_gateway(
DryRun=False,
InternetGatewayId=gw.id,
VpcId=vpc.id,
)
def route_tables(self, route_cfg):
"""Build route_tables defined in config"""
for rt_name, data in route_cfg.items():
longname = '{}-{}'.format(self.evpc.name, rt_name)
route_table = self.evpc.get_route_table(longname)
if route_table is None:
self.log.emit('creating route_table ({})'.format(longname))
if data.get('main', False) == True:
route_table = self.evpc.get_main_route_table()
else:
route_table = self.evpc.create_route_table()
self.log.emit('tagging route_table (Name:{})'.format(longname), 'debug')
update_tags(route_table, Name = longname)
# TODO: move to separate method ...
# gatewayId, natGatewayId, networkInterfaceId, vpcPeeringConnectionId or instanceId
# add routes to route_table defined in configuration.
for route in data.get('routes', []):
destination, target = route
self.log.emit('adding route {} to route_table ({})'.format(route, longname))
if target.lower() == 'internet_gateway':
# this is ugly but we assume only one internet gateway.
route_table.create_route(
DestinationCidrBlock = destination,
GatewayId = list(self.evpc.internet_gateways.all())[0].id,
)
def subnets(self, subnet_cfg):
"""Build subnets defined in config."""
sizes = sorted([x['size'] for x in subnet_cfg.values()])
cidrs = allocate(self.evpc.cidr_block, sizes)
azones = self.evpc.azones
subnets = {}
for size, cidr in zip(sizes, cidrs):
subnets.setdefault(size, []).append(cidr)
for name, sn in subnet_cfg.items():
longname = '{}-{}'.format(self.evpc.name, name)
az_letter = sn.get('availability_zone', None)
if az_letter is not None:
az_name = self.evpc.region_name + az_letter
else:
az_index = int(name.split('-')[-1]) - 1
az_name = azones[az_index]
cidr = subnets[sn['size']].pop()
self.log.emit('creating subnet {} in {}'.format(cidr, az_name))
subnet = self.evpc.create_subnet(
CidrBlock = str(cidr),
AvailabilityZone = az_name
)
self.log.emit('tagging subnet (Name:{})'.format(longname), 'debug')
update_tags(
subnet,
Name = longname,
description = sn.get('description', ''),
)
# Modifying the subnet's public IP addressing behavior.
if sn.get('public', False) == True:
subnet.map_public_ip_on_launch = True
def associate_route_tables_with_subnets(self, subnet_cfg):
for sn_name, sn_data in subnet_cfg.items():
rt_name = sn_data.get('route_table', None)
if rt_name is None:
continue
self.log.emit('associating rt {} with sn {}'.format(rt_name, sn_name))
self.evpc.associate_route_table_with_subnet(rt_name, sn_name)
def endpoints(self, route_tables):
"""Build VPC endpoints for given route_tables"""
if len(route_tables) == 0:
return None
self.log.emit(
'creating vpc endpoints in {}'.format(', '.join(route_tables))
)
self.evpc.vpc_endpoint.create_all(route_tables)
def security_groups(self, security_group_cfg):
"""Build Security Groups defined in config."""
for sg_name, rules in security_group_cfg.items():
sg = self.evpc.get_security_group(sg_name)
if sg is not None:
continue
longname = '{}-{}'.format(self.evpc.name, sg_name)
self.log.emit('creating security_group {}'.format(longname))
security_group = self.evpc.create_security_group(
GroupName = longname,
Description = longname,
)
self.log.emit(
'tagging security_group (Name:{})'.format(longname), 'debug'
)
update_tags(security_group, Name = longname)
def security_group_rules(self, security_group_cfg):
"""Build Security Group Rules defined in config."""
msg = "'{}' into '{}' over ports {} ({})"
for sg_name, rules in security_group_cfg.items():
sg = self.evpc.get_security_group(sg_name)
permissions = []
for rule in rules:
protocol = rule[1]
from_port, to_port = get_port_range(rule[2], protocol)
src_sg = self.evpc.get_security_group(rule[0])
permission = {
'IpProtocol' : protocol,
'FromPort' : from_port,
'ToPort' : to_port,
}
if src_sg is None:
permission['IpRanges'] = [{'CidrIp' : rule[0]}]
else:
permission['UserIdGroupPairs'] = [{'GroupId':src_sg.id}]
permissions.append(permission)
fmsg = msg.format(rule[0],sg_name,rule[2],rule[1].upper())
self.log.emit(fmsg)
sg.authorize_ingress(
IpPermissions = permissions
)
def key_pairs(self, key_pair_cfg):
key_pair_cfg.append('default')
for short_key_pair_name in key_pair_cfg:
if self.evpc.key_pair.get_key_pair(short_key_pair_name) is None:
self.log.emit('creating key pair {}'.format(short_key_pair_name))
self.evpc.key_pair.create_key_pair(short_key_pair_name)
def instance_roles(self, instance_role_cfg):
"""Returns a list of new created EnrichedInstance objects."""
new_instances = []
for role_name, role_data in instance_role_cfg.items():
desired_count = role_data.get('count', 0)
role_instances = self.instance_role(
role_name,
role_data,
desired_count,
)
new_instances += role_instances
return new_instances
def instance_role(self, role_name, role_data, desired_count):
self.log.emit('creating role: {}'.format(role_name))
ami = self.amis[role_data['ami']][self.evpc.region_name]
key_pair = self.evpc.key_pair.get_key_pair(
role_data.get('key_pair', 'default')
)
security_groups = map(
self.evpc.get_security_group,
role_data.get('security_groups', [])
)
subnets = map(
self.evpc.get_subnet,
role_data.get('subnets', [])
)
if len(subnets) == 0:
self.log.emit(
'no subnets found for role: {}'.format(role_name), 'warning'
)
# exit early.
return None
# sort by subnets by amount of instances, smallest first.
subnets = sorted(
subnets,
key = lambda sn : collection_len(sn.instances),
)
# determine the count of this role's existing instances.
# Note: we look for role in all subnets, not just the listed subnets.
existing_count = len(self.evpc.get_role(role_name))
if existing_count >= desired_count:
# for now we exit early, maybe terminate extras...
self.log.emit(existing_count + ' ' + desired_count, 'debug')
return None
# determine count of additional instances needed to reach desired_count.
needed_count = desired_count - existing_count
needed_per_subnet = needed_count / len(subnets)
needed_remainder = needed_count % len(subnets)
role_instances = []
for subnet in subnets:
# ensure Run_Instance_Idempotency.html#client-tokens
client_token = str(uuid4())
# figure out how many instances this subnet needs to create ...
existing_in_subnet = len(self.evpc.get_role(role_name, subnet.instances.all()))
count = needed_per_subnet - existing_in_subnet
if needed_remainder != 0:
needed_remainder -= 1
count += 1
if count == 0:
# skip this subnet, it doesn't need to launch any instances.
continue
subnet_name = make_tag_dict(subnet)['Name']
msg = '{} instances of role {} launching into {}'
self.log.emit(msg.format(count, role_name, subnet_name))
# create a batch of instances in subnet!
instances = subnet.create_instances(
ImageId = ami,
InstanceType = role_data.get('instance_type'),
MinCount = count,
MaxCount = count,
KeyName = key_pair.name,
SecurityGroupIds = get_ids(security_groups),
ClientToken = client_token,
)
# accumulate all new instances into a single list.
role_instances += instances
# cast role Instance objets to EnrichedInstance objects.
role_instances = self.evpc.get_instances(role_instances)
self.tag_instances(role_name, role_instances)
return role_instances
def tag_instances(self, role_name, instances):
"""Accept a list of EnrichedInstance, objects create tags."""
msg = 'tagging instance {} (Name:{}, role:{})'
for instance in instances:
h = '{}-{}-{}'
hostname = h.format(self.evpc.name, role_name, instance.id_human)
self.log.emit(msg.format(instance.identity, hostname, role_name))
update_tags(instance, Name = hostname, role = role_name)
def tag_instance_volumes(self, instance):
"""Accept an EnrichedInstance, tag all attached volumes."""
msg = 'tagging volumes for instance {} (Name:{})'
for volume in instance.volumes.all():
self.log.emit(msg.format(instance.identity, instance.identity))
update_tags(volume, Name = instance.identity)
def add_eip_to_instance(self, instance):
eip1_msg = 'allocating eip and associating with {}'
eip2_msg = 'allocated eip {} and associated with {}'
self.log.emit(eip1_msg.format(instance.identity))
eip = instance.allocate_eip()
self.log.emit(eip2_msg.format(eip.public_ip, instance.identity))
def finish_instance_roles(self, instance_role_cfg, instances):
for instance in instances:
self.log.emit('waiting for {} to start'.format(instance.identity))
instance.wait_until_running()
self.tag_instance_volumes(instance)
# allocate eips and associate for the needful instances.
if instance_role_cfg[instance.role].get('eip', False) == True:
self.add_eip_to_instance(instance)
try:
self.log.emit('locking new instances to prevent termination')
self.evpc.lock_instances(instances)
except:
self.log.emit('could not lock instances, continuing...', 'warning')
class EnvironmentBuilder(object):
def __init__(self,
vpc_name,
config=None,
region_name=None,
profile_name=None,
log=None):
"""
vpc_name:
The human readable Name tag of this VPC.
config:
The dict returned by botoform.config.ConfigLoader's load method.
"""
self.vpc_name = vpc_name
self.config = config if config is not None else {}
self.log = log if log is not None else Log()
self.boto = BotoConnections(region_name, profile_name)
self.reflect = False
def apply_all(self):
"""Build the environment specified in the config."""
try:
self._apply_all(self.config)
except Exception as e:
self.log.emit('Botoform failed to build environment!', 'error')
self.log.emit('Failure reason: {}'.format(e), 'error')
self.log.emit(traceback.format_exc(), 'debug')
self.log.emit('Tearing down failed environment!', 'error')
#self.evpc.terminate()
raise
def _apply_all(self, config):
# set a var for no_cfg.
no_cfg = {}
# attach EnrichedVPC to self.
self.evpc = EnrichedVPC(self.vpc_name, self.boto.region_name,
self.boto.profile_name)
# the order of these method calls matters for new VPCs.
self.route_tables(config.get('route_tables', no_cfg))
self.subnets(config.get('subnets', no_cfg))
self.associate_route_tables_with_subnets(config.get('subnets', no_cfg))
self.endpoints(config.get('endpoints', []))
self.security_groups(config.get('security_groups', no_cfg))
self.security_group_rules(config.get('security_groups', no_cfg))
try:
self.evpc.lock_instances()
except:
self.log.emit('Could not lock instances, continuing...', 'warning')
def build_vpc(self, cidrblock):
"""Build VPC"""
self.log.emit('creating vpc ({}, {})'.format(self.vpc_name, cidrblock))
vpc = self.boto.ec2.create_vpc(CidrBlock=cidrblock)
self.log.emit('tagging vpc (Name:{})'.format(self.vpc_name), 'debug')
update_tags(vpc, Name=self.vpc_name)
self.log.emit('modifying vpc for dns support', 'debug')
vpc.modify_attribute(EnableDnsSupport={'Value': True})
self.log.emit('modifying vpc for dns hostnames', 'debug')
vpc.modify_attribute(EnableDnsHostnames={'Value': True})
igw_name = 'igw-' + self.vpc_name
self.log.emit('creating internet_gateway ({})'.format(igw_name))
gw = self.boto.ec2.create_internet_gateway()
self.log.emit('tagging gateway (Name:{})'.format(igw_name), 'debug')
update_tags(gw, Name=igw_name)
self.log.emit('attaching igw to vpc ({})'.format(igw_name))
vpc.attach_internet_gateway(
DryRun=False,
InternetGatewayId=gw.id,
VpcId=vpc.id,
)
def route_tables(self, route_cfg):
"""Build route_tables defined in config"""
for name, data in route_cfg.items():
longname = '{}-{}'.format(self.evpc.name, name)
route_table = self.evpc.get_route_table(longname)
if route_table is None:
self.log.emit('creating route_table ({})'.format(longname))
if data.get('main', False) == True:
route_table = self.evpc.get_main_route_table()
else:
route_table = self.evpc.create_route_table()
self.log.emit('tagging route_table (Name:{})'.format(longname),
'debug')
update_tags(route_table, Name=longname)
def subnets(self, subnet_cfg):
"""Build subnets defined in config."""
sizes = sorted([x['size'] for x in subnet_cfg.values()])
cidrs = allocate(self.evpc.cidr_block, sizes)
azones = self.evpc.azones
subnets = {}
for size, cidr in zip(sizes, cidrs):
subnets.setdefault(size, []).append(cidr)
for name, sn in subnet_cfg.items():
longname = '{}-{}'.format(self.evpc.name, name)
az_letter = sn.get('availability_zone', None)
if az_letter is not None:
az_name = self.evpc.region_name + az_letter
else:
az_index = int(name.split('-')[-1]) - 1
az_name = azones[az_index]
cidr = subnets[sn['size']].pop()
self.log.emit('creating subnet {} in {}'.format(cidr, az_name))
subnet = self.evpc.create_subnet(CidrBlock=str(cidr),
AvailabilityZone=az_name)
self.log.emit('tagging subnet (Name:{})'.format(longname), 'debug')
update_tags(
subnet,
Name=longname,
description=sn.get('description', ''),
)
def associate_route_tables_with_subnets(self, subnet_cfg):
for sn_name, sn_data in subnet_cfg.items():
rt_name = sn_data.get('route_table', None)
if rt_name is None:
continue
self.log.emit('associating rt {} with sn {}'.format(
rt_name, sn_name))
self.evpc.associate_route_table_with_subnet(rt_name, sn_name)
def endpoints(self, route_tables):
"""Build VPC endpoints for given route_tables"""
if len(route_tables) == 0:
return None
self.log.emit('creating vpc endpoints in {}'.format(
', '.join(route_tables)))
self.evpc.vpc_endpoint.create_all(route_tables)
def security_groups(self, security_group_cfg):
"""Build Security Groups defined in config."""
for sg_name, rules in security_group_cfg.items():
sg = self.evpc.get_security_group(sg_name)
if sg is not None:
continue
longname = '{}-{}'.format(self.evpc.name, sg_name)
self.log.emit('creating security_group {}'.format(longname))
security_group = self.evpc.create_security_group(
GroupName=longname,
Description=longname,
)
self.log.emit('tagging security_group (Name:{})'.format(longname),
'debug')
update_tags(security_group, Name=longname)
def security_group_rules(self, security_group_cfg):
"""Build Security Group Rules defined in config."""
msg = "'{}' into '{}' over ports {} ({})"
for sg_name, rules in security_group_cfg.items():
sg = self.evpc.get_security_group(sg_name)
permissions = []
for rule in rules:
protocol = rule[1]
from_port, to_port = get_port_range(rule[2], protocol)
src_sg = self.evpc.get_security_group(rule[0])
permission = {
'IpProtocol': protocol,
'FromPort': from_port,
'ToPort': to_port,
}
if src_sg is None:
permission['IpRanges'] = [{'CidrIp': rule[0]}]
else:
permission['UserIdGroupPairs'] = [{'GroupId': src_sg.id}]
permissions.append(permission)
fmsg = msg.format(rule[0], sg_name, rule[2], rule[1].upper())
self.log.emit(fmsg)
sg.authorize_ingress(IpPermissions=permissions)