Skip to content

Latest commit

 

History

History
99 lines (81 loc) · 5.41 KB

README.md

File metadata and controls

99 lines (81 loc) · 5.41 KB
Raw

terraform-aws-alb

A Terraform module containing common configurations for an AWS new style Load Balancer (ALB/NLB). Available through the terraform registry.

NOTE: There has been significant changes to the upstream module and this README has not been updated yet.

Branch Build status
master CircleCI
master (upstream) TravisCI

Assumptions

  • You want to create a set of resources for the ALB: namely an associated target group and listener.
  • You've created a Virtual Private Cloud (VPC) + subnets where you intend to put this ALB.
  • You have one or more security groups to attach to the ALB.
  • You want to configure a listener for HTTPS/HTTP
  • You've uploaded an SSL certificate to AWS IAM if using HTTPS

The module supports both (mutually exclusive):

  • Internal IP ALBs
  • External IP ALBs

It's recommended you use this module with terraform-aws-vpc, terraform-aws-security-group, and terraform-aws-autoscaling.

Why ALB instead of ELB?

The use-case presented here appears almost identical to how one would use an ELB but we inherit a few bonuses by moving to ALB. Those are best outlined in AWS's documentation. For an example of using ALB with ECS look no further than the hashicorp example.

Resources, inputs, outputs

Resources, inputs, and outputs documented in the terraform registry.

Usage example

A full example leveraging other community modules is contained in the examples/test_fixtures directory. Here's the gist of using it via the Terraform registry:

module "alb" {
  source                        = "terraform-aws-modules/alb/aws"
  alb_name                      = "my-alb"
  region                        = "us-east-2"
  alb_security_groups           = ["sg-edcd9784", "sg-edcd9785"]
  vpc_id                        = "vpc-abcde012"
  subnets                       = ["subnet-abcde012", "subnet-bcde012a"]
  alb_protocols                 = ["HTTPS"]
  certificate_arn               = "arn:aws:iam::123456789012:server-certificate/test_cert-123456789012"
  create_log_bucket             = true
  enable_logging                = true
  log_bucket_name               = "logs-us-east-2-123456789012"
  log_location_prefix           = "my-alb-logs"
  health_check_path             = "/"

  tags {
    "Terraform" = "true"
    "Env"       = "${terraform.workspace}"
  }
}
  1. Always terraform plan to see your change before running terraform apply.
  2. Win the day!

Testing

This module has been packaged with awspec tests through test kitchen. To run them:

  1. Install rvm and the ruby version specified in the Gemfile.
  2. Install bundler and the gems from our Gemfile:
gem install bundler; bundle install
  1. Ensure your AWS environment is configured (i.e. credentials and region) for test and set TF_VAR_region to a valid AWS region (e.g. export TF_VAR_region=${AWS_REGION}).
  2. Test using kitchen test from the root of the repo.

Contributing

Report issues/questions/feature requests on in the Issues section.

Pull requests are welcome! Ideally create a feature branch and issue for every individual change made. These are the steps:

  1. Fork the repo to a personal space or org.
  2. Create your feature branch from master (git checkout -b my-new-feature).
  3. Commit your awesome changes (git commit -am 'Added some feature').
  4. Push to the branch (git push origin my-new-feature).
  5. Create a new Pull Request and tell us about your changes.

IAM Permissions

Testing and using this repo requires a minimum set of IAM permissions. Test permissions are listed in the test_fixtures README.

Change log

The changelog captures all important release notes.

Authors

Created and maintained by Brandon O'Connor - [email protected]. Many thanks to the contributers listed here!

License

MIT Licensed. See LICENSE for full details.