Git Product home page Git Product logo

xavier-romero / terraform-aws-vault-dynamodb Goto Github PK

View Code? Open in Web Editor NEW

This project forked from giuliocalzolari/terraform-aws-vault-dynamodb

0.0 0.0 0.0 221 KB

Terraform module to boot a Hashicorp Vault using AWS DynamoDB backend with additional services

Home Page: https://registry.terraform.io/modules/giuliocalzolari/vault-dynamodb

License: Do What The F*ck You Want To Public License

Shell 25.90% HCL 74.10%

terraform-aws-vault-dynamodb's Introduction

Hashicorp Vault using AWS Native

Note

This is originally forked from https://github.com/giuliocalzolari/terraform-aws-vault-dynamodb and changed to make it work with Terraform > 1.0

Overview

Hashicorp Vault is becoming one of the most popular tools for secret management, every company to improve their security but sometimes setting a Vault it requires some time and deep understanding on how to configure it. To make it easy the journey to AWS Cloud and increase the level of security of all application I've decided to create an out-of-the-box solution to configure the AWS infrastructure and setting up Vault in one click.

Diagram

Created using CloudCraft

The solution

  • AWS Autoscaling group with Userdata to install Vault and AWS Cloudwatch Agent.
  • Vault with AWSKMS Auto-Unseal
  • AWS DynamoDB as backend
  • AWS Backup for DynamoDB
  • basic Vault Provisioning
  • Export of Vault sensitive parameters in AWS Paramaters Store
  • Using AWS ARM instance with a1.medium as default to save cost

Terraform Version

This module support Terraform >= 0.12.0 tested with 0.12, 0.13 and 0.14

Current module version GitHub tag (latest by date)

Module Overview

Providers

Name Version
aws n/a
random n/a
template n/a

Inputs

Name Description Type Default Required
actions_alarm A list of actions to take when alarms are triggered. Will likely be an SNS topic for event distribution. list(string) [] no
actions_ok A list of actions to take when alarms are cleared. Will likely be an SNS topic for event distribution. list(string) [] no
admin_cidr_blocks Admin CIDR Block to access SSH and internal Application ports list(string) [] no
alb_ssl_policy ALB ssl policy string "ELBSecurityPolicy-FS-1-2-2019-08" no
app_name Application name N.1 (e.g. vault, secure, store, etc..) string "vault" no
arch EC2 Architecture arm64/x86_64 (arm64 is suggested) string "arm64" no
aws_region AWS region to launch servers. string n/a yes
default_cooldown ASG cooldown time string "30" no
dynamodb_backup Enable AWS Backup for DynamoDB backend to have multiple RPO for the Vault bool true no
ec2_subnets ASG Subnets list(string) [] no
environment Environment Name (e.g. dev, test, uat, prod, etc..) string "dev" no
extra_tags Additional Tag to add map(string) n/a yes
health_check_type ASG health_check_type string "EC2" no
instance_type EC2 Instance Size string "a1.medium" no
internal ALB internal/public flag bool false no
key_name EC2 key pair name string n/a yes
kms_key_id KMS Key Id for vault Auto-Unseal string "" no
lb_subnets ALB Subnets list(string) [] no
prefix Prefix to add on all resources string "" no
protect_from_scale_in n/a bool false no
recreate_asg_when_lc_changes Whether to recreate an autoscaling group when launch configuration changes bool true no
root_volume_size EC2 ASG Disk Size string "8" no
size ASG Size string "2" no
suffix Suffix to add on all resources string "" no
termination_policies ASG Termination Policy list(string)
[
"Default"
]
no
vault_version Vault version to install string "1.6.1" no
vpc_id VPC Id string n/a yes
zone_name Public Route53 Zone name for DNS and ACM validation string "" no

Outputs

Name Description
alb_arn ALB ARN
alb_hostname ALB DNS
dynamodb_arn Dynamodb Table ARN
iam_role_arn IAM EC2 role ARN
kms_key_id KMS key ID
root_pass_arn SSM vault root password ARN
root_token_arn SSM vault root token ARN
vault_fqdn Vault DNS

Why Not Fargate?

Fargate is a new AWS serverless technology for running Docker containers. It was considered for this project but rejected for several reasons:

  1. No support for IPC_LOCK. Vault tries to lock its memory so that secret data is never swapped to disk. Although it seems unlikely Fargate swaps to disk, the lock capability is not provided.

  2. Running on EC2 makes configuring Vault easier. The Ansible playbooks or bash included with this terraform build the Vault configuration for each server. It would be much harder to do this in a Fargate environment with sidecar containers or custom Vault images.

  3. Running on EC2 makes DNS configuration easier. The Vault redirection method means you need to know the separate DNS endpoint names and doing this on Fargate is complicated. With EC2 we register some ElasticIPs and use those for the individual servers.

Many of these problems could be solved by running Vault in a custom image. However, it seemed valuable to use the Hashicorp Vault image instead of relying on custom built ones, so EC2 was chosen as the ECS technology.

Example

please check the example folder.

Test your solution

Do you want to test your deployment? Just open your shell, adjust the DNS and kill the primary vault

for i in {1..500}
do
   RES=$(curl -s -o /dev/null -w "%{http_code}"  https://vault.[ YOUR DOMAIN ]/ui/)
   echo "[$(date +%T)] HTTP:$RES attemp:$i"
   sleep 1
done

in less than a minute the standby instance will be available and in few minutes the ASG will launch a new node

pre-commit hook

this repo is using pre-commit hook to know more click here to manually trigger use this command

pre-commit install
pre-commit run --all-files

Troubleshooting / Known Issue

  • Autoscaling Group not encrypted EBS volume required to have a dedicated AMI already encrypted and required to have the proper service role for ASG to be albe to encrypt/decrypt the ebs volume

  • ACM soft limit if you see this error Error requesting certificate: LimitExceededException: Error: you have reached your limit of 20 certificates in the last year. please increase the Limit using AWs Support of AWS Quota

  • Cloudwatch Logs KMS Error Error: Creating CloudWatch Log Group failed: InvalidParameterException: The specified KMS Key Id could not be found., double check if the KMS key have proper policy to allow the regional Cloudwatch logs Service Principle (e.g. logs.eu-central-1.amazonaws.com)

  • AWS Backup Vault can create an error (e.g. Error: error deleting Backup Vault (test-vault-dynamodb-backup): InvalidRequestException: Backup vault cannot be deleted (contains X recovery points)) if a backup is already created. Recovery point require to be mnually deleted

License

this repo is licensed under the WTFPL.

terraform-aws-vault-dynamodb's People

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.