Skip to content

Latest commit

 

History

History
116 lines (82 loc) · 4.27 KB

Readme.md

File metadata and controls

116 lines (82 loc) · 4.27 KB
Raw

cidr-house-rules

Build Status

A lightweight API and collection system to centralize important AWS resource information across multiple accounts in near-realtime

cidr-house-rules

Collection subsystem

Centralized AWS Lambda functions assume role on monitored AWS accounts to collect the following:

  • NAT Gateway IPs with associated VPCs and environment tags
  • EIPs
  • VPC CIDR blocks (including associated CIDR blocks)
  • Available IPv4 Addresses per subnet (Note that the IPv4 addresses for any stopped instances are considered unavailable)

API interface

An API interface is provided to expose collected data for consumption. Example usage is through Terraform's http data source

  • retrieve all NAT Gateways for a given AWS account (team)
  • retrieve all EIPs for a given AWS account (team)
  • lookup a given CIDR block, i.e. 10.0.16.0/16 for potential VPC peering conflicts

Terraform modules that use cidr-house-rules for dynamic data

  • todo: open source example data driven TF modules that use cidr-house-rules

Deployment

  1. Requires serverless-aws-documentation plugin
  2. Pick an AWS account to deploy cidr-house-rules to.
  3. On remote accounts applying the supporting terraform see link below to generate role access
  4. With roles generated on remote accounts you can now move serverless.yml.example to serverless.yml and add your target account roles
  5. Run serverless deploy --stage prod

Onboarding new AWS accounts

  1. Apply the following Terraform and obtain outputs
provider "aws" {
  region = "us-west-2"
}

module "cidr-house-rules-role" {
  cidr_house_rules_account_number = "123456770"
  serverless_stage                = "prod"
  serverless_region               = "us-west-2"
  source                          = "git::ssh://git@github.com/trulia/cidr-house-rules-role.git?ref=v0.0.1"
}

output "account_alias" {
  value = "${module.cidr-house-rules-role.account_alias}"
}

output "account_id" {
  value = "${module.cidr-house-rules-role.account_id}"
}

output "cidr-house-rules-role" {
  value = "${module.cidr-house-rules-role.cidr-house-rules-role}"
}
  1. With the account_alias, account_id to app
curl \
  --header "X-Api-Key: <GET_KEY_FROM_AWS_API_GATEWAY>" \
  https://yourapigateway-endpoint-generated-by-serverless.com/prod/add_account?team=trucomms?account=35682931234
  1. Add the role for Lambda functions to use in serverless.yml
Under this section add the new role, there should be a list of them already
iamRoleStatements:
  - Effect: Allow
    Action: sts:AssumeRole
    Resource:
      arn:aws:iam::<remote_aws_account_number_here>:role/role_cidr_house
  1. Run deployment job in Jenkins noted in the "Deployment" section

Example API calls

Obtain NAT gateways for platform team
curl \
  --header "X-Api-Key: <GET_KEY_FROM_AWS_API_GATEWAY>" \
   https://yourapigateway-endpoint-generated-by-serverless.com/prod/get_nat_gateways_for_team?team=platform
Check for a VPC CIDR conflict
curl \
  --header "X-Api-Key: <GET_KEY_FROM_AWS_API_GATEWAY>" \
  https://yourapigateway-endpoint-generated-by-serverless.com/dev/check_conflict?cidr=10.17.0.0/16
Add a new account
curl \
  --header "X-Api-Key: <GET_KEY_FROM_AWS_API_GATEWAY>" \
  https://yourapigateway-endpoint-generated-by-serverless.com/dev/add_account?team=my_aws_account_alias_here?account=35682931234
Supporting Terraform

cird-house-rules-role - use this Terraform on your accounts you would like your cidr-house-rules deployment to have access to. The outputs on this Terraform can then be used in your serverless.yml. The account number of the remote account can then be added using the add_account API endpoint.