peerd is an AWS VPC Peering Connection management tool. It creates full-meshes of VPCs from a yaml file, and manages the full lifecycle of creation, deletion and route table updates needed to make VPC peerings useful across accounts and regions. Contributions welcome.
peerd is an AWS VPC Peering Connection management tool. It creates full-meshes of VPCs peerings based on a simple yaml file, and manages the full lifecycle of creation, deletion and route table updates needed to make VPC peerings useful across accounts and regions. Contributions welcome.
./peerd.py --help usage: peerd.py [-h] [--debug] --config CONFIG --environment ENVIRONMENT
AWS VPC Peering Management Tool
optional arguments: -h, --help show this help message and exit --debug Set log-level to DEBUG --config CONFIG, -c CONFIG Path to configuration file --environment ENVIRONMENT, -e ENVIRONMENT Only execute the script on this environment --dryrun, -d Only check for peerings which might be created or deleted. No changes made to mesh.
Ansible, Terraform, Transit Gateway are valid approaches to creating networks between AWS VPCs. peerd attempts to solve the issue of managing complex overlapping meshes of VPC peerings between many accounts and regions, which can be difficult with other tools or result in large configuration modules/files.
peerd will assume a target IAM role with the same principal name in each account it needs to perform work in. The target IAM role must have EC2 route table, VPC and Peering read and write permissions.
arn:aws:iam::0987654321:role/peerd-botare two accounts with VPCs being peered together.
# Install python 3.8 or higher if needed brew install [email protected]
$ python3 --version Python 3.8.1
Verify python path (may be different if using brew)
$ which python3 /Library/Frameworks/Python.framework/Versions/3.8/bin/python3
Create a virtual environment
mkvirtualenv peerd -p python3
Activate virtual environment
pip install -r requirements.txt
In the following example, VPCs across multiple regions and accounts will be peered together into a two overlapping meshes. Route tables in each VPC with tag peerd_eligible:true on said route tables will be updated. Unassumable account numbers, principals and non-existent VPCs will be skipped.
metadata: resourceowner: myname businessunit: PaaS servicename: peerd support: [email protected] commonprincipalname: peerd-bot rolesessionname: peerd environments: myfirstenvironment: - accountid: '415433457294' vpcid: vpc-bi37c2c47 region: ap-southeast-2 note: peerd test vpc1 cidroverrides: - 192.168.4.0/24 peeringtags: mycustomtaga: '0' - accountid: '415433457294' vpcid: vpc-vb787854 region: ap-southeast-2 note: peerd test vpc2 cidroverrides: - 10.53.101.32/27 - 10.53.128.128/25 - 192.168.2.0/24 - 188.8.131.52/24 peeringtags: mycustomtagb: '1' - accountid: '415433457294' vpcid: vpc-v52oby8v7 region: ap-southeast-2 note: peerd test vpc3 - accountid: '415433457294' vpcid: vpc-2378vby38vb348 region: ap-southeast-1 note: peerd test vpc4 - accountid: '415433457294' vpcid: vpc-8tv23o87yv4 region: ap-southeast-1 note: vpc does not exist, will be skipped - accountid: '123456789012' vpcid: vpc-abc12345 region: ap-southeast-2 note: account does not exist, will be skipped - accountid: '4375823475902' vpcid: vpc-7834bcri234bcr region: us-east-1 note: peerd test vpc5 myseecondenvironment: - accountid: '415433457294' vpcid: vpc-2378vby38vb348 region: ap-southeast-1 note: peerd test vpc4 - accountid: '4375823475902' vpc_id: vpc-23754cn5b38bc region: us-east-2 note: peerd test vpc6 ```
./peerd.py --config ./config/config.yaml --environment myfirstenvironment
Simply remove the vpc block from the configuration file then re-run the tool.
Note: The tool does not keep state, but it is possible to remove multiple VPCs at a time. When run, the tool will go through all existing peerings that terminate in accounts in the config file, and will check if any of them peers with accounts not listed the config file. If it finds any, it will login to those accounts, and determine if there are additional peerings to delete.
For this reason, to completely delete an entire mesh, first remove all VPCs from the config file except one (the tool will need one to be able to determine all the peerings that have to be deleted). Once all peerings are deleted, you can safely remove the last one from the config file.
Shane Anderson, Nicolas Meessen, Abdul Karim, James Flemming, Michael Gehrmann, Joshua Baldock, Haishan Du, Rui Meireles, Brock Campbell
Copyright (c) 2020 Atlassian and others. Apache 2.0 licensed, see LICENSE.txt file. USA Patent Pending 15/788,229.